Merge pull request #106 from arup-group/task/OGH-24-Add-PostHog-component

OGH-24-Add-PostHog-component

Author: tlmnrnhrdt

GH_UnitNumber/Components/SendToPostHog.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Drawing;
+using Grasshopper.Kernel;
+using Newtonsoft.Json;
+using OasysGH;
+using OasysGH.Components;
+using OasysGH.Helpers;
+
+namespace GH_UnitNumber.Components {
+  public class SendToPostHog : GH_OasysComponent {
+    public override Guid ComponentGuid => new Guid("9da7ba33-62fc-4f36-81a3-7e24a09a644b");
+    public override GH_Exposure Exposure => GH_Exposure.hidden;
+    public override OasysPluginInfo PluginInfo => GH_UnitNumberPluginInfo.Instance;
+    protected override Bitmap Icon => null;
+
+    public SendToPostHog() : base("Send to PostHog", "PostHog",
+      "Send an event to a PostHog server", "Params", "Util") {
+      Hidden = true;
+    }
+
+    protected override void RegisterInputParams(GH_InputParamManager pManager) {
+      pManager.AddTextParameter("API key", "K", "PostHog API key", GH_ParamAccess.item);
+      pManager.AddTextParameter("Event name", "E", "PostHog event name", GH_ParamAccess.item);
+      pManager.AddTextParameter("Event properties", "P", "[Optional] PostHog event properties as JSON string", GH_ParamAccess.item);
+      pManager.AddBooleanParameter("Enabled", "On", "[Optional] If true, the component will try to send the PostHog event", GH_ParamAccess.item, true);
+      pManager[2].Optional = true;
+      pManager[3].Optional = true;
+    }
+
+    protected override void RegisterOutputParams(GH_OutputParamManager pManager) {
+    }
+
+    protected override void SolveInstance(IGH_DataAccess da) {
+      string apiKey = string.Empty;
+      da.GetData(0, ref apiKey);
+
+      string eventName = string.Empty;
+      da.GetData(1, ref eventName);
+
+      string json = string.Empty;
+      da.GetData(2, ref json);
+
+      bool enabled = true;
+      da.GetData(3, ref enabled);
+
+      if (enabled) {
+        IDictionary<string, object> properties = JsonConvert.DeserializeObject<Dictionary<string, object>>(json);
+
+        _ = PostHog.SendToPostHog(apiKey, GH_UnitNumberPluginInfo.Instance.PluginName, GH_UnitNumberPluginInfo.Instance.Version, GH_UnitNumberPluginInfo.Instance.IsBeta, eventName, properties);
+      }
+    }
+  }
+}

OasysGH/Helpers/PostHog.cs

@@ -19,12 +19,12 @@ private class PhContainer {
       private string _event;
 
       [JsonProperty("properties")]
-      private Dictionary<string, object> _properties;
+      private IDictionary<string, object> _properties;
 
       [JsonProperty("timestamp")]
       private DateTime _timestamp;
 
-      public PhContainer(string apiKey, string eventName, Dictionary<string, object> properties) {
+      public PhContainer(string apiKey, string eventName, IDictionary<string, object> properties) {
         _apiKey = apiKey;
         _event = eventName;
         _properties = properties;
@@ -84,16 +84,20 @@ public static void RemovedFromDocument(GH_Component component, OasysPluginInfo p
       }
     }
 
-    public static async Task<HttpResponseMessage> SendToPostHog(OasysPluginInfo pluginInfo, string eventName, Dictionary<string, object> additionalProperties = null) {
+    public static async Task<HttpResponseMessage> SendToPostHog(OasysPluginInfo pluginInfo, string eventName, IDictionary<string, object> additionalProperties = null) {
+      return await SendToPostHog(pluginInfo.PostHogApiKey, pluginInfo.PluginName, pluginInfo.Version, pluginInfo.IsBeta, eventName, additionalProperties);
+    }
+
+    public static async Task<HttpResponseMessage> SendToPostHog(string postHogApiKey, string pluginName, string version, bool isBeta, string eventName, IDictionary<string, object> additionalProperties = null) {
       // posthog ADS plugin requires a user object
       User user = currentUser;
 
       var properties = new Dictionary<string, object>() {
         { "distinct_id", user.UserName },
         { "user", user },
-        { "pluginName", pluginInfo.PluginName },
-        { "version", pluginInfo.Version },
-        { "isBeta", pluginInfo.IsBeta },
+        { "pluginName", pluginName },
+        { "version", version },
+        { "isBeta", isBeta },
       };
 
       if (additionalProperties != null) {
@@ -102,7 +106,11 @@ public static async Task<HttpResponseMessage> SendToPostHog(OasysPluginInfo plug
         }
       }
 
-      var container = new PhContainer(pluginInfo.PostHogApiKey, eventName, properties);
+      return await SendToPostHog(postHogApiKey, eventName, properties);
+    }
+
+    public static async Task<HttpResponseMessage> SendToPostHog(string postHogApiKey, string eventName, IDictionary<string, object> properties) {
+      var container = new PhContainer(postHogApiKey, eventName, properties);
       string body = JsonConvert.SerializeObject(container);
       var content = new StringContent(body, Encoding.UTF8, "application/json");
       HttpResponseMessage response = await phClient.PostAsync("https://eu.posthog.com/capture/", content);