Add query and verify option (#16)

* Add a short description to the doc comment of WebhookMessage properties

* Update Guzzle options: verify and query

Allow setting the verify option to a boolean or a string
Add the query option to modify the GET parameters of the request

* Fix StyleCI

Author: Guillaume

README.md

@@ -76,8 +76,10 @@ public function routeNotificationForWebhook()
 ### Available methods
 
 - `data('')`: Accepts a JSON-encodable value for the Webhook body.
+- `query('')`: Accepts an associative array of query string values to add to the request.
 - `userAgent('')`: Accepts a string value for the Webhook user agent.
 - `header($name, $value)`: Sets additional headers to send with the POST Webhook.
+- `verify()`: Enable the SSL certificate verification or provide the path to a CA bundle
 
 
 ## Changelog

src/WebhookChannel.php

@@ -37,8 +37,9 @@ public function send($notifiable, Notification $notification)
         $webhookData = $notification->toWebhook($notifiable)->toArray();
 
         $response = $this->client->post($url, [
+            'query' => Arr::get($webhookData, 'query'),
             'body' => json_encode(Arr::get($webhookData, 'data')),
-            'verify' => false,
+            'verify' => Arr::get($webhookData, 'verify'),
             'headers' => Arr::get($webhookData, 'headers'),
         ]);
 

src/WebhookMessage.php

@@ -4,15 +4,41 @@
 
 class WebhookMessage
 {
-    /** @var mixed */
+    /**
+     * The GET parameters of the request.
+     *
+     * @var array|string|null
+     */
+    protected $query;
+
+    /**
+     * The POST data of the Webhook request.
+     *
+     * @var mixed
+     */
     protected $data;
 
-    /** @var array|null */
+    /**
+     * The headers to send with the request.
+     *
+     * @var array|null
+     */
     protected $headers;
 
-    /** @var string|null */
+    /**
+     * The user agent header.
+     *
+     * @var string|null
+     */
     protected $userAgent;
 
+    /**
+     * The Guzzle verify option.
+     *
+     * @var bool|string
+     */
+    protected $verify = false;
+
     /**
      * @param mixed $data
      *
@@ -31,6 +57,20 @@ public function __construct($data = '')
         $this->data = $data;
     }
 
+    /**
+     * Set the Webhook parameters to be URL encoded.
+     *
+     * @param mixed $query
+     *
+     * @return $this
+     */
+    public function query($query)
+    {
+        $this->query = $query;
+
+        return $this;
+    }
+
     /**
      * Set the Webhook data to be JSON encoded.
      *
@@ -74,14 +114,28 @@ public function userAgent($userAgent)
         return $this;
     }
 
+    /**
+     * Indicate that the request should be verified.
+     *
+     * @return $this
+     */
+    public function verify($value = true)
+    {
+        $this->verify = $value;
+
+        return $this;
+    }
+
     /**
      * @return array
      */
     public function toArray()
     {
         return [
+            'query' => $this->query,
             'data' => $this->data,
             'headers' => $this->headers,
+            'verify' => $this->verify,
         ];
     }
 }

tests/ChannelTest.php

@@ -21,6 +21,7 @@ public function it_can_send_a_notification()
             ->once()
             ->with('https://notifiable-webhook-url.com',
                 [
+                    'query' => null,
                     'body' => '{"payload":{"webhook":"data"}}',
                     'verify' => false,
                     'headers' => [
@@ -42,6 +43,7 @@ public function it_can_send_a_notification_with_2xx_status()
             ->once()
             ->with('https://notifiable-webhook-url.com',
                 [
+                    'query' => null,
                     'body' => '{"payload":{"webhook":"data"}}',
                     'verify' => false,
                     'headers' => [
@@ -54,6 +56,31 @@ public function it_can_send_a_notification_with_2xx_status()
         $channel->send(new TestNotifiable(), new TestNotification());
     }
 
+    /** @test */
+    public function it_can_send_a_notification_with_query_string()
+    {
+        $response = new Response();
+        $client = Mockery::mock(Client::class);
+        $client->shouldReceive('post')
+            ->once()
+            ->with('https://notifiable-webhook-url.com',
+                [
+                    'query' => [
+                        'webhook' => 'data',
+                    ],
+                    'body' => '""',
+                    'verify' => false,
+                    'headers' => [
+                        'User-Agent' => 'WebhookAgent',
+                        'X-Custom' => 'CustomHeader',
+                    ],
+                ])
+            ->andReturn($response);
+
+        $channel = new WebhookChannel($client);
+        $channel->send(new TestNotifiable(), new QueryTestNotification());
+    }
+
     /**
      * @expectedException NotificationChannels\Webhook\Exceptions\CouldNotSendNotification
      * @test
@@ -98,3 +125,15 @@ public function toWebhook($notifiable)
             ->header('X-Custom', 'CustomHeader');
     }
 }
+
+class QueryTestNotification extends Notification
+{
+    public function toWebhook($notifiable)
+    {
+        return
+            (new WebhookMessage())
+                ->query(['webhook' => 'data'])
+                ->userAgent('WebhookAgent')
+                ->header('X-Custom', 'CustomHeader');
+    }
+}

tests/MessageTest.php

@@ -33,6 +33,13 @@ public function it_provides_a_create_method()
         $this->assertEquals(['foo' => 'bar'], Arr::get($message->toArray(), 'data'));
     }
 
+    /** @test */
+    public function it_can_set_the_webhook_query()
+    {
+        $this->message->query(['foo' => 'bar']);
+        $this->assertEquals(['foo' => 'bar'], Arr::get($this->message->toArray(), 'query'));
+    }
+
     /** @test */
     public function it_can_set_the_webhook_data()
     {
@@ -53,4 +60,11 @@ public function it_can_set_a_custom_header()
         $this->message->header('X-Custom', 'Value');
         $this->assertEquals(['X-Custom' => 'Value'], Arr::get($this->message->toArray(), 'headers'));
     }
+
+    /** @test */
+    public function it_can_verify_the_request()
+    {
+        $this->message->verify();
+        $this->assertEquals(true, Arr::get($this->message->toArray(), 'verify'));
+    }
 }