Fire an event when unknown devices are referenced (#15)

Author: axlon

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 All notable changes to `laravel-notification-channels/pushwoosh` will be documented in this file
 
+## 3.0.0
+- Removed `UnknownDevicesException`, a `UnknownDevices` event is now dispatched instead
+
 ## 2.3.0 - (2020-09-17)
 - Allow pushwoosh to be disabled on local environments via `config('services.pushwoosh.enabled')`
 

README.md

@@ -122,6 +122,21 @@ Or to multiple users:
 Notification::send($customers, new WishlistItemOnSale($product));
 ```
 
+#### Unknown devices
+When you reference devices that do not exist (anymore), a `NotificationChannels\Pushwoosh\Events\UnknownDevices` event
+will be dispatched.
+
+You can easily hook into this event like so:
+
+```php
+Event::listen(
+    NotificationChannels\Pushwoosh\Events\UnknownDevices::class,
+    function ($event) {
+        // Handle the event
+    }
+);
+```
+
 ### Available methods
 This section details the public API of this package.
 

composer.json

@@ -14,14 +14,12 @@
         "ext-json": "*",
         "guzzlehttp/guzzle": "^6.2 || ^7.0",
         "guzzlehttp/psr7": "^1.0",
-        "illuminate/notifications": "^5.5 || ^6.0 || ^7.0 || ^8.0",
-        "illuminate/support": "^5.5 || ^6.0 || ^7.0 || ^8.0"
+        "laravel/framework": "^5.5 || ^6.0 || ^7.0 || ^8.0"
     },
     "require-dev": {
-        "illuminate/database": "^5.5 || ^6.0 || ^7.0 || ^8.0",
-        "illuminate/queue": "^5.5 || ^6.0 || ^7.0 || ^8.0",
         "mockery/mockery": "^1.3.1",
-        "phpunit/phpunit": "^7.5"
+        "orchestra/testbench": "^3.5 || ^4.0 || ^5.0 || ^6.0",
+        "phpunit/phpunit": "^7.5 || ^8.0 || ^9.0"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -16,8 +16,8 @@
     </include>
   </coverage>
   <testsuites>
-    <testsuite name="Unit">
-      <directory suffix="Test.php">./tests/Unit</directory>
+    <testsuite name="Tests">
+      <directory suffix="Test.php">./tests</directory>
     </testsuite>
   </testsuites>
 </phpunit>

src/Events/UnknownDevices.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace NotificationChannels\Pushwoosh\Events;
+
+class UnknownDevices
+{
+    /**
+     * The referenced devices.
+     *
+     * @var string[]
+     */
+    public $devices;
+
+    /**
+     * The message ID.
+     *
+     * @var string
+     */
+    public $message;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param string $message
+     * @param array $devices
+     * @return void
+     */
+    public function __construct(string $message, array $devices)
+    {
+        $this->devices = $devices;
+        $this->message = $message;
+    }
+}

src/Exceptions/UnknownDeviceException.php

@@ -6,9 +6,10 @@
 use function GuzzleHttp\json_decode;
 use function GuzzleHttp\json_encode;
 use GuzzleHttp\Psr7\Request;
+use Illuminate\Contracts\Events\Dispatcher;
 use NotificationChannels\Pushwoosh\Concerns\DetectsPushwooshErrors;
+use NotificationChannels\Pushwoosh\Events\UnknownDevices;
 use NotificationChannels\Pushwoosh\Exceptions\PushwooshException;
-use NotificationChannels\Pushwoosh\Exceptions\UnknownDeviceException;
 use Throwable;
 
 class Pushwoosh
@@ -17,22 +18,25 @@ class Pushwoosh
 
     protected $application;
     protected $client;
+    protected $dispatcher;
     protected $enabled;
     protected $token;
 
     /**
      * Create a new Pushwoosh API client.
      *
      * @param \GuzzleHttp\ClientInterface $client
+     * @param \Illuminate\Contracts\Events\Dispatcher $dispatcher
      * @param string|null $application
      * @param string|null $token
      * @param bool $enabled
      * @return void
      */
-    public function __construct(ClientInterface $client, ?string $application, ?string $token, bool $enabled = true)
+    public function __construct(ClientInterface $client, Dispatcher $dispatcher, ?string $application, ?string $token, bool $enabled = true)
     {
         $this->application = $application;
         $this->client = $client;
+        $this->dispatcher = $dispatcher;
         $this->enabled = $enabled;
         $this->token = $token;
     }
@@ -66,7 +70,9 @@ public function createMessage(PushwooshPendingMessage $message)
         }
 
         if (isset($response->response->UnknownDevices)) {
-            throw new UnknownDeviceException($response->response->UnknownDevices);
+            foreach ($response->response->UnknownDevices as $identifier => $devices) {
+                $this->dispatcher->dispatch(new UnknownDevices($identifier, $devices));
+            }
         }
 
         $message->wasSent();

src/Pushwoosh.php

@@ -3,6 +3,7 @@
 namespace NotificationChannels\Pushwoosh;
 
 use GuzzleHttp\Client;
+use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Notifications\ChannelManager;
 use Illuminate\Support\ServiceProvider;
 
@@ -13,17 +14,18 @@ class PushwooshServiceProvider extends ServiceProvider
      *
      * @return void
      */
-    public function register()
+    public function register(): void
     {
         $this->app->afterResolving(ChannelManager::class, function (ChannelManager $channels) {
             $channels->extend('pushwoosh', function ($app) {
                 return $app[PushwooshChannel::class];
             });
         });
 
-        $this->app->bindIf(Pushwoosh::class, function ($app) {
+        $this->app->bindIf(Pushwoosh::class, function (Application $app) {
             return new Pushwoosh(
-                new Client(),
+                $app->make(Client::class),
+                $app['events'],
                 $app['config']['services.pushwoosh.application'],
                 $app['config']['services.pushwoosh.token'],
                 $app['config']['services.pushwoosh.enabled'] ?? true

src/PushwooshServiceProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace NotificationChannels\Pushwoosh\Tests;
+
+use NotificationChannels\Pushwoosh\PushwooshServiceProvider;
+
+abstract class TestCase extends \Orchestra\Testbench\TestCase
+{
+    /**
+     * Get the package providers.
+     *
+     * @param \Illuminate\Foundation\Application $app
+     * @return string[]
+     */
+    protected function getPackageProviders($app): array
+    {
+        return [
+            PushwooshServiceProvider::class,
+        ];
+    }
+}

tests/TestCase.php

@@ -4,14 +4,14 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Response;
-use Illuminate\Support\Str;
+use Illuminate\Support\Facades\Event;
 use Mockery;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+use NotificationChannels\Pushwoosh\Events\UnknownDevices;
 use NotificationChannels\Pushwoosh\Exceptions\PushwooshException;
-use NotificationChannels\Pushwoosh\Exceptions\UnknownDeviceException;
 use NotificationChannels\Pushwoosh\Pushwoosh;
 use NotificationChannels\Pushwoosh\PushwooshPendingMessage;
-use PHPUnit\Framework\TestCase;
+use NotificationChannels\Pushwoosh\Tests\TestCase;
 
 class PushwooshTest extends TestCase
 {
@@ -32,8 +32,12 @@ class PushwooshTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->client = Mockery::mock(Client::class);
-        $this->pushwoosh = new Pushwoosh($this->client, Str::random(8), Str::random(24));
+        parent::setUp();
+
+        Event::fake();
+
+        $this->app->instance(Client::class, $this->client = Mockery::mock(Client::class));
+        $this->pushwoosh = $this->app->make(Pushwoosh::class);
     }
 
     /**
@@ -84,11 +88,13 @@ public function testUnknownDevices()
             new Response(200, [], file_get_contents(__DIR__ . '/../Fixtures/unknown-devices.json'))
         );
 
-        $this->expectException(UnknownDeviceException::class);
-        $this->expectExceptionMessage('Unknown device(s) referenced: foo, bar');
-
         $this->pushwoosh->createMessage(
             new PushwooshPendingMessage($this->pushwoosh)
         );
+
+        Event::assertDispatched(UnknownDevices::class, function (UnknownDevices $event) {
+            return $event->message === 'AF0B-EEFE4D5E-E445B2E9'
+                && $event->devices === ['foo', 'bar'];
+        });
     }
 }