Merge pull request #4 from nextapps-be/feature/add_custom_notification_class

Feature/add custom notification class

Author: yinx

README.md

@@ -60,6 +60,11 @@ You sometimes may want to exclude one or more characters from the selected or de
 ### Expire hours
 The amount of hours it takes for a verification code to expire. You're free to increase this in the config.
 
+### Custom Notification
+If you want to use a custom notification to send the verification code, you can create your own notification class which should extend the `VerificationCodeCreatedInterface`. Make sure you don't forget to pass the verification code to the mail.
+
+Lastly set the config value `notification` to the full path of your newly created notification.
+
 ### Queue
 In specific cases you may want to put the  verification code notifications on a queue. This can be done by defining the queue in the config (e.g. `queue => 'notifications'`).
 

config/verification-code.php

@@ -48,6 +48,21 @@
     */
     'expire_hours' => 1,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Custom notification
+    |--------------------------------------------------------------------------
+    |
+    | This class contains the notification sent to users upon creation
+    | of the verification code.
+    |
+    | It should implement the following interfaces:
+    | - Illuminate\Contracts\Queue\ShouldQueue
+    | - NextApps\VerificationCode\Notifications\VerificationCodeCreatedInterface
+    |
+    */
+    'notification' => \NextApps\VerificationCode\Notifications\VerificationCodeCreated::class,
+
     /*
     |--------------------------------------------------------------------------
     | Queue

src/Exceptions/InvalidClassException.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace NextApps\VerificationCode\Exceptions;
+
+use Exception;
+
+class InvalidClassException extends Exception
+{
+    public static function handle(): self
+    {
+        return new static('The notification should extend the VerificationCodeCreatedInterface.');
+    }
+}

src/Notifications/VerificationCodeCreated.php

@@ -7,7 +7,7 @@
 use Illuminate\Notifications\Messages\MailMessage;
 use Illuminate\Notifications\Notification;
 
-class VerificationCodeCreated extends Notification implements ShouldQueue
+class VerificationCodeCreated extends Notification implements ShouldQueue, VerificationCodeCreatedInterface
 {
     use Queueable;
 

src/Notifications/VerificationCodeCreatedInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace NextApps\VerificationCode\Notifications;
+
+interface VerificationCodeCreatedInterface
+{
+    /**
+     * Create a new message instance.
+     *
+     * @param string $code
+     */
+    public function __construct(string $code);
+}

src/VerificationCodeManager.php

@@ -4,35 +4,43 @@
 
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Facades\Notification;
+use NextApps\VerificationCode\Exceptions\InvalidClassException;
 use NextApps\VerificationCode\Models\VerificationCode;
 use NextApps\VerificationCode\Notifications\VerificationCodeCreated;
+use NextApps\VerificationCode\Notifications\VerificationCodeCreatedInterface;
 
 class VerificationCodeManager
 {
     /**
      * Create and send a verification code via mail.
      *
      * @param string $verifiable
+     * @param string $channel
      *
      * @return void
      */
-    public function send($verifiable)
+    public function send($verifiable, $channel = 'mail')
     {
         $testVerifiables = config('verification-code.test_verifiables', []);
+        $notificationClass = config('verification-code.notification', VerificationCodeCreated::class);
+        $queue = config('verification-code.queue', null);
+
+        if (! is_subclass_of($notificationClass, VerificationCodeCreatedInterface::class)) {
+            throw InvalidClassException::handle();
+        }
 
         if (in_array($verifiable, $testVerifiables)) {
             return;
         }
 
         $code = VerificationCode::createFor($verifiable);
 
-        if (config('verification-code.queue') !== null) {
-            Notification::route('mail', $verifiable)
-                ->notify((new VerificationCodeCreated($code))
-                ->onQueue(config('verification-code.queue')));
+        if ($queue !== null) {
+            Notification::route($channel, $verifiable)
+                ->notify((new $notificationClass($code))->onQueue($queue));
         } else {
-            Notification::route('mail', $verifiable)
-                ->notifyNow((new VerificationCodeCreated($code)));
+            Notification::route($channel, $verifiable)
+                ->notifyNow(new $notificationClass($code));
         }
     }
 

tests/VerificationCodeTest.php

@@ -5,8 +5,10 @@
 use Illuminate\Notifications\AnonymousNotifiable;
 use Illuminate\Support\Facades\Notification;
 use Illuminate\Support\Str;
+use NextApps\VerificationCode\Exceptions\InvalidClassException;
 use NextApps\VerificationCode\Models\VerificationCode;
 use NextApps\VerificationCode\Notifications\VerificationCodeCreated;
+use NextApps\VerificationCode\Notifications\WrongNotification;
 use NextApps\VerificationCode\VerificationCode as VerificationCodeFacade;
 
 class VerificationCodeTest extends TestCase
@@ -173,4 +175,33 @@ public function it_returns_false_if_test_verifiable_with_empty_test_code()
 
         $this->assertFalse(VerificationCodeFacade::verify('', $verifiable));
     }
+
+    /** @test */
+    public function it_works_if_notification_config_value_is_empty()
+    {
+        $email = $this->faker->safeEmail;
+
+        VerificationCodeFacade::send($email);
+
+        $this->assertNotNull(VerificationCode::where('verifiable', $email)->first());
+
+        Notification::assertSentTo(
+            new AnonymousNotifiable,
+            VerificationCodeCreated::class,
+            function ($notification, $channels, $notifiable) use ($email) {
+                return $notifiable->routes['mail'] === $email;
+            });
+    }
+
+    /** @test */
+    public function it_throws_an_error_if_notification_does_not_extend_the_verification_notification_class()
+    {
+        $this->expectException(InvalidClassException::class);
+        $this->expectExceptionMessage('The notification should extend the VerificationCodeCreatedInterface.');
+        $email = $this->faker->safeEmail;
+
+        config()->set('verification-code.notification', WrongNotification::class);
+
+        VerificationCodeFacade::send($email);
+    }
 }

tests/stubs/WrongNotification.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace NextApps\VerificationCode\Notifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Notification;
+
+class WrongNotification extends Notification implements ShouldQueue
+{
+    use Queueable;
+}