kameleoon-client-ruby 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05500f77891f22fd67b10f0dec830e6673a77d8ff83b391ffbf8547893bfcf1e
-  data.tar.gz: 4c572f1464af6e5026642e4fac03dcc1e1a99715228c76982c67de5063c2235e
+  metadata.gz: b5566ec9ff02ebb63ff3ee337f4c26fc0c229f2de8df0893fe85dc3f83fbc0ce
+  data.tar.gz: fcd11bacbaead7a0c357a0fd4828fb6c4b7347ebf1fab728f4e00882b0224dc7
 SHA512:
-  metadata.gz: b7ac1acb43bf56661f194dacc810b064e2c4cba67010b1af49d928c190ae53c139ee0447fb7e5f5670ae1fb0c406a0efb7e2c7fe0eedac323635dc0e215de869
-  data.tar.gz: 58278744be7aaef43a0e0dcbe71bf93ee9ab9c1aec3a0b6e6f296e940f24ce943ee7c7998a550ecf1950cbcb3f36cb78858feacea6289a2b8ce1c3439b4b037e
+  metadata.gz: 78418ebd561b9d1fe2639751d0dae68a875a4a76f4782ac079fe2f3f3c6e2b7466c41cb762e978b4895973a97ddf4940b10171d36c2695a565ed2e1b66445f53
+  data.tar.gz: b91b577c23c13547d78c09c98a2c39bb788a314b280b50c57bf1cc25891dd74747127aec2bc14b0a5a4908a2cde2d0e2089ec13c6f5200087b7c52bd80b7a68f

data/lib/kameleoon/configuration/custom_data_info.rb

@@ -13,16 +13,18 @@ module Kameleoon
       def initialize(hashes)
         @local_only = Set[]
         @visitor_scope = Set[]
+        @custom_data_index_by_id = {}
         unless hashes.nil?
           for hash in hashes
             index = hash['index']
             @local_only.add(index) if hash['localOnly']
             @visitor_scope.add(index) if hash['scope'] == SCOPE_VISITOR
+            id = hash['id']
+            @custom_data_index_by_id[id] = index if id && index
             if hash['isMappingIdentifier']
               unless @mapping_identifier_index.nil?
                 Logging::KameleoonLogger.warning('More than one mapping identifier is set. Undefined behavior ' \
                                           'may occur on cross-device reconciliation.')
-
               end
               @mapping_identifier_index = index
             end
@@ -42,6 +44,10 @@ module Kameleoon
         @visitor_scope.include?(index)
       end
 
+      def get_custom_data_index_by_id(custom_data_id)
+        @custom_data_index_by_id[custom_data_id]
+      end
+
       def self.mapping_identifier?(custom_data_info, custom_data)
         !custom_data_info.nil? && (custom_data.id == custom_data_info.mapping_identifier_index) && \
           !(custom_data.values.empty? || custom_data.values[0].empty?)

data/lib/kameleoon/configuration/data_file.rb

@@ -6,6 +6,7 @@ require 'kameleoon/configuration/feature_flag'
 require 'kameleoon/configuration/me_group'
 require 'kameleoon/configuration/settings'
 require 'kameleoon/logging/kameleoon_logger'
+require 'kameleoon/targeting/models'
 
 module Kameleoon
   module Configuration
@@ -69,18 +70,29 @@ module Kameleoon
       def init(configuration)
         Logging::KameleoonLogger.debug('CALL: DataFile.init(configuration: %s)', configuration)
         @settings = Settings.new(configuration['configuration'])
-        @feature_flags = {}
-        configuration['featureFlags'].each do |raw|
-          ff = FeatureFlag.new(raw)
-          @feature_flags[ff.feature_key] = ff
-        end
+        segments = parse_segments(configuration)
+        @custom_data_info = CustomDataInfo.new(configuration['customData'])
+        @feature_flags = parse_feature_flags(configuration, segments, @custom_data_info)
         @me_groups = make_me_groups(@feature_flags)
         @has_any_targeted_delivery_rule = any_targeted_delivery_rule?
-        @custom_data_info = CustomDataInfo.new(configuration['customData'])
         @holdout = Experiment.from_json(configuration['holdout']) if configuration.include?('holdout')
         Logging::KameleoonLogger.debug('RETURN: DataFile.init(configuration: %s)', configuration)
       end
 
+      def parse_segments(configuration)
+        configuration['segments'].to_h do |raw_seg|
+          seg = Targeting::Segment.new(raw_seg)
+          [seg.id, seg]
+        end
+      end
+
+      def parse_feature_flags(configuration, segments, cdi)
+        configuration['featureFlags'].to_h do |raw_ff|
+          ff = FeatureFlag.new(raw_ff, segments, cdi)
+          [ff.feature_key, ff]
+        end
+      end
+
       def any_targeted_delivery_rule?
         @feature_flags.any? { |_, ff| ff.environment_enabled && ff.rules.any?(&:targeted_delivery_type?) }
       end

data/lib/kameleoon/configuration/feature_flag.rb

@@ -8,7 +8,8 @@ module Kameleoon
   module Configuration
     # Class for manage all feature flags with rules
     class FeatureFlag
-      attr_accessor :id, :feature_key, :variations, :default_variation_key, :me_group_name, :environment_enabled, :rules
+      attr_reader :id, :feature_key, :variations, :default_variation_key, :me_group_name, :environment_enabled, :rules,
+                  :bucketing_custom_data_index
 
       def self.create_from_array(array)
         array&.map { |it| FeatureFlag.new(it) }
@@ -21,18 +22,21 @@ module Kameleoon
           "environment_enabled:#{@environment_enabled}," \
           "default_variation_key:'#{@default_variation_key}'," \
           "me_group_name:'#{@me_group_name}'," \
-          "rules:#{@rules.size}" \
+          "rules:#{@rules.size}," \
+          "bucketing_custom_data_index:#{@bucketing_custom_data_index}" \
           '}'
       end
 
-      def initialize(hash)
+      def initialize(hash, segments, cdi)
         @id = hash['id']
         @feature_key = hash['featureKey']
         @variations = Variation.create_from_array(hash['variations'])
         @default_variation_key = hash['defaultVariationKey']
         @me_group_name = hash['mutuallyExclusiveGroup']
         @environment_enabled = hash['environmentEnabled']
-        @rules = Rule.create_from_array(hash['rules'])
+        @rules = Rule.create_from_array(hash['rules'], segments)
+        bucketing_cd_id = hash['bucketingCustomDataId']
+        @bucketing_custom_data_index = bucketing_cd_id ? cdi.get_custom_data_index_by_id(bucketing_cd_id) : nil
       end
 
       def get_variation_by_key(key)

data/lib/kameleoon/configuration/rule.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'experiment'
-require 'kameleoon/targeting/models'
 
 module Kameleoon
   # Module which contains all internal data of SDK
@@ -32,22 +31,22 @@ module Kameleoon
       attr_reader :id, :order, :type, :exposition, :experiment, :respool_time, :segment_id
       attr_accessor :targeting_segment
 
-      def self.create_from_array(array)
-        array&.map { |it| Rule.new(it) }
+      def self.create_from_array(array, segments)
+        array&.map { |it| Rule.new(it, segments) }
       end
 
       def to_s
         "Rule{id:#{@id}}"
       end
 
-      def initialize(hash)
+      def initialize(hash, segments)
         @id = hash['id']
         @order = hash['order']
         @type = RuleType.from_literal(hash['type'])
         @exposition = hash['exposition']
         @respool_time = hash['respoolTime']
-        @targeting_segment = Kameleoon::Targeting::Segment.new((hash['segment'])) if hash['segment']
-        @segment_id = @targeting_segment != nil ? targeting_segment.id : -1
+        @segment_id = hash['segmentId'] || -1
+        @targeting_segment = segments[@segment_id] if @segment_id != -1
         @experiment = Experiment.from_json(hash)
       end
 

data/lib/kameleoon/data/cookie.rb

@@ -15,4 +15,3 @@ module Kameleoon
     end
   end
 end
-

data/lib/kameleoon/kameleoon_client.rb

@@ -933,7 +933,7 @@ module Kameleoon
       forced_variation = visitor&.get_forced_feature_variation(feature_flag.feature_key)
       if forced_variation
         eval_exp = EvaluatedExperiment.from_forced_variation(forced_variation)
-      elsif visitor_not_in_holdout?(visitor, visitor_code, track, save) && \
+      elsif visitor_not_in_holdout?(visitor, visitor_code, track, save, feature_flag.bucketing_custom_data_index) && \
             ff_unrestricted_by_me_group?(visitor, visitor_code, feature_flag)
         eval_exp = _calculate_variation_key_for_feature(visitor_code, feature_flag)
       end
@@ -955,7 +955,7 @@ module Kameleoon
       unrestricted = true
       me_group = @data_manager.data_file.me_groups[feature_flag.me_group_name]
       if me_group
-        code_for_hash = get_code_for_hash(visitor, visitor_code)
+        code_for_hash = get_code_for_hash(visitor, visitor_code, feature_flag.bucketing_custom_data_index)
         me_group_hash = Utils::Hasher.obtain_hash_for_me_group(code_for_hash, feature_flag.me_group_name)
         Logging::KameleoonLogger.debug(
           "Calculated ME group hash %s for code: '%s', meGroup: '%s'",
@@ -970,17 +970,17 @@ module Kameleoon
       unrestricted
     end
 
-    def visitor_not_in_holdout?(visitor, visitor_code, track, save)
+    def visitor_not_in_holdout?(visitor, visitor_code, track, save, bucketing_custom_data_index)
       holdout = @data_manager.data_file.holdout
       return true if holdout.nil?
 
       in_holdout_variation_key = 'in-holdout'
       Logging::KameleoonLogger.debug(
-        "CALL: KameleoonClient.visitor_not_in_holdout?(visitor, visitor_code: '%s', track: %s, save: %s)",
-        visitor_code, track, save
+        "CALL: KameleoonClient.visitor_not_in_holdout?(visitor, visitor_code: '%s', track: %s, save: %s, " \
+        'bucketing_custom_data_index: %s)', visitor_code, track, save, bucketing_custom_data_index
       )
       is_not_in_holdout = true
-      code_for_hash = get_code_for_hash(visitor, visitor_code)
+      code_for_hash = get_code_for_hash(visitor, visitor_code, bucketing_custom_data_index)
       variation_hash = Utils::Hasher.obtain(code_for_hash, holdout.id)
       Logging::KameleoonLogger.debug("Calculated holdout hash %s for code '%s'", variation_hash, code_for_hash)
       var_by_exp = holdout.get_variation(variation_hash)
@@ -992,9 +992,9 @@ module Kameleoon
         end
       end
       Logging::KameleoonLogger.debug(
-        "RETURN: KameleoonClient.visitor_not_in_holdout?(visitor, visitor_code: '%s', track: %s, save: %s)" \
-        ' -> (is_not_in_holdout: %s)',
-        visitor_code, track, save, is_not_in_holdout
+        "RETURN: KameleoonClient.visitor_not_in_holdout?(visitor, visitor_code: '%s', track: %s, save: %s, " \
+        'bucketing_custom_data_index: %s) -> (is_not_in_holdout: %s)',
+        visitor_code, track, save, bucketing_custom_data_index, is_not_in_holdout
       )
       is_not_in_holdout
     end
@@ -1038,16 +1038,24 @@ module Kameleoon
       )
     end
 
-    def get_code_for_hash(visitor, visitor_code)
-      # use mappingIdentifier instead of visitor_code if it was set up
-      visitor&.mapping_identifier || visitor_code
+    def get_code_for_hash(visitor, visitor_code, bucketing_custom_data_index)
+      return visitor_code if visitor.nil?
+
+      # 1. Try to use the bucketing custom data's value if bucketingCustomDataId is defined
+      if bucketing_custom_data_index
+        bucketing_custom_data = visitor.custom_data.get(bucketing_custom_data_index)
+        return bucketing_custom_data.values[0] if bucketing_custom_data && !bucketing_custom_data.values.empty?
+      end
+      # 2. Use mappingIdentifier instead of visitorCode if it was set up
+      visitor.mapping_identifier || visitor_code
     end
 
-    def evaluate_cbscores(visitor, visitor_code, rule)
+    def evaluate_cbscores(visitor, visitor_code, rule, bucketing_custom_data_index)
       return nil if visitor&.cbscores.nil?
 
       Logging::KameleoonLogger.debug(
-        "CALL: KameleoonClient.evaluate_cbscores(visitor, visitor_code: '%s', rule: %s)", visitor_code, rule
+        "CALL: KameleoonClient.evaluate_cbscores(visitor, visitor_code: '%s', rule: %s, " \
+        'bucketing_custom_data_index: %s)', visitor_code, rule, bucketing_custom_data_index
       )
       eval_exp = nil
       var_id_group_by_scores = visitor.cbscores.values[rule.experiment.id]
@@ -1062,7 +1070,7 @@ module Kameleoon
         if (var_by_exp_in_cbs&.size || 0).positive?
           size = var_by_exp_in_cbs.size
           if size > 1
-            code_for_hash = get_code_for_hash(visitor, visitor_code)
+            code_for_hash = get_code_for_hash(visitor, visitor_code, bucketing_custom_data_index)
             variation_hash = Utils::Hasher.obtain(code_for_hash, rule.experiment.id, rule.respool_time)
             Logging::KameleoonLogger.debug("Calculated CBS hash %s for code '%s'", variation_hash, code_for_hash)
             idx = [(variation_hash * size).to_i, size - 1].min
@@ -1073,8 +1081,8 @@ module Kameleoon
         end
       end
       Logging::KameleoonLogger.debug(
-        "RETURN: KameleoonClient.evaluate_cbscores(visitor, visitor_code: '%s', rule: %s) -> (eval_exp: %s)",
-        visitor_code, rule, eval_exp
+        "RETURN: KameleoonClient.evaluate_cbscores(visitor, visitor_code: '%s', rule: %s," \
+        'bucketing_custom_data_index: %s) -> (eval_exp: %s)', visitor_code, rule, bucketing_custom_data_index, eval_exp
       )
       eval_exp
     end
@@ -1087,7 +1095,7 @@ module Kameleoon
         visitor_code, feature_flag
       )
       visitor = @visitor_manager.get_visitor(visitor_code)
-      code_for_hash = get_code_for_hash(visitor, visitor_code)
+      code_for_hash = get_code_for_hash(visitor, visitor_code, feature_flag.bucketing_custom_data_index)
       # no rules -> return default_variation_key
       eval_exp = nil
       feature_flag.rules.each do |rule|
@@ -1110,7 +1118,7 @@ module Kameleoon
         Logging::KameleoonLogger.debug("Calculated rule hash %s for code '%s'", hash_rule, code_for_hash)
         # check main expostion for rule with hashRule
         if hash_rule <= rule.exposition
-          eval_exp = evaluate_cbscores(visitor, visitor_code, rule)
+          eval_exp = evaluate_cbscores(visitor, visitor_code, rule, feature_flag.bucketing_custom_data_index)
           break unless eval_exp.nil?
 
           if rule.targeted_delivery_type?

data/lib/kameleoon/network/content_type.rb

@@ -3,6 +3,7 @@
 module Kameleoon
   module Network
     module ContentType
+      WILDCARD = '*/*'
       TEXT = 'text/plain'
       JSON = 'application/json'
       FORM = 'application/x-www-form-urlencoded'

data/lib/kameleoon/network/network_manager.rb

@@ -66,7 +66,7 @@ module Kameleoon
 
         url = @url_provider.make_tracking_url
         timeout = ensure_timeout(timeout)
-        request = Request.new(Method::POST, url, ContentType::TEXT, timeout, data: lines)
+        request = Request.new(Method::POST, url, ContentType::WILDCARD, timeout, data: lines)
         unwrap_response(*make_call(request, true, TRACKING_CALL_ATTEMPT_NUMBER - 1, TRACKING_CALL_RETRY_DELAY))
       end
 

data/lib/kameleoon/network/url_provider.rb

@@ -19,7 +19,7 @@ module Kameleoon
       DEFAULT_ACCESS_TOKEN_DOMAIN = 'api.kameleoon.com'
       DEFAULT_DATA_API_DOMAIN = 'data.kameleoon.io'
 
-      CONFIGURATION_API_URL_FORMAT = 'https://%s/%s'
+      CONFIGURATION_API_URL_FORMAT = 'https://%s/v3/%s'
       DATA_API_URL_FORMAT = 'https://%s%s?%s'
       RT_CONFIGURATION_URL_FORMAT = 'https://%s:8110/sse?%s'
       ACCESS_TOKEN_URL_FORMAT = 'https://%s/oauth/token'

data/lib/kameleoon/targeting/models.rb

@@ -9,6 +9,7 @@ module Kameleoon
     class Segment
       include TreeBuilder
       attr_accessor :id, :tree
+
       def to_s
         @tree.to_s
       end
@@ -84,13 +85,13 @@ module Kameleoon
           # Computing results
           if is_left_child_targeted.nil?
             if is_right_child_targeted == @or_operator
-              is_targeted = Marshal.load(Marshal.dump(@or_operator)) #Deep copy
+              is_targeted = Marshal.load(Marshal.dump(@or_operator)) # Deep copy
             else
               is_targeted = nil
             end
           else
             if is_left_child_targeted == @or_operator
-              is_targeted = Marshal.load(Marshal.dump(@or_operator)) #Deep copy
+              is_targeted = Marshal.load(Marshal.dump(@or_operator)) # Deep copy
             else
               if is_right_child_targeted == true
                 is_targeted = true
@@ -102,7 +103,7 @@ module Kameleoon
             end
           end
         end
-        Marshal.load(Marshal.dump(is_targeted)) #Deep copy
+        Marshal.load(Marshal.dump(is_targeted)) # Deep copy
       end
 
       def check_condition(datas, condition = @condition)

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.13.0'
+  SDK_VERSION = '3.14.0'
   SDK_NAME = 'RUBY'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kameleoon-client-ruby
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2025-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request