feat: add Vonage Messages API adapter

Author: bhardwajparth51

src/Utopia/Messaging/Adapter/SMS/VonageMessages.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Utopia\Messaging\Adapter\SMS;
+
+use Utopia\Messaging\Adapter\SMS as SMSAdapter;
+use Utopia\Messaging\Adapter\VonageMessagesBase;
+use Utopia\Messaging\Messages\SMS as SMSMessage;
+use Utopia\Messaging\Response;
+
+/**
+ * Vonage Messages API SMS Adapter.
+ *
+ * Uses the newer Vonage Messages API (V1) instead of the older SMS API.
+ * The Messages API is cheaper and supports multiple message types.
+ *
+ * Reference: https://developer.vonage.com/en/api/messages
+ */
+class VonageMessages extends SMSAdapter
+{
+    use VonageMessagesBase;
+
+    protected const NAME = 'Vonage Messages';
+
+    /**
+     * @param  string  $apiKey Vonage API Key
+     * @param  string  $apiSecret Vonage API Secret
+     */
+    public function __construct(
+        /** @phpstan-ignore property.onlyWritten */
+        private string $apiKey,
+        /** @phpstan-ignore property.onlyWritten */
+        private string $apiSecret,
+        private ?string $from = null
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return static::NAME;
+    }
+
+    public function getMaxMessagesPerRequest(): int
+    {
+        return 1;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function process(SMSMessage $message): array
+    {
+        $to = \ltrim($message->getTo()[0], '+');
+        $from = $this->from ?? $message->getFrom();
+
+        $response = new Response($this->getType());
+
+        $result = $this->request(
+            method: 'POST',
+            url: $this->getApiEndpoint(),
+            headers: $this->getRequestHeaders(),
+            body: [
+                'message_type' => 'text',
+                'to' => $to,
+                'from' => $from,
+                'text' => $message->getContent(),
+                'channel' => 'sms',
+            ],
+        );
+
+        if ($result['statusCode'] === 202) {
+            $response->setDeliveredTo(1);
+            $response->addResult($message->getTo()[0]);
+        } else {
+            $errorMessage = 'Unknown error';
+            if (isset($result['response']['detail'])) {
+                $errorMessage = $result['response']['detail'];
+            } elseif (isset($result['response']['title'])) {
+                $errorMessage = $result['response']['title'];
+            } elseif (!empty($result['error'])) {
+                $errorMessage = $result['error'];
+            }
+
+            $response->addResult($message->getTo()[0], $errorMessage);
+        }
+
+        return $response->toArray();
+    }
+}

src/Utopia/Messaging/Adapter/VonageMessagesBase.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Utopia\Messaging\Adapter;
+
+/**
+ * Trait for Vonage Messages API adapters.
+ *
+ * Provides common functionality for adapters using the Vonage Messages API (V1).
+ * This trait can be used by different message type adapters (SMS, Chat, etc.).
+ *
+ * Required properties (from extending class):
+ * - $apiKey: string
+ * - $apiSecret: string
+ *
+ * Reference: https://developer.vonage.com/en/api/messages
+ */
+trait VonageMessagesBase
+{
+    /**
+     * Get the API endpoint for the Vonage Messages API.
+     */
+    protected function getApiEndpoint(): string
+    {
+        return 'https://api.nexmo.com/v1/messages';
+    }
+
+    protected function getAuthorizationHeader(): string
+    {
+        return 'Basic ' . \base64_encode("{$this->apiKey}:{$this->apiSecret}");
+    }
+
+    /**
+     * Build the request headers for the Messages API.
+     *
+     * @return array<string>
+     */
+    protected function getRequestHeaders(): array
+    {
+        return [
+            "Authorization: {$this->getAuthorizationHeader()}",
+            'Content-Type: application/json',
+            'Accept: application/json',
+        ];
+    }
+}

tests/Messaging/Adapter/SMS/VonageMessagesTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Utopia\Tests\Adapter\SMS;
+
+use Utopia\Messaging\Adapter\SMS\VonageMessages;
+use Utopia\Messaging\Messages\SMS;
+use Utopia\Tests\Adapter\Base;
+
+class VonageMessagesTest extends Base
+{
+    /**
+     * @throws \Exception
+     */
+    public function testSendSMS(): void
+    {
+        $apiKey = \getenv('VONAGE_API_KEY');
+        $apiSecret = \getenv('VONAGE_API_SECRET');
+
+        if (!$apiKey || !$apiSecret) {
+            $this->markTestSkipped('Vonage Messages credentials are not available.');
+        }
+
+        $sender = new VonageMessages(
+            apiKey: $apiKey,
+            apiSecret: $apiSecret,
+            from: \getenv('VONAGE_FROM') ?: 'Vonage',
+        );
+
+        $message = new SMS(
+            to: [\getenv('VONAGE_TO')],
+            content: 'Test Content',
+            from: \getenv('VONAGE_FROM')
+        );
+
+        $response = $sender->send($message);
+
+        $this->assertResponse($response);
+    }
+}