Docs + custom queue support

Author: pascalbaljet

README.md

@@ -28,15 +28,15 @@ Publish the config and view files:
 php artisan vendor:publish --provider="ProtoneMedia\AnalyticsEventTracking\ServiceProvider"
 ```
 
-Set your [Google Analytics tracking ID](https://support.google.com/analytics/answer/1008080) in your `.env` file or in the `config/analytics-event-tracking.php` file.
+Set your [Google Analytics Tracking ID](https://support.google.com/analytics/answer/1008080) in the `.env` file or in the `config/analytics-event-tracking.php` file.
 
 ```bash
 GOOGLE_ANALYTICS_TRACKING_ID=UA-01234567-89
 ```
 
 ## Broadcast Events to Google Analytics
 
-Just add the `ShouldBroadcastToAnalytics` interface to your event and you're ready!
+Add the `ShouldBroadcastToAnalytics` interface to your event and you're ready! You don't have to manually bind any listeners.
 
 ``` php
 <?php
@@ -93,7 +93,7 @@ class OrderWasPaid implements ShouldBroadcastToAnalytics
 
     public function withAnalytics(Analytics $analytics)
     {
-        $analytics->setEventValue(100);
+        $analytics->setEventValue($this->order->sum_in_cents * 100);
     }
 
     public function broadcastAnalyticsActionAs(Analytics $analytics)

config/config.php

@@ -1,16 +1,40 @@
 <?php
 
 return [
+    /**
+     * Your Google Analytics Tracking ID.
+     * https://support.google.com/analytics/answer/1008080
+     */
     'tracking_id' => env('GOOGLE_ANALYTICS_TRACKING_ID'),
 
-    'client_id_session_key' => 'analytics-event-tracker-client-id',
-
-    // set to null to disable
-    'http_uri' => 'gaid',
-
+    /**
+     * Use SSL to make calls to Google Analytics.
+     */
     'use_ssl' => true,
 
+    /**
+     * Anonymize IP when making calls to Google Analytics.
+     */
     'anonymize_ip' => true,
 
+    /**
+     * Send the ID of the authenticated user to Google Analytics.
+     */
     'send_user_id' => true,
+
+    /*
+     * This queue will be used to perform the API calls to Google Analytics.
+     * Leave empty to use the default queue.
+     */
+    'queue_name' => '',
+
+    /**
+     * The session key to store the Client ID.
+     */
+    'client_id_session_key' => 'analytics-event-tracker-client-id',
+
+    /**
+     * HTTP URI to store the Client ID.
+     */
+    'http_uri' => '/gaid',
 ];

src/Listeners/DispatchAnalyticsJob.php

@@ -23,6 +23,12 @@ public function __construct(ClientIdRepostory $clientIdRepository)
      */
     public function handle(ShouldBroadcastToAnalytics $event): void
     {
-        SendEventToAnalytics::dispatch($event, $this->clientIdRepository->get());
+        $job = new SendEventToAnalytics($event, $this->clientIdRepository->get());
+
+        if ($queueName = config('analytics-event-tracking.queue_name')) {
+            $job->onQueue($queueName);
+        }
+
+        dispatch($job);
     }
 }

tests/EventListenerTest.php

@@ -19,4 +19,18 @@ public function it_listen_for_events_that_should_be_broadcasted_to_analytics()
 
         Bus::assertDispatchedTimes(SendEventToAnalytics::class, 1);
     }
+
+    /** @test */
+    public function it_can_dispatch_jobs_on_a_dedicated_queue()
+    {
+        Bus::fake();
+
+        config(['analytics-event-tracking.queue_name' => 'http']);
+
+        event(new BroadcastMe);
+
+        Bus::assertDispatched(SendEventToAnalytics::class, function ($job) {
+            return $job->queue === 'http';
+        });
+    }
 }