Add VoIP support with additional channel

README.md

@@ -98,6 +98,39 @@ return ApnMessage::create()
     ->via($customClient)
 ```
 
+### VoIP push notifications
+
+Sending VoIP push notifications is very similar. You just need to use the `ApnVoipChannel` channel with `ApnVoipMessage` (which has the same API has a regular `ApnMessage`).
+
+```php
+use NotificationChannels\Apn\ApnVoipChannel;
+use NotificationChannels\Apn\ApnVoipMessage;
+use Illuminate\Notifications\Notification;
+
+class AccountApproved extends Notification
+{
+    public function via($notifiable)
+    {
+        return [ApnVoipChannel::class];
+    }
+
+    public function toApnVoip($notifiable)
+    {
+        return ApnVoipMessage::create()
+            ->badge(1);
+    }
+}
+```
+
+In your `notifiable` model, make sure to include a `routeNotificationForApnVoip()` method, which return one or an array of tokens.
+
+```php
+public function routeNotificationForApnVoip()
+{
+    return $this->apn_voip_token;
+}
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

src/ApnVoipChannel.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace NotificationChannels\Apn;
+
+use Illuminate\Notifications\Notification;
+
+class ApnVoipChannel extends ApnChannel
+{
+    /**
+     * Send the notification to Apple Push Notification Service.
+     *
+     * @param mixed $notifiable
+     * @param \Illuminate\Notifications\Notification $notification
+     * @return array|void
+     */
+    public function send($notifiable, Notification $notification)
+    {
+        $tokens = (array) $notifiable->routeNotificationFor('apn_voip', $notification);
+
+        if (empty($tokens)) {
+            return;
+        }
+
+        $message = $notification->toApnVoip($notifiable);
+
+        $responses = $this->sendNotifications(
+            $message->client ?? $this->client,
+            $message,
+            $tokens
+        );
+
+        $this->dispatchEvents($notifiable, $notification, $responses);
+
+        return $responses;
+    }
+}

src/ApnVoipMessage.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace NotificationChannels\Apn;
+
+class ApnVoipMessage extends ApnMessage
+{
+    /**
+     * Value indicating when the message will expire.
+     *
+     * @var \string
+     */
+    public $pushType = 'voip';
+}

tests/ApnChannelTest.php

@@ -4,15 +4,12 @@
 
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Notifications\Events\NotificationFailed;
-use Illuminate\Notifications\Notifiable;
-use Illuminate\Notifications\Notification;
 use Mockery;
 use NotificationChannels\Apn\ApnChannel;
-use NotificationChannels\Apn\ApnMessage;
 use Pushok\Client;
 use Pushok\Response;
 
-class ChannelTest extends TestCase
+class ApnChannelTest extends TestCase
 {
     protected $client;
     protected $events;
@@ -66,42 +63,3 @@ public function it_dispatches_events_for_failed_notifications()
         $this->channel->send(new TestNotifiable, new TestNotification);
     }
 }
-
-class TestNotifiable
-{
-    use Notifiable;
-
-    /**
-     * @return array
-     */
-    public function routeNotificationForApn()
-    {
-        return [
-            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd8',
-            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd9',
-        ];
-    }
-}
-
-class TestNotification extends Notification
-{
-    public function toApn($notifiable)
-    {
-        return new ApnMessage('title');
-    }
-}
-
-class TestNotificationWithClient extends Notification
-{
-    protected $client;
-
-    public function __construct($client)
-    {
-        $this->client = $client;
-    }
-
-    public function toApn($notifiable)
-    {
-        return (new ApnMessage('title'))->via($this->client);
-    }
-}

tests/ApnVoipChannelTest.php

@@ -0,0 +1,129 @@
+<?php
+
+namespace NotificationChannels\Apn\Tests;
+
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Notifications\Events\NotificationFailed;
+use Illuminate\Notifications\Notifiable;
+use Illuminate\Notifications\Notification;
+use Mockery;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Apn\ApnVoipChannel;
+use Pushok\Client;
+use Pushok\Response;
+
+class ApnVoipChannelTest extends TestCase
+{
+    protected $client;
+    protected $events;
+    protected $notification;
+    protected $channel;
+
+    public function setUp(): void
+    {
+        $this->client = Mockery::mock(Client::class);
+        $this->events = Mockery::mock(Dispatcher::class);
+        $this->channel = new ApnVoipChannel($this->client, $this->events);
+    }
+
+    /** @test */
+    public function it_can_send_a_notification()
+    {
+        $this->client->shouldReceive('addNotification');
+        $this->client->shouldReceive('push')->once();
+
+        $this->channel->send(new TestNotifiable, new TestNotification);
+    }
+
+    /** @test */
+    public function it_can_send_a_notification_with_custom_client()
+    {
+        $customClient = Mockery::mock(Client::class);
+
+        $this->client->shouldNotReceive('addNotification');
+
+        $customClient->shouldReceive('addNotification');
+        $customClient->shouldReceive('push')->once();
+
+        $this->channel->send(new TestNotifiable, (new TestNotificationWithClient($customClient)));
+    }
+
+    /** @test */
+    public function it_dispatches_events_for_failed_notifications()
+    {
+        $this->events->shouldReceive('dispatch')
+            ->once()
+            ->with(Mockery::type(NotificationFailed::class));
+
+        $this->client->shouldReceive('addNotification');
+        $this->client->shouldReceive('push')
+            ->once()
+            ->andReturn([
+                new Response(200, 'headers', 'body'),
+                new Response(400, 'headers', 'body'),
+            ]);
+
+        $this->channel->send(new TestNotifiable, new TestNotification);
+    }
+}
+
+class TestNotifiable
+{
+    use Notifiable;
+
+    /**
+     * @return array
+     */
+    public function routeNotificationForApn()
+    {
+        return [
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd8',
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd9',
+        ];
+    }
+
+    /**
+     * @return array
+     */
+    public function routeNotificationForApnVoip()
+    {
+        return [
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd1',
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd2',
+        ];
+    }
+}
+
+class TestNotification extends Notification
+{
+    public function toApn($notifiable)
+    {
+        return new ApnMessage('title');
+    }
+
+    public function toApnVoip($notifiable)
+    {
+        return (new ApnMessage)
+            ->pushType('voip');
+    }
+}
+
+class TestNotificationWithClient extends Notification
+{
+    protected $client;
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    public function toApn($notifiable)
+    {
+        return (new ApnMessage('title'))->via($this->client);
+    }
+
+    public function toApnVoip($notifiable)
+    {
+        return (new ApnMessage)->pushType('voip')->via($this->client);
+    }
+}

tests/ApnVoipMessageTest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace NotificationChannels\Apn\Tests;
+
+use NotificationChannels\Apn\ApnVoipMessage;
+
+class ApnVoipMessageTest extends TestCase
+{
+    /** @test */
+    public function it_defaults_push_type_to_voip()
+    {
+        $message = new ApnVoipMessage;
+
+        $this->assertEquals('voip', $message->pushType);
+    }
+}

tests/TestNotifiable.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace NotificationChannels\Apn\Tests;
+
+use Illuminate\Notifications\Notifiable;
+
+class TestNotifiable
+{
+    use Notifiable;
+
+    /**
+     * @return array
+     */
+    public function routeNotificationForApn()
+    {
+        return [
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd8',
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd9',
+        ];
+    }
+
+    /**
+     * @return array
+     */
+    public function routeNotificationForApnVoip()
+    {
+        return [
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd1',
+            '662cfe5a69ddc65cdd39a1b8f8690647778204b064df7b264e8c4c254f94fdd2',
+        ];
+    }
+}

tests/TestNotification.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace NotificationChannels\Apn\Tests;
+
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Apn\ApnVoipMessage;
+
+class TestNotification extends Notification
+{
+    public function toApn($notifiable)
+    {
+        return new ApnMessage('title');
+    }
+
+    public function toApnVoip($notifiable)
+    {
+        return new ApnVoipMessage('title');
+    }
+}

tests/TestNotificationWithClient.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace NotificationChannels\Apn\Tests;
+
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Apn\ApnVoipMessage;
+
+class TestNotificationWithClient extends Notification
+{
+    protected $client;
+
+    public function __construct($client)
+    {
+        $this->client = $client;
+    }
+
+    public function toApn($notifiable)
+    {
+        return (new ApnMessage('title'))->via($this->client);
+    }
+
+    public function toApnVoip($notifiable)
+    {
+        return (new ApnVoipMessage)->via($this->client);
+    }
+}