posthog-ruby 2.9.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9be467263d4138e0b223e18281a9b0af56351fbf9d807b01bf4ff8f87d004a7
-  data.tar.gz: 1c4a9990d2958023b7db53511e64aa90ade5364d06e42e23b2b981d6acb59ba2
+  metadata.gz: 952a3d08e42e35c4006614c4ea33cb0fb7216c250f2eade20bb6c37d12fb5b13
+  data.tar.gz: 9f4773ec646c3e7e4f5183d818245d0dab1f275ec5f01de1ddcc073483499fbb
 SHA512:
-  metadata.gz: abde921140981a63fb82677e5024c4fcce79f9e560a870b0fd91114eaff0df1af0a5908742fbab3dee612d1d1a866998e9f1d10a587484e4baaf06b2f7cafd45
-  data.tar.gz: 7d88779cd59527ba500d8a2dcee0692a7135da88910d8045b276f32b635caee887b3fe2382a85fd6408b0e8cd57c58e0ca84495c99f912763a13f2b62e01dc78
+  metadata.gz: f3b66458d3987de0296702f9ef32a3ec90485fb263a986ff7e703ee6ca5113be320acb28fa07b48231401898e630c24f2c11067e6a01aa5bc7860ce494b15a40
+  data.tar.gz: 92d1b482dbe35e57c30cbc0160a6be1f1589cb63a8871eaaefdde8c64aa49d8d1d280a05d6ecd4f55fb1a850e62f73c756878081d53b6bede4b21c9859cfd006

data/bin/posthog

@@ -11,7 +11,7 @@ program :version, '1.0.0'
 program :description, 'PostHog API'
 
 def json_hash(str)
-  return JSON.parse(str) if str
+  JSON.parse(str) if str
 end
 
 command :capture do |c|
@@ -27,13 +27,13 @@ command :capture do |c|
   c.option '--event=<event>', String, 'The event name to send with the event'
   c.option '--properties=<properties>', 'The properties to send (JSON-encoded)'
 
-  c.action do |args, options|
+  c.action do |_args, options|
     posthog =
       PostHog::Client.new(
         {
           api_key: options.api_key,
           api_host: options.api_host,
-          on_error: Proc.new { |status, msg| print msg }
+          on_error: proc { |_status, msg| print msg }
         }
       )
 
@@ -61,13 +61,13 @@ command :identify do |c|
            'The distinct id to send the event as'
   c.option '--properties=<properties>', 'The properties to send (JSON-encoded)'
 
-  c.action do |args, options|
+  c.action do |_args, options|
     posthog =
       PostHog::Client.new(
         {
           api_key: options.api_key,
           api_host: options.api_host,
-          on_error: Proc.new { |status, msg| print msg }
+          on_error: proc { |_status, msg| print msg }
         }
       )
 
@@ -92,13 +92,13 @@ command :alias do |c|
   c.option '--distinct-id=<distinct_id>', String, 'The distinct id'
   c.option '--alias=<alias>', 'The alias to give to the distinct id'
 
-  c.action do |args, options|
+  c.action do |_args, options|
     posthog =
       PostHog::Client.new(
         {
           api_key: options.api_key,
           api_host: options.api_host,
-          on_error: Proc.new { |status, msg| print msg }
+          on_error: proc { |_status, msg| print msg }
         }
       )
 

data/lib/posthog/client.rb

@@ -22,8 +22,12 @@ class PostHog
     #   queued for testing. Defaults to +false+.
     # @option opts [Proc] :on_error Handles error calls from the API.
     # @option opts [String] :host Fully qualified hostname of the PostHog server. Defaults to `https://app.posthog.com`
-    # @option opts [Integer] :feature_flags_polling_interval How often to poll for feature flag definition changes. Measured in seconds, defaults to 30.
-    # @option opts [Integer] :feature_flag_request_timeout_seconds How long to wait for feature flag evaluation. Measured in seconds, defaults to 3.
+    # @option opts [Integer] :feature_flags_polling_interval How often to poll for feature flag definition changes.
+    #   Measured in seconds, defaults to 30.
+    # @option opts [Integer] :feature_flag_request_timeout_seconds How long to wait for feature flag evaluation.
+    #   Measured in seconds, defaults to 3.
+    # @option opts [Proc] :before_send A block that receives the event hash and should return either a modified hash
+    #   to be sent to PostHog or nil to prevent the event from being sent. e.g. `before_send: ->(event) { event }`
     def initialize(opts = {})
       symbolize_keys!(opts)
 
@@ -34,10 +38,10 @@ class PostHog
       @max_queue_size = opts[:max_queue_size] || Defaults::Queue::MAX_SIZE
       @worker_mutex = Mutex.new
       @worker = if opts[:test_mode]
-        NoopWorker.new(@queue)
-      else
-        SendWorker.new(@queue, @api_key, opts)
-      end
+                  NoopWorker.new(@queue)
+                else
+                  SendWorker.new(@queue, @api_key, opts)
+                end
       @worker_thread = nil
       @feature_flags_poller = nil
       @personal_api_key = opts[:personal_api_key]
@@ -53,8 +57,12 @@ class PostHog
           opts[:feature_flag_request_timeout_seconds] || Defaults::FeatureFlags::FLAG_REQUEST_TIMEOUT_SECONDS,
           opts[:on_error]
         )
-      
-      @distinct_id_has_sent_flag_calls = SizeLimitedHash.new(Defaults::MAX_HASH_SIZE) { |hash, key| hash[key] = Array.new }
+
+      @distinct_id_has_sent_flag_calls = SizeLimitedHash.new(Defaults::MAX_HASH_SIZE) do |hash, key|
+        hash[key] = []
+      end
+
+      @before_send = opts[:before_send]
     end
 
     # Synchronously waits until the worker has cleared the queue.
@@ -88,6 +96,10 @@ class PostHog
     # @option attrs [String] :event Event name
     # @option attrs [Hash] :properties Event properties (optional)
     # @option attrs [Bool] :send_feature_flags Whether to send feature flags with this event (optional)
+    # @option attrs [String] :uuid ID that uniquely identifies an event;
+    #                             events in PostHog are deduplicated by the
+    #                             combination of teamId, timestamp date,
+    #                             event name, distinct id, and UUID
     # @macro common_attrs
     def capture(attrs)
       symbolize_keys! attrs
@@ -147,18 +159,34 @@ class PostHog
       @queue.length
     end
 
-    def is_feature_enabled(flag_key, distinct_id, groups: {}, person_properties: {}, group_properties: {}, only_evaluate_locally: false, send_feature_flag_events: true)
-      response = get_feature_flag(flag_key, distinct_id, groups: groups, person_properties: person_properties, group_properties: group_properties, only_evaluate_locally: only_evaluate_locally, send_feature_flag_events: send_feature_flag_events)
-      if response.nil?
-        return nil
-      end
+    # TODO: In future version, rename to `feature_flag_enabled?`
+    def is_feature_enabled( # rubocop:disable Naming/PredicateName
+      flag_key,
+      distinct_id,
+      groups: {},
+      person_properties: {},
+      group_properties: {},
+      only_evaluate_locally: false,
+      send_feature_flag_events: true
+    )
+      response = get_feature_flag(
+        flag_key,
+        distinct_id,
+        groups: groups,
+        person_properties: person_properties,
+        group_properties: group_properties,
+        only_evaluate_locally: only_evaluate_locally,
+        send_feature_flag_events: send_feature_flag_events
+      )
+      return nil if response.nil?
+
       !!response
     end
 
     # @param [String] flag_key The unique flag key of the feature flag
     # @return [String] The decrypted value of the feature flag payload
     def get_remote_config_payload(flag_key)
-      return @feature_flags_poller.get_remote_config_payload(flag_key)
+      @feature_flags_poller.get_remote_config_payload(flag_key)
     end
 
     # Returns whether the given feature flag is enabled for the given user or not
@@ -168,35 +196,56 @@ class PostHog
     # @param [Hash] groups
     # @param [Hash] person_properties key-value pairs of properties to associate with the user.
     # @param [Hash] group_properties
-    # 
+    #
     # @return [String, nil] The value of the feature flag
     #
     # The provided properties are used to calculate feature flags locally, if possible.
     #
-    # `groups` are a mapping from group type to group key. So, if you have a group type of "organization" and a group key of "5",
+    # `groups` are a mapping from group type to group key. So, if you have a group type of "organization"
+    # and a group key of "5",
     # you would pass groups={"organization": "5"}.
     # `group_properties` take the format: { group_type_name: { group_properties } }
-    # So, for example, if you have the group type "organization" and the group key "5", with the properties name, and employee count,
-    # you'll send these as:
+    # So, for example, if you have the group type "organization" and the group key "5", with the properties name,
+    # and employee count, you'll send these as:
     # ```ruby
     #     group_properties: {"organization": {"name": "PostHog", "employees": 11}}
     # ```
-    def get_feature_flag(key, distinct_id, groups: {}, person_properties: {}, group_properties: {}, only_evaluate_locally: false, send_feature_flag_events: true)
-      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
-      feature_flag_response, flag_was_locally_evaluated, request_id = @feature_flags_poller.get_feature_flag(key, distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+    def get_feature_flag(
+      key,
+      distinct_id,
+      groups: {},
+      person_properties: {},
+      group_properties: {},
+      only_evaluate_locally: false,
+      send_feature_flag_events: true
+    )
+      person_properties, group_properties = add_local_person_and_group_properties(
+        distinct_id,
+        groups,
+        person_properties,
+        group_properties
+      )
+      feature_flag_response, flag_was_locally_evaluated, request_id = @feature_flags_poller.get_feature_flag(
+        key,
+        distinct_id,
+        groups,
+        person_properties,
+        group_properties,
+        only_evaluate_locally
+      )
 
       feature_flag_reported_key = "#{key}_#{feature_flag_response}"
       if !@distinct_id_has_sent_flag_calls[distinct_id].include?(feature_flag_reported_key) && send_feature_flag_events
         capture(
           {
-            'distinct_id': distinct_id,
-            'event': '$feature_flag_called',
-            'properties': {
+            distinct_id: distinct_id,
+            event: '$feature_flag_called',
+            properties: {
               '$feature_flag' => key,
               '$feature_flag_response' => feature_flag_response,
               'locally_evaluated' => flag_was_locally_evaluated
-            }.merge(request_id ? {'$feature_flag_request_id' => request_id} : {}),
-            'groups': groups,
+            }.merge(request_id ? { '$feature_flag_request_id' => request_id } : {}),
+            groups: groups
           }
         )
         @distinct_id_has_sent_flag_calls[distinct_id] << feature_flag_reported_key
@@ -210,11 +259,19 @@ class PostHog
     # @param [Hash] groups
     # @param [Hash] person_properties key-value pairs of properties to associate with the user.
     # @param [Hash] group_properties
-    # 
+    #
     # @return [Hash] String (not symbol) key value pairs of flag and their values
-    def get_all_flags(distinct_id, groups: {}, person_properties: {}, group_properties: {}, only_evaluate_locally: false)
-      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
-      return @feature_flags_poller.get_all_flags(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+    def get_all_flags(
+      distinct_id,
+      groups: {},
+      person_properties: {},
+      group_properties: {},
+      only_evaluate_locally: false
+    )
+      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups,
+                                                                                  person_properties, group_properties)
+      @feature_flags_poller.get_all_flags(distinct_id, groups, person_properties, group_properties,
+                                          only_evaluate_locally)
     end
 
     # Returns payload for a given feature flag
@@ -227,13 +284,23 @@ class PostHog
     # @option [Hash] group_properties
     # @option [Boolean] only_evaluate_locally
     #
-    def get_feature_flag_payload(key, distinct_id, match_value: nil, groups: {}, person_properties: {}, group_properties: {}, only_evaluate_locally: false)
-      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
-      @feature_flags_poller.get_feature_flag_payload(key, distinct_id, match_value, groups, person_properties, group_properties, only_evaluate_locally)
+    def get_feature_flag_payload(
+      key,
+      distinct_id,
+      match_value: nil,
+      groups: {},
+      person_properties: {},
+      group_properties: {},
+      only_evaluate_locally: false
+    )
+      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups,
+                                                                                  person_properties, group_properties)
+      @feature_flags_poller.get_feature_flag_payload(key, distinct_id, match_value, groups, person_properties,
+                                                     group_properties, only_evaluate_locally)
     end
 
     # Returns all flags and payloads for a given user
-    # 
+    #
     # @return [Hash] A hash with the following keys:
     #   featureFlags: A hash of feature flags
     #   featureFlagPayloads: A hash of feature flag payloads
@@ -244,9 +311,20 @@ class PostHog
     # @option [Hash] group_properties
     # @option [Boolean] only_evaluate_locally
     #
-    def get_all_flags_and_payloads(distinct_id, groups: {}, person_properties: {}, group_properties: {}, only_evaluate_locally: false)
-      person_properties, group_properties = add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
-      response = @feature_flags_poller.get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+    def get_all_flags_and_payloads(
+      distinct_id,
+      groups: {},
+      person_properties: {},
+      group_properties: {},
+      only_evaluate_locally: false
+    )
+      person_properties, group_properties = add_local_person_and_group_properties(
+        distinct_id, groups, person_properties, group_properties
+      )
+      response = @feature_flags_poller.get_all_flags_and_payloads(
+        distinct_id, groups, person_properties, group_properties, only_evaluate_locally
+      )
+
       response.delete(:requestId) # remove internal information.
       response
     end
@@ -268,10 +346,36 @@ class PostHog
 
     private
 
+    # before_send should run immediately before the event is sent to the queue.
+    # @param [Object] action The event to be sent to PostHog
+    # @return [null, Object, nil] The processed event or nil if the event should not be sent
+    def process_before_send(action)
+      return action if action.nil? || action.empty?
+      return action unless @before_send
+
+      begin
+        processed_action = @before_send.call(action)
+
+        if processed_action.nil?
+          logger.warn("Event #{action[:event]} was rejected in beforeSend function")
+        elsif processed_action.empty?
+          logger.warn("Event #{action[:event]} has no properties after beforeSend function, this is likely an error")
+        end
+
+        processed_action
+      rescue StandardError => e
+        logger.error("Error in beforeSend function - using original event: #{e.message}")
+        action
+      end
+    end
+
     # private: Enqueues the action.
     #
     # returns Boolean of whether the item was added to the queue.
     def enqueue(action)
+      action = process_before_send(action)
+      return false if action.nil? || action.empty?
+
       # add our request id for tracing purposes
       action[:messageId] ||= uid
 
@@ -283,8 +387,8 @@ class PostHog
       else
         logger.warn(
           'Queue is full, dropping events. The :max_queue_size ' \
-            'configuration parameter can be increased to prevent this from ' \
-            'happening.'
+          'configuration parameter can be increased to prevent this from ' \
+          'happening.'
         )
         false
       end
@@ -297,8 +401,10 @@ class PostHog
 
     def ensure_worker_running
       return if worker_running?
+
       @worker_mutex.synchronize do
         return if worker_running?
+
         @worker_thread = Thread.new { @worker.run }
       end
     end
@@ -308,7 +414,6 @@ class PostHog
     end
 
     def add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
-
       groups ||= {}
       person_properties ||= {}
       group_properties ||= {}
@@ -317,21 +422,22 @@ class PostHog
       symbolize_keys! person_properties
       symbolize_keys! group_properties
 
-      group_properties.each do |key, value|
+      group_properties.each_value do |value|
         symbolize_keys! value
       end
 
-      all_person_properties = { "distinct_id" => distinct_id }.merge(person_properties)
+      all_person_properties = { distinct_id: distinct_id }.merge(person_properties)
 
       all_group_properties = {}
       if groups
         groups.each do |group_name, group_key|
           all_group_properties[group_name] = {
-            "$group_key" => group_key}.merge(group_properties&.dig(group_name) || {})
+            :'$group_key' => group_key
+          }.merge((group_properties && group_properties[group_name]) || {})
         end
       end
 
-      return all_person_properties, all_group_properties
+      [all_person_properties, all_group_properties]
     end
   end
 end

data/lib/posthog/defaults.rb

@@ -1,25 +1,24 @@
 class PostHog
   module Defaults
-
     MAX_HASH_SIZE = 50_000
 
     module Request
-      HOST = 'app.posthog.com'
+      HOST = 'app.posthog.com'.freeze
       PORT = 443
-      PATH = '/batch/'
+      PATH = '/batch/'.freeze
       SSL = true
       HEADERS = {
         'Accept' => 'application/json',
         'Content-Type' => 'application/json',
         'User-Agent' => "posthog-ruby/#{PostHog::VERSION}"
-      }
+      }.freeze
       RETRIES = 10
     end
 
     module FeatureFlags
       FLAG_REQUEST_TIMEOUT_SECONDS = 3
     end
-    
+
     module Queue
       MAX_SIZE = 10_000
     end

data/lib/posthog/feature_flag.rb

@@ -4,34 +4,35 @@ class FeatureFlag
 
   def initialize(json)
     json.transform_keys!(&:to_s)
-    @key = json["key"]
-    @enabled = json["enabled"]
-    @variant = json["variant"]
-    @reason = json["reason"] ? EvaluationReason.new(json["reason"]) : nil
-    @metadata = json["metadata"] ? FeatureFlagMetadata.new(json["metadata"].transform_keys(&:to_s)) : nil
+    @key = json['key']
+    @enabled = json['enabled']
+    @variant = json['variant']
+    @reason = json['reason'] ? EvaluationReason.new(json['reason']) : nil
+    @metadata = json['metadata'] ? FeatureFlagMetadata.new(json['metadata'].transform_keys(&:to_s)) : nil
   end
 
-  def get_value
+  # TODO: Rename to `value` in future version
+  def get_value # rubocop:disable Naming/AccessorMethodName
     @variant || @enabled
   end
 
   def payload
-    @metadata&.payload
+    @metadata.payload if @metadata
   end
 
   def self.from_value_and_payload(key, value, payload)
     new({
-      "key" => key,
-      "enabled" => value.is_a?(String) ? true : value,
-      "variant" => value.is_a?(String) ? value : nil,
-      "reason" => nil,
-      "metadata" => {
-        "id" => nil,
-        "version" => nil,
-        "payload" => payload,
-        "description" => nil
-      }
-    })
+          'key' => key,
+          'enabled' => value.is_a?(String) || value,
+          'variant' => value.is_a?(String) ? value : nil,
+          'reason' => nil,
+          'metadata' => {
+            'id' => nil,
+            'version' => nil,
+            'payload' => payload,
+            'description' => nil
+          }
+        })
   end
 end
 
@@ -41,9 +42,9 @@ class EvaluationReason
 
   def initialize(json)
     json.transform_keys!(&:to_s)
-    @code = json["code"]
-    @description = json["description"]
-    @condition_index = json["condition_index"]&.to_i if json["condition_index"]
+    @code = json['code']
+    @description = json['description']
+    @condition_index = json['condition_index'].to_i if json['condition_index']
   end
 end
 
@@ -53,9 +54,9 @@ class FeatureFlagMetadata
 
   def initialize(json)
     json.transform_keys!(&:to_s)
-    @id = json["id"]
-    @version = json["version"]
-    @payload = json["payload"]
-    @description = json["description"]
+    @id = json['id']
+    @version = json['version']
+    @payload = json['payload']
+    @description = json['description']
   end
-end
+end