Merge pull request #1 from binary-cats/analysis-OMM4OL

cyrillkalita · web-flow · commit ed236ae2db16 · 2019-12-28T14:01:27.000-06:00
Apply fixes from StyleCI
diff --git a/src/Contracts/WebhookEvent.php b/src/Contracts/WebhookEvent.php
@@ -4,5 +4,4 @@
 
 interface WebhookEvent
 {
-
 }
diff --git a/src/Event.php b/src/Event.php
@@ -3,19 +3,18 @@
 namespace BinaryCats\MailgunWebhooks;
 
 use BinaryCats\MailgunWebhooks\Contracts\WebhookEvent;
-use Illuminate\Support\Arr;
 
 class Event implements WebhookEvent
 {
     /**
-     * Attributes from the event
+     * Attributes from the event.
      *
      * @var array
      */
     public $attributes = [];
 
     /**
-     * Create new Event
+     * Create new Event.
      *
      * @param array $attributes
      */
@@ -25,11 +24,11 @@ public function __construct($attributes)
     }
 
     /**
-     * Construct the event
+     * Construct the event.
      *
      * @return Event
      */
-    public static function constructFrom($data) : Event
+    public static function constructFrom($data) : self
     {
         return new static($data);
     }
diff --git a/src/Exceptions/WebhookFailed.php b/src/Exceptions/WebhookFailed.php
@@ -7,17 +7,17 @@
 
 class WebhookFailed extends Exception
 {
-    public static function signingSecretNotSet() : WebhookFailed
+    public static function signingSecretNotSet() : self
     {
         return new static('The webhook signing secret is not set. Make sure that the `signing_secret` config key is set to the correct value.');
     }
 
-    public static function jobClassDoesNotExist(string $jobClass, WebhookCall $webhookCall): WebhookFailed
+    public static function jobClassDoesNotExist(string $jobClass, WebhookCall $webhookCall): self
     {
         return new static("Could not process webhook id `{$webhookCall->id}` of type `{$webhookCall->type} because the configured jobclass `$jobClass` does not exist.");
     }
 
-    public static function missingType(WebhookCall $webhookCall): WebhookFailed
+    public static function missingType(WebhookCall $webhookCall): self
     {
         return new static("Webhook call id `{$webhookCall->id}` did not contain a type. Valid Mailgun webhook calls should always contain a type.");
     }
diff --git a/src/Jobs/HandleDelivered.php b/src/Jobs/HandleDelivered.php
@@ -11,14 +11,14 @@ class HandleDelivered
     use Dispatchable, SerializesModels;
 
     /**
-     * Bind the implementation
+     * Bind the implementation.
      *
      * @var Spatie\WebhookClient\Models\WebhookCall
      */
     protected $webhookCall;
 
     /**
-     * Create new Job
+     * Create new Job.
      *
      * @param Spatie\WebhookClient\Models\WebhookCall $webhookCall
      */
@@ -34,6 +34,5 @@ public function __construct(WebhookCall $webhookCall)
      */
     public function handle()
     {
-
     }
 }
diff --git a/src/MailgunSignatureValidator.php b/src/MailgunSignatureValidator.php
@@ -3,34 +3,33 @@
 namespace BinaryCats\MailgunWebhooks;
 
 use Exception;
-use BinaryCats\MailgunWebhooks\Webhook;
 use Illuminate\Http\Request;
-use Spatie\WebhookClient\WebhookConfig;
 use Spatie\WebhookClient\SignatureValidator\SignatureValidator;
+use Spatie\WebhookClient\WebhookConfig;
 
 class MailgunSignatureValidator implements SignatureValidator
 {
     /**
-     * Bind the implemetation
+     * Bind the implemetation.
      *
      * @var Illuminate\Http\Request
      */
     protected $request;
 
     /**
-     * Inject the config
+     * Inject the config.
      *
      * @var Spatie\WebhookClient\WebhookConfig
      */
     protected $config;
 
     /**
-     * True if the signature has been valiates
+     * True if the signature has been valiates.
      *
      * @param  Illuminate\Http\Request       $request
      * @param  Spatie\WebhookClient\WebhookConfig $config
      *
-     * @return boolean
+     * @return bool
      */
     public function isValid(Request $request, WebhookConfig $config): bool
     {
diff --git a/src/MailgunWebhooksController.php b/src/MailgunWebhooksController.php
@@ -10,7 +10,7 @@
 class MailgunWebhooksController
 {
     /**
-     * Invoke controller method
+     * Invoke controller method.
      *
      * @param  \Illuminate\Http\Request $request
      * @param  string|null $configKey
diff --git a/src/MailgunWebhooksServiceProvider.php b/src/MailgunWebhooksServiceProvider.php
@@ -8,7 +8,7 @@
 class MailgunWebhooksServiceProvider extends ServiceProvider
 {
     /**
-     * Boot application services
+     * Boot application services.
      *
      * @return void
      */
diff --git a/src/ProcessMailgunWebhookJob.php b/src/ProcessMailgunWebhookJob.php
@@ -9,14 +9,14 @@
 class ProcessMailgunWebhookJob extends ProcessWebhookJob
 {
     /**
-     * Name of the payload key to contain the type of event
+     * Name of the payload key to contain the type of event.
      *
      * @var string
      */
     protected $key = 'event-data.event';
 
     /**
-     * Handle the process
+     * Handle the process.
      *
      * @return void
      */
diff --git a/src/Webhook.php b/src/Webhook.php
@@ -2,12 +2,10 @@
 
 namespace BinaryCats\MailgunWebhooks;
 
-use BinaryCats\MailgunWebhooks\Exceptions\UnexpectedValueException;
-
 class Webhook
 {
     /**
-     * Validate and raise an appropriate event
+     * Validate and raise an appropriate event.
      *
      * @param  $payload
      * @param  array $signature
@@ -16,9 +14,9 @@ class Webhook
      */
     public static function constructEvent(array $payload, array $signature, string $secret) : Event
     {
-        # verify we are good, else throw an expection
+        // verify we are good, else throw an expection
         WebhookSignature::make($signature, $secret)->verify();
-        # Make an event
+        // Make an event
         return Event::constructFrom($payload);
     }
 }
diff --git a/src/WebhookSignature.php b/src/WebhookSignature.php
@@ -2,27 +2,26 @@
 
 namespace BinaryCats\MailgunWebhooks;
 
-use BinaryCats\MailgunWebhooks\Exceptions\WebhookFailed;
 use Illuminate\Support\Arr;
 
 class WebhookSignature
 {
     /**
-     * Signature array
+     * Signature array.
      *
      * @var array
      */
     protected $signatureArray;
 
     /**
-     * Signature secret
+     * Signature secret.
      *
      * @var string
      */
     protected $secret;
 
     /**
-     * Create new Signature
+     * Create new Signature.
      *
      * @param array  $signatureArray
      * @param string $secret
@@ -34,7 +33,7 @@ public function __construct(array $signatureArray, string $secret)
     }
 
     /**
-     * Statis accessor into the class constructor
+     * Statis accessor into the class constructor.
      *
      * @param  array  $signatureArray
      * @param  string $secret
@@ -46,17 +45,17 @@ public static function make($signatureArray, string $secret)
     }
 
     /**
-     * True if the signature is valid
+     * True if the signature is valid.
      *
-     * @return boolean
+     * @return bool
      */
     public function verify() : bool
     {
         return hash_equals($this->signature, $this->computeSignature());
     }
 
     /**
-     * Compute expected signature
+     * Compute expected signature.
      *
      * @return string
      */
@@ -71,7 +70,7 @@ protected function computeSignature()
     }
 
     /**
-     * Magically access items from signature array
+     * Magically access items from signature array.
      *
      * @param  string $attribute
      * @return mixed
diff --git a/tests/DummyJob.php b/tests/DummyJob.php
@@ -7,14 +7,14 @@
 class DummyJob
 {
     /**
-     * Bind the implementation
+     * Bind the implementation.
      *
      * @var Spatie\WebhookClient\Models\WebhookCall
      */
     public $webhookCall;
 
     /**
-     * Create new Job
+     * Create new Job.
      *
      * @param Spatie\WebhookClient\Models\WebhookCall $webhookCall
      */
@@ -24,7 +24,7 @@ public function __construct(WebhookCall $webhookCall)
     }
 
     /**
-     * Handle the job
+     * Handle the job.
      *
      * @return void
      */
diff --git a/tests/IntegrationTest.php b/tests/IntegrationTest.php
@@ -2,9 +2,9 @@
 
 namespace BinaryCats\MailgunWebhooks\Tests;
 
+use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Route;
-use Illuminate\Support\Arr;
 use Spatie\WebhookClient\Models\WebhookCall;
 
 class IntegrationTest extends TestCase
@@ -29,7 +29,7 @@ public function it_can_handle_a_valid_request()
             'event-data' => [
                 'event' => 'my.type',
                 'key' => 'value',
-            ]
+            ],
         ];
 
         Arr::set($payload, 'signature', $this->determineMailgunSignature($payload));
@@ -63,7 +63,7 @@ public function a_request_with_an_invalid_signature_wont_be_logged()
             'event-data' => [
                 'event' => 'my.type',
                 'key' => 'value',
-            ]
+            ],
         ];
 
         Arr::set($payload, 'signature', 'invalid_signature');
@@ -119,7 +119,7 @@ public function a_request_with_a_config_key_will_use_the_correct_signing_secret(
             'event-data' => [
                 'event' => 'my.type',
                 'key' => 'value',
-            ]
+            ],
         ];
 
         Arr::set($payload, 'signature', $this->determineMailgunSignature($payload));
diff --git a/tests/MailgunWebhookCallTest.php b/tests/MailgunWebhookCallTest.php
@@ -2,9 +2,9 @@
 
 namespace BinaryCats\MailgunWebhooks\Tests;
 
+use BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob;
 use Illuminate\Support\Facades\Event;
 use Spatie\WebhookClient\Models\WebhookCall;
-use BinaryCats\MailgunWebhooks\ProcessMailgunWebhookJob;
 
 class MailgunWebhookCallTest extends TestCase
 {
@@ -28,7 +28,7 @@ public function setUp(): void
                 'event-data' => [
                     'event' => 'my.type',
                     'key' => 'value',
-                ]
+                ],
             ],
         ]);
 
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -2,12 +2,12 @@
 
 namespace BinaryCats\MailgunWebhooks\Tests;
 
-use Exception;
+use BinaryCats\MailgunWebhooks\MailgunWebhooksServiceProvider;
 use CreateWebhookCallsTable;
-use Illuminate\Foundation\Exceptions\Handler;
+use Exception;
 use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Foundation\Exceptions\Handler;
 use Orchestra\Testbench\TestCase as OrchestraTestCase;
-use BinaryCats\MailgunWebhooks\MailgunWebhooksServiceProvider;
 
 abstract class TestCase extends OrchestraTestCase
 {
@@ -56,8 +56,7 @@ protected function getPackageProviders($app)
 
     protected function disableExceptionHandling()
     {
-        $this->app->instance(ExceptionHandler::class, new class extends Handler
-        {
+        $this->app->instance(ExceptionHandler::class, new class extends Handler {
             public function __construct()
             {
             }
@@ -86,9 +85,9 @@ protected function determineMailgunSignature(array $payload, string $configKey =
         $token = hash_hmac('sha256', $timestampedPayload, $secret);
 
         return [
-            "timestamp" => $timestamp,
-            "token" => $token,
-            "signature" => hash_hmac('sha256', "{$timestamp}.{$token}", $secret),
+            'timestamp' => $timestamp,
+            'token' => $token,
+            'signature' => hash_hmac('sha256', "{$timestamp}.{$token}", $secret),
         ];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,4 @@`
`4`	`4`
`5`	`5`	`interface WebhookEvent`
`6`	`6`	`{`
`7`		`-`
`8`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,19 +3,18 @@`
`3`	`3`	`namespace BinaryCats\MailgunWebhooks;`
`4`	`4`
`5`	`5`	`use BinaryCats\MailgunWebhooks\Contracts\WebhookEvent;`
`6`		`-use Illuminate\Support\Arr;`
`7`	`6`
`8`	`7`	`class Event implements WebhookEvent`
`9`	`8`	`{`
`10`	`9`	`/**`
`11`		`- * Attributes from the event`
	`10`	`+ * Attributes from the event.`
`12`	`11`	`*`
`13`	`12`	`* @var array`
`14`	`13`	`*/`
`15`	`14`	`public $attributes = [];`
`16`	`15`
`17`	`16`	`/**`
`18`		`- * Create new Event`
	`17`	`+ * Create new Event.`
`19`	`18`	`*`
`20`	`19`	`* @param array $attributes`
`21`	`20`	`*/`
`@@ -25,11 +24,11 @@ public function __construct($attributes)`
`25`	`24`	`}`
`26`	`25`
`27`	`26`	`/**`
`28`		`- * Construct the event`
	`27`	`+ * Construct the event.`
`29`	`28`	`*`
`30`	`29`	`* @return Event`
`31`	`30`	`*/`
`32`		`- public static function constructFrom($data) : Event`
	`31`	`+ public static function constructFrom($data) : self`
`33`	`32`	`{`
`34`	`33`	`return new static($data);`
`35`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,17 +7,17 @@`
`7`	`7`
`8`	`8`	`class WebhookFailed extends Exception`
`9`	`9`	`{`
`10`		`- public static function signingSecretNotSet() : WebhookFailed`
	`10`	`+ public static function signingSecretNotSet() : self`
`11`	`11`	`{`
`12`	`12`	return new static('The webhook signing secret is not set. Make sure that the `signing_secret` config key is set to the correct value.');
`13`	`13`	`}`
`14`	`14`
`15`		`- public static function jobClassDoesNotExist(string $jobClass, WebhookCall $webhookCall): WebhookFailed`
	`15`	`+ public static function jobClassDoesNotExist(string $jobClass, WebhookCall $webhookCall): self`
`16`	`16`	`{`
`17`	`17`	return new static("Could not process webhook id `{$webhookCall->id}` of type `{$webhookCall->type} because the configured jobclass `$jobClass` does not exist.");
`18`	`18`	`}`
`19`	`19`
`20`		`- public static function missingType(WebhookCall $webhookCall): WebhookFailed`
	`20`	`+ public static function missingType(WebhookCall $webhookCall): self`
`21`	`21`	`{`
`22`	`22`	return new static("Webhook call id `{$webhookCall->id}` did not contain a type. Valid Mailgun webhook calls should always contain a type.");
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,14 +11,14 @@ class HandleDelivered`
`11`	`11`	`use Dispatchable, SerializesModels;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * Bind the implementation`
	`14`	`+ * Bind the implementation.`
`15`	`15`	`*`
`16`	`16`	`* @var Spatie\WebhookClient\Models\WebhookCall`
`17`	`17`	`*/`
`18`	`18`	`protected $webhookCall;`
`19`	`19`
`20`	`20`	`/**`
`21`		`- * Create new Job`
	`21`	`+ * Create new Job.`
`22`	`22`	`*`
`23`	`23`	`* @param Spatie\WebhookClient\Models\WebhookCall $webhookCall`
`24`	`24`	`*/`
`@@ -34,6 +34,5 @@ public function __construct(WebhookCall $webhookCall)`
`34`	`34`	`*/`
`35`	`35`	`public function handle()`
`36`	`36`	`{`
`37`		`-`
`38`	`37`	`}`
`39`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class MailgunWebhooksController`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`		`- * Invoke controller method`
	`13`	`+ * Invoke controller method.`
`14`	`14`	`*`
`15`	`15`	`* @param \Illuminate\Http\Request $request`
`16`	`16`	`* @param string\|null $configKey`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`class MailgunWebhooksServiceProvider extends ServiceProvider`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`		`- * Boot application services`
	`11`	`+ * Boot application services.`
`12`	`12`	`*`
`13`	`13`	`* @return void`
`14`	`14`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -9,14 +9,14 @@`
`9`	`9`	`class ProcessMailgunWebhookJob extends ProcessWebhookJob`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`		`- * Name of the payload key to contain the type of event`
	`12`	`+ * Name of the payload key to contain the type of event.`
`13`	`13`	`*`
`14`	`14`	`* @var string`
`15`	`15`	`*/`
`16`	`16`	`protected $key = 'event-data.event';`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Handle the process`
	`19`	`+ * Handle the process.`
`20`	`20`	`*`
`21`	`21`	`* @return void`
`22`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,10 @@`
`2`	`2`
`3`	`3`	`namespace BinaryCats\MailgunWebhooks;`
`4`	`4`
`5`		`-use BinaryCats\MailgunWebhooks\Exceptions\UnexpectedValueException;`
`6`		`-`
`7`	`5`	`class Webhook`
`8`	`6`	`{`
`9`	`7`	`/**`
`10`		`- * Validate and raise an appropriate event`
	`8`	`+ * Validate and raise an appropriate event.`
`11`	`9`	`*`
`12`	`10`	`* @param $payload`
`13`	`11`	`* @param array $signature`
`@@ -16,9 +14,9 @@ class Webhook`
`16`	`14`	`*/`
`17`	`15`	`public static function constructEvent(array $payload, array $signature, string $secret) : Event`
`18`	`16`	`{`
`19`		`- # verify we are good, else throw an expection`
	`17`	`+ // verify we are good, else throw an expection`
`20`	`18`	`WebhookSignature::make($signature, $secret)->verify();`
`21`		`- # Make an event`
	`19`	`+ // Make an event`
`22`	`20`	`return Event::constructFrom($payload);`
`23`	`21`	`}`
`24`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,27 +2,26 @@`
`2`	`2`
`3`	`3`	`namespace BinaryCats\MailgunWebhooks;`
`4`	`4`
`5`		`-use BinaryCats\MailgunWebhooks\Exceptions\WebhookFailed;`
`6`	`5`	`use Illuminate\Support\Arr;`
`7`	`6`
`8`	`7`	`class WebhookSignature`
`9`	`8`	`{`
`10`	`9`	`/**`
`11`		`- * Signature array`
	`10`	`+ * Signature array.`
`12`	`11`	`*`
`13`	`12`	`* @var array`
`14`	`13`	`*/`
`15`	`14`	`protected $signatureArray;`
`16`	`15`
`17`	`16`	`/**`
`18`		`- * Signature secret`
	`17`	`+ * Signature secret.`
`19`	`18`	`*`
`20`	`19`	`* @var string`
`21`	`20`	`*/`
`22`	`21`	`protected $secret;`
`23`	`22`
`24`	`23`	`/**`
`25`		`- * Create new Signature`
	`24`	`+ * Create new Signature.`
`26`	`25`	`*`
`27`	`26`	`* @param array $signatureArray`
`28`	`27`	`* @param string $secret`
`@@ -34,7 +33,7 @@ public function __construct(array $signatureArray, string $secret)`
`34`	`33`	`}`
`35`	`34`
`36`	`35`	`/**`
`37`		`- * Statis accessor into the class constructor`
	`36`	`+ * Statis accessor into the class constructor.`
`38`	`37`	`*`
`39`	`38`	`* @param array $signatureArray`
`40`	`39`	`* @param string $secret`
`@@ -46,17 +45,17 @@ public static function make($signatureArray, string $secret)`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`/**`
`49`		`- * True if the signature is valid`
	`48`	`+ * True if the signature is valid.`
`50`	`49`	`*`
`51`		`- * @return boolean`
	`50`	`+ * @return bool`
`52`	`51`	`*/`
`53`	`52`	`public function verify() : bool`
`54`	`53`	`{`
`55`	`54`	`return hash_equals($this->signature, $this->computeSignature());`
`56`	`55`	`}`
`57`	`56`
`58`	`57`	`/**`
`59`		`- * Compute expected signature`
	`58`	`+ * Compute expected signature.`
`60`	`59`	`*`
`61`	`60`	`* @return string`
`62`	`61`	`*/`
`@@ -71,7 +70,7 @@ protected function computeSignature()`
`71`	`70`	`}`
`72`	`71`
`73`	`72`	`/**`
`74`		`- * Magically access items from signature array`
	`73`	`+ * Magically access items from signature array.`
`75`	`74`	`*`
`76`	`75`	`* @param string $attribute`
`77`	`76`	`* @return mixed`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,14 @@`
`7`	`7`	`class DummyJob`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`		`- * Bind the implementation`
	`10`	`+ * Bind the implementation.`
`11`	`11`	`*`
`12`	`12`	`* @var Spatie\WebhookClient\Models\WebhookCall`
`13`	`13`	`*/`
`14`	`14`	`public $webhookCall;`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * Create new Job`
	`17`	`+ * Create new Job.`
`18`	`18`	`*`
`19`	`19`	`* @param Spatie\WebhookClient\Models\WebhookCall $webhookCall`
`20`	`20`	`*/`
`@@ -24,7 +24,7 @@ public function __construct(WebhookCall $webhookCall)`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * Handle the job`
	`27`	`+ * Handle the job.`
`28`	`28`	`*`
`29`	`29`	`* @return void`
`30`	`30`	`*/`