Merge pull request #15 from laravel-notification-channels/feature/addImage

Add media to Twitter status update

Author: Christoph Rumpel

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to the `Twitter notification channel` will be documented in this file
 
+## 0.0.5 - 2016-09-17
+
+- refactor the code to provide separate classes for Twitter status updates and direct messages
+
 
 ## 0.0.4 - 2016-08-27
 

README.md

@@ -14,9 +14,11 @@ This package makes it easy to send notifications using [Twitter](https://dev.twi
 ## Contents
 
 - [Installation](#installation)
-	- [Setting up the Twitter service](#setting-up-the-Twitter-service)
+- [Setting up the Twitter service](#setting-up-the-twitter-service)
 - [Usage](#usage)
-	- [Available Message methods](#available-message-methods)
+	- [Publish Twitter status update](#publish-twitter-status-update)
+	- [Publish Twitter status update with images](#publish-twitter-status-update-with-images)
+ - [Send a direct message](#send-a-direct-message)
 - [Changelog](#changelog)
 - [Testing](#testing)
 - [Security](#security)
@@ -73,7 +75,7 @@ Follow Laravel's documentation to add the channel to your Notification class.
 use NotificationChannels\Twitter\TwitterChannel;
 use NotificationChannels\Twitter\TwitterMessage;
 
-class  NewForumDiscussionCreated extends Notification
+class NewsWasPublished extends Notification
 {
 
     /**
@@ -88,25 +90,37 @@ class  NewForumDiscussionCreated extends Notification
     }
 
     public function toTwitter($notifiable) {
-        return new TwitterMessage('Why Laravel Notification Channels are awesome -> url:...');
+        return new TwitterStatusUpdate('Laravel notifications are awesome!');
     }
 }
 ```
 
-Take a closer look at the `TwitterMessage` object. Like this, it will send a status update to your Twitter timeline.
+Take a closer look at the `TwitterStatusUpdate` object. This is where the magic happens.
 ````php
 public function toTwitter($notifiable) {
-    return new TwitterMessage('Why Laravel Notification Channels are awesome -> url:...');
+    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 just have to pass the image paths as the second 
+parameter. These images will then be shown next to your Twitter status message.
+````php
+public function toTwitter($notifiable) {
+    return new TwitterStatusUpdate(
+        'Laravel notifications are awesome!',
+        [public_path('marcel.png'), public_path('mohamed.png'), public_path('freek.png')]
+    );
+}
+````
 ### Send a direct message
-But it is possible to send a Twitter direct message too. Just provide a second argument. The first one will be the user, the second one the 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) {
-    return new TwitterMessage('christophrumpel', 'Hey Christoph, whats up?');
+     return new TwitterDirectMessage('marcelpociot', 'Hey Marcel, it was nice meeting you at the Larcon.');
 }
 ```` 
-Make sure the user is following you on Twitter. If this is not the case, it will throw an Exception.
+Make sure the user is following you on Twitter to make this work.
 
 
 

src/Exceptions/CouldNotSendNotification.php

@@ -6,7 +6,7 @@ class CouldNotSendNotification extends \Exception
 {
     public static function serviceRespondedWithAnError($response)
     {
-        $responseBody = print_r($response->getBody(), true);
+        $responseBody = print_r($response->errors[0]->message, true);
 
         return new static("Couldn't post Notification. Response: ".$responseBody);
     }

src/TwitterChannel.php

@@ -30,18 +30,20 @@ public function __construct(TwitterOAuth $twitter)
     public function send($notifiable, Notification $notification)
     {
         $twitterMessage = $notification->toTwitter($notifiable);
-        if ($twitterMessage->getReceiver() != null) {
-            $response = $this->twitter->post('direct_messages/new', [
-                    'text' => $twitterMessage->getContent(),
-                    'screen_name' => $twitterMessage->getReceiver(),
-                ]);
-        } else {
-            $response = $this->twitter->post(
-                'statuses/update', ['status' => $twitterMessage->getContent()]);
+        if (is_a($twitterMessage, TwitterStatusUpdate::class) && $twitterMessage->getImagePaths()) {
+            $this->twitter->setTimeouts(10, 15);
+
+            $twitterMessage->imageIds = $twitterMessage->getImagePaths()->map(function ($path) {
+                $media = $this->twitter->upload('media/upload', ['media' => $path]);
+
+                return $media->media_id_string;
+            });
         }
 
-        if ($response->getHttpCode() !== 200) {
-            throw CouldNotSendNotification::serviceRespondedWithAnError($response);
+        $this->twitter->post($twitterMessage->getApiEndpoint(), $twitterMessage->getRequestBody());
+
+        if ($this->twitter->getLastHttpCode() !== 200) {
+            throw CouldNotSendNotification::serviceRespondedWithAnError($this->twitter->getLastBody());
         }
     }
 }

src/TwitterDirectMessage.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace NotificationChannels\Twitter;
+
+class TwitterDirectMessage
+{
+    /** @var string */
+    private $content;
+
+    /**
+     * @var  string
+     */
+    private $to;
+
+    /**
+     * @var  string
+     */
+    private $apiEndpoint = 'direct_messages/new';
+
+    /*
+     * @param  string $content
+     */
+    public function __construct(string $to, string $content)
+    {
+        $this->to = $to;
+        $this->content = $content;
+    }
+
+    /**
+     * Get Twitter direct messsage content.
+     *
+     * @return  string
+     */
+    public function getContent()
+    {
+        return $this->content;
+    }
+
+    /**
+     * Get Twitter direct message receiver.
+     *
+     * @return  string
+     */
+    public function getReceiver()
+    {
+        return $this->to;
+    }
+
+    /**
+     * Return Twitter direct message api endpoint.
+     * @return  string
+     */
+    public function getApiEndpoint()
+    {
+        return $this->apiEndpoint;
+    }
+
+    /**
+     * Build Twitter request body.
+     * @return  array
+     */
+    public function getRequestBody()
+    {
+        $body = [
+            'screen_name' => $this->getReceiver(),
+            'text'        => $this->getContent(),
+        ];
+
+        return $body;
+    }
+}

src/TwitterMessage.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace NotificationChannels\Twitter;
+
+class TwitterStatusUpdate
+{
+    /** @var string */
+    protected $content;
+
+    /**
+     * @var  array
+     */
+    private $imagePaths;
+
+    /**
+     * @var  array
+     */
+    public $imageIds;
+
+    /**
+     * @var  string
+     */
+    private $apiEndpoint = 'statuses/update';
+
+    /*
+     * @param  string $content
+     */
+    public function __construct(string $content, array $imagePaths = null)
+    {
+        $this->content = $content;
+        $this->imagePaths = $imagePaths ? collect($imagePaths) : null;
+    }
+
+    /**
+     * Get Twitter status update content.
+     *
+     * @return  string
+     */
+    public function getContent()
+    {
+        return $this->content;
+    }
+
+    /**
+     * Get Twitter status update image paths.
+     *
+     * @return  string
+     */
+    public function getImagePaths()
+    {
+        return $this->imagePaths;
+    }
+
+    /**
+     * Return Twitter status update api endpoint.
+     * @return  string
+     */
+    public function getApiEndpoint()
+    {
+        return $this->apiEndpoint;
+    }
+
+    /**
+     * Build Twitter request body.
+     * @return  array
+     */
+    public function getRequestBody()
+    {
+        $body = [
+            'status' => $this->getContent(),
+        ];
+
+        if ($this->imageIds) {
+            $body['media_ids'] = $this->imageIds->implode(',');
+        }
+
+        return $body;
+    }
+}