Merge pull request #79 from otsch/clean-up

Some clean up and improvements

Author: christophrumpel

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to the `Twitter notification channel` will be documented in this file
 
+## 6.0.0 - 2022-02-x
+### Added
+- Abstract parent class `TwitterMessage` for
+  `TwitterStatusUpdate` and `TwitterDirectMessage`.
+
+### Changed
+- Add a lot of missing argument and return types.
+- Make use of constructor property promotion.
+
 ## 2.0.0 - 2018-11-08
 
 - update dependencies

README.md

@@ -71,12 +71,14 @@ To use this package, you need to create a notification class, like `NewsWasPubli
 
 ```php
 <?php
+
+use Illuminate\Notifications\Notification;
 use NotificationChannels\Twitter\TwitterChannel;
+use NotificationChannels\Twitter\TwitterMessage;
 use NotificationChannels\Twitter\TwitterStatusUpdate;
 
 class NewsWasPublished extends Notification
 {
-
     /**
      * Get the notification's delivery channels.
      *
@@ -88,7 +90,7 @@ class NewsWasPublished extends Notification
         return [TwitterChannel::class];
     }
 
-    public function toTwitter($notifiable)
+    public function toTwitter(mixed $notifiable): TwitterMessage
     {
         return new TwitterStatusUpdate('Laravel notifications are awesome!');
     }
@@ -98,15 +100,15 @@ class NewsWasPublished extends Notification
 Take a closer look at the `toTwitter` method. Here we define what kind of Twitter message we want to trigger. In this case, it is a status update message, which is just a new message in your timeline.
 
 ````php
-public function toTwitter($notifiable)
+public function toTwitter(mixed $notifiable): TwitterMessage
 {
     return new TwitterStatusUpdate('Laravel notifications are awesome!');
 }
 ````
 ### Publish Twitter status update with images
 It is possible to publish images with your status update too. You have to pass the image path to the `withImage` method.
 ````php
-public function toTwitter($notifiable)
+public function toTwitter(mixed $notifiable): TwitterMessage
 {
     return (new TwitterStatusUpdate('Laravel notifications are awesome!'))->withImage('marcel.png');
 }
@@ -121,7 +123,7 @@ return (new TwitterStatusUpdate('Laravel notifications are awesome!'))->withImag
 ### Send a direct message
 To send a Twitter direct message to a specific user, you will need the `TwitterDirectMessage` class. Provide the Twitter user handler as the first parameter and the the message as the second one.
 ````php
-public function toTwitter($notifiable)
+public function toTwitter(mixed $notifiable): TwitterMessage
 {
      return new TwitterDirectMessage('marcelpociot', 'Hey Marcel, it was nice meeting you at the Laracon.');
 }
@@ -130,7 +132,7 @@ public function toTwitter($notifiable)
 You can also provide the `user ID` instead of the `screen name`. This would prevent an extra Twitter API call. Make sure to pass it as an integer when you do.
 
 ````php
-public function toTwitter($notifiable)
+public function toTwitter(mixed $notifiable): TwitterMessage
 {
      return new TwitterDirectMessage(12345, 'Hey Marcel, it was nice meeting you at the Laracon.');
 }

src/Exceptions/CouldNotSendNotification.php

@@ -2,13 +2,11 @@
 
 namespace NotificationChannels\Twitter\Exceptions;
 
-class CouldNotSendNotification extends \Exception
+use Exception;
+
+class CouldNotSendNotification extends Exception
 {
-    /**
-     * @param $response
-     * @return CouldNotSendNotification
-     */
-    public static function serviceRespondsNotSuccessful($response)
+    public static function serviceRespondsNotSuccessful(mixed $response): CouldNotSendNotification
     {
         if (isset($response->error)) {
             return new static("Couldn't post notification. Response: ".$response->error);
@@ -19,23 +17,17 @@ public static function serviceRespondsNotSuccessful($response)
         return new static("Couldn't post notification. Response: ".$responseBody);
     }
 
-    /**
-     * @param $response
-     * @return CouldNotSendNotification
-     */
-    public static function userWasNotFound($response)
+    public static function userWasNotFound(mixed $response): CouldNotSendNotification
     {
         $responseBody = print_r($response->errors[0]->message, true);
 
         return new static("Couldn't send direct message notification. Response: ".$responseBody);
     }
 
-    /**
-     * @param $exceededLength
-     * @return CouldNotSendNotification
-     */
-    public static function statusUpdateTooLong($exceededLength)
+    public static function statusUpdateTooLong(int $exceededLength): CouldNotSendNotification
     {
-        return new static("Couldn't post notification, because the status message was too long by ".$exceededLength.' character(s).');
+        return new static(
+            "Couldn't post notification, because the status message was too long by ${exceededLength} character(s)."
+        );
     }
 }

src/TwitterChannel.php

@@ -3,37 +3,34 @@
 namespace NotificationChannels\Twitter;
 
 use Abraham\TwitterOAuth\TwitterOAuth;
-use Illuminate\Notifications\Notifiable;
 use Illuminate\Notifications\Notification;
 use NotificationChannels\Twitter\Exceptions\CouldNotSendNotification;
 
 class TwitterChannel
 {
-    /** @var TwitterOAuth */
-    protected $twitter;
-
-    /** @param TwitterOAuth $twitter */
-    public function __construct(TwitterOAuth $twitter)
+    public function __construct(protected TwitterOAuth $twitter)
     {
-        $this->twitter = $twitter;
     }
 
     /**
      * Send the given notification.
      *
-     * @param mixed $notifiable
-     * @param \Illuminate\Notifications\Notification $notification
+     * @param  mixed  $notifiable  Should be an object that uses the Illuminate\Notifications\Notifiable trait.
+     *
      * @throws CouldNotSendNotification
      */
-    public function send($notifiable, Notification $notification)
+    public function send($notifiable, Notification $notification): array|object
     {
         $this->changeTwitterSettingsIfNeeded($notifiable);
 
         $twitterMessage = $notification->toTwitter($notifiable);
         $twitterMessage = $this->addImagesIfGiven($twitterMessage);
 
-        $twitterApiResponse = $this->twitter->post($twitterMessage->getApiEndpoint(), $twitterMessage->getRequestBody($this->twitter),
-            $twitterMessage->isJsonRequest);
+        $twitterApiResponse = $this->twitter->post(
+            $twitterMessage->getApiEndpoint(),
+            $twitterMessage->getRequestBody(),
+            $twitterMessage->isJsonRequest,
+        );
 
         if ($this->twitter->getLastHttpCode() !== 200) {
             throw CouldNotSendNotification::serviceRespondsNotSuccessful($this->twitter->getLastBody());
@@ -45,23 +42,27 @@ public function send($notifiable, Notification $notification)
     /**
      * Use per user settings instead of default ones.
      *
-     * @param Notifiable $notifiable
+     * @param  object  $notifiable  Provide an object that uses the Illuminate\Notifications\Notifiable trait.
      */
-    private function changeTwitterSettingsIfNeeded($notifiable)
+    private function changeTwitterSettingsIfNeeded(object $notifiable)
     {
-        if (method_exists($notifiable, 'routeNotificationFor') && $twitterSettings = $notifiable->routeNotificationFor('twitter')) {
-            $this->twitter = new TwitterOAuth($twitterSettings[0], $twitterSettings[1], $twitterSettings[2],
-                $twitterSettings[3]);
+        if (
+            method_exists($notifiable, 'routeNotificationFor') &&
+            $twitterSettings = $notifiable->routeNotificationFor('twitter')
+        ) {
+            $this->twitter = new TwitterOAuth(
+                $twitterSettings[0],
+                $twitterSettings[1],
+                $twitterSettings[2],
+                $twitterSettings[3],
+            );
         }
     }
 
     /**
      * If it is a status update message and images are provided, add them.
-     *
-     * @param $twitterMessage
-     * @return mixed
      */
-    private function addImagesIfGiven($twitterMessage)
+    private function addImagesIfGiven(TwitterMessage $twitterMessage): object
     {
         if (is_a($twitterMessage, TwitterStatusUpdate::class) && $twitterMessage->getImages()) {
             $this->twitter->setTimeouts(10, 15);

src/TwitterDirectMessage.php

@@ -5,50 +5,28 @@
 use Abraham\TwitterOAuth\TwitterOAuth;
 use NotificationChannels\Twitter\Exceptions\CouldNotSendNotification;
 
-class TwitterDirectMessage
+class TwitterDirectMessage extends TwitterMessage
 {
-    /** @var string */
-    private $content;
+    public bool $isJsonRequest = true;
 
-    /** @var string */
-    private $to;
-
-    /** @var bool */
-    public $isJsonRequest = true;
-
-    /** @var string */
-    private $apiEndpoint = 'direct_messages/events/new';
-
-    /**
-     * TwitterDirectMessage constructor.
-     *
-     * @param $to
-     * @param $content
-     */
-    public function __construct($to, $content)
+    public function __construct(private string|int $to, string $content)
     {
-        $this->to = $to;
-        $this->content = $content;
+        parent::__construct($content);
     }
 
-    /**
-     * Get Twitter direct message content.
-     *
-     * @return  string
-     */
-    public function getContent()
+    public function getApiEndpoint(): string
     {
-        return $this->content;
+        return 'direct_messages/events/new';
     }
 
     /**
      * Get Twitter direct message receiver.
      *
-     * @param TwitterOAuth $twitter
-     * @return  string
+     * @return string|mixed
+     *
      * @throws CouldNotSendNotification
      */
-    public function getReceiver(TwitterOAuth $twitter)
+    public function getReceiver(TwitterOAuth $twitter): mixed
     {
         if (is_int($this->to)) {
             return $this->to;
@@ -67,24 +45,12 @@ public function getReceiver(TwitterOAuth $twitter)
         return $user->id;
     }
 
-    /**
-     * Return Twitter direct message api endpoint.
-     *
-     * @return  string
-     */
-    public function getApiEndpoint()
-    {
-        return $this->apiEndpoint;
-    }
-
     /**
      * Build Twitter request body.
      *
-     * @param TwitterOAuth $twitter
-     * @return  array
      * @throws CouldNotSendNotification
      */
-    public function getRequestBody(TwitterOAuth $twitter)
+    public function getRequestBody(TwitterOAuth $twitter): array
     {
         return [
             'event' => [

src/TwitterImage.php

@@ -4,25 +4,11 @@
 
 class TwitterImage
 {
-    /** @var string */
-    private $imagePath;
-
-    /**
-     * TwitterImage constructor.
-     *
-     * @param $imagePath
-     */
-    public function __construct($imagePath)
+    public function __construct(private string $imagePath)
     {
-        $this->imagePath = $imagePath;
     }
 
-    /**
-     * Get image path.
-     *
-     * @return string
-     */
-    public function getPath()
+    public function getPath(): string
     {
         return $this->imagePath;
     }

src/TwitterMessage.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace NotificationChannels\Twitter;
+
+abstract class TwitterMessage
+{
+    public bool $isJsonRequest = false;
+
+    public function __construct(protected string $content)
+    {
+    }
+
+    public function getContent(): string
+    {
+        return $this->content;
+    }
+
+    abstract public function getApiEndpoint(): string;
+}