Added the ability to queue the notification.

Author: andreshg112

README.md

@@ -13,18 +13,23 @@ This package allows you to send notifications with audit data instead of saving
 
 If you have some microservices and want to have centralized auditing, this could be helpful.
 
+## Requirements
+
+-   PHP >= 7.1
+-   Laravel >= 5.2 && < 5.8
+
 ## Installation
 
 ### Step 1
 
+> This package depends on [owen-it/laravel-auditing:^8.0](https://github.com/owen-it/laravel-auditing) and [lab123it/aws-sns:dev-master](https://github.com/lab123it/aws-sns), so you have to install and configure them first in order to make this work.
+
 You can install the package via composer:
 
 ```bash
 composer require andreshg112/laravel-auditing-notifications
 ```
 
-> This package depends on [owen-it/laravel-auditing:^8.0](https://github.com/owen-it/laravel-auditing) and [lab123it/aws-sns:dev-master](https://github.com/lab123it/aws-sns), so you have to install and configure them first in order to make this work.
-
 ### Step 2
 
 Change the audit default driver:
@@ -61,6 +66,10 @@ return [
         // Required if you're going to use different notifications channels for sending audit data.
         'notifications' => [
             Andreshg112\LaravelAuditingNotifications\AuditSns::class,
+
+            // Or this if you want to queue the delivery of the message.
+            // https://laravel.com/docs/5.2/queues
+            // Andreshg112\LaravelAuditingNotifications\AuditSnsQueue::class,
         ],
 
         // Required if you're going to use the default Andreshg112\LaravelAuditingNotifications\AuditSns Notification.

src/AuditSns.php

@@ -2,7 +2,6 @@
 
 namespace Andreshg112\LaravelAuditingNotifications;
 
-use Illuminate\Bus\Queueable;
 use Illuminate\Support\Facades\Config;
 use Lab123\AwsSns\Messages\AwsSnsMessage;
 use Illuminate\Notifications\Notification;
@@ -11,8 +10,6 @@
 
 class AuditSns extends Notification
 {
-    use Queueable;
-
     /** @var array $auditData */
     protected $auditData = null;
 
@@ -38,7 +35,7 @@ public function via($notifiable)
     }
 
     /**
-     * Get the mail representation of the notification.
+     * Get the SNS representation of the notification.
      *
      * @param  \OwenIt\Auditing\Contracts\Auditable  $notifiable
      * @return \Lab123\AwsSns\Messages\AwsSnsMessage

src/AuditSnsQueue.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Andreshg112\LaravelAuditingNotifications;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+/**
+ * Use this notification if you want to queue the delivery of the SNS message.
+ */
+class AuditSnsQueue extends AuditSns implements ShouldQueue
+{
+    use Queueable;
+}

tests/AuditSnsQueueTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Andreshg112\LaravelAuditingNotifications\Tests;
+
+use Orchestra\Testbench\TestCase;
+use Illuminate\Support\Facades\Notification;
+use Andreshg112\LaravelAuditingNotifications\AuditSnsQueue;
+
+class AuditSnsQueueTest extends TestCase
+{
+    /** @test */
+    public function it_sends_the_notification()
+    {
+        Notification::fake();
+
+        $model = new AuditableModel;
+
+        $model->setAuditEvent('created');
+
+        $model->notify(new AuditSnsQueue($model->toAudit()));
+
+        Notification::assertSentTo($model, AuditSnsQueue::class);
+    }
+}

tests/AuditSnsTest.php

@@ -12,7 +12,14 @@ class AuditSnsTest extends TestCase
     /** @test */
     public function it_returns_a_sns_message()
     {
-        $this->mockConfig();
+        /**
+         * You should not mock the Request facade. Instead, pass the input you desire into the HTTP
+         * helper methods such as get and post when running your test. Likewise, instead of mocking
+         * the Config facade, call the Config::set method in your tests.
+         *
+         * https://laravel.com/docs/5.6/mocking#mocking-facades
+         */
+        Config::set('audit.notification-driver.sns.topic_arn', 'topic:arn');
 
         $model = new AuditableModel;
 
@@ -24,38 +31,4 @@ public function it_returns_a_sns_message()
 
         $this->assertInstanceOf(AwsSnsMessage::class, $snsMessage);
     }
-
-    public function mockConfig()
-    {
-        $events = ['created', 'updated', 'deleted', 'restored'];
-
-        Config::shouldReceive('get')
-            ->with('audit.events', $events)
-            ->andReturn($events);
-
-        Config::shouldReceive('get')
-            ->with('audit.notification-driver.sns.topic_arn')
-            ->once()
-            ->andReturn('topic:arn');
-
-        Config::shouldReceive('get')
-            ->with('audit.console', false)
-            ->once()
-            ->andReturn(false);
-
-        Config::shouldReceive('get')
-            ->with('audit.strict', false)
-            ->once()
-            ->andReturn(false);
-
-        Config::shouldReceive('get')
-            ->with('audit.timestamps', false)
-            ->once()
-            ->andReturn(false);
-
-        Config::shouldReceive('get')
-            ->with('audit.user.morph_prefix', 'user')
-            ->once()
-            ->andReturn('user');
-    }
 }