kameleoon-client-ruby 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a64d8edfee07c22561b166de49f9185d89a6fbdec9b49f6fd65860125bd54eab
-  data.tar.gz: ee7ccf78d0d11dec198b930e77e496c39a220b87471d724015c78114b85368f8
+  metadata.gz: 8d0ea98aa7ca7ea1585f83f6bd231aa577a774124b4332d18ca4e2c2649bfbc2
+  data.tar.gz: ec43717ed1dd3a61828a9c062f10040a7e214e070f30f6deb2a76bec9d60fb76
 SHA512:
-  metadata.gz: ccfba38b35f50d2b1dda0ef2bf31406f74fd92663276f4297ae867bc7b88b8606b345a8a4234f24ef71c71fdc3555cc9852d7324c1a6a668ed8b6cbc98cfeedb
-  data.tar.gz: 38543c67b7c8949ccba5c8e0f08eae86d2755a737bc25a5dc82e94dd92011c7678cb4b32647ffae0edb606913bff537455f2f42295fe9f421554726a57675808
+  metadata.gz: bec6bd1d823d247b5b1e561e621f454e4d451bec12fb1312dc2a9f348f1e2ccbcc884e6927bae254da107e6314e4d91acad9bb1ef67012d96b62a34253f2978f
+  data.tar.gz: d5f5c2c4d85b5d2f706d35fc77f3bc5ce8b6e24ce56413e5d9086fd95aae0d8adf1bbe37a6b5d041f389575db0c8c3815e005a78a7a9d45f255a9325b4f11c46

data/lib/kameleoon/configuration/data_file.rb

@@ -3,15 +3,16 @@
 require 'kameleoon/configuration/custom_data_info'
 require 'kameleoon/configuration/experiment'
 require 'kameleoon/configuration/feature_flag'
+require 'kameleoon/configuration/me_group'
 require 'kameleoon/configuration/settings'
 require 'kameleoon/logging/kameleoon_logger'
 
 module Kameleoon
   module Configuration
     class DataFile
-      attr_reader :settings, :feature_flags, :has_any_targeted_delivery_rule, :feature_flag_by_id, :rule_by_segment_id,
-                  :rule_info_by_exp_id, :variation_by_id, :custom_data_info, :experiment_ids_with_js_css_variable,
-                  :holdout
+      attr_reader :settings, :feature_flags, :me_groups, :has_any_targeted_delivery_rule, :feature_flag_by_id,
+                  :rule_by_segment_id, :rule_info_by_exp_id, :variation_by_id, :custom_data_info,
+                  :experiment_ids_with_js_css_variable, :holdout
 
       def to_s
         'DataFile{' \
@@ -51,6 +52,7 @@ module Kameleoon
         Logging::KameleoonLogger.debug('CALL: DataFile.init_default')
         @settings = Settings.new
         @feature_flags = {}
+        @me_groups = {}
         @has_any_targeted_delivery_rule = false
         @custom_data_info = Kameleoon::Configuration::CustomDataInfo.new(nil)
         Logging::KameleoonLogger.debug('RETURN: DataFile.init_default')
@@ -64,6 +66,7 @@ module Kameleoon
           ff = FeatureFlag.new(raw)
           @feature_flags[ff.feature_key] = ff
         end
+        @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')
@@ -101,6 +104,21 @@ module Kameleoon
         @experiment_ids_with_js_css_variable.freeze
       end
 
+      def make_me_groups(feature_flags)
+        me_group_lists = {}
+        feature_flags.each_value do |feature_flag|
+          next if feature_flag.me_group_name.nil?
+
+          me_group_list = me_group_lists[feature_flag.me_group_name]
+          if me_group_list
+            me_group_list.push(feature_flag)
+          else
+            me_group_lists[feature_flag.me_group_name] = [feature_flag]
+          end
+        end
+        me_group_lists.transform_values { |me_group_list| MEGroup.new(me_group_list) }
+      end
+
       def feature_flag_variable_js_css?(feature_flag)
         feature_flag.variations.first&.variables&.any? do |variable|
           %w[JS CSS].include?(variable.type)

data/lib/kameleoon/configuration/feature_flag.rb

@@ -8,7 +8,7 @@ module Kameleoon
   module Configuration
     # Class for manage all feature flags with rules
     class FeatureFlag
-      attr_accessor :id, :feature_key, :variations, :default_variation_key, :environment_enabled, :rules
+      attr_accessor :id, :feature_key, :variations, :default_variation_key, :me_group_name, :environment_enabled, :rules
 
       def self.create_from_array(array)
         array&.map { |it| FeatureFlag.new(it) }
@@ -16,10 +16,11 @@ module Kameleoon
 
       def to_s
         'FeatureFlag{' \
-          "id:#{@id}, " \
-          "feature_key:#{@feature_key}, " \
-          "environment_enabled:#{@environment_enabled}, " \
-          "default_variation_key:#{@default_variation_key}, " \
+          "id:#{@id}," \
+          "feature_key:'#{@feature_key}'," \
+          "environment_enabled:#{@environment_enabled}," \
+          "default_variation_key:'#{@default_variation_key}'," \
+          "me_group_name:'#{@me_group_name}'," \
           "rules:#{@rules.size}" \
           '}'
       end
@@ -29,6 +30,7 @@ module Kameleoon
         @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'])
       end

data/lib/kameleoon/configuration/me_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kameleoon
+  module Configuration
+    class MEGroup
+      attr_reader :feature_flags
+
+      def initialize(feature_flags)
+        @feature_flags = feature_flags.sort { |a, b| a.id <=> b.id }
+      end
+
+      def get_feature_flag_by_hash(hash)
+        idx = (hash * @feature_flags.size).to_i
+        idx = @feature_flags.size - 1 if idx >= @feature_flags.size
+        @feature_flags[idx]
+      end
+    end
+  end
+end

data/lib/kameleoon/kameleoon_client.rb

@@ -922,37 +922,62 @@ 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) && \
+            ff_unrestricted_by_me_group?(visitor, visitor_code, feature_flag)
         eval_exp = _calculate_variation_key_for_feature(visitor_code, feature_flag)
       end
       save_variation(visitor_code, eval_exp, track: track) if save && !forced_variation&.simulated
       Logging::KameleoonLogger.debug(
         "RETURN: KameleoonClient.evaluate(visitor, visitor_code: '%s', feature_flag: %s, track: %s, save: %s)" \
-        ' -> (eval_exp: %s)',
-        visitor_code, feature_flag, track, save, eval_exp
+        ' -> (eval_exp: %s)', visitor_code, feature_flag, track, save, eval_exp
       )
       eval_exp
     end
 
+    def ff_unrestricted_by_me_group?(visitor, visitor_code, feature_flag)
+      return true if feature_flag.me_group_name.nil?
+
+      Logging::KameleoonLogger.debug(
+        "CALL: KameleoonClient.ff_unrestricted_by_me_group?(visitor, visitor_code: '%s', feature_flag: %s)",
+        visitor_code, feature_flag
+      )
+      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)
+        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'",
+          me_group_hash, code_for_hash, feature_flag.me_group_name
+        )
+        unrestricted = me_group.get_feature_flag_by_hash(me_group_hash) == feature_flag
+      end
+      Logging::KameleoonLogger.debug(
+        "RETURN: KameleoonClient.ff_unrestricted_by_me_group?(visitor, visitor_code: '%s', feature_flag: %s)" \
+        ' -> (unrestricted: %s)', visitor_code, feature_flag, unrestricted
+      )
+      unrestricted
+    end
+
     def visitor_not_in_holdout?(visitor, visitor_code, track, save)
+      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
       )
-      holdout = @data_manager.data_file.holdout
       is_not_in_holdout = true
-      unless holdout.nil?
-        code_for_hash = get_code_for_hash(visitor, visitor_code)
-        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)
-        unless var_by_exp.nil?
-          is_not_in_holdout = var_by_exp.variation_key != in_holdout_variation_key
-          if save
-            eval_exp = EvaluatedExperiment.new(var_by_exp, holdout, Configuration::RuleType::EXPERIMENTATION)
-            save_variation(visitor_code, eval_exp, track: track)
-          end
+      code_for_hash = get_code_for_hash(visitor, visitor_code)
+      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)
+      unless var_by_exp.nil?
+        is_not_in_holdout = var_by_exp.variation_key != in_holdout_variation_key
+        if save
+          eval_exp = EvaluatedExperiment.new(var_by_exp, holdout, Configuration::RuleType::EXPERIMENTATION)
+          save_variation(visitor_code, eval_exp, track: track)
         end
       end
       Logging::KameleoonLogger.debug(

data/lib/kameleoon/utils.rb

@@ -38,6 +38,10 @@ module Kameleoon
         calculate("#{visitor_code}#{container_id}#{suffix}")
       end
 
+      def self.obtain_hash_for_me_group(visitor_code, me_group_name)
+        calculate("#{visitor_code}#{me_group_name}")
+      end
+
       def self.calculate(string_to_hash)
         parsed_value = Digest::SHA256.hexdigest(string_to_hash.encode('UTF-8')).to_i(16)
         max_value = BigDecimal('2')**BigDecimal('256')

data/lib/kameleoon/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Kameleoon
-  SDK_VERSION = '3.8.0'
+  SDK_VERSION = '3.9.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.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Kameleoon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -80,6 +80,7 @@ files:
 - lib/kameleoon/configuration/data_file.rb
 - lib/kameleoon/configuration/experiment.rb
 - lib/kameleoon/configuration/feature_flag.rb
+- lib/kameleoon/configuration/me_group.rb
 - lib/kameleoon/configuration/rule.rb
 - lib/kameleoon/configuration/settings.rb
 - lib/kameleoon/configuration/variable.rb