Merge pull request #24 from christophrumpel/feature/addMessageLimitHandling

Throw exception if status message character count is exceeded

Author: Christoph Rumpel

composer.json

@@ -15,7 +15,8 @@
         "php": ">=5.6.4",
         "abraham/twitteroauth": "^0.6.4",
         "illuminate/notifications": "5.3.*",
-        "illuminate/support": "5.1.*|5.2.*|5.3.*"
+        "illuminate/support": "5.1.*|5.2.*|5.3.*",
+        "kylewm/brevity": "^0.2.9"
     },
     "require-dev": {
         "mockery/mockery": "^0.9.5",

src/Exceptions/CouldNotSendNotification.php

@@ -10,4 +10,10 @@ public static function serviceRespondedWithAnError($response)
 
         return new static("Couldn't post Notification. Response: ".$responseBody);
     }
+
+    public static function statusUpdateTooLong($exceededLength)
+    {
+        return new static("Couldn't post Notification, because the status message was too long by " .
+            $exceededLength . " character(s).");
+    }
 }

src/TwitterStatusUpdate.php

@@ -2,10 +2,13 @@
 
 namespace NotificationChannels\Twitter;
 
+use Kylewm\Brevity\Brevity;
+use NotificationChannels\Twitter\Exceptions\CouldNotSendNotification;
 use NotificationChannels\Twitter\TwitterImage;
 
 class TwitterStatusUpdate
 {
+
     /** @var string */
     protected $content;
 
@@ -29,6 +32,9 @@ class TwitterStatusUpdate
      */
     public function __construct($content)
     {
+        if ($exceededLength = $this->messageIsTooLong($content, new Brevity())) {
+            throw CouldNotSendNotification::statusUpdateTooLong($exceededLength);
+        }
         $this->content = $content;
     }
 
@@ -38,10 +44,12 @@ public function __construct($content)
      * @param   array|string $images
      * @return  $this
      */
-    public function withImage($images){
-        collect($images)->each(function($image){
+    public function withImage($images)
+    {
+        collect($images)->each(function ($image) {
             $this->images[] = new TwitterImage($image);
         });
+
         return $this;
     }
 
@@ -90,4 +98,18 @@ public function getRequestBody()
 
         return $body;
     }
+
+    /**
+     * Check if the message length is too long
+     * @param $content
+     * @param $brevity
+     * @return int
+     */
+    private function messageIsTooLong($content, $brevity)
+    {
+        $tweetLength = $brevity->tweetLength($content);
+        $exceededLength = $tweetLength - 140;
+
+        return $exceededLength > 0 ? $exceededLength : 0;
+    }
 }

tests/TwitterChannelTest.php

@@ -85,7 +85,6 @@ public function it_throws_an_exception_when_it_could_not_send_the_notification()
 
         $this->channel->send(new TestNotifiable(), new TestNotification());
     }
-
 }
 
 

tests/TwitterStatusUpdateTest.php

@@ -2,11 +2,13 @@
 
 namespace NotificationChannels\Twitter\Test;
 
+use NotificationChannels\Twitter\Exceptions\CouldNotSendNotification;
 use NotificationChannels\Twitter\TwitterImage;
 use NotificationChannels\Twitter\TwitterStatusUpdate;
 
 class TwitterStatusUpdateTest extends \PHPUnit_Framework_TestCase
 {
+
     /** @var TwitterStatusUpdate */
     protected $message;
 
@@ -32,15 +34,17 @@ public function it_accepts_one_image_path()
         $message = (new TwitterStatusUpdate('myMessage'))->withImage('image1.png');
 
         $this->assertEquals('myMessage', $message->getContent());
-        $this->assertEquals([ new TwitterImage('image1.png') ], $message->getImages());
+        $this->assertEquals([new TwitterImage('image1.png')], $message->getImages());
     }
 
     /** @test */
     public function it_accepts_array_of_image_paths()
     {
         $imagePaths = ['path1', 'path2'];
         $message = (new TwitterStatusUpdate('myMessage'))->withImage($imagePaths);
-        $imagePathsObjects = collect($imagePaths)->map(function($image){ return new TwitterImage($image); })->toArray();
+        $imagePathsObjects = collect($imagePaths)->map(function ($image) {
+            return new TwitterImage($image);
+        })->toArray();
 
         $this->assertEquals('myMessage', $message->getContent());
         $this->assertEquals($imagePathsObjects, $message->getImages());
@@ -57,4 +61,41 @@ public function it_constructs_a_request_body()
             'media_ids' => '434,435,436',
         ]);
     }
+
+    /** @test */
+    public function it_throws_an_exception_when_the_status_update_is_too_long()
+    {
+        $tooLongMessage = 'Laravel Notification Channels are awesome and this message is far too long for a Twitter 
+            status update and this is why an exception is thrown!';
+
+        try {
+            $statusUpdate = new TwitterStatusUpdate($tooLongMessage);
+        } catch (CouldNotSendNotification $e) {
+            $this->assertEquals(CouldNotSendNotification::class, get_class($e));
+        }
+    }
+
+    /** @test */
+    public function it_provides_exceeded_message_count_when_the_status_update_is_too_long()
+    {
+        $tooLongMessage = 'Laravel Notification Channels are awesome and this message is far too long for a Twitter status update because of this URL https://github.com/laravel-notification-channels';
+
+        try {
+            $statusUpdate = new TwitterStatusUpdate($tooLongMessage);
+        } catch (CouldNotSendNotification $e) {
+            $this->assertEquals("Couldn't post Notification, because the status message was too long by 6 character(s).",
+                $e->getMessage());
+        }
+
+        $anotherTooLongMessage = 'Laravel Notification Channels are awesome and this message is just in length so that Twitter does not complain!!!!!!! https://github.com/laravel-notification-channels';
+
+        try {
+            $statusUpdate = new TwitterStatusUpdate($anotherTooLongMessage);
+        } catch (CouldNotSendNotification $e) {
+            $this->assertEquals("Couldn't post Notification, because the status message was too long by 1 character(s).",
+                $e->getMessage());
+        }
+
+    }
+
 }