scrutinise

Author: freekmurze

README.md

@@ -14,7 +14,7 @@ First you must install the service provider:
 // config/app.php
 'providers' => [
     ...
-    NotificationChannels\WebPushNotifications\Provider::class,
+    NotificationChannels\WebPush\WebPushServiceProvider::class,
 ];
 ```
 
@@ -27,10 +27,10 @@ Then configure [Google Cloud Messaging](https://console.cloud.google.com) by set
 ],
 ```
 
-You need to add the `NotificationChannels\WebPushNotifications\HasPushSubscriptions` in your `User` model:
+You need to add the `NotificationChannels\WebPush\HasPushSubscriptions` in your `User` model:
 
 ``` php
-use NotificationChannels\WebPushNotifications\HasPushSubscriptions;
+use NotificationChannels\WebPush\HasPushSubscriptions;
 
 class User extends Model
 {
@@ -41,7 +41,7 @@ class User extends Model
 Next publish the migration with:
 
 ``` bash
-php artisan vendor:publish --provider="NotificationChannels\WebPushNotifications\Provider" --tag="migrations"
+php artisan vendor:publish --provider="NotificationChannels\WebPush\WebPushServiceProvider" --tag="migrations"
 ```
 
 After the migration has been published you can create the `push_subscriptions` table by running the migrations:
@@ -56,8 +56,8 @@ Now you can use the channel in your `via()` method inside the notification as we
 
 ``` php
 use Illuminate\Notifications\Notification;
-use NotificationChannels\WebPushNotifications\Message;
-use NotificationChannels\WebPushNotifications\Channel as WebPushChannel;
+use NotificationChannels\WebPush\WebPushMessage;
+use NotificationChannels\WebPush\WebPushChannel;
 
 class AccountApproved extends Notification
 {
@@ -68,7 +68,7 @@ class AccountApproved extends Notification
 
     public function toWebPush($notifiable, $notification)
     {
-        return (new WebPushMessage())
+        return WebPushMessage::create()
             // ->id($notification->id)
             ->title('Approved!')
             ->icon('/approved-icon.png')
@@ -108,6 +108,24 @@ For a complete implementation with a Service Worker check this [demo](https://gi
 
 The [Push API](https://developer.mozilla.org/en/docs/Web/API/Push_API) currently works on Chrome and Firefox.
 
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Testing
+    
+``` bash
+$ composer test
+```
+
+## Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
 ## Credits
 
 - [Cretu Eusebiu](https://github.com/cretueusebiu)

composer.json

@@ -16,6 +16,7 @@
         "illuminate/notifications": "^5.3@dev",
         "illuminate/support": "^5.3@dev",
         "illuminate/events": "^5.3@dev",
+        "illuminate/database": "^5.3@dev",
         "minishlink/web-push": "^1.1"
     },
     "require-dev": {
@@ -24,12 +25,12 @@
     },
     "autoload": {
         "psr-4": {
-            "NotificationChannels\\WebPushNotifications\\": "src"
+            "NotificationChannels\\WebPush\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "NotificationChannels\\:WebPushNotifications\\Test\\": "tests"
+            "NotificationChannels\\:WebPush\\Test\\": "tests"
         }
     },
     "config": {

src/Events/MessageWasSent.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications\Events;
+namespace NotificationChannels\WebPush\Events;
 
 use Illuminate\Notifications\Notification;
 

src/Events/SendingMessage.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications\Events;
+namespace NotificationChannels\WebPush\Events;
 
 use Illuminate\Notifications\Notification;
 

src/HasPushSubscriptions.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications;
+namespace NotificationChannels\WebPush;
 
 trait HasPushSubscriptions
 {
@@ -20,36 +20,42 @@ public function pushSubscriptions()
      * @param  string $endpoint
      * @param  string|null $key
      * @param  string|null $token
-     * @return \Eusebiu\WebPush\PushSubscription
+     *
+     * @return PushSubscription
      */
     public function updatePushSubscription($endpoint, $key = null, $token = null)
     {
         $subscription = PushSubscription::findByEndpoint($endpoint);
 
-        // Check if a subscription exists for the given endpoint.
-        if ($subscription) {
-            // If it belongs to a different user then delete it.
-            if ((int) $subscription->user_id !== (int) $this->getAuthIdentifier()) {
-                $subscription->delete();
-            }
-            // Otherwise update the public key and auth token.
-            else {
-                $subscription->public_key = $key;
-                $subscription->auth_token = $token;
-                $subscription->save();
+        if ($subscription && !$this->subscriptionBelongsToDifferentUser()) {
+            $subscription->public_key = $key;
+            $subscription->auth_token = $token;
+            $subscription->save();
+
+            return $subscription;
+        }
 
-                return $subscription;
-            }
+        if ($subscription && $this->subscriptionBelongsToDifferentUser()) {
+            $subscription->delete();
         }
 
-        // Just create a new subscription.
+
         return $this->pushSubscriptions()->save(new PushSubscription([
             'endpoint' => $endpoint,
             'public_key' => $key,
             'auth_token' => $token,
         ]));
     }
 
+    /**
+     * @param PushSubscription $subscription
+     * @return bool
+     */
+    public function subscriptionBelongsToDifferentUser($subscription)
+    {
+        return (int)$subscription->user_id !== (int)$this->getAuthIdentifier();
+    }
+
     /**
      * Delete subscription by endpoint.
      *
@@ -59,16 +65,16 @@ public function updatePushSubscription($endpoint, $key = null, $token = null)
     public function deleteSubscription($endpoint)
     {
         $this->pushSubscriptions()
-                ->where('endpoint', $endpoint)
-                ->delete();
+            ->where('endpoint', $endpoint)
+            ->delete();
     }
 
     /**
      * Get all subscriptions.
      *
      * @return \Illuminate\Database\Eloquent\Collection
      */
-    public function routeNotificationForWebPushNotifications()
+    public function routeNotificationForWebPush()
     {
         return $this->pushSubscriptions;
     }

src/PushSubscription.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications;
+namespace NotificationChannels\WebPush;
 
 use Illuminate\Support\Facades\Config;
 use Illuminate\Database\Eloquent\Model;

src/Channel.php renamed to src/WebPushChannel.php

@@ -1,22 +1,18 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications;
+namespace NotificationChannels\WebPush;
 
 use Minishlink\WebPush\WebPush;
 use Illuminate\Notifications\Notification;
-use NotificationChannels\WebPushNotifications\Events\MessageWasSent;
-use NotificationChannels\WebPushNotifications\Events\SendingMessage;
+use NotificationChannels\WebPush\Events\MessageWasSent;
+use NotificationChannels\WebPush\Events\SendingMessage;
 
-class Channel
+class WebPushChannel
 {
-    /**
-     * @var \Minishlink\WebPush\WebPush
-     */
+    /** @var \Minishlink\WebPush\WebPush */
     protected $webPush;
 
     /**
-     * Create a new Web Push channel instance.
-     *
      * @param  \Minishlink\WebPush\WebPush $webPush
      * @return void
      */
@@ -40,7 +36,7 @@ public function send($notifiable, Notification $notification)
             return;
         }
 
-        $subscriptions = $notifiable->routeNotificationFor('WebPushNotifications');
+        $subscriptions = $notifiable->routeNotificationFor('WebPush');
 
         if ($subscriptions->isEmpty()) {
             return;
@@ -59,15 +55,23 @@ public function send($notifiable, Notification $notification)
 
         $response = $this->webPush->flush();
 
-        // Delete the invalid subscriptions.
+        $this->deleteInvalidSubscriptions($response, $subscriptions);
+
+        event(new MessageWasSent($notifiable, $notification));
+    }
+
+    /**
+     * @param $response
+     * @param $subscriptions
+     */
+    protected function deleteInvalidSubscriptions($response, $subscriptions)
+    {
         if (is_array($response)) {
             foreach ($response as $index => $value) {
-                if (! $value['success'] && isset($subscriptions[$index])) {
+                if (!$value['success'] && isset($subscriptions[$index])) {
                     $subscriptions[$index]->delete();
                 }
             }
         }
-
-        event(new MessageWasSent($notifiable, $notification));
     }
 }

src/Message.php renamed to src/WebPushMessage.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications;
+namespace NotificationChannels\WebPush;
 
 use Illuminate\Support\Arr;
 
-class Message
+class WebPushMessage
 {
     /**
      * The notification id.
@@ -42,12 +42,20 @@ class Message
     protected $actions = [];
 
     /**
-     * @param string $title
      * @param string $body
+     * @return static
      */
-    public function __construct($title = '', $body = '')
+    public static function create($body = '')
     {
-        $this->title = $title;
+        return static ($body);
+    }
+
+    /**
+     * @param string $body
+     */
+    public function __construct($body = '')
+    {
+        $this->title = '';
         $this->body = $body;
     }
 

src/Provider.php renamed to src/WebPushServiceProvider.php

@@ -1,11 +1,11 @@
 <?php
 
-namespace NotificationChannels\WebPushNotifications;
+namespace NotificationChannels\WebPush;
 
 use Minishlink\WebPush\WebPush;
 use Illuminate\Support\ServiceProvider;
 
-class Provider extends ServiceProvider
+class WebPushServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application services.
@@ -14,7 +14,7 @@ class Provider extends ServiceProvider
      */
     public function boot()
     {
-        $this->app->when(Channel::class)
+        $this->app->when(WebPushChannel::class)
             ->needs(WebPush::class)
             ->give(function () {
                 return new WebPush([
@@ -43,14 +43,4 @@ protected function definePublishing()
             ], 'migrations');
         }
     }
-
-    /**
-     * Register the service provider.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        //
-    }
 }