Publishing to users (#57)

Author: andreaselia

README.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
@@ -124,7 +129,7 @@ public function toPushNotification($notifiable)
 
 ### 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`, 
+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:
@@ -141,10 +146,21 @@ public function routeNotificationFor($channel)
     return $class.'.'.$this->getKey();
 }
 ```
-     
-     
-     PusherPushNotifications()` in the notifiable class method that 
-returns the interest name.
+
+`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
 

src/PusherChannel.php

@@ -6,11 +6,17 @@
 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
      */
@@ -41,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(
-                Arr::wrap($interest),
+            $notificationType = sprintf('publishTo%s', Str::ucfirst($type));
+
+            $this->beamsClient->{$notificationType}(
+                Arr::wrap($data),
                 $notification->toPushNotification($notifiable)->toArray()
             );
         } catch (Throwable $exception) {
@@ -57,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));
 

tests/ChannelTest.php

@@ -25,37 +25,95 @@ public function setUp(): void
 
         $this->notification = new TestNotification;
 
-        $this->notifiable = new TestNotifiable;
+        $this->notifiableInterest = new TestNotifiableInterest;
+        $this->notifiableInterests = new TestNotifiableInterests;
+
+        $this->notifiableUser = new TestNotifiableUser;
+        $this->notifiableUsers = new TestNotifiableUsers;
     }
 
     /** @test */
-    public function it_can_send_a_notification()
+    public function it_can_send_a_notification_to_interest()
     {
-        $message = $this->notification->toPushNotification($this->notifiable);
+        $message = $this->notification->toPushNotification($this->notifiableInterest);
 
         $data = $message->toArray();
 
         $this->pusher->shouldReceive('publishToInterests')->once()->with(['interest_name'], $data);
 
-        $this->channel->send($this->notifiable, $this->notification);
+        $this->channel->send($this->notifiableInterest, $this->notification);
+    }
+
+    /** @test */
+    public function it_can_send_a_notification_to_interests()
+    {
+        $message = $this->notification->toPushNotification($this->notifiableInterests);
+
+        $data = $message->toArray();
+
+        $this->pusher->shouldReceive('publishToInterests')->once()->with([
+            'interest_one', 'interest_two', 'interest_three',
+        ], $data);
+
+        $this->channel->send($this->notifiableInterests, $this->notification);
     }
 
     /** @test */
-    public function it_fires_failure_event_on_failure()
+    public function it_fires_failure_event_on_interest_failure()
     {
-        $message = $this->notification->toPushNotification($this->notifiable);
+        $message = $this->notification->toPushNotification($this->notifiableInterest);
 
         $data = $message->toArray();
 
         $this->pusher->shouldReceive('publishToInterests')->once()->with(['interest_name'], $data)->andThrow(new Exception('Something happened'));
 
         $this->events->shouldReceive('dispatch')->once()->with(Mockery::type(NotificationFailed::class));
 
-        $this->channel->send($this->notifiable, $this->notification);
+        $this->channel->send($this->notifiableInterest, $this->notification);
+    }
+
+    /** @test */
+    public function it_can_send_a_notification_to_user()
+    {
+        $message = $this->notification->toPushNotification($this->notifiableUser);
+
+        $data = $message->toArray();
+
+        $this->pusher->shouldReceive('publishToUsers')->once()->with(['user_1'], $data);
+
+        $this->channel->send($this->notifiableUser, $this->notification);
+    }
+
+    /** @test */
+    public function it_can_send_a_notification_to_users()
+    {
+        $message = $this->notification->toPushNotification($this->notifiableUsers);
+
+        $data = $message->toArray();
+
+        $this->pusher->shouldReceive('publishToUsers')->once()->with([
+            'user_1', 'user_2', 'user_3',
+        ], $data);
+
+        $this->channel->send($this->notifiableUsers, $this->notification);
+    }
+
+    /** @test */
+    public function it_fires_failure_event_on_user_failure()
+    {
+        $message = $this->notification->toPushNotification($this->notifiableUser);
+
+        $data = $message->toArray();
+
+        $this->pusher->shouldReceive('publishToUsers')->once()->with(['user_1'], $data)->andThrow(new Exception('Something happened'));
+
+        $this->events->shouldReceive('dispatch')->once()->with(Mockery::type(NotificationFailed::class));
+
+        $this->channel->send($this->notifiableUser, $this->notification);
     }
 }
 
-class TestNotifiable
+class TestNotifiableInterest
 {
     use Notifiable;
 
@@ -65,6 +123,40 @@ public function routeNotificationForPusherPushNotifications()
     }
 }
 
+class TestNotifiableInterests
+{
+    use Notifiable;
+
+    public function routeNotificationForPusherPushNotifications()
+    {
+        return ['interest_one', 'interest_two', 'interest_three'];
+    }
+}
+
+class TestNotifiableUser
+{
+    use Notifiable;
+
+    public $pushNotificationType = 'users';
+
+    public function routeNotificationForPusherPushNotifications()
+    {
+        return 'user_1';
+    }
+}
+
+class TestNotifiableUsers
+{
+    use Notifiable;
+
+    public $pushNotificationType = 'users';
+
+    public function routeNotificationForPusherPushNotifications()
+    {
+        return ['user_1', 'user_2', 'user_3'];
+    }
+}
+
 class TestNotification extends Notification
 {
     public function toPushNotification($notifiable)