feat: resend webhooks

config/filament-better-mails.php

@@ -4,6 +4,8 @@
 use Basement\BetterMails\Core\Models\BetterEmail;
 use Basement\BetterMails\Core\Models\BetterEmailAttachment;
 use Basement\BetterMails\Core\Models\BetterEmailEvent;
+use Basement\BetterMails\Resend\Email\Middleware\VerifyResendWebhookSignature;
+use Basement\BetterMails\Resend\ResendDriver;
 
 return [
     'mails' => [
@@ -26,7 +28,7 @@
         ],
 
         'headers' => [
-            'key' => 'X-Better-Mails-Event-Id'
+            'key' => 'X-Better-Mails-Event-ID'
         ],
 
         'logging' => [
@@ -36,5 +38,16 @@
                 'root' => 'mails/attachments',
             ],
         ]
+    ],
+    'webhooks' => [
+        'provider' => env('MAILS_WEBHOOK_PROVIDER', 'resend'),
+
+        'drivers' => [
+            'resend' => [
+                'middleware' => VerifyResendWebhookSignature::class,
+                'driver' => ResendDriver::class,
+                'key_secret' => env('MAILS_WEBHOOK_SECRET', ''),
+            ],
+        ]
     ]
 ];

database/factories/BetterMailEventFactory.php → database/factories/BetterEmailEventFactory.php

@@ -2,25 +2,28 @@
 
 namespace Basement\BetterMails\Database\Factories;
 
+use Basement\BetterMails\Core\Enums\MailEventTypeEnum;
+use Basement\BetterMails\Core\Models\BetterEmail;
 use Basement\BetterMails\Core\Models\BetterEmailEvent;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
-class BetterMailEventFactory extends Factory
+final class BetterEmailEventFactory extends Factory
 {
     protected $model = BetterEmailEvent::class;
 
     public function definition(): array
     {
         return [
-            'type' => 'delivered',
+            'mail_id' => BetterEmail::factory(),
+            'type' => MailEventTypeEnum::Sent,
             'payload' => [],
         ];
     }
 
-    public function bounce(): Factory
+    public function withEvent(MailEventTypeEnum $type): Factory
     {
         return $this->state(fn () => [
-            'type' => 'hard_bounced',
+            'type' => $type,
         ]);
     }
 }

database/factories/BetterMailFactory.php

@@ -55,4 +55,11 @@ public function hasBcc(): BetterMailFactory
             ],
         ]);
     }
+
+    public function withDriver(SupportedMailProvidersEnum $transport): static
+    {
+        return $this->state(fn () => [
+            'transport' => $transport,
+        ]);
+    }
 }

routes/filament-better-mails-route.php

@@ -0,0 +1,13 @@
+<?php
+
+use Basement\BetterMails\Core\Contracts\BetterMiddlewareContract;
+use Basement\BetterMails\Core\Enums\SupportedMailProvidersEnum;
+use Basement\BetterMails\Core\Http\Controllers\WebhookController;
+use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken;
+use Illuminate\Support\Facades\Route;
+
+Route::post('/webhook/{provider}', WebhookController::class)
+    ->whereIn('provider', SupportedMailProvidersEnum::cases())
+    ->middleware([BetterMiddlewareContract::class])
+    ->withoutMiddleware(VerifyCsrfToken::class)
+    ->name('filament-better-mails.webhook.store');

src/Core/AbstractMailDriver.php

@@ -4,4 +4,7 @@
 
 use Basement\BetterMails\Core\Contracts\BetterDriverContract;
 
-abstract class AbstractMailDriver implements BetterDriverContract {}
+abstract class AbstractMailDriver implements BetterDriverContract
+{
+    abstract public function handle(array $data): void;
+}

src/Core/Concerns/HasMail.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Basement\BetterMails\Core\Concerns;
+
+use Basement\BetterMails\Core\Models\BetterEmail;
+
+trait HasMail
+{
+    public function findMail(string $uuid): BetterEmail
+    {
+        return BetterEmail::query()->where('uuid', $uuid)->firstOrFail();
+    }
+}

src/Core/Contracts/BetterDTOContract.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts;
+
+interface BetterDTOContract
+{
+    public static function fromWebhook(array $dto): self;
+}

src/Core/Contracts/BetterDriverContract.php

@@ -2,4 +2,7 @@
 
 namespace Basement\BetterMails\Core\Contracts;
 
-interface BetterDriverContract {}
+interface BetterDriverContract
+{
+    public function handle(array $data): void;
+}

src/Core/Contracts/BetterMiddlewareContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts;
+
+interface BetterMiddlewareContract {}

src/Core/Contracts/External/ClickedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface ClickedEventContract {}

src/Core/Contracts/External/ComplainedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface ComplainedEventContract {}

src/Core/Contracts/External/DeliveredEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface DeliveredEventContract {}

src/Core/Contracts/External/FailedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface FailedEventContract {}

src/Core/Contracts/External/HardBouncedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface HardBouncedEventContract {}

src/Core/Contracts/External/OpenedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface OpenedEventContract {}

src/Core/Contracts/External/RecievedEventContract.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Basement\BetterMails\Core\Contracts\External;
+
+interface RecievedEventContract {}

src/Core/Events/TODO.md

@@ -2,15 +2,15 @@
 
 ## Delivery Events
 
-- [ ] Implement "delivered" event handling
+- [x] Implement "delivered" event handling
 - [ ] Implement "bounced" event handling
 - [ ] Implement "deferred" event handling
 - [ ] Implement "blocked" event handling
 
 ## Engagement Events
 
-- [ ] Implement "opened" event handling
-- [ ] Implement "clicked" event handling
+- [x] Implement "opened" event handling
+- [x] Implement "clicked" event handling
 - [ ] Implement "unsubscribed" event handling
 - [ ] Implement "complained" (spam report) event handling
 

src/Core/Http/Controllers/WebhookController.php

@@ -2,4 +2,13 @@
 
 namespace Basement\BetterMails\Core\Http\Controllers;
 
-class WebhookController {}
+use Basement\BetterMails\Core\Contracts\BetterDriverContract;
+use Illuminate\Http\Request;
+
+final class WebhookController
+{
+    public function __invoke(Request $request, BetterDriverContract $driver)
+    {
+        $driver->handle($request->all());
+    }
+}

src/Core/Listeners/External/ClickedMailListener.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Concerns\HasMail;
+use Basement\BetterMails\Core\Contracts\External\ClickedEventContract;
+
+final class ClickedMailListener
+{
+    use HasMail;
+
+    public function handle(ClickedEventContract $event): void
+    {
+        $mail = $this->findMail($event->dto->mailUuid);
+        $mail->clicked();
+    }
+}

src/Core/Listeners/External/ComplainedMailListener.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Concerns\HasMail;
+use Basement\BetterMails\Core\Contracts\External\ComplainedEventContract;
+
+final class ComplainedMailListener
+{
+    use HasMail;
+
+    public function handle(ComplainedEventContract $event): void
+    {
+        $mail = $this->findMail($event->dto->mailUuid);
+        $mail->complained();
+    }
+}

src/Core/Listeners/External/DeliveredMailListener.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Concerns\HasMail;
+use Basement\BetterMails\Core\Contracts\External\DeliveredEventContract;
+
+final class DeliveredMailListener
+{
+    use HasMail;
+
+    public function handle(DeliveredEventContract $event): void
+    {
+        $mail = $this->findMail($event->dto->mailUuid);
+        $mail->delivered();
+    }
+}

src/Core/Listeners/External/FailedMailListener.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Contracts\External\FailedEventContract;
+
+final class FailedMailListener
+{
+    public function handle(FailedEventContract $event): void {}
+}

src/Core/Listeners/External/HardBouncedMailListener.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Concerns\HasMail;
+use Basement\BetterMails\Core\Contracts\External\HardBouncedEventContract;
+
+final class HardBouncedMailListener
+{
+    use HasMail;
+
+    public function handle(HardBouncedEventContract $event): void
+    {
+        $mail = $this->findMail($event->dto->mailUuid);
+        $mail->hardBounced();
+    }
+}

src/Core/Listeners/External/OpenedMailListener.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Concerns\HasMail;
+use Basement\BetterMails\Core\Contracts\External\OpenedEventContract;
+
+final class OpenedMailListener
+{
+    use HasMail;
+
+    public function handle(OpenedEventContract $event): void
+    {
+        $mail = $this->findMail($event->dto->mailUuid);
+        $mail->opened();
+    }
+}

src/Core/Listeners/External/ReceivedMailListener.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Basement\BetterMails\Core\Listeners\External;
+
+use Basement\BetterMails\Core\Contracts\External\RecievedEventContract;
+
+final class ReceivedMailListener
+{
+    public function handle(RecievedEventContract $event): void {}
+}