Added functionality to manipulate tracking data.

Author: mikebronner

CHANGELOG.md

@@ -9,6 +9,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 (This is already detected in subscription update.)
 - Filter any incoming web-hook events that are in test mode.
 
+## [0.9.1] - 2019-10-18
+### Added
+- functionality to inject custom data points into track events.
+
+### Fixed
+- Laravel 6.x compatibility.
+
+## [0.9.0] - 2019-08-28
+### Added
+- Laravel 6.0 compatibility.
+
 ## [0.8.1] - 2019-07-28
 ### Fixed
 - tracking of user information.

README.md

@@ -66,6 +66,8 @@ MIXPANEL_TOKEN=xxxxxxxxxxxxxxxxxxxxxx
  connections timeout.
 - `services.mixpanel.timeout`: (default: 2) set the number of seconds after which event tracking
  times out.
+- `services.mixpanel.data_callback_class`: (default: null) manipulate the data
+  being passed back to mixpanel for the track events.
 
 ## Upgrade Notes
 ### Version 0.7.0 for Laravel 5.5
@@ -232,6 +234,36 @@ the first name. Otherwise it will look for `first_name` and `last_name` fields i
     Session:
       - Status: Logged Out
   ```
+### Tracking Data Manipulation
+If you need to make changes or additions to the data being tracked, create a
+  class that implements `\GeneaLabs\LaravelMixpanel\Interfaces\DataCallback`:
+
+```php
+<?php
+
+namespace App;
+
+use GeneaLabs\LaravelMixpanel\Interfaces\DataCallback;
+
+class MixpanelUserData implements DataCallback
+{
+    public function process(array $data = []) : array
+    {
+        $data["test"] = "value";
+
+        return $data;
+    }
+}
+```
+
+Then register this class in your `services` configuration:
+
+```php
+    'mixpanel' => [
+      // ...
+        "data_callback_class" => \App\MixpanelUserData::class,
+    ]
+```
 
 ### Stripe Integration
 Many L5 sites are running Cashier to manage their subscriptions. This package creates an API webhook endpoint that keeps

composer.json

@@ -14,27 +14,28 @@
         }
     },
     "require": {
-        "illuminate/auth": "5.5 - 6.0",
-        "illuminate/config": "5.5 - 6.0",
-        "illuminate/console": "5.5 - 6.0",
-        "illuminate/events": "5.5 - 6.0",
-        "illuminate/http": "5.5 - 6.0",
-        "illuminate/routing": "5.5 - 6.0",
-        "illuminate/queue": "5.5 - 6.0",
-        "illuminate/support": "5.5 - 6.0",
-        "mixpanel/mixpanel-php": "*",
-        "sinergi/browser-detector": "*"
+        "illuminate/auth": "^5.5|^6.0",
+        "illuminate/config": "^5.5|^6.0",
+        "illuminate/console": "^5.5|^6.0",
+        "illuminate/events": "^5.5|^6.0",
+        "illuminate/http": "^5.5|^6.0",
+        "illuminate/routing": "^5.5|^6.0",
+        "illuminate/queue": "^5.5|^6.0",
+        "illuminate/support": "^5.5|^6.0",
+        "mixpanel/mixpanel-php": "^2.7",
+        "sinergi/browser-detector": "^6.1"
     },
     "require-dev": {
-        "fzaninotto/faker": "*",
-        "laravel/laravel": "dev-develop@dev",
-        "laravel/browser-kit-testing": "*",
-        "mockery/mockery": "*",
-        "phpmd/phpmd": "*",
-        "phpunit/phpunit": "*",
-        "sebastian/phpcpd": "*",
-        "symfony/thanks": "*",
-        "php-coveralls/php-coveralls": "*"
+        "fzaninotto/faker": "^1.8",
+        "laravel/laravel": "^6.0",
+        "laravel/browser-kit-testing": "^5.1",
+        "mockery/mockery": "^1.2",
+        "phpmd/phpmd": "^2.7",
+        "phpunit/phpunit": "^8.4",
+        "sebastian/phpcpd": "^4.1",
+        "symfony/thanks": "^1.0",
+        "php-coveralls/php-coveralls": "^2.1",
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "autoload-dev": {
         "psr-4": {

config/services.php

@@ -7,5 +7,6 @@
         'consumer' => 'socket',
         'connect-timeout' => 2,
         'timeout' => 2,
+        "data_callback_class" => null,
     ]
 ];

phpmd.xml

@@ -0,0 +1,8 @@
+<?php
+
+namespace GeneaLabs\LaravelMixpanel\Interfaces;
+
+interface DataCallback
+{
+    public function process(array $data = []) : array;
+}

src/Interfaces/DataCallback.php

@@ -1,4 +1,6 @@
-<?php namespace GeneaLabs\LaravelMixpanel;
+<?php
+
+namespace GeneaLabs\LaravelMixpanel;
 
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\App;
@@ -9,18 +11,21 @@
 
 class LaravelMixpanel extends Mixpanel
 {
+    private $callbackResults;
     private $defaults;
     private $request;
 
     public function __construct(Request $request, array $options = [])
     {
+        $this->callbackResults = [];
         $this->defaults = [
             'consumer' => config('services.mixpanel.consumer', 'socket'),
             'connect_timeout' => config('services.mixpanel.connect-timeout', 2),
             'timeout' => config('services.mixpanel.timeout', 2),
         ];
         $this->request = $request;
 
+
         parent::__construct(
             config('services.mixpanel.token'),
             array_merge($this->defaults, $options)
@@ -58,7 +63,13 @@ protected function getData() : array
     public function track($event, $properties = [])
     {
         $properties = array_filter($properties);
+        $data = $properties + $this->getData();
+
+        if ($callbackClass = config("services.mixpanel.data_callback_class")) {
+            $data = (new $callbackClass)->process($data);
+            $data = array_filter($data);
+        }
 
-        parent::track($event, $properties + $this->getData());
+        parent::track($event, $data);
     }
 }

src/LaravelMixpanel.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace GeneaLabs\LaravelMixpanel\Tests\Fixtures\App;
+
+use GeneaLabs\LaravelMixpanel\Interfaces\DataCallback;
+
+class MixpanelUserData implements DataCallback
+{
+    public function process(array $data = []) : array
+    {
+        $data["test"] = "value";
+
+        return $data;
+    }
+}

tests/Fixtures/app/MixpanelUserData.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace GeneaLabs\LaravelMixpanel\Tests\Unit;
+
+use GeneaLabs\LaravelMixpanel\Tests\Fixtures\App\MixpanelUserData;
+use GeneaLabs\LaravelMixpanel\Tests\UnitTestCase;
+
+class DataCallbackTest extends UnitTestCase
+{
+    public function testDataCallbackClassReturnsArray()
+    {
+        $data = (new MixpanelUserData)->process();
+
+        $this->assertIsArray($data);
+    }
+
+    public function testDataCallbackArrayContainsValue()
+    {
+        $data = (new MixpanelUserData)->process();
+
+        $this->assertArrayHasKey("test", $data);
+        $this->assertEquals("value", $data["test"]);
+    }
+}

tests/Unit/DataCallbackTest.php

@@ -1,4 +1,6 @@
-<?php namespace GeneaLabs\LaravelMixpanel\Tests\Unit\Facades;
+<?php
+
+namespace GeneaLabs\LaravelMixpanel\Tests\Unit\Facades;
 
 use GeneaLabs\LaravelMixpanel\Facades\Mixpanel;
 use GeneaLabs\LaravelMixpanel\LaravelMixpanel;