Merge pull request #26 from PostHog/group-analytics-support

Add group analytics support
PostHog · Oct 28, 2021 · d1d9c14 · d1d9c14
2 parents eeec32d + 2095a02
commit d1d9c14
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 7 deletions.
diff --git a/bin/posthog b/bin/posthog
@@ -22,6 +22,9 @@ $options = getopt(
         'event:',
         'properties:',
         'alias:',
+        'groupType:',
+        'groupKey:',
+        'no-ssl',
         'debug'
     )
 );
@@ -30,7 +33,14 @@ if (empty($options['apiKey'])) {
     error('apiKey flag required');
 }
 
-PostHog::init($options['apiKey'], array('host' => $options['host'], 'debug' => array_key_exists('debug', $options)));
+PostHog::init(
+    $options['apiKey'],
+    array(
+        'host' => $options['host'],
+        'debug' => array_key_exists('debug', $options),
+        'ssl' => !array_key_exists('no-ssl', $options)
+    )
+);
 
 switch ($options['type']) {
     case 'capture':
@@ -61,6 +71,16 @@ switch ($options['type']) {
         );
         break;
 
+    case 'groupIdentify':
+        PostHog::groupIdentify(
+            array(
+                'groupType' => $options['groupType'],
+                'groupKey' => $options['groupKey'],
+                'properties' => parse_json($options['properties'])
+            )
+        );
+        break;
+
     default:
         error(usage());
         break;
@@ -72,12 +92,15 @@ function usage(): string
 {
     return "\n  Common keys:" .
         "\n    --apiKey KEY" .
+        "\n    --host HOST" .
         "\n    --debug" .
+        "\n    --no-ssl" .
         "\n" .
         "\n  Usage:" .
-        "\n    posthog --type capture --distinctId \"id\" --event \"event name\" --properties \"{ json: 'object' }\"" .
-        "\n    posthog --type identify --distinctId \"id\" --properties \"{ json: 'object' }" .
+        "\n    posthog --type capture --distinctId \"id\" --event \"event name\" --properties '{ \"json\": \"object\" }'" .
+        "\n    posthog --type identify --distinctId \"id\" --properties '{ \"json\": \"object\" }'" .
         "\n    posthog --type alias --distinctId \"id\" --alias \"alias\"" .
+        "\n    posthog --type groupIdentify --groupType \"organization\" --groupKey \"id:5\" --properties '{ \"json\": \"object\" }'" .
         "\n\n\n";
 }
 

diff --git a/composer.json b/composer.json
@@ -36,4 +36,4 @@
 	"bin": [
 		"bin/posthog"
 	]
-}
+}
diff --git a/lib/Client.php b/lib/Client.php
@@ -30,7 +30,7 @@ class Client
      * @var Consumer
      */
     protected $consumer;
-    
+
     /**
      * @var HttpClient
      */
@@ -56,7 +56,7 @@ public function __construct(string $apiKey, array $options = [], ?HttpClient $ht
             10000,
             false,
             $options["debug"] ?? false
-        );   
+        );
     }
 
     public function __destruct()
@@ -276,5 +276,4 @@ private function message($msg)
 
         return $msg;
     }
-
 }
diff --git a/lib/PostHog.php b/lib/PostHog.php
@@ -74,6 +74,34 @@ public static function identify(array $message)
         return self::$client->identify($message);
     }
 
+    /**
+     * Adds properties to a group.
+     *
+     * @param array $message Must contain keys `groupType`, `groupKey`, `properties`
+     * @return boolean whether the groupIdentify call succeeded
+     * @throws Exception
+     */
+    public static function groupIdentify(array $message)
+    {
+        self::assert(!empty($message["groupType"]), "PostHog::groupIdentify() expects a groupType");
+        self::assert(!empty($message["groupKey"]), "PostHog::groupIdentify() expects a groupKey");
+
+        if (!isset($message["properties"])) {
+            $message["properties"] = array();
+        }
+
+        $msg = array(
+            "event" => "\$groupidentify",
+            "distinctId" => "\${$message['groupType']}_{$message['groupKey']}",
+            "properties" => array(
+                "\$group_type" => $message["groupType"],
+                "\$group_key" => $message["groupKey"],
+                "\$group_set" => $message["properties"],
+            )
+        );
+
+        return self::capture($msg);
+    }
 
     /**
      * decide if the feature flag is enabled for this distinct id.

diff --git a/test/PostHogTest.php b/test/PostHogTest.php
@@ -188,4 +188,37 @@ public function testTimestamps(): void
             )
         );
     }
+
+    public function testGroupIdentify(): void
+    {
+        self::assertTrue(
+            PostHog::groupIdentify(
+                array(
+                    "groupType" => "company",
+                    "groupKey" => "id:5",
+                    "properties" => array(
+                        "foo" => "bar"
+                    )
+                )
+            )
+        );
+
+        self::assertTrue(
+            PostHog::groupIdentify(
+                array(
+                    "groupType" => "company",
+                    "groupKey" => "id:5",
+                )
+            )
+        );
+    }
+
+    public function testGroupIdentifyValidation(): void
+    {
+        try {
+            Posthog::groupIdentify(array());
+        } catch (Exception $e) {
+            $this->assertEquals("PostHog::groupIdentify() expects a groupType", $e->getMessage());
+        }
+    }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,4 +36,4 @@ @@
     	"bin": [
     		"bin/posthog"
     	]
-    }
+    }