configcat 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed70c40f6865601f6d5476cbb12b158e359413baa9fc186a58c0bc0b1334e9a5
-  data.tar.gz: 848a6b3550eee7cdc6cb0467b0b0893e6f37ce9d1a0dffb95c77ca4f248e8d74
+  metadata.gz: b842d2ff2f62e6a6c3dbe2ddab53c561e4b1db93f3928ce805044127cd2d7819
+  data.tar.gz: 6d64d084c4a732d26d54879d914f4e9ce1722b9e73fee2aa4161cc5503e152d7
 SHA512:
-  metadata.gz: 9aa50e9733ab9ed0612d28fe2daee49ce0396feb1fab353324b2d3ae63ce67722a58d7c0c67d5884d4146106bd52859e36e08725a1a1757390bb6462baf4c1e0
-  data.tar.gz: 40a2aa9993dc5ba3cba64c944a06c9c4c15895ba4ee6f227db250abe051894956f7c3fc2fe7dff298582ce4e573190e5cc8d4e0055afcdff0e5ed278f7d2a52e
+  metadata.gz: 83a7d19dc642e492bb5443a1fc42f0f35db8f5278f02582848e8677133f4450faa41a1a30b158ccdca58bc5396cad109b914fa4851e4db74dcf03df1f5129d00
+  data.tar.gz: 2e79ed9965f3c9da2f8afd9fed4636b6d349b0bda09fdfb0d8398b6e4334a458713114d23083fc5f611878ea02801c5e8ea1e73fad54f6e580ef1c098e8f9d7c

data/lib/configcat/configcatclient.rb

@@ -7,6 +7,7 @@ require 'configcat/lazyloadingcachepolicy'
 require 'configcat/rolloutevaluator'
 
 module ConfigCat
+  KeyValue = Struct.new(:key, :value)
   class ConfigCatClient
     def initialize(sdk_key,
                    poll_interval_seconds:60,
@@ -49,7 +50,8 @@ module ConfigCat
       if config === nil
         return default_value
       end
-      return RolloutEvaluator.evaluate(key, user, default_value, config)
+      value, variation_id = RolloutEvaluator.evaluate(key, user, default_value, nil, config)
+      return value
     end
 
     def get_all_keys()
@@ -60,6 +62,57 @@ module ConfigCat
       return config.keys
     end
 
+    def get_variation_id(key, default_variation_id, user=nil)
+      config = @_cache_policy.get()
+      if config === nil
+        ConfigCat.logger.warn("Evaluating get_variation_id('%s') failed. Cache is empty. "\
+                              "Returning default_variation_id in your get_variation_id call: [%s]." %
+                              [key, default_variation_id.to_s])
+        return default_variation_id
+      end
+      value, variation_id = RolloutEvaluator.evaluate(key, user, nil, default_variation_id, config)
+      return variation_id
+    end
+
+    def get_all_variation_ids(user: nil)
+      keys = get_all_keys()
+      variation_ids = []
+      for key in keys
+        variation_id = get_variation_id(key, nil, user)
+        if !variation_id.equal?(nil)
+          variation_ids.push(variation_id)
+        end
+      end
+      return variation_ids
+    end
+
+    def get_key_and_value(variation_id)
+      config = @_cache_policy.get()
+      if config === nil
+        ConfigCat.logger.warn("Evaluating get_variation_id('%s') failed. Cache is empty. Returning nil." % variation_id)
+        return nil
+      end
+      for key, value in config
+        if variation_id == value.fetch(RolloutEvaluator::VARIATION_ID, nil)
+          return KeyValue.new(key, value[RolloutEvaluator::VALUE])
+        end
+
+        rollout_rules = value.fetch(RolloutEvaluator::ROLLOUT_RULES, [])
+        for rollout_rule in rollout_rules
+          if variation_id == rollout_rule.fetch(RolloutEvaluator::VARIATION_ID, nil)
+            return KeyValue.new(key, rollout_rule[RolloutEvaluator::VALUE])
+          end
+        end
+
+        rollout_percentage_items = value.fetch(RolloutEvaluator::ROLLOUT_PERCENTAGE_ITEMS, [])
+        for rollout_percentage_item in rollout_percentage_items
+          if variation_id == rollout_percentage_item.fetch(RolloutEvaluator::VARIATION_ID, nil)
+            return KeyValue.new(key, rollout_percentage_item[RolloutEvaluator::VALUE])
+          end
+        end
+      end
+    end
+
     def force_refresh()
       @_cache_policy.force_refresh()
     end

data/lib/configcat/rolloutevaluator.rb

@@ -13,14 +13,15 @@ module ConfigCat
     ROLLOUT_PERCENTAGE_ITEMS = "p"
     PERCENTAGE = "p"
     ROLLOUT_RULES = "r"
+    VARIATION_ID = "i"
 
-    def self.evaluate(key, user, default_value, config)
+    def self.evaluate(key, user, default_value, default_variation_id, config)
       ConfigCat.logger.info("Evaluating get_value('%s')." % key)
 
       setting_descriptor = config.fetch(key, nil)
       if setting_descriptor === nil
         ConfigCat.logger.error("Evaluating get_value('%s') failed. Value not found for key '%s'. Returning default_value: [%s]. Here are the available keys: %s" % [key, key, default_value.to_s, config.keys.join(", ")])
-        return default_value
+        return default_value, default_variation_id
       end
 
       rollout_rules = setting_descriptor.fetch(ROLLOUT_RULES, [])
@@ -35,8 +36,9 @@ module ConfigCat
           ConfigCat.logger.warn("Evaluating get_value('%s'). UserObject missing! You should pass a UserObject to get_value(), in order to make targeting work properly. Read more: https://configcat.com/docs/advanced/user-object/" % key)
         end
         return_value = setting_descriptor.fetch(VALUE, default_value)
+        return_variation_id = setting_descriptor.fetch(VARIATION_ID, default_variation_id)
         ConfigCat.logger.info("Returning [%s]" % return_value.to_s)
-        return return_value
+        return return_value, return_variation_id
       end
 
       ConfigCat.logger.info("User object:\n%s" % user.to_s)
@@ -54,30 +56,31 @@ module ConfigCat
         end
 
         value = rollout_rule.fetch(VALUE, nil)
+        variation_id = rollout_rule.fetch(VARIATION_ID, default_variation_id)
 
         # IS ONE OF
         if comparator == 0
           if comparison_value.to_s.split(",").map { |x| x.strip() }.include?(user_value.to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         # IS NOT ONE OF
         elsif comparator == 1
           if !comparison_value.to_s.split(",").map { |x| x.strip() }.include?(user_value.to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         # CONTAINS
         elsif comparator == 2
           if user_value.to_s.include?(comparison_value.to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         # DOES NOT CONTAIN
         elsif comparator == 3
           if !user_value.to_s.include?(comparison_value.to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         # IS ONE OF, IS NOT ONE OF (Semantic version)
         elsif (4 <= comparator) && (comparator <= 5)
@@ -90,7 +93,7 @@ module ConfigCat
             }
             if match && comparator == 4 || !match && comparator == 5
               ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value
+              return value, variation_id
             end
           rescue ArgumentError => e
             ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
@@ -106,7 +109,7 @@ module ConfigCat
                (comparator == 8 && user_value_version > comparison_value_version) ||
                (comparator == 9 && user_value_version >= comparison_value_version)
               ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value
+              return value, variation_id
             end
           rescue ArgumentError => e
             ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
@@ -123,7 +126,7 @@ module ConfigCat
                (comparator == 14 && user_value_float > comparison_value_float) ||
                (comparator == 15 && user_value_float >= comparison_value_float)
               ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value
+              return value, variation_id
             end
           rescue Exception => e
             ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
@@ -133,13 +136,13 @@ module ConfigCat
         elsif comparator == 16
           if comparison_value.to_s.split(",").map { |x| x.strip() }.include?(Digest::SHA1.hexdigest(user_value).to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         # IS NOT ONE OF (Sensitive)
         elsif comparator == 17
           if !comparison_value.to_s.split(",").map { |x| x.strip() }.include?(Digest::SHA1.hexdigest(user_value).to_s)
             ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-            return value
+            return value, variation_id
           end
         end
         ConfigCat.logger.info(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
@@ -154,14 +157,16 @@ module ConfigCat
           bucket += rollout_percentage_item.fetch(PERCENTAGE, 0)
           if hash_val < bucket
             percentage_value = rollout_percentage_item.fetch(VALUE, nil)
+            variation_id = rollout_percentage_item.fetch(VARIATION_ID, default_variation_id)
             ConfigCat.logger.info("Evaluating %% options. Returning %s" % percentage_value)
-            return percentage_value
+            return percentage_value, variation_id
           end
         end
       end
-      def_value = setting_descriptor.fetch(VALUE, default_value)
-      ConfigCat.logger.info("Returning %s" % def_value)
-      return def_value
+      return_value = setting_descriptor.fetch(VALUE, default_value)
+      return_variation_id = setting_descriptor.fetch(VARIATION_ID, default_variation_id)
+      ConfigCat.logger.info("Returning %s" % return_value)
+      return return_value, return_variation_id
     end
 
     private

data/lib/configcat/user.rb

@@ -5,11 +5,11 @@ module ConfigCat
     #    The user object for variation evaluation
     #
 
-    PREDEFINED = ["identifier", "email", "country"]
+    PREDEFINED = ["Identifier", "Email", "Country"]
 
     def initialize(identifier, email: nil, country: nil, custom: nil)
-      @__identifier = identifier
-      @__data = {"identifier" => identifier, "email" => email, "country" => country}
+      @__identifier = (!identifier.equal?(nil)) ? identifier : ""
+      @__data = {"Identifier" => identifier, "Email" => email, "Country" => country}
       @__custom = custom
     end
 
@@ -18,14 +18,14 @@ module ConfigCat
     end
 
     def get_attribute(attribute)
-      attribute = attribute.to_s.downcase()
+      attribute = attribute.to_s
       if PREDEFINED.include?(attribute)
         return @__data[attribute]
       end
 
       if !@__custom.equal?(nil)
         @__custom.each do |customField, customValue|
-          if customField.to_s.downcase() == attribute
+          if customField.to_s == attribute
             return customValue
           end
         end

data/lib/configcat/version.rb

@@ -1,3 +1,3 @@
 module ConfigCat
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -135,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: ConfigCat SDK for Ruby.