feat: added message failover (#540)

Author: manchuck

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 80
+indent_style = space
+indent_size = 4
+charset = utf-8

.phpactor.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "/phpactor.schema.json",
+    "language_server_phpstan.enabled": false,
+    "php_code_sniffer.enabled": false,
+    "prophecy.enabled": false
+}

composer.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://getcomposer.org/schema.json",
   "name": "vonage/client-core",
   "type": "library",
   "description": "PHP Client for using Vonage's API.",
@@ -9,6 +10,11 @@
       "name": "James Seconde",
       "email": "jim.seconde@vonage.com",
       "role": "PHP Developer Advocate"
+    },
+    {
+      "name": "Chuck \"MANCHUCK\" Reeves",
+      "homepage": "https://github.com/manchuck",
+      "role": "Sr Developer Advocate"
     }
   ],
   "require": {
@@ -22,7 +28,7 @@
     "psr/log": "^1.1|^2.0|^3.0",
     "vonage/jwt": "^0.5.0"
   },
-  "require-dev": {  
+  "require-dev": {
     "guzzlehttp/guzzle": ">=6",
     "helmich/phpunit-json-assert": "^3.3",
     "php-http/mock-client": "^1.4",

src/Messages/Channel/BaseMessage.php

@@ -11,6 +11,7 @@ abstract class BaseMessage implements Message
     protected ?string $clientRef = null;
     protected ?string $webhookUrl = null;
     protected ?string $webhookVersion = null;
+    protected ?array $failover = null;
 
     protected array $permittedVersions = [
         'v0.1',
@@ -91,6 +92,17 @@ public function getWebhookVersion(): ?string
         return $this->webhookVersion;
     }
 
+    public function addFailover(Message $message): void
+    {
+        if (!isset($this->failover)) {
+            $this->failover = [];
+        }
+        array_push(
+            $this->failover,
+            $message
+        );
+    }
+
     public function getBaseMessageUniversalOutputArray(): array
     {
         $returnArray = [
@@ -112,6 +124,11 @@ public function getBaseMessageUniversalOutputArray(): array
             $returnArray['webhook_version'] = $this->getWebhookVersion();
         }
 
+        if (isset($this->failover)) {
+            $callback = fn(Message $message): array => $message->toArray();
+            $returnArray['failover'] = array_map($callback, $this->failover);
+        }
+
         return $returnArray;
     }
 }

src/Messages/Channel/Message.php

@@ -20,6 +20,8 @@ public function setWebhookUrl(string $url): void;
     public function getWebhookVersion(): ?string;
     public function setWebhookVersion(string $version): void;
     public function validatesE164(): bool;
+    public function addFailover(Message $message): void;
+  
 
     /**
      * All message types have shared outputs required by the endpoint.

test/Messages/ClientTest.php

@@ -166,6 +166,38 @@ public function testCanSendSMSWithOptionalFields(): void
         $this->assertArrayHasKey('message_uuid', $result);
     }
 
+    public function testCanSendSMSWtihFailover(): void
+    {
+        $payload = [
+            'to' => '447700900000',
+            'from' => '16105551212',
+            'text' => 'Reticulating Splines',
+            'message_type' => 'text',
+            'channel' => 'sms',
+            'failover' => [
+                [
+                    'message_type' => 'text',
+                    'to' => '447700900000',
+                    'from' => '16105551212',
+                    'channel' => 'sms',
+                    'text' => 'Reticulating Splines',
+                ]
+            ]
+        ];
+
+        $message = new SMSText($payload['to'], $payload['from'], $payload['text']);
+        $failMessage = new SMSText($payload['to'], $payload['from'], $payload['text']);
+        $message->addFailover($failMessage);
+
+        $this->vonageClient->send(Argument::that(function (Request $request) use ($payload) {
+            $this->assertRequestJsonBodyContains('failover', $payload['failover'], $request);
+            return true;
+        }))->willReturn($this->getResponse('sms-success', 202));
+        $result = $this->messageClient->send($message);
+        $this->assertIsArray($result);
+        $this->assertArrayHasKey('message_uuid', $result);
+    }
+
     public function testCanSendMMSImage(): void
     {
         $imageUrl = 'https://picsum.photos/200/300';