Two events for success and failure

`SMSSentSuccessfullyEvent` and `SMSSendingFailedEvent`

Author: marventhieme

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to `CMSMS` will be documented in this file
 - Changed CM endpoint
 #### Added
 - Added config value for encoding detection type
+- Two events for success and failure: `SMSSentSuccessfullyEvent` and `SMSSendingFailedEvent`
 
 ## [3.3.0] - 2024-03-22
 #### Added

README.md

@@ -108,6 +108,11 @@ public function routeNotificationForCmsms()
 - `tariff()`: Accepts a integer value for your message tariff. The unit is eurocent. Requires the `originator` to be set to a specific value. Contact CM for this tariff value. CM also must enable this feature for your contract manually.
 - `multipart($minimum, $maximum)`: Accepts a 0 to 8 integer range which allows multipart messages. See the [documentation from CM](https://dashboard.onlinesmsgateway.com/docs#send-a-message-multipart) for more information.
 
+### Available events
+- `SMSSentSuccessfullyEvent`: This event will be fired after the message was sent. The event will contain the payload we have sent to CM.
+- `SMSSendingFailedEvent`: This event will be fired if the message was not sent. The event will contain the response body we received from CM.
+
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

src/CmsmsClient.php

@@ -5,8 +5,12 @@
 namespace NotificationChannels\Cmsms;
 
 use GuzzleHttp\Client as GuzzleClient;
+use GuzzleHttp\Exception\GuzzleException;
 use Illuminate\Support\Arr;
+use NotificationChannels\Cmsms\Events\SMSSendingFailedEvent;
+use NotificationChannels\Cmsms\Events\SMSSentSuccessfullyEvent;
 use NotificationChannels\Cmsms\Exceptions\CouldNotSendNotification;
+use NotificationChannels\Cmsms\Exceptions\InvalidMessage;
 
 class CmsmsClient
 {
@@ -18,14 +22,21 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @throws InvalidMessage
+     * @throws GuzzleException
+     * @throws CouldNotSendNotification
+     */
     public function send(CmsmsMessage $message, string $recipient): void
     {
         if (empty($message->getOriginator())) {
             $message->originator(config('services.cmsms.originator'));
         }
 
+        $payload = $this->buildMessageJson($message, $recipient);
+
         $response = $this->client->request('POST', static::GATEWAY_URL, [
-            'body' => $this->buildMessageJson($message, $recipient),
+            'body' => $payload,
             'headers' => [
                 'accept' => 'application/json',
                 'content-type' => 'application/json',
@@ -38,8 +49,11 @@ public function send(CmsmsMessage $message, string $recipient): void
         $body = $response->getBody()->getContents();
         $errorCode = Arr::get(json_decode($body, true), 'errorCode');
         if ($errorCode !== 0) {
+            SMSSendingFailedEvent::dispatch($body);
             throw CouldNotSendNotification::serviceRespondedWithAnError($body);
         }
+
+        SMSSentSuccessfullyEvent::dispatch($payload);
     }
 
     /**

src/Events/SMSSendingFailedEvent.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace NotificationChannels\Cmsms\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class SMSSendingFailedEvent
+{
+    use Dispatchable;
+
+    public function __construct(public string $response)
+    {
+    }
+}

src/Events/SMSSentSuccessfullyEvent.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace NotificationChannels\Cmsms\Events;
+
+use Illuminate\Foundation\Events\Dispatchable;
+
+class SMSSentSuccessfullyEvent
+{
+    use Dispatchable;
+
+    public function __construct(public string $payload)
+    {
+    }
+}

tests/CmsmsClientTest.php

@@ -4,9 +4,13 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Psr7\Response;
+use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Facades\Event;
 use Mockery;
 use NotificationChannels\Cmsms\CmsmsClient;
 use NotificationChannels\Cmsms\CmsmsMessage;
+use NotificationChannels\Cmsms\Events\SMSSendingFailedEvent;
+use NotificationChannels\Cmsms\Events\SMSSentSuccessfullyEvent;
 use NotificationChannels\Cmsms\Exceptions\CouldNotSendNotification;
 use Orchestra\Testbench\TestCase;
 
@@ -123,4 +127,38 @@ public function it_includes_reference_data()
         $this->assertTrue(isset($messageJsonObject->messages->msg[0]->reference));
         $this->assertEquals('ABC', $messageJsonObject->messages->msg[0]->reference);
     }
+
+    /** @test */
+    public function it_dispatches_a_success_event()
+    {
+        Event::fake();
+
+        $this->guzzle
+            ->shouldReceive('request')
+            ->once()
+            ->andReturn(new Response(200, [], '{"details": "Created 1 message(s)", "errorCode": 0}'));
+
+        $this->client->send($this->message, '00301234');
+
+        Event::assertDispatched(SMSSentSuccessfullyEvent::class);
+    }
+
+    /** @test */
+    public function it_dispatches_a_failure_event()
+    {
+        Event::fake();
+
+        $this->guzzle
+            ->shouldReceive('request')
+            ->once()
+            ->andReturn(new Response(200, [], '{"details": "Some error message", "errorCode": 1}'));
+
+        try {
+            $this->client->send($this->message, '00301234');
+        } catch (CouldNotSendNotification $e) {
+            // Do nothing, we know about the exception
+        }
+
+        Event::assertDispatched(SMSSendingFailedEvent::class);
+    }
 }