Added Message Search to Client:

- Can search with message objet or ID.
- Normalized `getBody()` for both message types.

Author: tjlytle

src/Message/Client.php

@@ -73,6 +73,69 @@ public function send($message)
         return $message;
     }
 
+    /**
+     * @param string|MessageInterface $idOrMessage
+     */
+    public function search($idOrMessage)
+    {
+        if($idOrMessage instanceof MessageInterface){
+            $id = $idOrMessage->getMessageId();
+            $message = $idOrMessage;
+        } else {
+            $id = $idOrMessage;
+        }
+
+        $request = new Request(
+            \Nexmo\Client::BASE_REST . '/search/message?' . http_build_query(['id' => $id]),
+            'GET',
+            'php://temp',
+            ['Accept' => 'application/json']
+        );
+
+        $response = $this->client->send($request);
+
+        $response->getBody()->rewind();
+        
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        if(!$data){
+            throw new Exception\Request('no message found for `' . $id . '`');
+        }
+
+        if($response->getStatusCode() != '200' && isset($data['error-code'])){
+            throw new Exception\Request($data['error-code-label'], $data['error-code']);
+        } elseif($response->getStatusCode() != '200'){
+            throw new Exception\Request('error status from API', $response->getStatusCode());
+        }
+
+
+        switch($data['type']){
+            case 'MT':
+                $new = new Message($data['message-id']);
+                break;
+            case 'MO':
+                $new = new InboundMessage($data['message-id']);
+                break;
+            default:
+                throw new Exception\Exception('unexpected response from API');
+        }
+
+        if(isset($message) && !($message instanceof $new)){
+            throw new Exception\Exception(sprintf(
+                'searched for message with type `%s` but message of type `%s`',
+                get_class($message),
+                get_class($new)
+            ));
+        }
+
+        if(!isset($message)){
+            $message = $new;
+        }
+
+        $message->setResponse($response);
+        return $message;
+    }
+
     /**
      * @param array $message
      * @return Message
@@ -97,7 +160,7 @@ protected function createMessageFromArray($message)
 
         return new Message($to, $from, $message);
     }
-
+    
     /**
      * Convenience feature allowing messages to be sent without creating a message object first.
      *

src/Message/InboundMessage.php

@@ -91,7 +91,7 @@ public function getMessageId()
         return $this['messageId'];
     }
 
-    public function getText()
+    public function getBody()
     {
         if($this->getRequest()){
             return $this['text'];

src/Message/MessageInterface.php

@@ -10,5 +10,5 @@
 
 interface MessageInterface extends \Nexmo\Entity\EntityInterface
 {
-    
+    public function getMessageId();
 }

test/Message/ClientTest.php

@@ -9,6 +9,7 @@
 namespace NexmoTest\Message;
 
 use Nexmo\Message\Client;
+use Nexmo\Message\Message;
 use Nexmo\Message\Text;
 use NexmoTest\Psr7AssertionTrait;
 use Prophecy\Argument;
@@ -115,6 +116,50 @@ public function testThrowServerException()
         }
     }
 
+    public function testCanSearchByMessage()
+    {
+        $message = new Message('02000000D912945A');
+        $response = $this->getResponse('search-outbound');
+
+        $this->nexmoClient->send(Argument::that(function(Request $request) {
+            $this->assertRequestQueryContains('id', '02000000D912945A', $request);
+            return true;
+        }))->willReturn($response);
+
+        $this->messageClient->search($message);
+        $this->assertSame($response, $message->getResponse());
+    }
+
+    public function testCanSearchBySingleOutboundId()
+    {
+        $response = $this->getResponse('search-outbound');
+
+        $this->nexmoClient->send(Argument::that(function(Request $request) {
+            $this->assertRequestQueryContains('id', '02000000D912945A', $request);
+            return true;
+        }))->willReturn($response);
+
+        $message = $this->messageClient->search('02000000D912945A');
+
+        $this->assertInstanceOf('Nexmo\Message\Message', $message);
+        $this->assertSame($response, $message->getResponse());
+    }
+
+    public function testCanSearchBySingleInboundId()
+    {
+        $response = $this->getResponse('search-inbound');
+
+        $this->nexmoClient->send(Argument::that(function(Request $request) {
+            $this->assertRequestQueryContains('id', '02000000DA7C52E7', $request);
+            return true;
+        }))->willReturn($response);
+
+        $message = $this->messageClient->search('02000000DA7C52E7');
+
+        $this->assertInstanceOf('Nexmo\Message\InboundMessage', $message);
+        $this->assertSame($response, $message->getResponse());
+    }
+
     /**
      * Get the API response we'd expect for a call to the API. Message API currently returns 200 all the time, so only
      * change between success / fail is body of the message.

test/Message/InboundMessageTest.php

@@ -42,7 +42,7 @@ public function testRequestObjectAccess($request)
         $this->assertEquals('14845552121', $message->getFrom());
         $this->assertEquals('16105553939', $message->getTo());
         $this->assertEquals('02000000DA7C52E7', $message->getMessageId());
-        $this->assertEquals('Test this.', $message->getText());
+        $this->assertEquals('Test this.', $message->getBody());
         $this->assertEquals('text', $message->getType());
     }
 
@@ -74,7 +74,7 @@ public function testResponseObjectAccess($response)
         $this->assertEquals('14845552121', $message->getFrom());
         $this->assertEquals('16105553939', $message->getTo());
         $this->assertEquals('02000000DA7C52E7', $message->getMessageId());
-        $this->assertEquals('Test this.', $message->getText());
+        $this->assertEquals('Test this.', $message->getBody());
         $this->assertEquals('6cff3913', $message->getAccountId());
         $this->assertEquals('US-VIRTUAL-BANDWIDTH', $message->getNetwork());
     }