Feat uniform response

.gitignore

@@ -2,7 +2,6 @@
 vendor
 Makefile
 .envrc
-.env
 *.p8
 
 ### Linux ###

README.md

@@ -95,7 +95,7 @@ $messaging->send($message);
 - [x] [Twilio](https://www.twilio.com/)
 - [x] [Twilio Notify](https://www.twilio.com/notify)
 - [x] [Telesign](https://www.telesign.com/)
-- [x] [TextMagic](https://www.textmagic.com/)
+- [x] [Textmagic](https://www.textmagic.com/)
 - [x] [Msg91](https://msg91.com/)
 - [x] [Vonage](https://www.vonage.com/)
 - [x] [Plivo](https://www.plivo.com/)

docs/sms-pricing.md

@@ -27,7 +27,7 @@ _In most providers when you're sending SMS to US numbers you must own a US phone
 | Clickatell | 0.0075     | 75 $  |
 | Twilio     | 0.0079     | 79 $  |
 | Sinch      | 0.0120     | 120 $ |
-| TextMagic  | 0.0400     | 400 $ |
+| Textmagic  | 0.0400     | 400 $ |
 | Telnyx     | 0.0440     | 440 $ |
 | Seven      | 0.0810     | 810 $ |
 
@@ -45,7 +45,7 @@ _In most providers when you're sending SMS to US numbers you must own a US phone
 | Seven      | 0.0810     | 810 $ |
 | Infobip    | n/a        |       |
 | Sinch      | n/a        |       |
-| TextMagic  | n/a        |       |
+| Textmagic  | n/a        |       |
 
 ## Israel
 
@@ -61,4 +61,4 @@ _In most providers when you're sending SMS to US numbers you must own a US phone
 | Twilio     | 0.112      | 1120 $   |
 | Clickatell | 0.13144    | 1314.4 $ |
 | Sinch      | n/a        |          |
-| TextMagic  | n/a        |          |
+| Textmagic  | n/a        |          |

src/Utopia/Messaging/Adapter.php

@@ -29,8 +29,6 @@ abstract public function getMaxMessagesPerRequest(): int;
      *
      * @param  Message  $message The message to send.
      * @return string The response body.
-     *
-     * @throws \Exception
      */
     public function send(Message $message): string
     {
@@ -54,16 +52,14 @@ public function send(Message $message): string
      * @param  string  $url The URL to send the request to.
      * @param  array<string>  $headers An array of headers to send with the request.
      * @param  string|null  $body The body of the request.
-     * @return string The response body.
-     *
-     * @throws \Exception If the request fails.
+     * @return array<string, mixed> The response body.
      */
     protected function request(
         string $method,
         string $url,
         array $headers = [],
         string $body = null,
-    ): string {
+    ): array {
         $ch = \curl_init();
 
         if (! \is_null($body)) {
@@ -79,15 +75,11 @@ protected function request(
 
         $response = \curl_exec($ch);
 
-        if (\curl_errno($ch)) {
-            throw new \Exception('Error: '.\curl_error($ch));
-        }
-        if (\curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
-            throw new \Exception($response);
-        }
-
         \curl_close($ch);
 
-        return $response;
+        return [
+            'response' => \json_decode($response, true),
+            'statusCode' => \curl_getinfo($ch, CURLINFO_HTTP_CODE),
+        ];
     }
 }

src/Utopia/Messaging/Adapter/Chat/Discord.php

@@ -4,6 +4,7 @@
 
 use Utopia\Messaging\Adapter;
 use Utopia\Messaging\Messages\Discord as DiscordMessage;
+use Utopia\Messaging\Response;
 
 class Discord extends Adapter
 {
@@ -37,9 +38,6 @@ public function getMaxMessagesPerRequest(): int
         return 1;
     }
 
-    /**
-     * @throws \Exception
-     */
     protected function process(DiscordMessage $message): string
     {
         $query = [];
@@ -59,7 +57,8 @@ protected function process(DiscordMessage $message): string
             $queryString .= $key.'='.$value;
         }
 
-        return $this->request(
+        $response = new Response($this->getType());
+        $result = $this->request(
             method: 'POST',
             url: "https://discord.com/api/webhooks/{$this->webhookId}/{$this->webhookToken}{$queryString}",
             headers: [
@@ -78,5 +77,18 @@ protected function process(DiscordMessage $message): string
                 'thread_name' => $message->getThreadName(),
             ]),
         );
+
+        $statusCode = $result['statusCode'];
+
+        if ($statusCode >= 200 && $statusCode < 300) {
+            $response->setDeliveredTo(1);
+            $response->addToDetails($message->getThreadId() ?? '');
+        } elseif ($statusCode >= 400 && $statusCode < 500) {
+            $response->addToDetails($message->getThreadId() ?? '', 'Bad Request.');
+        } else {
+            $response->addToDetails($message->getThreadId() ?? '', 'Unknown Error.');
+        }
+
+        return \json_encode($response->toArray());
     }
 }

src/Utopia/Messaging/Adapter/Email.php

@@ -3,7 +3,6 @@
 namespace Utopia\Messaging\Adapter;
 
 use Utopia\Messaging\Adapter;
-use Utopia\Messaging\Message;
 use Utopia\Messaging\Messages\Email as EmailMessage;
 
 abstract class Email extends Adapter

src/Utopia/Messaging/Adapter/Email/Mailgun.php

@@ -3,7 +3,8 @@
 namespace Utopia\Messaging\Adapter\Email;
 
 use Utopia\Messaging\Adapter\Email as EmailAdapter;
-use Utopia\Messaging\Messages\Email;
+use Utopia\Messaging\Messages\Email as EmailMessage;
+use Utopia\Messaging\Response;
 
 class Mailgun extends EmailAdapter
 {
@@ -36,17 +37,17 @@ public function getMaxMessagesPerRequest(): int
 
     /**
      * {@inheritdoc}
-     *
-     * @throws \Exception
      */
-    protected function process(Email $message): string
+    protected function process(EmailMessage $message): string
     {
         $usDomain = 'api.mailgun.net';
         $euDomain = 'api.eu.mailgun.net';
 
         $domain = $this->isEU ? $euDomain : $usDomain;
 
-        $response = $this->request(
+        $response = new Response($this->getType());
+
+        $result = $this->request(
             method: 'POST',
             url: "https://$domain/v3/{$this->domain}/messages",
             headers: [
@@ -61,6 +62,19 @@ protected function process(Email $message): string
             ]),
         );
 
-        return $response;
+        $statusCode = $result['statusCode'];
+
+        if ($statusCode >= 200 && $statusCode < 300) {
+            $response->setDeliveredTo(\count($message->getTo()));
+            foreach ($message->getTo() as $to) {
+                $response->addToDetails($to);
+            }
+        } elseif ($statusCode >= 400 && $statusCode < 500) {
+            foreach ($message->getTo() as $to) {
+                $response->addToDetails($to, $result['response']['message']);
+            }
+        }
+
+        return \json_encode($response->toArray());
     }
 }

src/Utopia/Messaging/Adapter/Email/Mock.php

@@ -2,10 +2,10 @@
 
 namespace Utopia\Messaging\Adapter\Email;
 
-use PHPMailer\PHPMailer\Exception;
 use PHPMailer\PHPMailer\PHPMailer;
 use Utopia\Messaging\Adapter\Email as EmailAdapter;
-use Utopia\Messaging\Messages\Email;
+use Utopia\Messaging\Messages\Email as EmailMessage;
+use Utopia\Messaging\Response;
 
 class Mock extends EmailAdapter
 {
@@ -22,12 +22,10 @@ public function getMaxMessagesPerRequest(): int
 
     /**
      * {@inheritdoc}
-     *
-     * @throws Exception
-     * @throws \Exception
      */
-    protected function process(Email $message): string
+    protected function process(EmailMessage $message): string
     {
+        $response = new Response($this->getType());
         $mail = new PHPMailer();
         $mail->isSMTP();
         $mail->XMailer = 'Utopia Mailer';
@@ -51,9 +49,14 @@ protected function process(Email $message): string
         }
 
         if (! $mail->send()) {
-            throw new \Exception($mail->ErrorInfo);
+            $response->addToDetails('', $mail->ErrorInfo);
+        } else {
+            $response->setDeliveredTo(\count($message->getTo()));
+            foreach ($message->getTo() as $to) {
+                $response->addToDetails($to);
+            }
         }
 
-        return \json_encode($message);
+        return \json_encode($response->toArray());
     }
 }

src/Utopia/Messaging/Adapter/Email/Sendgrid.php

@@ -3,7 +3,8 @@
 namespace Utopia\Messaging\Adapter\Email;
 
 use Utopia\Messaging\Adapter\Email as EmailAdapter;
-use Utopia\Messaging\Messages\Email;
+use Utopia\Messaging\Messages\Email as EmailMessage;
+use Utopia\Messaging\Response;
 
 class Sendgrid extends EmailAdapter
 {
@@ -33,13 +34,11 @@ public function getMaxMessagesPerRequest(): int
 
     /**
      * {@inheritdoc}
-     *
-     *
-     * @throws \Exception
      */
-    protected function process(Email $message): string
+    protected function process(EmailMessage $message): string
     {
-        return $this->request(
+        $response = new Response($this->getType());
+        $result = $this->request(
             method: 'POST',
             url: 'https://api.sendgrid.com/v3/mail/send',
             headers: [
@@ -67,5 +66,20 @@ protected function process(Email $message): string
                 ],
             ]),
         );
+
+        $statusCode = $result['statusCode'];
+
+        if ($statusCode === 202) {
+            $response->setDeliveredTo(\count($message->getTo()));
+            foreach ($message->getTo() as $recipient) {
+                $response->addToDetails($recipient);
+            }
+        } else {
+            foreach ($message->getTo() as $recipient) {
+                $response->addToDetails($recipient, $result['response']['errors'][0]['message']);
+            }
+        }
+
+        return \json_encode($response->toArray());
     }
 }

src/Utopia/Messaging/Adapter/Push.php

@@ -3,7 +3,6 @@
 namespace Utopia\Messaging\Adapter;
 
 use Utopia\Messaging\Adapter;
-use Utopia\Messaging\Message;
 use Utopia\Messaging\Messages\Push as PushMessage;
 
 abstract class Push extends Adapter