From 2f587aac28d7a554a0e3a50d0317dff0040ea5c7 Mon Sep 17 00:00:00 2001 From: Charlotta Jung Date: Wed, 11 Oct 2017 23:15:23 +0200 Subject: [PATCH 1/6] :art: ADD README.md and docblock I add README.md file and docblocks for classes. --- .idea/modules.xml | 1 + .idea/workspace.xml | 229 +++++++++++++++++------- README.md | 33 ++++ src/AuthValidator.php | 7 +- src/AuthValidatorContract.php | 7 +- src/AuthValidatorServiceProvider.php | 4 + src/Exceptions/HashFailedException.php | 7 +- src/Exceptions/NonceFailedException.php | 7 +- src/HMacValidator.php | 7 +- src/HMacValidatorContract.php | 7 +- src/NonceContract.php | 7 +- src/NonceGenerator.php | 6 +- 12 files changed, 244 insertions(+), 78 deletions(-) create mode 100644 README.md diff --git a/.idea/modules.xml b/.idea/modules.xml index bff0671..9a8e2e1 100644 --- a/.idea/modules.xml +++ b/.idea/modules.xml @@ -4,6 +4,7 @@ + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml index f2b119f..7a1a562 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,9 +2,18 @@ - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - + - + - + @@ -189,7 +210,7 @@ - + @@ -197,81 +218,81 @@ - + - - + + - + - - + + - + - - - - - + + + - + - - + + - + - - + + - - + + - + - - + + - + - - + + - + - - - + + + + + - + @@ -287,24 +308,24 @@ - - - - - - - - - - + + + + + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index 55dae61..672a641 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,6 @@ TODO: Write usage instructions 4. Push to the branch: `git push origin my-new-feature` 5. Submit a pull request :D -## History - -TODO: Write history - ## Credits [Dylan DPC](https://github.com/Dylan-DPC) diff --git a/src/AuthValidator.php b/src/AuthValidator.php index 1115b00..44bcbff 100644 --- a/src/AuthValidator.php +++ b/src/AuthValidator.php @@ -4,10 +4,6 @@ use Illuminate\Database\Eloquent\Model; -/** - * Class AuthValidator - * @package Dpc\HashVerifier - */ class AuthValidator implements AuthValidatorContract { protected $generator; diff --git a/src/AuthValidatorContract.php b/src/AuthValidatorContract.php index 8137123..97631e3 100644 --- a/src/AuthValidatorContract.php +++ b/src/AuthValidatorContract.php @@ -4,10 +4,6 @@ use Illuminate\Database\Eloquent\Model; -/** - * Interface AuthValidatorContract - * @package Dpc\HashVerifier - */ interface AuthValidatorContract { diff --git a/src/AuthValidatorServiceProvider.php b/src/AuthValidatorServiceProvider.php index 46d77d8..8281e80 100644 --- a/src/AuthValidatorServiceProvider.php +++ b/src/AuthValidatorServiceProvider.php @@ -4,10 +4,6 @@ use Illuminate\Support\ServiceProvider; -/** - * Class AuthValidatorServiceProvider - * @package Dpc\HashVerifier - */ class AuthValidatorServiceProvider extends ServiceProvider { /** diff --git a/src/Exceptions/HashFailedException.php b/src/Exceptions/HashFailedException.php index 6307c86..6947a42 100644 --- a/src/Exceptions/HashFailedException.php +++ b/src/Exceptions/HashFailedException.php @@ -2,10 +2,6 @@ namespace Dpc\HashVerifier\Exceptions; -/** - * Class HashFailedException - * @package Dpc\HashVerifier\Exceptions - */ class HashFailedException extends \Exception { diff --git a/src/Exceptions/NonceFailedException.php b/src/Exceptions/NonceFailedException.php index d33cf9f..d8ee471 100644 --- a/src/Exceptions/NonceFailedException.php +++ b/src/Exceptions/NonceFailedException.php @@ -2,10 +2,6 @@ namespace Dpc\HashVerifier\Exceptions; -/** - * Class NonceFailedException - * @package Dpc\HashVerifier\Exceptions - */ class NonceFailedException extends \Exception { diff --git a/src/HMacValidator.php b/src/HMacValidator.php index 6bfa025..d47f1c9 100644 --- a/src/HMacValidator.php +++ b/src/HMacValidator.php @@ -2,10 +2,6 @@ namespace Dpc\HashVerifier; -/** - * Class HMacValidator - * @package Dpc\HashVerifier - */ class HMacValidator implements HMacValidatorContract { diff --git a/src/HMacValidatorContract.php b/src/HMacValidatorContract.php index 7951f2f..4f2b66b 100644 --- a/src/HMacValidatorContract.php +++ b/src/HMacValidatorContract.php @@ -2,10 +2,6 @@ namespace Dpc\HashVerifier; -/** - * Interface HMacValidatorContract - * @package Dpc\HashVerifier - */ interface HMacValidatorContract { /** diff --git a/src/NonceContract.php b/src/NonceContract.php index d840b8e..d671080 100644 --- a/src/NonceContract.php +++ b/src/NonceContract.php @@ -4,10 +4,6 @@ use Illuminate\Database\Eloquent\Model; -/** - * Interface NonceContract - * @package Dpc\HashVerifier - */ interface NonceContract { /** diff --git a/src/NonceGenerator.php b/src/NonceGenerator.php index 5b5022c..fdb431c 100644 --- a/src/NonceGenerator.php +++ b/src/NonceGenerator.php @@ -5,10 +5,6 @@ use Illuminate\Database\Eloquent\Model; use function Sodium\randombytes_buf; -/** - * Class NonceGenerator - * @package Dpc\HashVerifier - */ class NonceGenerator implements NonceContract { /** From eca52814b54a497ce880661b409be419b1d6893e Mon Sep 17 00:00:00 2001 From: Charlotta Jung Date: Thu, 12 Oct 2017 00:09:48 +0200 Subject: [PATCH 3/6] Remve ide folder from tracked folders --- .gitignore | 2 +- .idea/modules.xml | 10 -- .idea/workspace.xml | 331 -------------------------------------------- 3 files changed, 1 insertion(+), 342 deletions(-) delete mode 100644 .idea/modules.xml delete mode 100644 .idea/workspace.xml diff --git a/.gitignore b/.gitignore index f7f8ac3..56e110b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -/.idea/ +/.idea/* /vendor/ diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 9a8e2e1..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index 3de5316..0000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - true - DEFINITION_ORDER - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -