posthog-ruby 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d987590608ff1c705f8f419d43cb6ef439233f8b3dbc5e3ac84bd64b3d552d9a
-  data.tar.gz: d4ae4f458a8a9faa654519b958cc20f828638ead4696dbc8a8c03ed198e44606
+  metadata.gz: 253c223f00642a02c72d074b6fbf7a523d5799b2a03eed42794e3ab03d6d9c82
+  data.tar.gz: e6c509257a8b09588a3cfd4081ef79184150d28e1d9d9b41a189364c9758e99a
 SHA512:
-  metadata.gz: a9671f5f0fb37ae15a605b1118f09a526fa383aa129335a78a85f8b54c772e8c28ade9e3fd06bf36e142f7a994eca33400965add6c1e2ceebf3b8fcc32d8df23
-  data.tar.gz: 5fd8756e6c1f20bb0df3c40e8e72aa9c9d79dedd2bedb0c53930254d8a58417b75c38867f9e2e673bd0a53968cb7beded76cc6be18760d3fe8755d33cc75cd1b
+  metadata.gz: 824adb5f3f57fbc404876cf8a3a05736ee1b9d5e42114f5a51cfd6d833a35ddff0a45eb9010aaa2744d1c3ea5e150807a2b05d4e88ed7883d579d9debd71a53f
+  data.tar.gz: d48f1843633e2a8ff16a5f17a9ada51d431a1219ca91b273e72872e8e6acae2f0d409252247c1ec0b7c165ea11fe844313dbad57f16322de20c0bf53651cf6fb

data/bin/posthog

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'posthog'
 require 'rubygems'

data/lib/posthog/backoff_policy.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'posthog/defaults'
 
-class PostHog
+module PostHog
   class BackoffPolicy
     include PostHog::Defaults::BackoffPolicy
 

data/lib/posthog/client.rb

@@ -1,4 +1,5 @@
-require 'thread'
+# frozen_string_literal: true
+
 require 'time'
 
 require 'posthog/defaults'
@@ -8,7 +9,7 @@ require 'posthog/send_worker'
 require 'posthog/noop_worker'
 require 'posthog/feature_flags'
 
-class PostHog
+module PostHog
   class Client
     include PostHog::Utils
     include PostHog::Logging
@@ -26,6 +27,8 @@ class PostHog
     #   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)
 
@@ -59,6 +62,8 @@ class PostHog
       @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.
@@ -342,10 +347,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
 
@@ -380,7 +411,7 @@ class PostHog
     end
 
     def worker_running?
-      @worker_thread && @worker_thread.alive?
+      @worker_thread&.alive?
     end
 
     def add_local_person_and_group_properties(distinct_id, groups, person_properties, group_properties)
@@ -399,12 +430,10 @@ class PostHog
       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 && group_properties[group_name]) || {})
-        end
+      groups&.each do |group_name, group_key|
+        all_group_properties[group_name] = {
+          '$group_key': group_key
+        }.merge((group_properties && group_properties[group_name]) || {})
       end
 
       [all_person_properties, all_group_properties]

data/lib/posthog/defaults.rb

@@ -1,11 +1,13 @@
-class PostHog
+# frozen_string_literal: true
+
+module PostHog
   module Defaults
     MAX_HASH_SIZE = 50_000
 
     module Request
-      HOST = 'app.posthog.com'.freeze
+      HOST = 'app.posthog.com'
       PORT = 443
-      PATH = '/batch/'.freeze
+      PATH = '/batch/'
       SSL = true
       HEADERS = {
         'Accept' => 'application/json',

data/lib/posthog/feature_flag.rb

@@ -1,62 +1,66 @@
+# frozen_string_literal: true
+
 # Represents a feature flag returned by /flags v2
-class FeatureFlag
-  attr_reader :key, :enabled, :variant, :reason, :metadata
-
-  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
-  end
+module PostHog
+  class FeatureFlag
+    attr_reader :key, :enabled, :variant, :reason, :metadata
 
-  # TODO: Rename to `value` in future version
-  def get_value # rubocop:disable Naming/AccessorMethodName
-    @variant || @enabled
-  end
+    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
+    end
 
-  def payload
-    @metadata.payload if @metadata
-  end
+    # TODO: Rename to `value` in future version
+    def get_value # rubocop:disable Naming/AccessorMethodName
+      @variant || @enabled
+    end
 
-  def self.from_value_and_payload(key, value, payload)
-    new({
-          '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
-          }
-        })
+    def payload
+      @metadata&.payload
+    end
+
+    def self.from_value_and_payload(key, value, payload)
+      new({
+            '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
-end
 
-# Represents the reason why a flag was enabled/disabled
-class EvaluationReason
-  attr_reader :code, :description, :condition_index
+  # Represents the reason why a flag was enabled/disabled
+  class EvaluationReason
+    attr_reader :code, :description, :condition_index
 
-  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']
+    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']
+    end
   end
-end
 
-# Represents metadata about a feature flag
-class FeatureFlagMetadata
-  attr_reader :id, :version, :payload, :description
+  # Represents metadata about a feature flag
+  class FeatureFlagMetadata
+    attr_reader :id, :version, :payload, :description
 
-  def initialize(json)
-    json.transform_keys!(&:to_s)
-    @id = json['id']
-    @version = json['version']
-    @payload = json['payload']
-    @description = json['description']
+    def initialize(json)
+      json.transform_keys!(&:to_s)
+      @id = json['id']
+      @version = json['version']
+      @payload = json['payload']
+      @description = json['description']
+    end
   end
 end

data/lib/posthog/feature_flags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'concurrent'
 require 'net/http'
 require 'json'
@@ -6,7 +8,7 @@ require 'posthog/logging'
 require 'posthog/feature_flag'
 require 'digest'
 
-class PostHog
+module PostHog
   class InconclusiveMatchError < StandardError
   end
 
@@ -125,9 +127,9 @@ class PostHog
         # v3 format
         flags_response[:featureFlags] = flags_response[:featureFlags] || {}
         flags_response[:featureFlagPayloads] = flags_response[:featureFlagPayloads] || {}
-        flags_response[:flags] = flags_response[:featureFlags].map do |key, value|
+        flags_response[:flags] = flags_response[:featureFlags].to_h do |key, value|
           [key, FeatureFlag.from_value_and_payload(key, value, flags_response[:featureFlagPayloads][key])]
-        end.to_h
+        end
       end
       flags_response
     end
@@ -242,17 +244,15 @@ class PostHog
       request_id = nil # Only for /flags requests
 
       @feature_flags.each do |flag|
-        begin
-          match_value = _compute_flag_locally(flag, distinct_id, groups, person_properties, group_properties)
-          flags[flag[:key]] = match_value
-          match_payload = _compute_flag_payload_locally(flag[:key], match_value)
-          payloads[flag[:key]] = match_payload if match_payload
-        rescue InconclusiveMatchError
-          fallback_to_server = true
-        rescue StandardError => e
-          @on_error.call(-1, "Error computing flag locally: #{e}. #{e.backtrace.join("\n")} ")
-          fallback_to_server = true
-        end
+        match_value = _compute_flag_locally(flag, distinct_id, groups, person_properties, group_properties)
+        flags[flag[:key]] = match_value
+        match_payload = _compute_flag_payload_locally(flag[:key], match_value)
+        payloads[flag[:key]] = match_payload if match_payload
+      rescue InconclusiveMatchError
+        fallback_to_server = true
+      rescue StandardError => e
+        @on_error.call(-1, "Error computing flag locally: #{e}. #{e.backtrace.join("\n")} ")
+        fallback_to_server = true
       end
 
       if fallback_to_server && !only_evaluate_locally
@@ -264,7 +264,7 @@ class PostHog
           end
 
           # Check if feature_flags are quota limited
-          if flags_and_payloads[:quotaLimited] && flags_and_payloads[:quotaLimited].include?('feature_flags')
+          if flags_and_payloads[:quotaLimited]&.include?('feature_flags')
             logger.warn '[FEATURE FLAGS] Quota limited for feature flags'
             flags = {}
             payloads = {}
@@ -505,22 +505,20 @@ class PostHog
       # NOTE: This NEEDS to be `each` because `each_key` breaks
       # This is not a hash, it's just an array with 2 entries
       sorted_flag_conditions.each do |condition, _idx| # rubocop:disable Style/HashEachMethods
-        begin
-          if is_condition_match(flag, distinct_id, condition, properties)
-            variant_override = condition[:variant]
-            flag_multivariate = flag_filters[:multivariate] || {}
-            flag_variants = flag_multivariate[:variants] || []
-            variant = if flag_variants.map { |variant| variant[:key] }.include?(condition[:variant])
-                        variant_override
-                      else
-                        get_matching_variant(flag, distinct_id)
-                      end
-            result = variant || true
-            break
-          end
-        rescue InconclusiveMatchError
-          is_inconclusive = true
+        if is_condition_match(flag, distinct_id, condition, properties)
+          variant_override = condition[:variant]
+          flag_multivariate = flag_filters[:multivariate] || {}
+          flag_variants = flag_multivariate[:variants] || []
+          variant = if flag_variants.map { |variant| variant[:key] }.include?(condition[:variant])
+                      variant_override
+                    else
+                      get_matching_variant(flag, distinct_id)
+                    end
+          result = variant || true
+          break
         end
+      rescue InconclusiveMatchError
+        is_inconclusive = true
       end
 
       if !result.nil?

data/lib/posthog/field_parser.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'posthog/logging'
 
-class PostHog
+module PostHog
   class FieldParser
     class << self
       include PostHog::Utils
@@ -55,7 +57,7 @@ class PostHog
           {
             type: 'identify',
             event: '$identify',
-            :'$set' => properties,
+            '$set': properties,
             properties: properties.merge(common[:properties] || {})
           }
         )
@@ -79,9 +81,9 @@ class PostHog
           {
             event: '$groupidentify',
             properties: {
-              :'$group_type' => group_type,
-              :'$group_key' => group_key,
-              :'$group_set' => properties.merge(common[:properties] || {})
+              '$group_type': group_type,
+              '$group_key': group_key,
+              '$group_set': properties.merge(common[:properties] || {})
             }
           }
         )

data/lib/posthog/logging.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'logger'
 
-class PostHog
+module PostHog
   # Wraps an existing logger and adds a prefix to all messages
   class PrefixedLogger
     def initialize(logger, prefix)

data/lib/posthog/message_batch.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'posthog/logging'
 
-class PostHog
+module PostHog
   # A batch of `Message`s to be sent to the API
   class MessageBatch
     class JSONGenerationError < StandardError

data/lib/posthog/noop_worker.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # A worker that doesn't consume jobs
-class PostHog
+module PostHog
   class NoopWorker
     def initialize(queue)
       @queue = queue

data/lib/posthog/response.rb

@@ -1,4 +1,6 @@
-class PostHog
+# frozen_string_literal: true
+
+module PostHog
   class Response
     attr_reader :status, :error
 

data/lib/posthog/send_worker.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'posthog/defaults'
 require 'posthog/message_batch'
 require 'posthog/transport'
 require 'posthog/utils'
 
-class PostHog
+module PostHog
   class SendWorker
     include PostHog::Utils
     include PostHog::Defaults

data/lib/posthog/transport.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'posthog/defaults'
 require 'posthog/utils'
 require 'posthog/response'
@@ -7,7 +9,7 @@ require 'net/http'
 require 'net/https'
 require 'json'
 
-class PostHog
+module PostHog
   class Transport
     include PostHog::Defaults::Request
     include PostHog::Utils

data/lib/posthog/utils.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
-class PostHog
+module PostHog
   class InconclusiveMatchError < StandardError
   end
 
@@ -10,7 +12,7 @@ class PostHog
     # public: Return a new hash with keys converted from strings to symbols
     #
     def symbolize_keys(hash)
-      hash.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v }
+      hash.transform_keys(&:to_sym)
     end
 
     # public: Convert hash keys from strings to symbols in place
@@ -22,15 +24,15 @@ class PostHog
     # public: Return a new hash with keys as strings
     #
     def stringify_keys(hash)
-      hash.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+      hash.transform_keys(&:to_s)
     end
 
     # public: Returns a new hash with all the date values in the into iso8601
     #         strings
     #
     def isoify_dates(hash)
-      hash.each_with_object({}) do |(k, v), memo|
-        memo[k] = datetime_in_iso8601(v)
+      hash.transform_values do |v|
+        datetime_in_iso8601(v)
       end
     end
 
@@ -65,7 +67,7 @@ class PostHog
 
     def time_in_iso8601(time, fraction_digits = 3)
       fraction =
-        (('.%06i' % time.usec)[0, fraction_digits + 1] if fraction_digits > 0) # rubocop:disable Style/FormatString
+        (('.%06i' % time.usec)[0, fraction_digits + 1] if fraction_digits.positive?) # rubocop:disable Style/FormatString
 
       "#{time.strftime('%Y-%m-%dT%H:%M:%S')}#{fraction}#{formatted_offset(time, true, 'Z')}"
     end
@@ -80,7 +82,7 @@ class PostHog
     end
 
     def seconds_to_utc_offset(seconds, colon = true)
-      format((colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON), (seconds < 0 ? '-' : '+'),
+      format((colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON), (seconds.negative? ? '-' : '+'),
              seconds.abs / 3600, (seconds.abs % 3600) / 60)
     end
 
@@ -99,7 +101,7 @@ class PostHog
       end
     end
 
-    UTC_OFFSET_WITH_COLON = '%s%02d:%02d'.freeze
+    UTC_OFFSET_WITH_COLON = '%s%02d:%02d'
     UTC_OFFSET_WITHOUT_COLON = UTC_OFFSET_WITH_COLON.sub(':', '')
 
     # TODO: Rename to `valid_regex?` in future version
@@ -111,8 +113,8 @@ class PostHog
     end
 
     class SizeLimitedHash < Hash
-      def initialize(max_length, *args, &block)
-        super(*args, &block)
+      def initialize(max_length, ...)
+        super(...)
         @max_length = max_length
       end
 

data/lib/posthog/version.rb

@@ -1,3 +1,5 @@
-class PostHog
-  VERSION = '2.10.0'.freeze
+# frozen_string_literal: true
+
+module PostHog
+  VERSION = '3.0.0'
 end

data/lib/posthog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'posthog/version'
 require 'posthog/defaults'
 require 'posthog/utils'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 3.0.0
 platform: ruby
 authors:
 - ''
@@ -33,7 +33,6 @@ files:
 - bin/helpers/_utils.sh
 - bin/posthog
 - bin/test
-- lib/posthog-ruby.rb
 - lib/posthog.rb
 - lib/posthog/backoff_policy.rb
 - lib/posthog/client.rb
@@ -61,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/posthog-ruby.rb

@@ -1,3 +0,0 @@
-# rubocop:disable Naming/FileName
-require 'posthog'
-# rubocop:enable Naming/FileName