posthog-ruby 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57e103be9e2b8f115f96e948f0e82fd138b3c9ec9a7fe6fb1e1cff2e0c29b658
-  data.tar.gz: c275ab93b048fda6bd2e5fa65c8e1955296536b6a281405974db2460b941a626
+  metadata.gz: 987f48b8d0cfa660cf9fc2d53f7da5d7e59150b774fc8403c4b65b94873b577d
+  data.tar.gz: 84402895313a99ebbf865e50ab06b5ee9876510e4c621b206a521dde8d371bc7
 SHA512:
-  metadata.gz: 05cfc7dc4717b287287a37acd50680db1805ef41e42524feaabfd1b3113d96a1d5a90873b453f257e568ff75ce2d6a0e8db4ee82e26210ac280c628970bbed79
-  data.tar.gz: 7ca3acb35caa156e76b06bec03d13494b54a06fb6b727a6601c19d6cbb2e04437bb7873cb3e1e9534303042b84a34bbf35deba36e243bc843a7a89baeef278ac
+  metadata.gz: e34a38c0b8386e95ab5fde0fad897f4bbccacf727cd72c7a72b3ec832977b460055b2ea35d2ab670e65bc916feb84f7d00e8bfa7eaee6e451ae1e6a156e6471f
+  data.tar.gz: d338821ad6066df5a7036421d62b2de806f07fcb266cd695f87f605084b6644e96e954c90ab3395fcc2d246642d6e8055be04c6e6af15b90a730290156733c11

data/lib/posthog/client.rb

@@ -15,6 +15,7 @@ class PostHog
 
     # @param [Hash] opts
     # @option opts [String] :api_key Your project's api_key
+    # @option opts [String] :personal_api_key Your personal API key
     # @option opts [FixNum] :max_queue_size Maximum number of calls to be
     #   remain queued. Defaults to 10_000.
     # @option opts [Bool] :test_mode +true+ if messages should remain
@@ -91,7 +92,8 @@ class PostHog
       symbolize_keys! attrs
 
       if attrs[:send_feature_flags]
-        feature_variants = @feature_flags_poller.get_feature_variants(attrs[:distinct_id], attrs[:groups])
+        feature_variants = @feature_flags_poller._get_active_feature_variants(attrs[:distinct_id], attrs[:groups])
+
         attrs[:feature_variants] = feature_variants
       end
 
@@ -205,6 +207,32 @@ class PostHog
       return @feature_flags_poller.get_all_flags(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
     end
 
+    # Returns payload for a given feature flag
+    #
+    # @param [String] key The key of the feature flag
+    # @param [String] distinct_id The distinct id of the user
+    # @option [String or boolean] match_value The value of the feature flag to be matched
+    # @option [Hash] groups
+    # @option [Hash] person_properties key-value pairs of properties to associate with the user.
+    # @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)
+      @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
+    #
+    # @param [String] distinct_id The distinct id of the user
+    # @option [Hash] groups
+    # @option [Hash] person_properties key-value pairs of properties to associate with the user.
+    # @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)
+      @feature_flags_poller.get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+    end
+
     def reload_feature_flags
       unless @personal_api_key
         logger.error(

data/lib/posthog/feature_flags.rb

@@ -10,9 +10,6 @@ class PostHog
   class InconclusiveMatchError < StandardError
   end
 
-  class DecideAPIError < StandardError
-  end
-
   class FeatureFlagsPoller
     include PostHog::Logging
     include PostHog::Utils
@@ -25,6 +22,7 @@ class PostHog
       @feature_flags = Concurrent::Array.new
       @group_type_mapping = Concurrent::Hash.new
       @loaded_flags_successfully_once = Concurrent::AtomicBoolean.new
+      @feature_flags_by_key = nil
 
       @task =
         Concurrent::TimerTask.new(
@@ -49,7 +47,35 @@ class PostHog
     end
 
     def get_feature_variants(distinct_id, groups={}, person_properties={}, group_properties={})
+      decide_data = get_decide(distinct_id, groups, person_properties, group_properties)
+      if !decide_data.key?(:featureFlags)
+        logger.error "Missing feature flags key: #{decide_data.to_json}"
+      else
+        stringify_keys(decide_data[:featureFlags] || {})
+      end
+    end
+
+    def _get_active_feature_variants(distinct_id, groups={}, person_properties={}, group_properties={})
+      feature_variants = get_feature_variants(distinct_id, groups, person_properties, group_properties)
+      active_feature_variants = {}
+      feature_variants.each do |key, value|
+        if value != false
+          active_feature_variants[key] = value
+        end
+      end
+      active_feature_variants
+    end
+
+    def get_feature_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
+      decide_data = get_decide(distinct_id, groups, person_properties, group_properties)
+      if !decide_data.key?(:featureFlagPayloads)
+        logger.error "Missing feature flag payloads key: #{decide_data.to_json}"
+      else
+        stringify_keys(decide_data[:featureFlagPayloads] || {})
+      end
+    end
 
+    def get_decide(distinct_id, groups={}, person_properties={}, group_properties={})
       request_data = {
         "distinct_id": distinct_id,
         "groups": groups,
@@ -58,12 +84,6 @@ class PostHog
       }
 
       decide_data = _request_feature_flag_evaluation(request_data)
-
-      if !decide_data.key?(:featureFlags)
-        raise DecideAPIError.new(decide_data.to_json)
-      else
-        stringify_keys(decide_data[:featureFlags] || {})
-      end
     end
 
     def get_feature_flag(key, distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
@@ -119,16 +139,25 @@ class PostHog
 
     def get_all_flags(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
       # returns a string hash of all flags
+      response = get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+      flags = response[:featureFlags]
+    end
 
-      # make sure they're loaded on first run
+    def get_all_flags_and_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
       load_feature_flags
 
-      response = {}
+      flags = {}
+      payloads = {}
       fallback_to_decide = @feature_flags.empty?
 
       @feature_flags.each do |flag|
         begin
-          response[flag[:key]] = _compute_flag_locally(flag, distinct_id, groups, person_properties, group_properties)
+          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)
+          if match_payload
+            payloads[flag[:key]] = match_payload
+          end
         rescue InconclusiveMatchError => e
           fallback_to_decide = true
         rescue StandardError => e
@@ -136,15 +165,37 @@ class PostHog
           fallback_to_decide = true
         end
       end
-
       if fallback_to_decide && !only_evaluate_locally
         begin
-          flags = get_feature_variants(distinct_id, groups, person_properties, group_properties)
-          response = {**response, **flags}
+          flags_and_payloads = get_decide(distinct_id, groups, person_properties, group_properties)
+          flags = stringify_keys(flags_and_payloads[:featureFlags] || {})
+          payloads = stringify_keys(flags_and_payloads[:featureFlagPayloads] || {})
         rescue StandardError => e
           logger.error "Error computing flag remotely: #{e}"
         end
       end
+      {"featureFlags": flags, "featureFlagPayloads": payloads}
+    end
+
+    def get_feature_flag_payload(key, distinct_id, match_value = nil, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
+      if match_value == nil
+        match_value = get_feature_flag(
+          key,
+          distinct_id,
+          groups,
+          person_properties,
+          group_properties,
+          true,
+        )[0]
+      end
+      response = nil
+      if match_value != nil
+        response = _compute_flag_payload_locally(key, match_value)
+      end
+      if response == nil and !only_evaluate_locally
+        decide_payloads = get_feature_payloads(distinct_id, groups, person_properties, group_properties)
+        response = decide_payloads[key.downcase] || nil
+      end
       response
     end
 
@@ -248,6 +299,17 @@ class PostHog
 
     end
 
+    def _compute_flag_payload_locally(key, match_value)
+      response = nil
+
+      if [true, false].include? match_value
+        response = @feature_flags_by_key.dig(key, :filters, :payloads, match_value.to_s.to_sym)
+      elsif match_value.is_a? String
+        response = @feature_flags_by_key.dig(key, :filters, :payloads, match_value.to_sym)
+      end
+      response
+    end
+
     def match_feature_flag_properties(flag, distinct_id, properties)
       flag_filters = flag[:filters] || {}
 
@@ -341,12 +403,17 @@ class PostHog
 
     def _load_feature_flags()
       res = _request_feature_flag_definitions
-      @feature_flags.clear
 
       if !res.key?(:flags)
         logger.error "Failed to load feature flags: #{res}"
       else
-        @feature_flags = res[:flags] || []        
+        @feature_flags = res[:flags] || []
+        @feature_flags_by_key = {}
+        @feature_flags.each do |flag|
+          if flag[:key] != nil
+            @feature_flags_by_key[flag[:key]] = flag
+          end
+        end
         @group_type_mapping = res[:group_type_mapping] || {}
 
         logger.debug "Loaded #{@feature_flags.length} feature flags"
@@ -365,7 +432,7 @@ class PostHog
     end
 
     def _request_feature_flag_evaluation(data={})
-      uri = URI("#{@host}/decide/?v=2")
+      uri = URI("#{@host}/decide/?v=3")
       req = Net::HTTP::Post.new(uri)
       req['Content-Type'] = 'application/json'
       data['token'] = @project_api_key

data/lib/posthog/version.rb

@@ -1,3 +1,3 @@
 class PostHog
-  VERSION = '2.2.0'
+  VERSION = '2.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - ''
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-08 00:00:00.000000000 Z
+date: 2023-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -163,7 +163,7 @@ homepage: https://github.com/PostHog/posthog-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -178,8 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: PostHog library
 test_files: []