Nitpicks (#6)

* The ServiceProvider::register method isn't necessary anymore in 5.3

* Helper methods like 'event' require illuminate/foundation

* Sorted dependencies

* Docblock cleanup

* Normalized service provider class name

* Cleaned up tests

* Prefixed Message and Channel classes with Pusher

* Updated authors

* illuminate/foundation doesn't exist

* Changed pusher dependency to stable releases

Author: sebastiandedeyne

README.md

@@ -38,7 +38,7 @@ You must install the service provider:
 // config/app.php
 'providers' => [
     ...
-    NotificationChannels\PusherPushNotifications\Provider::class,
+    NotificationChannels\PusherPushNotifications\PusherPushNotificationsServiceProvider::class,
 ];
 ```
 
@@ -60,20 +60,20 @@ Before using this package you should set up a Pusher account. Here are the steps
 Now you can use the channel in your `via()` method inside the Notification class.
 
 ``` php
-use NotificationChannels\PusherPushNotifications\Channel;
-use NotificationChannels\PusherPushNotifications\Message;
+use NotificationChannels\PusherPushNotifications\PusherChannel;
+use NotificationChannels\PusherPushNotifications\PusherMessage;
 use Illuminate\Notifications\Notification;
 
 class AccountApproved extends Notification
 {
     public function via($notifiable)
     {
-        return [Channel::class];
+        return [PusherChannel::class];
     }
 
     public function toPushNotification($notifiable)
     {
-        return Message::create()
+        return PusherMessage::create()
             ->iOS()
             ->badge(1)
             ->sound('success')
@@ -121,6 +121,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 - [Mohamed Said](https://github.com/themsaid)
 - [Marcel Pociot](https://github.com/mpociot)
 - [Freek Van der Herten](https://github.com/freekmurze)
+- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -24,15 +24,20 @@
             "name": "Freek Van der Herten",
             "email": "[email protected]",
             "homepage": "https://spatie.be"
+        },
+        {
+            "name": "Sebastian De Deyne",
+            "email": "[email protected]",
+            "homepage": "https://sebastiandedeyne.com"
         }
     ],
     "require": {
         "php": ">=5.6.4",
-        "illuminate/notifications": "^5.3@dev",
-        "illuminate/support": "^5.3@dev",
         "illuminate/events": "^5.3@dev",
+        "illuminate/notifications": "^5.3@dev",
         "illuminate/queue": "^5.3@dev",
-        "pusher/pusher-php-server": "2.5.0-rc4"
+        "illuminate/support": "^5.3@dev",
+        "pusher/pusher-php-server": "^2.4.0"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.5",

src/Events/MessageWasSent.php

@@ -6,20 +6,14 @@
 
 class MessageWasSent
 {
-    /**
-     * @var
-     */
+    /** @var mixed */
     protected $notifiable;
 
-    /**
-     * @var \Illuminate\Notifications\Notification
-     */
+    /** @var \Illuminate\Notifications\Notification */
     protected $notification;
 
     /**
-     * MessageSending constructor.
-     *
-     * @param $notifiable
+     * @param mixed $notifiable
      * @param \Illuminate\Notifications\Notification $notification
      */
     public function __construct($notifiable, Notification $notification)

src/Events/SendingMessage.php

@@ -6,18 +6,14 @@
 
 class SendingMessage
 {
-    /**
-     * @var
-     */
+    /** @var mixed */
     protected $notifiable;
 
-    /**
-     * @var \Illuminate\Notifications\Notification
-     */
+    /** @var \Illuminate\Notifications\Notification */
     protected $notification;
 
     /**
-     * @param $notifiable
+     * @param mixed $notifiable
      * @param \Illuminate\Notifications\Notification $notification
      */
     public function __construct($notifiable, Notification $notification)

src/Exceptions/CouldNotSendNotification.php

@@ -6,6 +6,11 @@
 
 class CouldNotSendNotification extends Exception
 {
+    /**
+     * @param array $response
+     *
+     * @return static
+     */
     public static function pusherRespondedWithAnError(array $response)
     {
         return new static("Notification was not sent. Pusher responded with `{$response['code']}: {$response['body']}`");

src/Channel.php src/PusherChannel.phpsrc/Channel.php renamed to src/PusherChannel.php

@@ -8,13 +8,14 @@
 use Illuminate\Notifications\Notification;
 use Pusher;
 
-class Channel
+class PusherChannel
 {
-    /**
-     * @var Pusher
-     */
+    /** @var Pusher */
     protected $pusher;
 
+    /**
+     * @param \Pusher $pusher
+     */
     public function __construct(Pusher $pusher)
     {
         $this->pusher = $pusher;

src/Message.php src/PusherMessage.phpsrc/Message.php renamed to src/PusherMessage.php

@@ -5,7 +5,7 @@
 use Illuminate\Support\Arr;
 use NotificationChannels\PusherPushNotifications\Exceptions\CouldNotCreateMessage;
 
-class Message
+class PusherMessage
 {
     /**
      * The device platform (iOS/Android).
@@ -50,7 +50,7 @@ class Message
     protected $badge;
 
     /**
-     * Options.
+     * Extra options that will get added to the message.
      *
      * @var array
      */

src/Provider.php …sherPushNotificationsServiceProvider.phpsrc/Provider.php renamed to src/PusherPushNotificationsServiceProvider.php src/Provider.php renamed to src/PusherPushNotificationsServiceProvider.php

@@ -5,14 +5,14 @@
 use Illuminate\Support\ServiceProvider;
 use Pusher;
 
-class Provider extends ServiceProvider
+class PusherPushNotificationsServiceProvider extends ServiceProvider
 {
     /**
      * Bootstrap the application services.
      */
     public function boot()
     {
-        $this->app->when(Channel::class)
+        $this->app->when(PusherChannel::class)
             ->needs(Pusher::class)
             ->give(function () {
                 $pusherConfig = config('broadcasting.connections.pusher');
@@ -24,11 +24,4 @@ public function boot()
                 );
             });
     }
-
-    /**
-     * Register the application services.
-     */
-    public function register()
-    {
-    }
 }

tests/ChannelTest.php

@@ -2,9 +2,8 @@
 
 namespace NotificationChannels\PusherPushNotifications\Test;
 
-use Illuminate\Notifications\Notification;
 use Mockery;
-use NotificationChannels\PusherPushNotifications\Channel;
+use NotificationChannels\PusherPushNotifications\PusherChannel;
 use PHPUnit_Framework_TestCase;
 use Pusher;
 
@@ -13,15 +12,14 @@ class ChannelTest extends PHPUnit_Framework_TestCase
     /** @var Mockery\Mock */
     protected $pusher;
 
-    /** @var \NotificationChannels\PusherPushNotifications\Channel */
+    /** @var \NotificationChannels\PusherPushNotifications\PusherChannel */
     protected $channel;
 
-    /** @test */
     public function setUp()
     {
         $this->pusher = Mockery::mock(Pusher::class);
 
-        $this->channel = new Channel($this->pusher);
+        $this->channel = new PusherChannel($this->pusher);
     }
 
     public function tearDown()

tests/MessageTest.php

@@ -4,33 +4,33 @@
 
 use Illuminate\Support\Arr;
 use NotificationChannels\PusherPushNotifications\Exceptions\CouldNotCreateMessage;
-use NotificationChannels\PusherPushNotifications\Message;
+use NotificationChannels\PusherPushNotifications\PusherMessage;
 use PHPUnit_Framework_TestCase;
 
 class MessageTest extends PHPUnit_Framework_TestCase
 {
-    /** @var NotificationChannels\PusherPushNotifications\Message */
+    /** @var \NotificationChannels\PusherPushNotifications\PusherMessage */
     protected $message;
 
     public function setUp()
     {
         parent::setUp();
 
-        $this->message = new Message();
+        $this->message = new PusherMessage();
     }
 
     /** @test */
     public function it_can_accept_a_message_when_constructing_a_message()
     {
-        $message = new Message('myMessage');
+        $message = new PusherMessage('myMessage');
 
         $this->assertEquals('myMessage', Arr::get($message->toiOS(), 'apns.aps.alert.body'));
     }
 
     /** @test */
     public function it_provides_a_create_method()
     {
-        $message = Message::create('myMessage');
+        $message = PusherMessage::create('myMessage');
 
         $this->assertEquals('myMessage', Arr::get($message->toiOS(), 'apns.aps.alert.body'));
     }