code review

Author: freekmurze

README.md

@@ -1,5 +1,13 @@
 # Pushbullet notification channel for Laravel 5.3
 
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/pushbullet.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/pushbullet)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
+[![Build Status](https://img.shields.io/travis/laravel-notification-channels/pushbullet/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/pushbullet)
+[![StyleCI](https://styleci.io/repos/xxx/shield)](https://styleci.io/repos/xxx)
+[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/xxx.svg?style=flat-square)](https://insight.sensiolabs.com/projects/xxx)
+[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/pushbullet.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/pushbullet)
+[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/pushbullet.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/pushbullet)
+
 This package makes it easy to send notifications using [Pushbullet](http://pushbullet.com) with Laravel 5.3.
 
 ## Contents
@@ -98,10 +106,9 @@ public function toPushbullet($notifiable)
 {
     $url = url('/invoice/' . $this->invoice->id);
 
-    return (new PushbulletMessage)
+    return PushbulletMessage::create('Thank you for using our application!')
         ->link()
         ->title('One of your invoices has been paid!')
-        ->message('Thank you for using our application!')
         ->url($url);
 }
 ```

composer.json

@@ -13,9 +13,10 @@
     ],
     "require": {
         "php": ">=5.6.4",
+        "guzzlehttp/guzzle": "^6.2",
+        "illuminate/events": "^5.3@dev",
         "illuminate/notifications": "^5.3@dev",
-        "illuminate/support": "^5.3@dev",
-        "illuminate/events": "^5.3@dev"
+        "illuminate/support": "^5.3@dev"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.5",

src/Exceptions/CouldNotSendNotification.php

@@ -16,9 +16,9 @@ public static function pushbulletRespondedWithAnError(ClientException $exception
         return new static("Pushbullet responded with an error `{$code} - {$message}`");
     }
 
-    public static function providedEmailIsInvalid()
+    public static function providedEmailIsInvalid($email)
     {
-        return new static('Provided email of `notifiable` is not valid');
+        return new static("Provided email `{$email}` of `notifiable` is not valid");
     }
 
     public static function couldNotSendNotificationWithoutRecipient()
@@ -28,6 +28,6 @@ public static function couldNotSendNotificationWithoutRecipient()
 
     public static function couldNotCommunicateWithPushbullet()
     {
-        return new static('Couldn\'t connect to Pushbullet API.');
+        return new static("Couldn't connect to Pushbullet API.");
     }
 }

src/Pushbullet.php

@@ -2,21 +2,18 @@
 
 namespace NotificationChannels\Pushbullet;
 
+use Exception;
 use GuzzleHttp\Client as HttpClient;
 use GuzzleHttp\Exception\ClientException;
 use NotificationChannels\Pushbullet\Exceptions\CouldNotSendNotification;
 
 class Pushbullet
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     protected $token;
 
-    /**
-     * @var \GuzzleHttp\Client
-     */
-    protected $http;
+    /** @var \GuzzleHttp\Client */
+    protected $httpClient;
 
     /**
      * Create small Pushbullet client.
@@ -27,11 +24,12 @@ class Pushbullet
     public function __construct($token, HttpClient $httpClient)
     {
         $this->token = $token;
-        $this->http = $httpClient;
+
+        $this->httpClient = $httpClient;
     }
 
     /**
-     * Get url to send to pushbullet API
+     * Get url to send to Pushbullet API?
      *
      * @return string
      */
@@ -41,7 +39,7 @@ protected function getPushbulletUrl()
     }
 
     /**
-     * Get headers for API callse
+     * Get headers for API calls.
      *
      * @return array
      */
@@ -53,7 +51,7 @@ protected function getHeaders()
     }
 
     /**
-     * Send request to Pushbullet API
+     * Send request to Pushbullet API.
      *
      * @param  array  $params
      * @return \Psr\Http\Message\ResponseInterface
@@ -63,13 +61,13 @@ public function send($params)
         $url = $this->getPushbulletUrl();
 
         try {
-            return $this->http->post($url, [
+            return $this->httpClient->post($url, [
                 'json' => $params,
                 'headers' => $this->getHeaders()
             ]);
         } catch (ClientException $exception) {
             throw CouldNotSendNotification::pushbulletRespondedWithAnError($exception);
-        } catch (\Exception $exception) {
+        } catch (Exception $exception) {
             throw CouldNotSendNotification::couldNotCommunicateWithPushbullet();
         }
     }

src/PushbulletChannel.php

@@ -12,7 +12,7 @@
 class PushbulletChannel
 {
     /**
-     * @var  \NotificationChannels\Pushbullet\Pushbullet
+     * @var \NotificationChannels\Pushbullet\Pushbullet
      */
     protected $pushbullet;
 

src/PushbulletMessage.php

@@ -17,9 +17,7 @@ class PushbulletMessage
      */
     public $type = 'note';
 
-    /**
-     * @var \NotificationChannels\Pushbullet\Targets\Targetable
-     */
+    /** @var \NotificationChannels\Pushbullet\Targets\Targetable */
     protected $target;
 
     /**
@@ -37,14 +35,33 @@ class PushbulletMessage
     public $message;
 
     /**
-     * URL if notification is of link type
+     * Url if notification is of link type
      *
      * @var string
      */
     public $url;
 
+    /**
+     * @param string $message
+     *
+     * @return static
+     */
+    public static function create($message)
+    {
+        return new static($message);
+    }
+
+    /**
+     * @param string $message
+     */
+    public function __construct($message)
+    {
+        $this->message = $message;
+    }
+
     /**
      * @param  \NotificationChannels\Pushbullet\Targets\Targetable  $targetable
+     *
      * @return $this
      */
     public function target(Targetable $targetable)
@@ -55,7 +72,7 @@ public function target(Targetable $targetable)
     }
 
     /**
-     * Specify that notification is of `note` type
+     * Specify that notification is of `note` type.
      *
      * @return $this
      */
@@ -67,7 +84,7 @@ public function note()
     }
 
     /**
-     * Specify that notification is of `link` type
+     * Specify that notification is of `link` type.
      *
      * @return $this
      */
@@ -79,9 +96,10 @@ public function link()
     }
 
     /**
-     * Set notification title
+     * Set notification title.
      *
      * @param  string  $title
+     *
      * @return $this
      */
     public function title($title)
@@ -92,9 +110,10 @@ public function title($title)
     }
 
     /**
-     * Set notification message
+     * Set notification message.
      *
      * @param  string  $message
+     *
      * @return $this
      */
     public function message($message)
@@ -105,9 +124,10 @@ public function message($message)
     }
 
     /**
-     * Set notification url (if notification is of `link` type)
+     * Set notification url (if notification is of `link` type).
      *
      * @param  string  $url
+     *
      * @return $this
      */
     public function url($url)
@@ -118,7 +138,7 @@ public function url($url)
     }
 
     /**
-     * Get array representation of message for pushbullet client
+     * Get array representation of message for Pushbullet client.
      *
      * @return array
      */

src/PushbulletServiceProvider.php

@@ -16,14 +16,9 @@ public function boot()
         $this->app->when(PushbulletChannel::class)
             ->needs(Pushbullet::class)
             ->give(function () {
-                return new Pushbullet($this->app['config']['services.pushbullet.access_token'], new HttpClient);
-            });
-    }
+                $config = config('services.pushbullet');
 
-    /**
-     * Register the application services.
-     */
-    public function register()
-    {
+                return new Pushbullet($config['access_token'], new HttpClient);
+            });
     }
 }

src/Targets/Device.php

@@ -2,8 +2,6 @@
 
 namespace NotificationChannels\Pushbullet\Targets;
 
-use NotificationChannels\Pushbullet\Exceptions\CouldNotSendNotification;
-
 class Device implements Targetable
 {
     /**
@@ -24,7 +22,7 @@ public function __construct($device)
     }
 
     /**
-     * @inheritdoc
+     * @return array
      */
     public function getTarget()
     {

src/Targets/Email.php

@@ -21,7 +21,7 @@ class Email implements Targetable
     public function __construct($email)
     {
         if (filter_var($email, FILTER_VALIDATE_EMAIL) === false) {
-            throw CouldNotSendNotification::providedEmailIsInvalid();
+            throw CouldNotSendNotification::providedEmailIsInvalid($email);
         }
 
         $this->email = $email;

src/Targets/Targetable.php

@@ -5,7 +5,7 @@
 interface Targetable
 {
     /**
-     * Get proper target object for pushbullet client
+     * Get proper target object for Pushbullet client
      *
      * @return array
      */