posthog-ruby 2.7.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f2eecec568e40b102f14429a40372d2d3072bb4ad327c28c2f31d7197cf14ff
-  data.tar.gz: 66383a06e85a0e7447e4a46eeebe54e8d897ca5d9d0211cb112653de6e0ec179
+  metadata.gz: 403175c4385fd299bfb3288ec55ea218b5108efba7a2096574be5d57db3ad828
+  data.tar.gz: 31283de954af3bc6624c90ea5975df2451c901bd8a198f782938d74e73f7d6a5
 SHA512:
-  metadata.gz: c84276acbad7b6e0d10ee022bb7eb0b43e70623c0538954a377a6735349c88f56cb3400c04071e59c701685e923430a4175181da8bee09502fc425fcdb5496aa
-  data.tar.gz: 399eaeaaad63a6a36217e00673c08be3c88cbc2782d19ad1e60339808e1da00ebee2f24351dd15d81c2e3aefb423163b19da83f7b08197b98570422723391c98
+  metadata.gz: 9c566381334794edd10f75f20b28fc804cb18f950cb02e8fd381b39f7453b83af372c642e9fea14c17e204c50141ed49cf4a4e3d15057e6878d3460471b7a9ed
+  data.tar.gz: 761aba06f50b414406abfd8a40b00403e8002184406b13fbd1c728e03fb3379a995864da24931fd0bd6bb7227be07b1850eb88cce81fd54321d0bb1014d231cc

data/bin/helpers/_utils.sh

@@ -0,0 +1,15 @@
+error() {
+    echo "$@" >&2
+}
+
+fatal() {
+    error "$@"
+    exit 1
+}
+
+set_source_and_root_dir() {
+    { set +x; } 2>/dev/null
+    source_dir="$( cd -P "$( dirname "$0" )" >/dev/null 2>&1 && pwd )"
+    root_dir=$(cd $source_dir && cd ../ && pwd)
+    cd $root_dir
+}

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+#/ Usage: bin/test [<configuration>]
+#/ Description: Runs all the rspec tests.
+source bin/helpers/_utils.sh
+set_source_and_root_dir
+
+bundle exec rspec

data/lib/posthog/client.rb

@@ -183,7 +183,7 @@ class PostHog
     # ```
     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 = @feature_flags_poller.get_feature_flag(key, distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+      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
@@ -195,7 +195,7 @@ class PostHog
               '$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,
           }
         )
@@ -233,6 +233,10 @@ class PostHog
     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
     #
     # @param [String] distinct_id The distinct id of the user
     # @option [Hash] groups
@@ -242,7 +246,9 @@ class PostHog
     #
     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)
-      @feature_flags_poller.get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, only_evaluate_locally)
+      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
 
     def reload_feature_flags

data/lib/posthog/feature_flag.rb

@@ -0,0 +1,61 @@
+# Represents a feature flag returned by /decide v4
+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
+
+  def get_value
+    @variant || @enabled
+  end
+
+  def payload
+    @metadata&.payload
+  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
+      }
+    })
+  end
+end
+
+# 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"]
+  end
+end
+
+# 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"]
+  end
+end

data/lib/posthog/feature_flags.rb

@@ -3,6 +3,7 @@ require 'net/http'
 require 'json'
 require 'posthog/version'
 require 'posthog/logging'
+require 'posthog/feature_flag'
 require 'digest'
 
 class PostHog
@@ -77,7 +78,26 @@ class PostHog
         "group_properties": group_properties,
       }
 
-      decide_data = _request_feature_flag_evaluation(request_data)
+      decide_response = _request_feature_flag_evaluation(request_data)
+
+      # Only normalize if we have flags in the response
+      if decide_response[:flags]
+        #v4 format
+        flags_hash = decide_response[:flags].transform_values do |flag|
+          FeatureFlag.new(flag)
+        end
+        decide_response[:flags] = flags_hash
+        decide_response[:featureFlags] = flags_hash.transform_values(&:get_value).transform_keys(&:to_sym)
+        decide_response[:featureFlagPayloads] = flags_hash.transform_values(&:payload).transform_keys(&:to_sym)
+      elsif decide_response[:featureFlags]
+        #v3 format
+        decide_response[:featureFlags] = decide_response[:featureFlags] || {}
+        decide_response[:featureFlagPayloads] = decide_response[:featureFlagPayloads] || {}
+        decide_response[:flags] = decide_response[:featureFlags].map do |key, value|
+          [key, FeatureFlag.from_value_and_payload(key, value, decide_response[:featureFlagPayloads][key])]
+        end.to_h
+      end
+      decide_response
     end
 
     def get_remote_config_payload(flag_key)
@@ -119,9 +139,19 @@ class PostHog
 
       flag_was_locally_evaluated = !response.nil?
 
+      request_id = nil
+
       if !flag_was_locally_evaluated && !only_evaluate_locally
         begin
-          flags = get_feature_variants(distinct_id, groups, person_properties, group_properties, true)
+          decide_data = get_all_flags_and_payloads(distinct_id, groups, person_properties, group_properties, false, true)
+          if !decide_data.key?(:featureFlags)
+            logger.debug "Missing feature flags key: #{decide_data.to_json}"
+            flags = {}
+          else
+            flags = stringify_keys(decide_data[:featureFlags] || {})
+            request_id = decide_data[:requestId]
+          end
+
           response = flags[key]
           if response.nil?
             response = false
@@ -132,7 +162,7 @@ class PostHog
         end
       end
 
-      [response, flag_was_locally_evaluated]
+      [response, flag_was_locally_evaluated, request_id]
     end
 
     def get_all_flags(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
@@ -142,7 +172,7 @@ class PostHog
       end
       # 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]
+      response[:featureFlags]
     end
 
     def get_all_flags_and_payloads(distinct_id, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false, raise_on_error = false)
@@ -151,6 +181,7 @@ class PostHog
       flags = {}
       payloads = {}
       fallback_to_decide = @feature_flags.empty?
+      request_id = nil # Only for /decide requests
 
       @feature_flags.each do |flag|
         begin
@@ -183,13 +214,14 @@ class PostHog
           else
             flags = stringify_keys(flags_and_payloads[:featureFlags] || {})
             payloads = stringify_keys(flags_and_payloads[:featureFlagPayloads] || {})
+            request_id = flags_and_payloads[:requestId]
           end
         rescue StandardError => e
           @on_error.call(-1, "Error computing flag remotely: #{e}")
           raise if raise_on_error
         end
       end
-      {"featureFlags": flags, "featureFlagPayloads": payloads}
+      {"featureFlags": flags, "featureFlagPayloads": payloads, "requestId": request_id}
     end
 
     def get_feature_flag_payload(key, distinct_id, match_value = nil, groups = {}, person_properties = {}, group_properties = {}, only_evaluate_locally = false)
@@ -534,7 +566,7 @@ class PostHog
     end
 
     def _request_feature_flag_evaluation(data={})
-      uri = URI("#{@host}/decide/?v=3")
+      uri = URI("#{@host}/decide/?v=4")
       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.7.2'
+  VERSION = '2.8.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: posthog-ruby
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.8.0
 platform: ruby
 authors:
 - ''
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -143,12 +142,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 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
 - lib/posthog/defaults.rb
+- lib/posthog/feature_flag.rb
 - lib/posthog/feature_flags.rb
 - lib/posthog/field_parser.rb
 - lib/posthog/logging.rb
@@ -163,7 +165,6 @@ homepage: https://github.com/PostHog/posthog-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -178,8 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.6
 specification_version: 4
 summary: PostHog library
 test_files: []