Added Notification webhook to voice webhook factory

Author: dragonmantank

src/Voice/Webhook/Factory.php

@@ -33,6 +33,10 @@ public static function createFromArray(array $data)
             return new Error($data);
         }
 
+        if (array_key_exists('payload', $data)) {
+            return new Notification($data);
+        }
+
         throw new \InvalidArgumentException('Unable to detect incoming webhook type');
     }
 }

src/Voice/Webhook/Notification.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+
+namespace Nexmo\Voice\Webhook;
+
+class Notification
+{
+    /**
+     * @var array<string, mixed>
+     */
+    protected $payload;
+
+    /**
+     * @var string
+     */
+    protected $conversationUuid;
+    
+    /**
+     * @var \DateTimeImmutable
+     */
+    protected $timestamp;
+
+    public function __construct(array $data)
+    {
+        if (is_string($data['payload'])) {
+            $data['payload'] = json_decode($data['payload'], true);
+        }
+
+        $this->payload = $data['payload'];
+        $this->conversationUuid = $data['conversation_uuid'];
+        $this->timestamp = new \DateTimeImmutable($data['timestamp']);
+    }
+
+    public function getPayload() : array
+    {
+        return $this->payload;
+    }
+
+    public function getConversationUuid() : string
+    {
+        return $this->conversationUuid;
+    }
+
+    public function getTimestamp() : \DateTimeImmutable
+    {
+        return $this->timestamp;
+    }
+}

test/Voice/NCCO/Action/NotifyTest.php

@@ -46,7 +46,7 @@ public function testGeneratesCorrectNCCOArray()
 
         $this->assertSame('notify', $ncco['action']);
         $this->assertSame(['foo' => 'bar'], $ncco['payload']);
-        $this->assertSame('https://test.domain/events', $ncco['eventUrl']);
+        $this->assertSame(['https://test.domain/events'], $ncco['eventUrl']);
         $this->assertSame('POST', $ncco['eventMethod']);
     }
 
@@ -61,7 +61,7 @@ public function testJSONSerializesToCorrectStructure()
 
         $this->assertSame('notify', $ncco['action']);
         $this->assertSame(['foo' => 'bar'], $ncco['payload']);
-        $this->assertSame('https://test.domain/events', $ncco['eventUrl']);
+        $this->assertSame(['https://test.domain/events'], $ncco['eventUrl']);
         $this->assertSame('POST', $ncco['eventMethod']);
     }
 

test/Voice/Webhook/FactoryTest.php

@@ -12,6 +12,7 @@
 use Nexmo\Voice\Webhook\Factory;
 use Nexmo\Voice\Webhook\Transfer;
 use Zend\Diactoros\ServerRequest;
+use Nexmo\Voice\Webhook\Notification;
 use Zend\Diactoros\Request\Serializer;
 
 class FactoryTest extends TestCase
@@ -155,6 +156,34 @@ public function testCanGenerateAnErrorWebhook()
         $this->assertEquals(new \DateTimeImmutable($expected['timestamp']), $error->getTimestamp());
     }
 
+    public function testCanGenerateANotificationGetWebhook()
+    {
+        $request = $this->getRequest('event-get-notify');
+        $expected = $this->getRequest('event-get-notify')->getQueryParams();
+
+        /** @var Notification $notification */
+        $notification = Factory::createFromRequest($request);
+
+        $this->assertTrue($notification instanceof Notification);
+        $this->assertSame($expected['conversation_uuid'], $notification->getConversationUuid());
+        $this->assertSame(json_decode($expected['payload'], true), $notification->getPayload());
+        $this->assertEquals(new \DateTimeImmutable($expected['timestamp']), $notification->getTimestamp());
+    }
+
+    public function testCanGenerateANotificationPostWebhook()
+    {
+        $request = $this->getRequest('event-post-notify');
+        $expected = json_decode($this->getRequest('event-post-notify')->getBody()->getContents(), true);
+
+        /** @var Notification $notification */
+        $notification = Factory::createFromRequest($request);
+
+        $this->assertTrue($notification instanceof Notification);
+        $this->assertSame($expected['conversation_uuid'], $notification->getConversationUuid());
+        $this->assertSame($expected['payload'], $notification->getPayload());
+        $this->assertEquals(new \DateTimeImmutable($expected['timestamp']), $notification->getTimestamp());
+    }
+
     public function testThrowsExceptionOnUnknownWebhookData()
     {
         $this->expectException(\InvalidArgumentException::class);

test/Voice/requests/event-get-notify.txt

@@ -0,0 +1,5 @@
+GET /webhooks/notification?payload=%7B%22foo%22:%22bar%22%7D&conversation_uuid=CON-2541d01c-253e-48be-a8e0-da4bbe4c3722&timestamp=2020-07-29T17:33:00.043Z HTTP/1.1
+User-Agent: Apache-HttpAsyncClient/4.1 (Java/1.8.0_66)
+Host: demo.ngrok.io
+Cache-Control: max-age=0
+X-Forwarded-For: 169.63.86.173

test/Voice/requests/event-post-notify.txt

@@ -0,0 +1,9 @@
+POST /webhooks/notification HTTP/1.1
+Content-Type: application/json
+Content-Length: 127
+User-Agent: Apache-HttpAsyncClient/4.1 (Java/1.8.0_66)
+Host: demo.ngrok.io
+Cache-Control: max-age=259200
+X-Forwarded-For: 169.63.86.173
+
+{"payload":{"foo":"bar"},"conversation_uuid":"CON-2541d01c-253e-48be-a8e0-da4bbe4c3722","timestamp":"2020-07-29T17:32:26.628Z"}