Merge branch 'master' into master

Author: Stalinko

README.md

@@ -1,4 +1,4 @@
-# Pusher Beams push notifications channel for Laravel 5.5+, 6.x & 7.x 
+# Pusher Beams push notifications channel for Laravel 5.5+, 6.x, 7.x & 8.x
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/pusher-push-notifications.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/pusher-push-notifications)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
@@ -17,16 +17,21 @@ Also please note that prior to version 2.0, this package integrated with Pusher'
 
 ## Contents
 
-- [Installation](#installation)
-	- [Setting up your Pusher account](#setting-up-your-pusher-account)
-- [Usage](#usage)
-	- [Available Message methods](#available-message-methods)
-- [Changelog](#changelog)
-- [Testing](#testing)
-- [Security](#security)
-- [Contributing](#contributing)
-- [Credits](#credits)
-- [License](#license)
+- [Pusher Beams push notifications channel for Laravel 5.5+, 6.x, 7.x & 8.x](#pusher-beams-push-notifications-channel-for-laravel-55-6x-7x--8x)
+  - [Contents](#contents)
+  - [Installation](#installation)
+    - [Setting up your Pusher account](#setting-up-your-pusher-account)
+  - [Usage](#usage)
+    - [Available Message methods](#available-message-methods)
+    - [Sending to multiple platforms](#sending-to-multiple-platforms)
+    - [Routing a message](#routing-a-message)
+    - [Publish to users](#publish-to-users)
+  - [Changelog](#changelog)
+  - [Testing](#testing)
+  - [Security](#security)
+  - [Contributing](#contributing)
+  - [Credits](#credits)
+  - [License](#license)
 
 
 ## Installation
@@ -87,9 +92,11 @@ class AccountApproved extends Notification
 
 ### Available Message methods
 
-- `platform('')`: Accepts a string value of `iOS` or `Android`.
+- `platform('')`: Accepts a string value of `iOS`, `Android` or `web`.
 - `iOS()`: Sets the platform value to iOS.
 - `android()`: Sets the platform value to Android.
+- `web()`: Sets the platform value to web.
+- `link()`: Accepts a string value which will lead to URI specified on notification click.
 - `title('')`: Accepts a string value for the title.
 - `body('')`: Accepts a string value for the body.
 - `sound('')`: Accepts a string value for the notification sound file. Notice that if you leave blank the default sound value will be `default`.
@@ -120,11 +127,42 @@ public function toPushNotification($notifiable)
 ```
 
 > - Notice that iOS is the default platform, which means you don't have to call `->iOS()`.
-> - When using `withAndroid()` or `withiOS()` you don't have to define the platform, it's done behind the scenes for you.
+> - When using `withAndroid()`, `withiOS()` or `withWeb()` you don't have to define the platform, it's done behind the scenes for you.
 
 ### Routing a message
 
-By default the pusher "interest" messages will be sent to will be defined using the {notifiable}.{id} convention, for example `App.User.1`, however you can change this behaviour by including a `routeNotificationForPusherPushNotifications()` in the notifiable class method that returns the interest name.
+By default, the pusher "interest" messages will be sent to will be defined using the {notifiable}.{id} convention, for example `App.User.1`,
+however you can change this behaviour by including a `routeNotificationFor()` in the notifiable class.
+
+I.e. if you are pushing notification on ``User`` model, you can go to `App\User` class and implement method:
+
+```
+public function routeNotificationFor($channel)
+{
+    if($channel === 'PusherPushNotifications'){
+        return 'your.custom.interest.string';
+    }
+
+    $class = str_replace('\\', '.', get_class($this));
+
+    return $class.'.'.$this->getKey();
+}
+```
+
+`PusherPushNotifications()` in the notifiable class method returns the interest name.
+
+### Publish to users
+
+You can publish to users in the same way that you publish to interests but you must add the following variable to the notifiable model:
+
+```
+class Client extends Model
+{
+    use Notifiable;
+
+    public $pushNotificationType = 'users';
+}
+```
 
 ## Changelog
 

composer.json

@@ -33,10 +33,10 @@
     ],
     "require": {
         "php": ">=7.0",
-        "illuminate/events": "~5.5 || ~6.0 || ~7.0",
-        "illuminate/notifications": "~5.5 || ~6.0 || ~7.0",
-        "illuminate/queue": "~5.5 || ~6.0 || ~7.0",
-        "illuminate/support": "~5.5 || ~6.0 || ~7.0",
+        "illuminate/events": "~5.5 || ~6.0 || ~7.0 || ~8.0",
+        "illuminate/notifications": "~5.5 || ~6.0 || ~7.0 || ~8.0",
+        "illuminate/queue": "~5.5 || ~6.0 || ~7.0 || ~8.0",
+        "illuminate/support": "~5.5 || ~6.0 || ~7.0 || ~8.0",
         "pusher/pusher-push-notifications": "^1.1"
     },
     "require-dev": {

src/PusherChannel.php

@@ -5,11 +5,18 @@
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Notifications\Events\NotificationFailed;
 use Illuminate\Notifications\Notification;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
 use Pusher\PushNotifications\PushNotifications;
 use Throwable;
 
 class PusherChannel
 {
+    /**
+     * @var string
+     */
+    const INTERESTS = 'interests';
+
     /**
      * @var PushNotifications
      */
@@ -40,12 +47,16 @@ public function __construct(PushNotifications $beamsClient, Dispatcher $events)
      */
     public function send($notifiable, Notification $notification)
     {
-        $interest = $notifiable->routeNotificationFor('PusherPushNotifications')
-            ?: $this->interestName($notifiable);
+        $type = $notifiable->pushNotificationType ?? self::INTERESTS;
+
+        $data = $notifiable->routeNotificationFor('PusherPushNotifications')
+            ?: $this->defaultName($notifiable);
 
         try {
-            $this->beamsClient->publishToInterests(
-                is_array($interest) ? $interest : [$interest],
+            $notificationType = sprintf('publishTo%s', Str::ucfirst($type));
+
+            $this->beamsClient->{$notificationType}(
+                Arr::wrap($data),
                 $notification->toPushNotification($notifiable)->toArray()
             );
         } catch (Throwable $exception) {
@@ -56,13 +67,13 @@ public function send($notifiable, Notification $notification)
     }
 
     /**
-     * Get the interest name for the notifiable.
+     * Get the default name for the notifiable.
      *
      * @param $notifiable
      *
      * @return string
      */
-    protected function interestName($notifiable)
+    protected function defaultName($notifiable)
     {
         $class = str_replace('\\', '.', get_class($notifiable));
 

src/PusherMessage.php

@@ -49,6 +49,11 @@ class PusherMessage
      */
     protected $badge;
 
+    /**
+     * URL to follow on notification click.
+     */
+    protected $link;
+
     /**
      * Extra options that will get added to the message.
      *
@@ -99,7 +104,7 @@ public function __construct($body = '')
      */
     public function platform($platform)
     {
-        if (! in_array($platform, ['iOS', 'Android'])) {
+        if (! in_array($platform, ['iOS', 'Android', 'web'])) {
             throw CouldNotCreateMessage::invalidPlatformGiven($platform);
         }
 
@@ -132,6 +137,18 @@ public function android()
         return $this;
     }
 
+    /**
+     * Set the platform to web.
+     *
+     * @return $this
+     */
+    public function web()
+    {
+        $this->platform = 'web';
+
+        return $this;
+    }
+
     /**
      * Set an extra message to be sent to Android.
      *
@@ -158,6 +175,19 @@ public function withiOS(self $message)
         return $this;
     }
 
+    /**
+     * Set an extra message to be sent to web.
+     *
+     * @param \NotificationChannels\PusherPushNotifications\PusherMessage $message
+     * @return $this
+     */
+    public function withWeb(self $message)
+    {
+        $this->withExtra($message->web());
+
+        return $this;
+    }
+
     /**
      * Set an extra message to be sent to another platform.
      *
@@ -257,6 +287,20 @@ public function meta(array $meta)
         return $this;
     }
 
+    /**
+     * Set the message link.
+     *
+     * @param string $value
+     *
+     * @return $this
+     */
+    public function link($value)
+    {
+        $this->link = $value;
+
+        return $this;
+    }
+
     /**
      * @param string $key
      * @param mixed $value
@@ -277,9 +321,14 @@ public function setOption($key, $value)
      */
     public function toArray()
     {
-        return $this->platform === 'iOS'
-            ? $this->toiOS()
-            : $this->toAndroid();
+        switch ($this->platform) {
+            case 'Android':
+                return $this->toAndroid();
+            case 'web':
+                return $this->toWeb();
+            default:
+                return $this->toiOS();
+        }
     }
 
     /**
@@ -338,6 +387,30 @@ public function toAndroid()
         return $message;
     }
 
+    /**
+     * Format the message for web.
+     *
+     * @return array
+     */
+    public function toWeb()
+    {
+        $message = [
+            'web' => [
+                'notification' => array_filter([
+                    'title' => $this->title,
+                    'body' => $this->body,
+                    'sound' => $this->sound,
+                    'icon' => $this->icon,
+                    'deep_link' => $this->link,
+                ]),
+            ],
+        ];
+
+        $this->formatMessage($message);
+
+        return $message;
+    }
+
     /**
      * Return the current platform.
      *