Added support for get() to search messages:

- Query interface could be used with future API changes.
- Does not remove the `search` (yet), but that should be able to proxy this.
- Needs tests, and *may change*.

Author: tjlytle

src/Message/Client.php

@@ -81,6 +81,74 @@ public function send($message)
         return $message;
     }
 
+    /**
+     * @param $query
+     * @return MessageInterface[]
+     * @throws Exception\Exception
+     * @throws Exception\Request
+     */
+    public function get($query)
+    {
+        if($query instanceof Query){
+            $params = $query->getParams();
+        } else if($query instanceof MessageInterface){
+            $params = ['ids' => [$query->getMessageId()]];
+        } else if(is_string($query)) {
+            $params = ['ids' => [$query]];
+        } else if(is_array($query)){
+            $params = ['ids' => $query];
+        } else {
+            throw new \InvalidArgumentException('query must be an instance of Query, MessageInterface, string ID, or array of IDs.');
+        }
+
+        $request = new Request(
+            \Nexmo\Client::BASE_REST . '/search/messages?' . http_build_query($params),
+            'GET',
+            'php://temp',
+            ['Accept' => 'application/json']
+        );
+
+        $response = $this->client->send($request);
+        $response->getBody()->rewind();
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        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());
+        }
+
+        if(!isset($data['items'])){
+            throw new Exception\Exception('unexpected response from API');
+        }
+
+        if(count($data['items']) == 0){
+            return [];
+        }
+
+        $collection = [];
+
+        foreach($data['items'] as $index => $item){
+            switch($item['type']){
+                case 'MT':
+                    $new = new Message($item['message-id']);
+                    break;
+                case 'MO':
+                    $new = new InboundMessage($item['message-id']);
+                    break;
+                default:
+                    throw new Exception\Exception('unexpected response from API');
+            }
+
+            $new->setResponse($response);
+            $new->setIndex($index);
+            $collection[] = $new;
+
+        }
+
+        return $collection;
+    }
+
     /**
      * @param string|MessageInterface $idOrMessage
      */

src/Message/CollectionTrait.php

@@ -0,0 +1,12 @@
+<?php
+namespace Nexmo\Message;
+
+trait CollectionTrait
+{
+    protected $index = null;
+
+    public function setIndex($index)
+    {
+        $this->index = (int) $index;
+    }
+}

src/Message/InboundMessage.php

@@ -16,6 +16,7 @@ class InboundMessage implements MessageInterface, \ArrayAccess
 {
     use Psr7Trait;
     use JsonResponseTrait;
+    use CollectionTrait;
 
     protected $id;
 
@@ -148,6 +149,11 @@ public function getNetwork()
     public function offsetExists($offset)
     {
         $response = $this->getResponseData();
+
+        if(isset($this->index)){
+            $response = $response['items'][$this->index];
+        }
+
         $request  = $this->getRequestData();
         $dirty    = $this->getRequestData(false);
         return isset($response[$offset]) || isset($request[$offset]) || isset($dirty[$offset]);
@@ -164,6 +170,11 @@ public function offsetExists($offset)
     public function offsetGet($offset)
     {
         $response = $this->getResponseData();
+
+        if(isset($this->index)){
+            $response = $response['items'][$this->index];
+        }
+
         $request  = $this->getRequestData();
         $dirty    = $this->getRequestData(false);
 

src/Message/Message.php

@@ -21,6 +21,7 @@ class Message implements MessageInterface, \Countable, \ArrayAccess, \Iterator
     use Psr7Trait;
     use JsonResponseTrait;
     use RequestArrayTrait;
+    use CollectionTrait;
 
     const TYPE = null;
 
@@ -199,6 +200,11 @@ protected function getMessageData($name, $index = null)
     public function offsetExists($offset)
     {
         $response = $this->getResponseData();
+
+        if(isset($this->index)){
+            $response = $response['items'][$this->index];
+        }
+
         $request  = $this->getRequestData();
         $dirty    = $this->getRequestData(false);
         if(isset($response[$offset]) || isset($request[$offset]) || isset($dirty[$offset])){
@@ -216,6 +222,11 @@ public function offsetExists($offset)
     public function offsetGet($offset)
     {
         $response = $this->getResponseData();
+
+        if(isset($this->index)){
+            $response = $response['items'][$this->index];
+        }
+
         $request  = $this->getRequestData();
         $dirty    = $this->getRequestData(false);
 

src/Message/Query.php

@@ -0,0 +1,18 @@
+<?php
+namespace Nexmo\Message;
+
+class Query
+{
+    protected $params = [];
+
+    public function __construct(\DateTime $date, $to)
+    {
+        $this->params['date'] = $date->format('Y-m-d');
+        $this->params['to']   = $to;
+    }
+
+    public function getParams()
+    {
+        return $this->params;
+    }
+}