Merge pull request #92 from guiajlopes/feature/ENG-127-add-read-message

Add read message method

Author: marcel corso gonzalez

examples/conversations/message-read.php

@@ -0,0 +1,15 @@
+<?php
+
+// Retrieves a message.
+
+require(__DIR__ . '/../../autoload.php');
+
+$messageBird = new \MessageBird\Client('YOUR_ACCESS_KEY'); // Set your own API access key here.
+
+try {
+    $message = $messageBird->conversationMessages->read('YOUR MESSAGE ID');
+
+    var_dump($message);
+} catch (\Exception $e) {
+    echo sprintf("%s: %s", get_class($e), $e->getMessage());
+}

src/MessageBird/Resources/Conversation/Messages.php

@@ -20,6 +20,7 @@ class Messages
     const HTTP_STATUS_OK = 200;
 
     const RESOURCE_NAME = 'conversations/%s/messages';
+    const MESSAGE_RESOURCE_NAME = 'messages/%s';
 
     /**
      * @var HttpClient
@@ -123,6 +124,28 @@ public function getList($conversationId, $parameters = array())
         return $this->processRequest($body);
     }
 
+    public function read($messageId, $parameters = array()) {
+        list($status, , $body) = $this->httpClient->performHttpRequest(
+            HttpClient::REQUEST_GET,
+            sprintf(self::MESSAGE_RESOURCE_NAME, $messageId),
+            $parameters
+        );
+
+        if ($status !== self::HTTP_STATUS_OK) {
+            return $this->processRequest($body);
+        }
+
+        $body = json_decode($body);
+        if (empty($body)) {
+            return $this->processRequest($body);
+        }
+
+        $message = new Message();
+        $message->loadFromArray($body);
+
+        return $message;
+    }
+
     /**
      * Formats a URL for the Conversation API's messages endpoint based on the
      * conversationId.

tests/integration/conversation/ConversationMessageTest.php

@@ -30,6 +30,22 @@ class ConversationMessageTest extends BaseTest
         ]
     }';
 
+    const READ_RESPONSE = '{
+        "channelId": "chid",
+        "contactId": "conid",
+        "content": {
+            "video": {
+                "url": "https://developers.messagebird.com/assets/videos/foo.mp4"
+            }
+        },
+        "conversationId": "conid",
+        "createdDatetime": "2002-10-02T16:00:00Z",
+        "direction": "received",
+        "id": "genid",
+        "status": "delivered",
+        "type": "video"
+    }';
+
     public function setUp()
     {
         parent::setUp();
@@ -154,4 +170,31 @@ public function testListObject()
 
         $this->assertEquals($expectedMessage, $message);
     }
+
+    public function testReadMessage()
+    {
+        $this->mockClient
+            ->expects($this->once())->method('performHttpRequest')
+            ->with('GET', 'messages/message-id', array(), null)
+            ->willReturn(array(200, '', self::READ_RESPONSE));
+
+
+        $message = $this->client->conversationMessages->read('message-id');
+
+        $expectedContent = new Content();
+        $expectedContent->video = array(
+            'url' => 'https://developers.messagebird.com/assets/videos/foo.mp4'
+        );
+        $expectedMessage = new Message();
+        $expectedMessage->id = 'genid';
+        $expectedMessage->channelId = 'chid';
+        $expectedMessage->conversationId = 'conid';
+        $expectedMessage->content = $expectedContent;
+        $expectedMessage->type = 'video';
+        $expectedMessage->direction = 'received';
+        $expectedMessage->status = 'delivered';
+        $expectedMessage->createdDatetime = '2002-10-02T16:00:00Z';
+
+        $this->assertEquals($expectedMessage, $message);
+    }
 }