[BC break] Handled team inbox message

Author: mremi

README.md

@@ -52,18 +52,39 @@ Composer will install the library to your project's `vendor/mremi` directory.
 ```php
 <?php
 
-use Mremi\Flowdock\Api\Push\Chat\Chat;
-use Mremi\Flowdock\Api\Push\Chat\Message;
+use Mremi\Flowdock\Api\Push\ChatMessage;
+use Mremi\Flowdock\Api\Push\Push;
 
-$message = new Message;
-$message
+$message = ChatMessage::create()
     ->setContent('This message has been sent with mremi/flowdock PHP library')
     ->setExternalUserName('mremi')
     ->addTag('#hello-world');
 
-$chat = new Chat('your_flow_api_token');
+$push = new Push('your_flow_api_token');
 
-if (!$chat->sendMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) {
+if (!$push->sendChatMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) {
+    // handle errors...
+    $message->getErrors();
+}
+```
+
+### Team Inbox
+
+```php
+<?php
+
+use Mremi\Flowdock\Api\Push\Push;
+use Mremi\Flowdock\Api\Push\TeamInboxMessage;
+
+$message = TeamInboxMessage::create()
+    ->setSource('source')
+    ->setFromAddress('[email protected]')
+    ->setSubject('subject')
+    ->setContent('This message has been sent with mremi/flowdock PHP library');
+
+$push = new Push('your_flow_api_token');
+
+if (!$push->sendTeamInboxMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) {
     // handle errors...
     $message->getErrors();
 }

composer.json

@@ -19,6 +19,6 @@
         "phpunit/phpunit": "~4.1"
     },
     "autoload": {
-        "psr-0": { "Mremi\\Flowdock": "src" }
+        "psr-0": { "Mremi\\Flowdock": "src", "Mremi\\Flowdock\\Tests": "tests/" }
     }
 }

src/Mremi/Flowdock/Api/Push/BaseMessage.php

@@ -33,6 +33,14 @@ abstract class BaseMessage implements BaseMessageInterface
      */
     protected $errors = array();
 
+    /**
+     * {@inheritdoc}
+     */
+    public static function create()
+    {
+        return new static;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Mremi/Flowdock/Api/Push/BaseMessageInterface.php

@@ -18,12 +18,19 @@
  */
 interface BaseMessageInterface
 {
+    /**
+     * Creates a new message instance
+     *
+     * @return static
+     */
+    public static function create();
+
     /**
      * Sets the content of the message
      *
      * @param string $content
      *
-     * @return BaseMessageInterface
+     * @return static
      */
     public function setContent($content);
 
@@ -39,7 +46,7 @@ public function getContent();
      *
      * @param string $tag
      *
-     * @return BaseMessageInterface
+     * @return static
      */
     public function addTag($tag);
 
@@ -55,7 +62,7 @@ public function getTags();
      *
      * @param string $error
      *
-     * @return BaseMessageInterface
+     * @return static
      */
     public function addError($error);
 

src/Mremi/Flowdock/Api/Push/BasePush.php

@@ -9,16 +9,14 @@
  * file that was distributed with this source code.
  */
 
-namespace Mremi\Flowdock\Api\Push\Chat;
-
-use Mremi\Flowdock\Api\Push\BaseMessage;
+namespace Mremi\Flowdock\Api\Push;
 
 /**
  * Chat message class
  *
  * @author Rémi Marseille <[email protected]>
  */
-class Message extends BaseMessage implements MessageInterface
+class ChatMessage extends BaseMessage implements ChatMessageInterface
 {
     /**
      * @var string

src/Mremi/Flowdock/Api/Push/Chat/ChatInterface.php

@@ -9,23 +9,21 @@
  * file that was distributed with this source code.
  */
 
-namespace Mremi\Flowdock\Api\Push\Chat;
-
-use Mremi\Flowdock\Api\Push\BaseMessageInterface;
+namespace Mremi\Flowdock\Api\Push;
 
 /**
  * Chat message interface
  *
  * @author Rémi Marseille <[email protected]>
  */
-interface MessageInterface extends BaseMessageInterface
+interface ChatMessageInterface extends BaseMessageInterface
 {
     /**
      * Sets the name of the user sending the message
      *
      * @param string $externalUserName
      *
-     * @return MessageInterface
+     * @return ChatMessageInterface
      */
     public function setExternalUserName($externalUserName);
 
@@ -41,7 +39,7 @@ public function getExternalUserName();
      *
      * @param integer $messageId
      *
-     * @return MessageInterface
+     * @return ChatMessageInterface
      */
     public function setMessageId($messageId);
 

src/Mremi/Flowdock/Api/Push/Chat/Message.php renamed to src/Mremi/Flowdock/Api/Push/ChatMessage.php

@@ -9,25 +9,64 @@
  * file that was distributed with this source code.
  */
 
-namespace Mremi\Flowdock\Api\Push\Chat;
+namespace Mremi\Flowdock\Api\Push;
 
+use Guzzle\Http\Client;
 use Guzzle\Http\Message\Response;
 
-use Mremi\Flowdock\Api\Push\BasePush;
-
 /**
- * Chat class
+ * Push class
  *
  * @author Rémi Marseille <[email protected]>
  */
-class Chat extends BasePush implements ChatInterface
+class Push implements PushInterface
 {
+    const BASE_CHAT_URL       = 'https://api.flowdock.com/v1/messages/chat';
+    const BASE_TEAM_INBOX_URL = 'https://api.flowdock.com/v1/messages/team_inbox';
+
+    /**
+     * @var string
+     */
+    private $flowApiToken;
+
+    /**
+     * Constructor
+     *
+     * @param string $flowApiToken A flow API token
+     */
+    public function __construct($flowApiToken)
+    {
+        $this->flowApiToken = $flowApiToken;
+    }
+
     /**
      * {@inheritdoc}
      */
-    public function sendMessage(MessageInterface $message, array $options = array())
+    public function sendChatMessage(ChatMessageInterface $message, array $options = array())
+    {
+        return $this->sendMessage($message, self::BASE_CHAT_URL, $options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sendTeamInboxMessage(TeamInboxMessageInterface $message, array $options = array())
+    {
+        return $this->sendMessage($message, self::BASE_TEAM_INBOX_URL, $options);
+    }
+
+    /**
+     * Sends a message to a flow
+     *
+     * @param BaseMessageInterface $message A message instance to send
+     * @param string               $baseUrl A base URL
+     * @param array                $options An array of options used by request
+     *
+     * @return boolean
+     */
+    protected function sendMessage(BaseMessageInterface $message, $baseUrl, array $options = array())
     {
-        $client = $this->createClient();
+        $client = $this->createClient(sprintf('%s/%s', $baseUrl, $this->flowApiToken));
 
         $request = $client->post(null, array(
             'Content-Type' => 'application/json'
@@ -40,23 +79,15 @@ public function sendMessage(MessageInterface $message, array $options = array())
         return $this->isValid($message, $response);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function getApiUrl()
-    {
-        return sprintf('https://api.flowdock.com/v1/messages/chat/%s', $this->flowApiToken);
-    }
-
     /**
      * Returns TRUE whether the response is valid
      *
-     * @param MessageInterface $message  A message instance
-     * @param Response         $response A response instance
+     * @param BaseMessageInterface $message  A message instance
+     * @param Response             $response A response instance
      *
      * @return boolean
      */
-    protected function isValid(MessageInterface $message, Response $response)
+    protected function isValid(BaseMessageInterface $message, Response $response)
     {
         if (200 !== $response->getStatusCode()) {
             $message->addError(sprintf('Status code of response is wrong, expected 200, got %s', $response->getStatusCode()));
@@ -78,4 +109,16 @@ protected function isValid(MessageInterface $message, Response $response)
 
         return !$message->hasErrors();
     }
+
+    /**
+     * Creates a client to interact with Flowdock API
+     *
+     * @param string $url
+     *
+     * @return Client
+     */
+    protected function createClient($url)
+    {
+        return new Client($url);
+    }
 }