initial code review

Author: freekmurze

README.md

@@ -125,8 +125,7 @@ class GameChallengeNotification extends Notification
 
     public function toDiscord($notifiable)
     {
-        return (new DiscordMessage)
-            ->body("You have been challenged to a game of *{$this->game->name}* by **{$this->channelger->name}**!");
+        return DiscordMessage::create("You have been challenged to a game of *{$this->game->name}* by **{$this->channelger->name}**!");
     }
 }
 ```

src/Commands/SetupCommand.php

@@ -41,7 +41,7 @@ public function handle()
 
             $gateway = Arr::get(json_decode($response->getBody(), true), 'url', $gateway);
         } catch (\Excetion $e) {
-            $this->warn("Could not get a WebSocket gateway address, defaulting to '$gateway'.");
+            $this->warn("Could not get a WebSocket gateway address, defaulting to {$gateway}.");
         }
 
         $this->warn("Connecting to '$gateway'...");

src/Discord.php

@@ -2,26 +2,21 @@
 
 namespace NotificationChannels\Discord;
 
+use Exception;
 use Illuminate\Support\Arr;
 use GuzzleHttp\Client as HttpClient;
 use GuzzleHttp\Exception\RequestException;
 use NotificationChannels\Discord\Exceptions\CouldNotSendNotification;
 
 class Discord
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     protected $baseUrl = 'https://discordapp.com/api';
 
-    /**
-     * @var \GuzzleHttp\Client
-     */
-    protected $http;
+    /** @var \GuzzleHttp\Client */
+    protected $httpClient;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     protected $token;
 
     /**
@@ -30,13 +25,14 @@ class Discord
      */
     public function __construct(HttpClient $http, $token)
     {
-        $this->http = $http;
+        $this->httpClient = $http;
         $this->token = $token;
     }
 
     /**
      * @param  string  $channel
      * @param  array  $data
+     *
      * @return \Psr\Http\Message\ResponseInterface
      */
     public function send($channel, array $data)
@@ -46,6 +42,7 @@ public function send($channel, array $data)
 
     /**
      * @param  mixed  $user
+     *
      * @return string
      */
     public function getPrivateChannel($user)
@@ -54,26 +51,29 @@ public function getPrivateChannel($user)
     }
 
     /**
-     * @param  string  $endpoint
-     * @param  array  $data
+     * @param $verb
+     * @param  string $endpoint
+     * @param  array $data
+     *
      * @return array
+     *
      * @throws \NotificationChannels\Discord\Exceptions\CouldNotSendNotification
      */
     protected function request($verb, $endpoint, array $data)
     {
         $url = rtrim($this->baseUrl, '/').'/'.ltrim($endpoint, '/');
 
         try {
-            $response = $this->http->request($verb, $url, [
+            $response = $this->httpClient->request($verb, $url, [
                 'headers' => [
                     'Authorization' => 'Bot '.$this->token,
                 ],
                 'json' => $data,
             ]);
-        } catch (RequestException $e) {
-            throw CouldNotSendNotification::serviceRespondedWithAnHttpError($e->getResponse());
-        } catch (\Exception $e) {
-            throw CouldNotSendNotification::serviceCommunicationError($e);
+        } catch (RequestException $exception) {
+            throw CouldNotSendNotification::serviceRespondedWithAnHttpError($exception->getResponse());
+        } catch (Exception $exception) {
+            throw CouldNotSendNotification::serviceCommunicationError($exception);
         }
 
         $body = json_decode($response->getBody(), true);

src/DiscordChannel.php

@@ -9,9 +9,7 @@
 
 class DiscordChannel
 {
-    /**
-     * @var \NotificationChannels\Discord\Discord;
-     */
+    /** @var \NotificationChannels\Discord\Discord */
     protected $discord;
 
     /**
@@ -27,6 +25,7 @@ public function __construct(Discord $discord)
      *
      * @param  mixed  $notifiable
      * @param  \Illuminate\Notifications\Notification  $notification
+     *
      * @throws \NotificationChannels\Discord\Exceptions\CouldNotSendNotification
      */
     public function send($notifiable, Notification $notification)

src/DiscordMessage.php

@@ -2,7 +2,6 @@
 
 namespace NotificationChannels\Discord;
 
-use Illuminate\Support\Arr;
 
 class DiscordMessage
 {
@@ -13,6 +12,16 @@ class DiscordMessage
      */
     public $body;
 
+    /**
+     * @param  string $body
+     *
+     * @return static
+     */
+    public static function create($body = '')
+    {
+        return new static($body);
+    }
+
     /**
      * @param  string  $body
      */

src/Exceptions/CouldNotSendNotification.php

@@ -33,11 +33,11 @@ public static function serviceRespondedWithAnApiError($response)
     }
 
     /**
-     * @param  \Exception  $e
+     * @param  \Exception  $exception
      * @return static
      */
-    public static function serviceCommunicationError(Exception $e)
+    public static function serviceCommunicationError(Exception $exception)
     {
-        return new static("Communication with Discord failed: {$e->getCode()}: {$e->getMessage()}");
+        return new static("Communication with Discord failed: {$exception->getCode()}: {$exception->getMessage()}");
     }
 }