Refactor

Author: pascalbaljet

README.md

@@ -61,7 +61,7 @@ Add the directive somewhere after initializing/configuring GA. The POST request
 
 If you don't use Axios, you have to implement this call by yourself.
 
-## Broadcast Events to Google Analytics
+## Broadcast events to Google Analytics
 
 Add the `ShouldBroadcastToAnalytics` interface to your event and you're ready! You don't have to manually bind any listeners.
 
@@ -73,7 +73,7 @@ namespace App\Events;
 use App\Order;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
+use ProtoneMedia\AnalyticsEventTracking\ShouldBroadcastToAnalytics;
 
 class OrderWasPaid implements ShouldBroadcastToAnalytics
 {
@@ -88,6 +88,36 @@ class OrderWasPaid implements ShouldBroadcastToAnalytics
 }
 ```
 
+## Handle framework and 3rd-party events
+
+If you want to handle events where you can't add the `ShouldBroadcastToAnalytics` interface, you can manually register them in your `EventServiceProvider` using the `DispatchAnalyticsJob` listener.
+
+```php
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Auth\Events\Registered;
+use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+use ProtoneMedia\AnalyticsEventTracking\Listeners\DispatchAnalyticsJob;
+
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+        Registered::class => [
+            SendEmailVerificationNotification::class,
+            DispatchAnalyticsJob::class,
+        ],
+    ];
+}
+```
+
 ## Customize the broadcast
 
 There are two additional methods that lets you customize the call to Google Analytics.
@@ -105,7 +135,7 @@ use App\Order;
 use TheIconic\Tracking\GoogleAnalytics\Analytics;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
+use ProtoneMedia\AnalyticsEventTracking\ShouldBroadcastToAnalytics;
 
 class OrderWasPaid implements ShouldBroadcastToAnalytics
 {

src/Analytics/BroadcastEvent.php

@@ -2,7 +2,7 @@
 
 namespace ProtoneMedia\AnalyticsEventTracking\Analytics;
 
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
+use ProtoneMedia\AnalyticsEventTracking\ShouldBroadcastToAnalytics;
 use TheIconic\Tracking\GoogleAnalytics\Analytics;
 
 class BroadcastEvent implements EventBroadcaster

src/Analytics/EventBroadcaster.php

@@ -2,11 +2,9 @@
 
 namespace ProtoneMedia\AnalyticsEventTracking\Analytics;
 
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
-
 interface EventBroadcaster
 {
-    public function handle(ShouldBroadcastToAnalytics $event);
+    public function handle($event);
 
     public function withAnalytics(callable $callback): self;
 }

src/Events/ShouldBroadcastToAnalytics.php

@@ -8,20 +8,21 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use ProtoneMedia\AnalyticsEventTracking\Analytics\EventBroadcaster;
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
 use TheIconic\Tracking\GoogleAnalytics\Analytics;
 
 class SendEventToAnalytics implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    public ShouldBroadcastToAnalytics $event;
+    public $event;
     public ?string $clientId;
+    public ?string $userId;
 
-    public function __construct(ShouldBroadcastToAnalytics $event, string $clientId = null)
+    public function __construct($event, string $clientId = null, string $userId = null)
     {
         $this->event    = $event;
         $this->clientId = $clientId;
+        $this->userId   = $userId;
     }
 
     public function handle(EventBroadcaster $broadcaster)
@@ -30,6 +31,10 @@ public function handle(EventBroadcaster $broadcaster)
             $broadcaster->withAnalytics(fn (Analytics $analytics) => $analytics->setClientId($this->clientId));
         }
 
+        if ($this->userId) {
+            $broadcaster->withAnalytics(fn (Analytics $analytics) => $analytics->setUserId($this->userId));
+        }
+
         $broadcaster->handle($this->event);
     }
 }

src/Jobs/SendEventToAnalytics.php

@@ -3,7 +3,6 @@
 namespace ProtoneMedia\AnalyticsEventTracking\Listeners;
 
 use Illuminate\Queue\InteractsWithQueue;
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
 use ProtoneMedia\AnalyticsEventTracking\Http\ClientIdRepostory;
 use ProtoneMedia\AnalyticsEventTracking\Jobs\SendEventToAnalytics;
 
@@ -21,7 +20,7 @@ public function __construct(ClientIdRepostory $clientIdRepository)
     /**
      * Gets the Client ID from the repository and dispatched the event
      */
-    public function handle(ShouldBroadcastToAnalytics $event): void
+    public function handle($event): void
     {
         $job = new SendEventToAnalytics($event, $this->clientIdRepository->get());
 

src/Listeners/DispatchAnalyticsJob.php

@@ -9,7 +9,6 @@
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 use ProtoneMedia\AnalyticsEventTracking\Analytics\BroadcastEvent;
 use ProtoneMedia\AnalyticsEventTracking\Analytics\EventBroadcaster;
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
 use ProtoneMedia\AnalyticsEventTracking\Http\ClientIdRepostory;
 use ProtoneMedia\AnalyticsEventTracking\Http\ClientIdSession;
 use ProtoneMedia\AnalyticsEventTracking\Http\StoreClientIdInSession;

src/ServiceProvider.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace ProtoneMedia\AnalyticsEventTracking;
+
+interface ShouldBroadcastToAnalytics
+{
+}

src/ShouldBroadcastToAnalytics.php

@@ -2,7 +2,7 @@
 
 namespace ProtoneMedia\AnalyticsEventTracking\Tests\Fakes;
 
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
+use ProtoneMedia\AnalyticsEventTracking\ShouldBroadcastToAnalytics;
 use TheIconic\Tracking\GoogleAnalytics\Analytics;
 
 class BroadcastAs implements ShouldBroadcastToAnalytics

tests/Fakes/BroadcastAs.php

@@ -2,7 +2,7 @@
 
 namespace ProtoneMedia\AnalyticsEventTracking\Tests\Fakes;
 
-use ProtoneMedia\AnalyticsEventTracking\Events\ShouldBroadcastToAnalytics;
+use ProtoneMedia\AnalyticsEventTracking\ShouldBroadcastToAnalytics;
 
 class BroadcastMe implements ShouldBroadcastToAnalytics
 {