feat: inforu sms adapter

.env.dev

@@ -32,4 +32,6 @@ DISCORD_WEBHOOK_TOKEN=
 FAST2SMS_API_KEY=
 FAST2SMS_SENDER_ID=
 FAST2SMS_MESSAGE_ID=
-FAST2SMS_TO=
+FAST2SMS_TO=
+INFORU_API_TOKEN=
+INFORU_SENDER_ID=

.github/workflows/test.yml

@@ -49,6 +49,8 @@ jobs:
         FAST2SMS_SENDER_ID: ${{ secrets.FAST2SMS_SENDER_ID }}
         FAST2SMS_MESSAGE_ID: ${{ secrets.FAST2SMS_MESSAGE_ID }}
         FAST2SMS_TO: ${{ secrets.FAST2SMS_TO }}
+        INFORU_API_TOKEN: ${{ secrets.INFORU_API_TOKEN }}
+        INFORU_SENDER_ID: ${{ secrets.INFORU_SENDER_ID }}
       run: |
         docker compose up -d --build
         sleep 5

README.md

@@ -105,6 +105,7 @@ $messaging->send($message);
 - [x] [Sinch](https://www.sinch.com/)
 - [x] [Seven](https://www.seven.io/)
 - [ ] [SmsGlobal](https://www.smsglobal.com/)
+- [x] [Inforu](https://www.inforu.co.il/)
 
 ### Push
 - [x] [FCM](https://firebase.google.com/docs/cloud-messaging)

docker-compose.yml

@@ -42,6 +42,8 @@ services:
       - FAST2SMS_SENDER_ID
       - FAST2SMS_MESSAGE_ID
       - FAST2SMS_TO
+      - INFORU_API_TOKEN
+      - INFORU_SENDER_ID
 
   maildev:
     image: appwrite/mailcatcher:1.0.0

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

@@ -0,0 +1,83 @@
+<?php
+
+namespace Utopia\Messaging\Adapter\SMS;
+
+use Utopia\Messaging\Adapter\SMS as SMSAdapter;
+use Utopia\Messaging\Messages\SMS as SMSMessage;
+use Utopia\Messaging\Response;
+
+// Reference Material
+// https://apidoc.inforu.co.il/#d7b3f69d-7422-44b4-b7d1-0959f8a08881
+class Inforu extends SMSAdapter
+{
+    protected const NAME = 'Inforu';
+
+    /**
+     * @param string $apiToken Inforu API token
+     * @param string $senderId Sender ID
+     */
+    public function __construct(
+        private string $apiToken,
+        private string $senderId
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return static::NAME;
+    }
+
+    public function getMaxMessagesPerRequest(): int
+    {
+        return 100; // Setting a conservative limit, adjust if needed
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \Exception
+     */
+    protected function process(SMSMessage $message): array
+    {
+        $response = new Response($this->getType());
+
+        $recipients = array_map(
+            fn ($number) => ['Phone' => ltrim($number, '+')],
+            $message->getTo()
+        );
+
+        fwrite(STDOUT, json_encode($recipients, JSON_PRETTY_PRINT));
+
+        $result = $this->request(
+            method: 'POST',
+            url: 'https://capi.inforu.co.il/api/v2/SMS/SendSms',
+            headers: [
+                'Content-Type: application/json',
+                'Authorization: Basic ' . $this->apiToken,
+            ],
+            body: [
+                'Data' => [
+                    'Message' => $message->getContent(),
+                    'Recipients' => $recipients,
+                    'Settings' => [
+                        'Sender' => $this->senderId,
+                    ],
+                ],
+            ],
+        );
+
+        if ($result['statusCode'] === 200 && ($result['response']['StatusId'] ?? 0) === 1) {
+            $response->setDeliveredTo(count($message->getTo()));
+            foreach ($message->getTo() as $to) {
+                $response->addResult($to);
+            }
+        } else {
+            $errorMessage = $result['response']['StatusDescription'] ?? 'Unknown error';
+            foreach ($message->getTo() as $to) {
+                $response->addResult($to, $errorMessage);
+            }
+        }
+
+        return $response->toArray();
+    }
+}

tests/Messaging/Adapter/SMS/InforuTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Utopia\Tests\Adapter\SMS;
+
+use Utopia\Messaging\Adapter\SMS\Inforu;
+use Utopia\Messaging\Messages\SMS;
+use Utopia\Tests\Adapter\Base;
+
+class InforuTest extends Base
+{
+    /**
+     * @throws \Exception
+     */
+    public function testSendSMS(): void
+    {
+        $sender = new Inforu(
+            apiToken: \getenv('INFORU_API_TOKEN'),
+            senderId: \getenv('INFORU_SENDER_ID')
+        );
+
+        $message = new SMS(
+            to: ['0541234567'],
+            content: 'Test Content',
+        );
+
+        $response = $sender->send($message);
+
+        $this->assertResponse($response);
+    }
+}