Merge pull request #145 from rbibby/50-add-request-id-to-reply-objects

Reply Client updates

Author: bluemorbo

src/PSS/Entities/Reply.php

@@ -4,8 +4,16 @@
 
 class Reply
 {
+    /**
+     * @var int
+     */
     public $id;
 
+    /**
+     * @var int
+     */
+    public $requestId;
+
     /**
      * @var \UKFast\SDK\Pss\Entities\Author
      */

src/PSS/ReplyClient.php

@@ -41,6 +41,25 @@ public function getById($id)
         return $this->serializeReply($body->data);
     }
 
+    /**
+     * Gets a paginated response of all replies to a ticket
+     *
+     * @param int $requestId - ID of request replies belong to
+     * @param int $page
+     * @param int $perPage
+     * @param array $filters
+     * @return \UKFast\SDK\Page
+     */
+    public function getPageWithoutRequest($page = 1, $perPage = 15, $filters = [])
+    {
+        $page = $this->paginatedRequest("v1/replies", $page, $perPage, $filters);
+        $page->serializeWith(function ($item) {
+            return $this->serializeReply($item);
+        });
+
+        return $page;
+    }
+
     /**
      * @param int $requestId
      * @param \UKFast\SDK\PSS\Entities\Reply $reply
@@ -118,6 +137,7 @@ protected function serializeReply($item)
         $reply = new Entities\Reply;
 
         $reply->id = $item->id;
+        $reply->requestId = $item->request_id;
         $reply->author = new Entities\Author($item->author);
         $reply->description = $item->description;
         $reply->createdAt = DateTime::createFromFormat(DateTime::ISO8601, $item->created_at);

tests/PssClientTest.php

@@ -88,6 +88,7 @@ public function gets_replies()
             new Response(200, [], json_encode([
                 'data' => [[
                     'id' => 1,
+                    'request_id' => 123456,
                     'author' => [
                         'id' => 1,
                         'name' => 'Jonny Test',
@@ -125,6 +126,7 @@ public function gets_replies()
         $reply = $page->getItems()[0];
 
         $this->assertEquals(1, $reply->id);
+        $this->assertEquals(123456, $reply->requestId);
         $this->assertEquals(1, $reply->author->id);
         $this->assertEquals('Jonny Test', $reply->author->name);
         $this->assertFalse($reply->read);
@@ -142,6 +144,7 @@ public function gets_replies_with_attachments()
             new Response(200, [], json_encode([
                 'data' => [[
                     'id' => 1,
+                    'request_id' => 123456,
                     'author' => [
                         'id' => 1,
                         'name' => 'Jonny Test',
@@ -302,6 +305,7 @@ public function gets_one_reply()
             new Response(200, [], json_encode([
                 'data' => [
                     'id' => "C485939",
+                    'request_id' => 123456,
                     'author' => [
                         'id' => 10,
                         'name' => 'Test Man',
@@ -323,8 +327,80 @@ public function gets_one_reply()
 
         $this->assertTrue($reply instanceof \UKFast\SDK\PSS\Entities\Reply);
         $this->assertEquals('C485939', $reply->id);
+        $this->assertEquals(123456, $reply->requestId);
         $this->assertEquals('test', $reply->description);
         $this->assertInstanceOf(DateTime::class, $reply->createdAt);
         $this->assertTrue($reply->read);
     }
+
+    /**
+     * @test
+     */
+    public function gets_replies_without_request_id()
+    {
+        $mock = new MockHandler([
+            new Response(200, [], json_encode([
+                'data' => [
+                    [
+                        'id' => 1,
+                        'request_id' => 123456,
+                        'author' => [
+                            'id' => 1,
+                            'name' => 'Jonny Test',
+                            'type' => 'Client',
+                        ],
+                        'description' => 'Test',
+                        'created_at' => '2000-01-01T00:00:00+00',
+                        'attachments' => [],
+                        'read' => false,
+                    ],
+                    [
+                        'id' => 1,
+                        'request_id' => 654321,
+                        'author' => [
+                            'id' => 1,
+                            'name' => 'Jonny Test',
+                            'type' => 'Client',
+                        ],
+                        'description' => 'Test 2',
+                        'created_at' => '2000-01-01T00:00:00+00',
+                        'attachments' => [],
+                        'read' => false,
+                    ]
+                ],
+                'meta' => [
+                    'pagination' => [
+                        'total' => 2,
+                        'count' => 1,
+                        'per_page' => 2,
+                        'total_pages' => 1,
+                        'links' => [
+                            'next' => 'http://example.com/next',
+                            'previous' => 'http://example.com/previous',
+                            'first' => 'http://example.com/first',
+                            'last' => 'http://example.com/last',
+                        ]
+                    ]
+                ]
+            ])),
+        ]);
+        $handler = HandlerStack::create($mock);
+        $guzzle = new Client(['handler' => $handler]);
+
+        $client = new \UKFast\SDK\PSS\Client($guzzle);
+        $page = $client->replies()->getPageWithoutRequest();
+
+        $this->assertTrue($page instanceof \UKFast\SDK\Page);
+
+        $reply = $page->getItems()[0];
+
+        $this->assertEquals(1, $reply->id);
+        $this->assertEquals(123456, $reply->requestId);
+        $this->assertEquals(1, $reply->author->id);
+        $this->assertEquals('Jonny Test', $reply->author->name);
+        $this->assertFalse($reply->read);
+        $this->assertEquals('Test', $reply->description);
+        $this->assertInstanceOf(DateTime::class, $reply->createdAt);
+        $this->assertEquals('2000-01-01 00:00:00', $reply->createdAt->format('Y-m-d H:i:s'));
+    }
 }