kameleoon-client-ruby 3.16.2 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602844d249763c9165d740e924c71b8d98efbfdb77c8f70ef4cd0ad361dfb86f
-  data.tar.gz: 1a9ee1ce8a3b3548f38ba19f21d3f0de86aeba513549405870bcd3150a617608
+  metadata.gz: a9254260f1962a3abfa79d2a583188660b28540faea927f0eb04efc1898dc4c0
+  data.tar.gz: 231728dd53a2e4662b4b705fa63905a10a1b5598eb1875e1959a4124cf6334da
 SHA512:
-  metadata.gz: 8988b718fac058005be7ac57bc7519c9cc8ad4e6dd95d03e2505e3210eea483fc619362959b8af6788d5ee5f06045f52941b27cbca57f0b11b82c45e63e92612
-  data.tar.gz: 41c1a2c1c2a7903dd352b5fe3a515d4f2639656eb05de89a19791e2d50ae0c4ef5b4336649491e2dc358dd55c51e92ab1e411132a7c7b1cd9784735c6bae3e81
+  metadata.gz: d90ed8a74b0e64bd244f85c79381bdaad76adff7103cd1c1afde6578d98b4838d53f8466040b6fa6537706e91eb6589d0c558193be892b0ddb6785d93e4894de
+  data.tar.gz: 33dca1c8fcde8dcb441dd9eb001b329d4798a9900411c98a1a020331a832734d52f74d2e7b9204ffe5576f6c4cc8a0039610214e6b7fa1e9bd82ad6e12f2d8f1

data/lib/kameleoon/configuration/data_file.rb

@@ -46,8 +46,12 @@ module Kameleoon
       def get_feature_flag(feature_key)
         ff = @feature_flags[feature_key]
         raise Exception::FeatureNotFound, feature_key if ff.nil?
-        raise Exception::FeatureEnvironmentDisabled.new(feature_key, @environment) unless ff.environment_enabled
 
+        unless ff.environment_enabled
+          env = @environment.nil? ? 'default' : "'#{@environment}'"
+          msg = "Feature '#{feature_key}' is disabled for #{env} environment'"
+          raise Exception::FeatureEnvironmentDisabled, msg
+        end
         ff
       end
 

data/lib/kameleoon/configuration/settings.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'kameleoon/logging/kameleoon_logger'
+
 module Kameleoon
   # Module which contains all internal data of SDK
   module Configuration
@@ -7,7 +9,7 @@ module Kameleoon
     # state of real time update for site code and etc
     class Settings
       attr_accessor :real_time_update
-      attr_reader :is_consent_required, :data_api_domain
+      attr_reader :is_consent_required, :blocking_behaviour_if_consent_not_given, :data_api_domain
 
       def to_s
         "Settings{real_time_update:#{@real_time_update},is_consent_required:#{@is_consent_required}," \
@@ -18,13 +20,37 @@ module Kameleoon
         if configuration.nil?
           @real_time_update = false
           @is_consent_required = false
+          @blocking_behaviour_if_consent_not_given = ConsentBlockingBehaviour::PARTIALLY_BLOCKED
           @data_api_domain = nil
         else
           @real_time_update = configuration['realTimeUpdate'] || false
           @is_consent_required = configuration['consentType'] == 'REQUIRED'
+          @blocking_behaviour_if_consent_not_given =
+            ConsentBlockingBehaviour.from_str(configuration['consentOptOutBehavior'])
           @data_api_domain = configuration['dataApiDomain']
         end
       end
     end
+
+    # ConsentBlockingBehaviour
+    module ConsentBlockingBehaviour
+      PARTIALLY_BLOCKED = 0
+      COMPLETELY_BLOCKED = 1
+
+      PARTIALLY_BLOCKED_STR = 'PARTIALLY_BLOCK'
+      COMPLETELY_BLOCKED_STR = 'FULLY_BLOCK'
+
+      def self.from_str(str)
+        case str
+        when PARTIALLY_BLOCKED_STR
+          PARTIALLY_BLOCKED
+        when COMPLETELY_BLOCKED_STR
+          COMPLETELY_BLOCKED
+        else
+          Logging::KameleoonLogger.warning("Unexpected consent blocking type '%s'", str)
+          PARTIALLY_BLOCKED
+        end
+      end
+    end
   end
 end

data/lib/kameleoon/configuration/variation.rb

@@ -12,7 +12,7 @@ module Kameleoon
 
     # Variation of feature flag
     class Variation
-      attr_accessor :key, :variables
+      attr_reader :key, :variables, :name
 
       def self.create_from_array(array)
         array&.map { |it| Variation.new(it) }
@@ -21,6 +21,7 @@ module Kameleoon
       def initialize(hash)
         @key = hash['key']
         @variables = Variable.create_from_array(hash['variables'])
+        @name = hash['name'] || ''
       end
 
       def get_variable_by_key(key)

data/lib/kameleoon/data/manager/legal_consent.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module DataManager
+    module LegalConsent
+      UNKNOWN = 0
+      GIVEN = 1
+      NOT_GIVEN = 2
+    end
+  end
+end

data/lib/kameleoon/data/manager/visitor.rb

@@ -18,6 +18,7 @@ require 'kameleoon/data/manager/data_array_storage'
 require 'kameleoon/data/manager/data_map_storage'
 require 'kameleoon/data/manager/forced_experiment_variation'
 require 'kameleoon/data/manager/forced_feature_variation'
+require 'kameleoon/data/manager/legal_consent'
 require 'kameleoon/data/manager/page_view_visit'
 require 'kameleoon/logging/kameleoon_logger'
 
@@ -312,7 +313,7 @@ module Kameleoon
         Logging::KameleoonLogger.debug('CALL: VisitorData.new')
         @time_started = (Time.now.to_f * 1000).to_i
         @mutex = Concurrent::ReadWriteLock.new
-        @legal_consent = false
+        @legal_consent = LegalConsent::UNKNOWN
         Logging::KameleoonLogger.debug('RETURN: VisitorData.new')
       end
 

data/lib/kameleoon/exceptions.rb

@@ -53,10 +53,6 @@ module Kameleoon
 
     # Feature Environment Disabled
     class FeatureEnvironmentDisabled < FeatureError
-      def initialize(feature_key, environment = nil)
-        environment = environment.nil? ? 'default' : "'#{environment}'"
-        super("Feature '#{feature_key}' is disabled for #{environment} environment'")
-      end
     end
 
     # Config Error

data/lib/kameleoon/kameleoon_client.rb

@@ -8,6 +8,7 @@ require 'kameleoon/data/custom_data'
 require 'kameleoon/data/user_agent'
 require 'kameleoon/data/manager/assigned_variation'
 require 'kameleoon/data/manager/forced_experiment_variation'
+require 'kameleoon/data/manager/legal_consent'
 require 'kameleoon/data/manager/visitor_manager'
 require 'kameleoon/exceptions'
 require 'kameleoon/hybrid/manager'
@@ -27,6 +28,9 @@ require 'kameleoon/targeting/models'
 require 'kameleoon/targeting/targeting_manager'
 require 'kameleoon/types/variable'
 require 'kameleoon/types/variation'
+require 'kameleoon/types/rule'
+require 'kameleoon/types/feature_flag'
+require 'kameleoon/types/data_file'
 require 'rufus/scheduler'
 require 'yaml'
 require 'json'
@@ -123,8 +127,9 @@ module Kameleoon
     # visitor_code = get_visitor_code(cookies, 'my-domaine.com')
     #
     def get_visitor_code(cookies, default_visitor_code = nil)
-      Logging::KameleoonLogger.info("CALL: KameleoonClient.get_visitor_code(cookies: %s, default_visitor_code: '%s')",
-                           cookies, default_visitor_code)
+      Logging::KameleoonLogger.info(
+        "CALL: KameleoonClient.get_visitor_code(cookies: %s, default_visitor_code: '%s')", cookies, default_visitor_code
+      )
       visitor_code = @cookie_manager.get_or_add(cookies, default_visitor_code)
       Logging::KameleoonLogger.info(
         "RETURN: KameleoonClient.get_visitor_code(cookies: %s, default_visitor_code: '%s') -> (visitor_code: '%s')",
@@ -140,7 +145,7 @@ module Kameleoon
       )
       Utils::VisitorCode.validate(visitor_code)
       visitor = @visitor_manager.get_or_create_visitor(visitor_code)
-      visitor.legal_consent = consent
+      visitor.legal_consent = consent ? DataManager::LegalConsent::GIVEN : DataManager::LegalConsent::NOT_GIVEN
       @cookie_manager.update(visitor_code, consent, cookies)
       Logging::KameleoonLogger.info(
         "RETURN: KameleoonClient.set_legal_consent(visitor_code: '%s', consent: %s, cookies: %s)",
@@ -366,7 +371,11 @@ module Kameleoon
       @data_manager.data_file.feature_flags.each_value do |feature_flag|
         next unless feature_flag.environment_enabled
 
-        variation_key, eval_exp = get_variation_info(visitor_code, feature_flag, track)
+        begin
+          variation_key, eval_exp = get_variation_info(visitor_code, feature_flag, track)
+        rescue Exception::FeatureEnvironmentDisabled
+          next
+        end
         next if only_active && (variation_key == Configuration::VariationType::VARIATION_OFF)
 
         variation = feature_flag.get_variation_by_key(variation_key)
@@ -631,7 +640,11 @@ module Kameleoon
       @data_manager.data_file.feature_flags.each do |feature_key, feature_flag|
         next unless feature_flag.environment_enabled
 
-        eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
+        begin
+          eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
+        rescue Exception::FeatureEnvironmentDisabled
+          next
+        end
         variation_key = calculate_variation_key(eval_exp, feature_flag.default_variation_key)
         list_keys.push(feature_key) if variation_key != Kameleoon::Configuration::VariationType::VARIATION_OFF
       end
@@ -666,7 +679,11 @@ module Kameleoon
       @data_manager.data_file.feature_flags.each_value do |feature_flag|
         next unless feature_flag.environment_enabled
 
-        eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
+        begin
+          eval_exp = evaluate(visitor, visitor_code, feature_flag, false, false)
+        rescue Exception::FeatureEnvironmentDisabled
+          next
+        end
         variation_key = calculate_variation_key(eval_exp, feature_flag.default_variation_key)
 
         next if variation_key == Configuration::VariationType::VARIATION_OFF
@@ -779,6 +796,52 @@ module Kameleoon
       Logging::KameleoonLogger.info("RETURN: KameleoonClient.evaluate_audiences(visitor_code: '%s')", visitor_code)
     end
 
+    ##
+    # Retrieves the current SDK configuration (also known as the data file),
+    # containing all feature flags and their variations.
+    #
+    # @return [Kameleoon::Types::DataFile] The current DataFile instance.
+    def get_data_file
+      Logging::KameleoonLogger.info('CALL: KameleoonClient.get_data_file')
+
+      feature_flags_map = @data_manager.data_file.feature_flags.transform_values do |source_feature_flag|
+        # Collect variations
+        variations_map = source_feature_flag.variations.each_with_object({}) do |variation, variations_map|
+          variables_map = variation.variables.each_with_object({}) do |var, variables_map|
+            variables_map[var.key] = Types::Variable.new(var.key, var.type, _parse_feature_variable(var))
+          end
+          variations_map[variation.key] = Types::Variation.new(variation.key, nil, nil, variables_map, variation.name)
+        end
+
+        # Collect rules
+        rules = source_feature_flag.rules.map do |rule|
+          rule_variations = rule.experiment.variations_by_exposition.each_with_object({}) do |var_by_exp, rule_variations|
+            base_variation = variations_map[var_by_exp.variation_key]
+            next unless base_variation
+            rule_variations[base_variation.key] = Types::Variation.new(
+              base_variation.key,
+              var_by_exp.variation_id,
+              rule.experiment.id,
+              base_variation.variables,
+              base_variation.name
+            )
+          end
+          Types::Rule.new(rule_variations)
+        end
+
+        Types::FeatureFlag.new(
+          variations_map,
+          source_feature_flag.environment_enabled,
+          rules,
+          source_feature_flag.default_variation_key
+        )
+      end
+
+      data_file = Types::DataFile.new(feature_flags_map)
+      Logging::KameleoonLogger.info('RETURN: KameleoonClient.get_data_file -> (data_file: %s)', data_file)
+      data_file
+    end
+
     private
 
     HYBRID_EXPIRATION_TIME = 5
@@ -1116,6 +1179,9 @@ module Kameleoon
         visitor_code, feature_flag
       )
       visitor = @visitor_manager.get_visitor(visitor_code)
+      datafile = @data_manager.data_file
+      consent = datafile.settings.is_consent_required ?
+        visitor&.legal_consent || DataManager::LegalConsent::UNKNOWN : DataManager::LegalConsent::GIVEN
       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
@@ -1139,6 +1205,16 @@ 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
+          # Checking if the evaluation is blocked due to the consent policy
+          if (consent == DataManager::LegalConsent::NOT_GIVEN) && rule.experimentation_type?
+            blocking_behaviour = datafile.settings.blocking_behaviour_if_consent_not_given
+            break if blocking_behaviour == Configuration::ConsentBlockingBehaviour::PARTIALLY_BLOCKED
+
+            # TODO: In the next major, create a new error type for the Completely Blocked by Consent error
+            msg = "Evaluation of #{rule} is blocked because consent is not provided for visitor '#{visitor_code}'"
+            raise Exception::FeatureEnvironmentDisabled, msg
+          end
+          # Checking CBS
           eval_exp = evaluate_cbscores(visitor, visitor_code, rule, feature_flag.bucketing_custom_data_index)
           break unless eval_exp.nil?
 
@@ -1193,7 +1269,11 @@ module Kameleoon
       end
       ext_variables.freeze
       ext_variation = Types::Variation.new(
-        variation&.key, eval_exp&.var_by_exp&.variation_id, eval_exp&.experiment&.id, ext_variables
+        variation&.key || '',
+        eval_exp&.var_by_exp&.variation_id,
+        eval_exp&.experiment&.id,
+        ext_variables,
+        variation&.name || ''
       )
       Logging::KameleoonLogger.debug(
         'RETURN: KameleoonClient.create_external_variation(variation: %s, eval_exp: %s) -> (ext_variation: %s)',

data/lib/kameleoon/managers/tracking/tracking_builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'kameleoon/data/custom_data'
+require 'kameleoon/data/manager/legal_consent'
 require 'kameleoon/logging/kameleoon_logger'
 require 'kameleoon/network/activity_event'
 require 'kameleoon/network/uri_helper'
@@ -65,7 +66,8 @@ module Kameleoon
         end
 
         def consent_given?(visitor)
-          !@data_file.settings.is_consent_required || visitor&.legal_consent
+          !@data_file.settings.is_consent_required ||
+            ((visitor&.legal_consent || DataManager::LegalConsent::UNKNOWN) == DataManager::LegalConsent::GIVEN)
         end
 
         def collect_tracking_data(visitor_code, visitor, is_consent_given)

data/lib/kameleoon/network/cookie/cookie_manager.rb

@@ -45,16 +45,13 @@ module Kameleoon
         def update(visitor_code, consent, cookies)
           return if cookies.nil?
 
-          Logging::KameleoonLogger.debug("CALL: CookieManager.update(visitor_code: '%s', consent: %s, cookies: %s)",
-                                         visitor_code, consent, cookies)
-
-          if consent
-            add(visitor_code, cookies)
-          else
-            remove(cookies)
-          end
-          Logging::KameleoonLogger.debug("RETURN: CookieManager.update(visitor_code: '%s', consent: %s, cookies: %s)",
-                                         visitor_code, consent, cookies)
+          Logging::KameleoonLogger.debug(
+            "CALL: CookieManager.update(visitor_code: '%s', consent: %s, cookies: %s)", visitor_code, consent, cookies
+          )
+          add(visitor_code, cookies) if consent
+          Logging::KameleoonLogger.debug(
+            "RETURN: CookieManager.update(visitor_code: '%s', consent: %s, cookies: %s)", visitor_code, consent, cookies
+          )
         end
 
         private
@@ -79,7 +76,7 @@ module Kameleoon
           visitor_code = default_visitor_code
           Utils::VisitorCode.validate(visitor_code)
           Logging::KameleoonLogger.debug("Used default visitor code '{%s}'", default_visitor_code)
-          add(visitor_code, cookies)
+          add(visitor_code, cookies) unless @data_manager.visitor_code_managed?
           visitor_code
         end
 
@@ -100,13 +97,6 @@ module Kameleoon
           cookies
         end
 
-        def remove(cookies)
-          Logging::KameleoonLogger.debug('CALL: CookieManager.remove(cookies: %s)', cookies)
-          cookies[VISITOR_CODE_COOKIE] = nil if @data_manager.visitor_code_managed?
-          Logging::KameleoonLogger.debug('RETURN: CookieManager.remove(cookies: %s)', cookies)
-          cookies
-        end
-
         def process_simulated_variations(cookies, visitor_code)
           raw = get_value_from_cookies(cookies, KAMELEOON_SIMULATION_FF_DATA)
           return if raw.nil?

data/lib/kameleoon/network/net_provider.rb

@@ -28,6 +28,22 @@ module Kameleoon
 
     class SyncNetProvider < NetProvider
       def make_request(request)
+        for _ in 0..8 do
+          response = make_single_request(request)
+          break if (response.code != 307) && (response.code != 308)
+
+          # supports only absolute urls
+          new_loc = response.headers['location'][0]
+          break unless new_loc
+
+          request.redirect(new_loc)
+        end
+        response
+      end
+
+      private
+
+      def make_single_request(request)
         resp = nil
         case request.method
         when Method::GET

data/lib/kameleoon/network/request.rb

@@ -31,6 +31,10 @@ module Kameleoon
       def authorize(access_token)
         @access_token = access_token
       end
+
+      def redirect(new_loc)
+        @url = new_loc
+      end
     end
   end
 end

data/lib/kameleoon/targeting/condition_factory.rb

@@ -29,7 +29,8 @@ module Kameleoon
     # Module for create different targeting conditions
     module ConditionFactory
       def get_condition(condition_json)
-        case condition_json['targetingType']
+        cond_type = condition_json['targetingType']
+        case cond_type
         when ConditionType::CUSTOM_DATUM
           CustomDatum.new(condition_json)
         when ConditionType::TARGET_FEATURE_FLAG
@@ -77,6 +78,7 @@ module Kameleoon
         when ConditionType::HEAT_SLICE
           KcsHeatRangeCondition.new(condition_json)
         else
+          Logging::KameleoonLogger.info("Unexpected TargetingConditionType: '%s'", cond_type)
           UnknownCondition.new(condition_json)
         end
       end

data/lib/kameleoon/types/data_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Types
+    # DataFile
+    class DataFile
+      attr_reader :feature_flags
+
+      # @api private
+      def initialize(feature_flags)
+        @feature_flags = feature_flags
+      end
+
+      def to_s
+        "DataFile{feature_flags:#{@feature_flags}}"
+      end
+    end
+  end
+end

data/lib/kameleoon/types/feature_flag.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Types
+    # FeatureFlag
+    class FeatureFlag
+      attr_reader :variations, :environment_enabled, :rules, :default_variation_key
+
+      # @api private
+      def initialize(variations, environment_enabled, rules, default_variation_key)
+        @variations = variations
+        @environment_enabled = environment_enabled
+        @rules = rules
+        @default_variation_key = default_variation_key
+      end
+
+      def default_variation
+        @variations[@default_variation_key]
+      end
+
+      def to_s
+        "FeatureFlag{variations:#{@variations},environment_enabled:#{@environment_enabled},rules:#{@rules},default_variation_key:#{@default_variation_key}}"
+      end
+    end
+  end
+end

data/lib/kameleoon/types/remote_visitor_data_filter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  # Module which contains all internal data of SDK
   module Types
     class RemoteVisitorDataFilter
       attr_reader :previous_visit_amount, :current_visit, :custom_data, :page_views, :geolocation, :device, :browser,

data/lib/kameleoon/types/rule.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Types
+    # Rule
+    class Rule
+      attr_reader :variations
+
+      # @api private
+      def initialize(variations)
+        @variations = variations
+      end
+
+      def to_s
+        "Rule{variations:#{@variations}}"
+      end
+    end
+  end
+end

data/lib/kameleoon/types/variable.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  # Module which contains all internal data of SDK
   module Types
     # Variable
     class Variable
@@ -11,6 +10,7 @@ module Kameleoon
         "Variable{key:'#{@key}',type:'#{@type}',value:#{@value}}"
       end
 
+      # @api private
       def initialize(key, type, value)
         @key = key
         @type = type

data/lib/kameleoon/types/variation.rb

@@ -3,21 +3,22 @@
 require 'kameleoon/configuration/variation'
 
 module Kameleoon
-  # Module which contains all internal data of SDK
   module Types
     # Variation
     class Variation
-      attr_reader :key, :id, :experiment_id, :variables
+      attr_reader :name, :key, :id, :experiment_id, :variables
 
       def to_s
-        "Variation{key:'#{@key}',id:#{@id},experiment_id:#{@experiment_id},variables:#{@variables}}"
+        "Variation{name:'#{@name}',key:'#{@key}',id:#{@id},experiment_id:#{@experiment_id},variables:#{@variables}}"
       end
 
-      def initialize(key, id, experiment_id, variables)
+      # @api private
+      def initialize(key, id, experiment_id, variables, name = '')
         @key = key
         @id = id
         @experiment_id = experiment_id
         @variables = variables
+        @name = name
       end
 
       def active?

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.16.2'
+  SDK_VERSION = '3.17.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.16.2
+  version: 3.17.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-10-31 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -101,6 +101,7 @@ files:
 - lib/kameleoon/data/manager/forced_experiment_variation.rb
 - lib/kameleoon/data/manager/forced_feature_variation.rb
 - lib/kameleoon/data/manager/forced_variation.rb
+- lib/kameleoon/data/manager/legal_consent.rb
 - lib/kameleoon/data/manager/page_view_visit.rb
 - lib/kameleoon/data/manager/visitor.rb
 - lib/kameleoon/data/manager/visitor_manager.rb
@@ -178,7 +179,10 @@ files:
 - lib/kameleoon/targeting/models.rb
 - lib/kameleoon/targeting/targeting_manager.rb
 - lib/kameleoon/targeting/tree_builder.rb
+- lib/kameleoon/types/data_file.rb
+- lib/kameleoon/types/feature_flag.rb
 - lib/kameleoon/types/remote_visitor_data_filter.rb
+- lib/kameleoon/types/rule.rb
 - lib/kameleoon/types/variable.rb
 - lib/kameleoon/types/variation.rb
 - lib/kameleoon/utils.rb