Adding additional fields (#3)

* Added 'Additional Fields' to User Object for Identify calls.

* Added additionalFields to Tracking Event too

* Updated Keywords

* Update src/User.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/TrackingEvent.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix styling

* Fixed composer installation.

* Deconflicting pest-plugin-faker

* Fix failing tests.

* Fixed phpstan so it runs

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: spam-n-eggs

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Dominion Solutions LLC <mark.horninger@dominion.solutions>
+Copyright (c) Dominion Solutions LLC <sales@dominion.solutions>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -2,9 +2,9 @@
     "name": "dominion-solutions/customerio",
     "description": "A Laravel Integration Layer for CustomerIO",
     "keywords": [
-        "Dominion Solutions LLC",
         "laravel",
-        "customerio"
+        "customerio",
+        "tracking"
     ],
     "homepage": "https://github.com/dominion-solutions/customerio",
     "license": "MIT",
@@ -23,15 +23,15 @@
         "spatie/laravel-package-tools": "^1.16"
     },
     "require-dev": {
-        "illuminate/http": "*",
+        "illuminate/http": "^10.0||^11.0||^12.0",
         "larastan/larastan": "^2.9||^3.0",
         "laravel/pint": "^1.14",
         "matthewbdaly/artisan-standalone": "^0.0.12",
         "nunomaduro/collision": "^8.1.1||^7.10.0",
         "orchestra/testbench": "^10.0.0||^9.0.0||^8.22.0",
         "pestphp/pest": "^2.0||^3.0",
         "pestphp/pest-plugin-arch": "^2.5||^3.0",
-        "pestphp/pest-plugin-faker": "^3.0",
+        "pestphp/pest-plugin-faker": "^2.0||^3.0",
         "pestphp/pest-plugin-laravel": "^2.0||^3.0",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan-deprecation-rules": "^1.1||^2.0",

database/factories/ModelFactory.php

@@ -6,7 +6,6 @@ parameters:
     paths:
         - src
         - config
-        - database
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true

database/migrations/create_customerio_table.php.stub

@@ -10,16 +10,17 @@ public function __construct(
         public ?string $userId = null,
         public ?string $event = null,
         public ?array $properties = [],
+        public array $additionalFields = [],
         public ?array $context = [],
     ) {}
 
     public function toArray(): array
     {
-        return [
+        return collect([
             'userId' => $this->userId,
             'event' => $this->event,
             'properties' => $this->properties,
             'context' => $this->context,
-        ];
+        ])->merge($this->additionalFields)->toArray();
     }
 }

phpstan.neon.dist

@@ -6,17 +6,21 @@
 
 class User implements Arrayable
 {
-    public function __construct(public ?string $userId = null,
+    public function __construct(
+        public ?string $userId = null,
         public ?string $anonymousId = null,
-        public array $traits = []
+        public array $additionalFields = [],
+        public ?array $traits = [],
     ) {}
 
-    public function toArray()
+    public function toArray(): array
     {
-        return [
+        $baseData = collect([
             'userId' => $this->userId,
             'anonymousId' => $this->anonymousId,
             'traits' => $this->traits,
-        ];
+        ]);
+
+        return $baseData->merge($this->additionalFields)->toArray();
     }
 }

src/TrackingEvent.php

@@ -5,7 +5,7 @@
 
 it('can create a tracking event', function () {
     mockCustomerIO();
-    $trackingEvent = new TrackingEvent(userId: fake()->email(), tags: [
+    $trackingEvent = new TrackingEvent(userId: fake()->email(), properties: [
         fake()->word() => fake()->word(),
     ]);
     $response = CustomerIO::trackEvent($trackingEvent);
@@ -14,7 +14,7 @@
 
 it('can create an anonymous tracking event', function () {
     mockCustomerIO();
-    $trackingEvent = new TrackingEvent(anonymousId: fake()->email(), tags: [
+    $trackingEvent = new TrackingEvent(userId: fake()->email(), properties: [
         fake()->word() => fake()->word(),
     ]);
     $response = CustomerIO::trackEvent($trackingEvent);
@@ -23,7 +23,7 @@
 
 it('can handle errors', function () {
     mockCustomerIO(trackSuccess: false);
-    $trackingEvent = new TrackingEvent(userId: fake()->email(), tags: [
+    $trackingEvent = new TrackingEvent(userId: fake()->email(), properties: [
         fake()->word() => fake()->word(),
     ]);
     $response = CustomerIO::trackEvent($trackingEvent);