Return Sendgrid response (#17)

* return sendgrid response

* apply php-cs-fixer

* update readme

Author: aozisik

README.md

@@ -162,6 +162,21 @@ return (new SendGridMessage('Your SendGrid template ID'))
 
 For all the options, you can see Sendgrid's Mail class [here](https://github.com/sendgrid/sendgrid-php/blob/main/lib/mail/Mail.php).
 
+### Accessing SendGrid Response
+
+After the notification is sent, Laravel will emit `Illuminate\Notifications\Events\NotificationSent` event. You can listen to this event to get the SendGrid response object and/or message ID.
+
+```php
+use Illuminate\Notifications\Events\NotificationSent;
+
+Event::listen(NotificationSent::class, function (NotificationSent $event) {
+    /**
+     * @var \SendGrid\Response $response
+     */
+    $response = $event->response;
+});
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

src/SendGridChannel.php

@@ -60,5 +60,7 @@ public function send($notifiable, Notification $notification)
                 $response->body()
             );
         }
+
+        return $response;
     }
 }

tests/SendGridChannelTest.php

@@ -5,10 +5,12 @@
 use Mockery;
 use SendGrid;
 use SendGrid\Response;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Notifications\Notifiable;
 use Illuminate\Notifications\Notification;
 use NotificationChannels\SendGrid\SendGridChannel;
 use NotificationChannels\SendGrid\SendGridMessage;
+use Illuminate\Notifications\Events\NotificationSent;
 
 class SendGridChannelTest extends TestCase
 {
@@ -19,7 +21,14 @@ public function tearDown(): void
 
     public function testEmailIsSentViaSendGrid()
     {
+        Event::fake();
+
         $notification = new class extends Notification {
+            public function via()
+            {
+                return [SendGridChannel::class];
+            }
+
             public function toSendGrid($notifiable)
             {
                 return (new SendGridMessage('sendgrid-template-id'))
@@ -41,6 +50,8 @@ public function toSendGrid($notifiable)
             $sendgrid = Mockery::mock(new SendGrid('x'))
         );
 
+        $this->app->instance(SendGridChannel::class, $channel);
+
         $response = Mockery::mock(Response::class);
         $response->shouldReceive('statusCode')->andReturn(200);
 
@@ -60,6 +71,16 @@ public function toSendGrid($notifiable)
         // TODO: Verify that the Mail instance passed contains all the info from above
         $sendgrid->shouldReceive('send')->once()->andReturn($response);
 
-        $channel->send($notifiable, $notification);
+        $notifiable->notify($notification);
+
+        Event::assertDispatched(
+            NotificationSent::class,
+            fn ($event) => $event->channel === SendGridChannel::class
+        );
+
+        Event::assertDispatched(
+            NotificationSent::class,
+            fn ($event) => $event->response instanceof Response
+        );
     }
 }

tests/TestCase.php

@@ -2,6 +2,14 @@
 
 namespace NotificationChannels\SendGrid\Test;
 
+use NotificationChannels\SendGrid\SendGridServiceProvider;
+
 class TestCase extends \Orchestra\Testbench\TestCase
 {
+    protected function getPackageProviders($app)
+    {
+        return [
+            SendGridServiceProvider::class,
+        ];
+    }
 }