Search SMS rejections capability. Returns list of matching messages

Implements #42

Author: mheap

src/Message/Client.php

@@ -213,6 +213,56 @@ public function search($idOrMessage)
         return $message;
     }
 
+    public function searchRejections(Query $query) {
+
+        $params = $query->getParams();
+        $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 array $message
      * @return Message

test/Message/ClientTest.php

@@ -8,10 +8,12 @@
 
 namespace NexmoTest\Message;
 
+use Nexmo\Client\Exception;
 use Nexmo\Message\Client;
 use Nexmo\Message\Message;
 use Nexmo\Message\Text;
 use NexmoTest\Psr7AssertionTrait;
+use NexmoTest\MessageAssertionTrait;
 use Prophecy\Argument;
 use Psr\Http\Message\RequestInterface;
 use Zend\Diactoros\Request;
@@ -20,6 +22,7 @@
 class ClientTest extends \PHPUnit_Framework_TestCase
 {
     use Psr7AssertionTrait;
+    use MessageAssertionTrait;
 
     protected $nexmoClient;
 
@@ -202,6 +205,53 @@ public function testRateLimitRetires()
         $this->assertEquals($success, $message->getResponse());
     }
 
+    /**
+     * @dataProvider searchRejectionsProvider
+     */
+    public function testCanSearchRejections($date, $to, $responseFile, $expectedResponse, $expectedHttpCode, $expectedException)
+    {
+        $query = new \Nexmo\Message\Query($date, $to);
+
+        $apiResponse = $this->getResponse($responseFile, $expectedHttpCode);
+
+        $this->nexmoClient->send(Argument::that(function (Request $request) use ($to, $date) {
+            $this->assertRequestQueryContains('to', $to, $request);
+            $this->assertRequestQueryContains('date', $date->format('Y-m-d'), $request);
+            return true;
+        }))->willReturn($apiResponse);
+
+
+        // If we're expecting this to throw an exception, listen for it in advance
+        if ($expectedException !== null) {
+                $this->expectException($expectedException);
+                $this->expectExceptionMessage($expectedResponse);
+        }
+
+        // Make the request and assert that our responses match
+        $rejectionsResponse = $this->messageClient->searchRejections($query);
+        $this->assertListOfMessagesEqual($expectedResponse, $rejectionsResponse);
+    }
+
+    public function searchRejectionsProvider()
+    {
+        $r = [];
+
+        $r['no rejections found'] = [new \DateTime(), '123456', 'search-rejections-empty', [], 200, null];
+
+        // Build up our expected message object
+        $message = new Message('0C0000005BA0B864');
+        $message->setResponse($this->getResponse('search-rejections'));
+        $message->setIndex(0);
+        $r['rejection found'] = [new \DateTime(), '123456', 'search-rejections', [$message], 200, null];
+
+        $r['error-code provided (validation)'] = [new \DateTime(), '123456', 'search-rejections-error-provided-validation', 'Validation error: You forgot to do something', 400, Exception\Request::class];
+        $r['error-code provided (server error)'] = [new \DateTime(), '123456', 'search-rejections-error-provided-server-error', 'Gremlins! There are gremlins in the system!', 500, Exception\Request::class];
+        $r['error-code not provided'] = [new \DateTime(), '123456', 'empty', 'error status from API', 500, Exception\Request::class];
+        $r['missing items key in response on 200'] = [new \DateTime(), '123456', 'empty', 'unexpected response from API', 200, Exception\Exception::class];
+
+        return $r;
+    }
+
     /**
      * 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/responses/search-rejections-empty.json

@@ -0,0 +1,4 @@
+{
+  "count": 0,
+  "items": []
+}

test/Message/responses/search-rejections-error-provided-server-error.json

@@ -0,0 +1,4 @@
+{
+  "error-code": 99,
+  "error-code-label": "Gremlins! There are gremlins in the system!"
+}

test/Message/responses/search-rejections-error-provided-validation.json

@@ -0,0 +1,4 @@
+{
+  "error-code": 42,
+  "error-code-label": "Validation error: You forgot to do something"
+}

test/Message/responses/search-rejections.json

@@ -0,0 +1 @@
+{"count":1,"items":[{"message-id":"0C0000005BA0B864","account-id":"7c9738e6","network":"US-PREMIUM","from":"12013800826","to":"14155550100","body":"A text message sent using the Nexmo SMS API","price":"0","date-received":"2017-09-04 15:08:44","status":"REJECTD","error-code":"1","error-code-label":"Unknown","type":"MT"}]}

test/MessageAssertionTrait.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * Nexmo Client Library for PHP
+ *
+ * @copyright Copyright (c) 2016 Nexmo, Inc. (http://nexmo.com)
+ * @license   https://github.com/Nexmo/nexmo-php/blob/master/LICENSE.txt MIT License
+ */
+
+namespace NexmoTest;
+
+use GuzzleHttp\Psr7\Request;
+use Nexmo\Message\Message;
+
+trait MessageAssertionTrait
+{
+    public static function assertListOfMessagesEqual(array $expected, array $actual)
+    {
+        $expectedCount = count($expected);
+        $actualCount = count($actual);
+
+        if ($expectedCount !== $actualCount) {
+            throw new \InvalidArgumentException('Expected count and actual count must match');
+        }
+
+        // If passed empty arrays, there are no messages to compare
+        if ($expectedCount === 0) {
+            return;
+        }
+
+        foreach ($expected as $k => $item) {
+            self::assertMessagesEqual($expected[$k], $actual[$k]);
+        }
+    }
+
+    public static function assertMessagesEqual(Message $expected, Message $actual)
+    {
+        self::assertEquals($expected->getResponseData(), $actual->getResponseData());
+    }
+}