Add notification options

https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters

Closes #25 #31 #32

Author: cretueusebiu

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All Notable changes to `laravel-notification-channels/webpush` will be documented in this file
 
+## 3.0.0 - 2017-11-15
+
+- Removed `id` and `create` methods from `WebPushMessage`.
+- Added `badge`, `dir`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `vibrate`, `data` methods on `WebPushMessage`.
+
 ## 2.0.0 - 2017-10-23
 
 - Added support for package discovery.

README.md

@@ -88,12 +88,20 @@ class AccountApproved extends Notification
 
     public function toWebPush($notifiable, $notification)
     {
-        return WebPushMessage::create()
-            // ->id($notification->id)
+        return (new WebPushMessage)
             ->title('Approved!')
             ->icon('/approved-icon.png')
             ->body('Your account was approved!')
             ->action('View account', 'view_account');
+            // ->data(['id' => $notification->id])
+            // ->badge()
+            // ->dir()
+            // ->image()
+            // ->lang()
+            // ->renotify()
+            // ->requireInteraction()
+            // ->tag()
+            // ->vibrate()
     }
 }
 ```

src/WebPushMessage.php

@@ -2,104 +2,144 @@
 
 namespace NotificationChannels\WebPush;
 
+/**
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#Parameters
+ */
 class WebPushMessage
 {
     /**
-     * The notification id.
-     *
      * @var string
      */
-    protected $id = null;
+    protected $title;
+
+    /**
+     * @var array
+     */
+    protected $actions = [];
 
     /**
-     * The notification title.
-     *
      * @var string
      */
-    protected $title;
+    protected $badge;
 
     /**
-     * The notification body.
-     *
      * @var string
      */
     protected $body;
 
     /**
-     * The notification icon.
-     *
      * @var string
      */
-    protected $icon = null;
+    protected $dir;
+
+    /**
+     * @var string
+     */
+    protected $icon;
+
+    /**
+     * @var string
+     */
+    protected $image;
+
+    /**
+     * @var string
+     */
+    protected $lang;
+
+    /**
+     * @var bool
+     */
+    protected $renotify;
+
+    /**
+     * @var bool
+     */
+    protected $requireInteraction;
+
+    /**
+     * @var string
+     */
+    protected $tag;
 
     /**
-     * The notification actions.
-     *
      * @var array
      */
-    protected $actions = [];
+    protected $vibrate;
+
+    /**
+     * @var mixed
+     */
+    protected $data;
 
     /**
-     * @param string $body
+     * Set the notification title.
      *
-     * @return static
+     * @param  string $value
+     * @return $this
      */
-    public static function create($body = '')
+    public function title($value)
     {
-        return new static($body);
+        $this->title = $value;
+
+        return $this;
     }
 
     /**
-     * @param string $body
+     * Add a notification action.
+     *
+     * @param  string $title
+     * @param  string $action
+     * @return $this
      */
-    public function __construct($body = '')
+    public function action($title, $action)
     {
-        $this->title = '';
+        $this->actions[] = compact('title', 'action');
 
-        $this->body = $body;
+        return $this;
     }
 
     /**
-     * Set the notification id.
+     * Set the notification badge.
      *
      * @param  string $value
      * @return $this
      */
-    public function id($value)
+    public function badge($value)
     {
-        $this->id = $value;
+        $this->badge = $value;
 
         return $this;
     }
 
     /**
-     * Set the notification title.
+     * Set the notification body.
      *
      * @param  string $value
      * @return $this
      */
-    public function title($value)
+    public function body($value)
     {
-        $this->title = $value;
+        $this->body = $value;
 
         return $this;
     }
 
     /**
-     * Set the notification body.
+     * Set the notification direction.
      *
      * @param  string $value
      * @return $this
      */
-    public function body($value)
+    public function dir($value)
     {
-        $this->body = $value;
+        $this->dir = $value;
 
         return $this;
     }
 
     /**
-     * Set the notification icon.
+     * Set the notification icon url.
      *
      * @param  string $value
      * @return $this
@@ -112,15 +152,88 @@ public function icon($value)
     }
 
     /**
-     * Set an action.
+     * Set the notification image url.
      *
-     * @param  string $title
-     * @param  string $action
+     * @param  string $value
      * @return $this
      */
-    public function action($title, $action)
+    public function image($value)
     {
-        $this->actions[] = compact('title', 'action');
+        $this->image = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the notification language.
+     *
+     * @param  string $value
+     * @return $this
+     */
+    public function lang($value)
+    {
+        $this->lang = $value;
+
+        return $this;
+    }
+
+    /**
+     * @param  bool $value
+     * @return $this
+     */
+    public function renotify($value = true)
+    {
+        $this->renotify = $value;
+
+        return $this;
+    }
+
+    /**
+     * @param  bool $value
+     * @return $this
+     */
+    public function requireInteraction($value = true)
+    {
+        $this->requireInteraction = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the notification tag.
+     *
+     * @param  string $value
+     * @return $this
+     */
+    public function tag($value)
+    {
+        $this->tag = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the notification vibration pattern.
+     *
+     * @param  array $value
+     * @return $this
+     */
+    public function vibrate($value)
+    {
+        $this->vibrate = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the notification arbitrary data.
+     *
+     * @param  mixed $value
+     * @return $this
+     */
+    public function data($value)
+    {
+        $this->data = $value;
 
         return $this;
     }
@@ -132,12 +245,27 @@ public function action($title, $action)
      */
     public function toArray()
     {
-        return [
-            'id' => $this->id,
-            'title' => $this->title,
-            'body' => $this->body,
-            'actions' => $this->actions,
-            'icon' => $this->icon,
-        ];
+        return collect([
+            'title',
+            'actions',
+            'badge',
+            'body',
+            'dir',
+            'icon',
+            'image',
+            'lang',
+            'renotify',
+            'requireInteraction',
+            'tag',
+            'vibrate',
+            'data',
+        ])
+        ->mapWithKeys(function ($option) {
+            return [$option => $this->{$option}];
+        })
+        ->reject(function ($value) {
+            return is_null($value);
+        })
+        ->toArray();
     }
 }

tests/ChannelTest.php

@@ -44,6 +44,8 @@ public function it_can_send_a_notification()
         $this->testUser->updatePushSubscription('endpoint', 'key', 'token');
 
         $this->channel->send($this->testUser, new TestNotification);
+
+        $this->assertTrue(true);
     }
 
     /** @test */
@@ -81,6 +83,14 @@ public function it_will_delete_invalid_subscriptions()
      */
     protected function getPayload()
     {
-        return '{"id":1,"title":"Title","body":"Body","actions":[{"title":"Title","action":"Action"}],"icon":"Icon"}';
+        return json_encode([
+            'title' => 'Title',
+            'actions' => [
+                ['title' => 'Title', 'action' => 'Action']
+            ],
+            'body' => 'Body',
+            'icon' => 'Icon',
+            'data' => ['id' => 1],
+        ]);
     }
 }