configcat 5.0.2 → 6.1.0

data/lib/configcat/interfaces.rb

@@ -1,71 +1,16 @@
 module ConfigCat
-
-  class ConfigFetcher
-    #
-    #       Config fetcher interface
-    #
-
-    def get_configuration_json()
-      #
-      #     :return: Returns the configuration json Dictionary
-      #
-    end
-
-    def close()
-      #
-      #         Closes the ConfigFetcher's resources
-      #
-    end
-  end
-
+  # Config cache interface
   class ConfigCache
-    #
-    #       Config cache interface
-    #
-
+    # :returns the config json object from the cache
     def get(key)
-      #
-      #     :returns the config json object from the cache
-      #
     end
 
+    # Sets the config json cache.
     def set(key, value)
-      #
-      #     Sets the config json cache.
-      #
-    end
-  end
-
-  class CachePolicy
-    #
-    #       Config cache interface
-    #
-
-    def get()
-      #
-      #     :returns the config json object from the cache
-      #
-    end
-
-    def force_refresh()
-      #
-      #
-      #     :return:
-      #
-    end
-
-    def stop()
-      #
-      #
-      #     :return:
-      #
     end
   end
 
+  # Generic ConfigCatClientException
   class ConfigCatClientException < Exception
-    #
-    #   Generic ConfigCatClientException
-    #
   end
-
 end

data/lib/configcat/localdictionarydatasource.rb

@@ -3,17 +3,27 @@ require 'configcat/constants'
 
 
 module ConfigCat
+  class LocalDictionaryFlagOverrides < FlagOverrides
+    def initialize(source, override_behaviour)
+      @source = source
+      @override_behaviour = override_behaviour
+    end
+
+    def create_data_source(log)
+      return LocalDictionaryDataSource.new(@source, @override_behaviour)
+    end
+  end
+
   class LocalDictionaryDataSource < OverrideDataSource
     def initialize(source, override_behaviour)
       super(override_behaviour)
-      dictionary = {}
+      @_settings = {}
       source.each do |key, value|
-        dictionary[key] = {VALUE => value}
+        @_settings[key] = { VALUE => value }
       end
-      @_settings = {FEATURE_FLAGS => dictionary}
     end
 
-    def get_overrides()
+    def get_overrides
       return @_settings
     end
   end

data/lib/configcat/localfiledatasource.rb

@@ -3,25 +3,37 @@ require 'configcat/constants'
 
 
 module ConfigCat
-  class LocalFileDataSource < OverrideDataSource
+  class LocalFileFlagOverrides < FlagOverrides
     def initialize(file_path, override_behaviour)
+      @file_path = file_path
+      @override_behaviour = override_behaviour
+    end
+
+    def create_data_source(log)
+      return LocalFileDataSource.new(@file_path, @override_behaviour, log)
+    end
+  end
+
+  class LocalFileDataSource < OverrideDataSource
+    def initialize(file_path, override_behaviour, log)
       super(override_behaviour)
-      if File.exists?(file_path)
-        ConfigCat.logger.error("The file '%s' does not exists." % file_path)
+      @log = log
+      if !File.exists?(file_path)
+        @log.error(1300, "Cannot find the local config file '#{file_path}'. This is a path that your application provided to the ConfigCat SDK by passing it to the `LocalFileFlagOverrides.new()` method. Read more: https://configcat.com/docs/sdk-reference/ruby/#json-file")
       end
       @_file_path = file_path
       @_settings = nil
       @_cached_file_stamp = 0
     end
 
-    def get_overrides()
+    def get_overrides
       reload_file_content()
       return @_settings
     end
 
     private
 
-    def reload_file_content()
+    def reload_file_content
       begin
         stamp = File.mtime(@_file_path)
         if stamp != @_cached_file_stamp
@@ -29,20 +41,19 @@ module ConfigCat
           file = File.read(@_file_path)
           data = JSON.parse(file)
           if data.key?("flags")
-            dictionary = {}
+            @_settings = {}
             source = data["flags"]
             source.each do |key, value|
-              dictionary[key] = {VALUE => value}
+              @_settings[key] = { VALUE => value }
             end
-            @_settings = {FEATURE_FLAGS => dictionary}
           else
-            @_settings = data
+            @_settings = data[FEATURE_FLAGS]
           end
         end
       rescue JSON::ParserError => e
-        ConfigCat.logger.error("Could not decode json from file %s. %s" % [@_file_path, e.to_s])
+        @log.error(2302, "Failed to decode JSON from the local config file '#{@_file_path}'. #{e}")
       rescue Exception => e
-        ConfigCat.logger.error("Could not read the content of the file %s. %s" % [@_file_path, e.to_s])
+        @log.error(1302, "Failed to read the local config file '#{@_file_path}'. #{e}")
       end
     end
   end

data/lib/configcat/overridedatasource.rb

@@ -15,16 +15,22 @@ module ConfigCat
     REMOTE_OVER_LOCAL = 2
   end
 
+  class FlagOverrides
+    # :returns [OverrideDataSource] the created OverrideDataSource
+    def create_data_source(log)
+    end
+  end
+
   class OverrideDataSource
     def initialize(override_behaviour)
       @_override_behaviour = override_behaviour
     end
 
-    def get_behaviour()
+    def get_behaviour
       return @_override_behaviour
     end
 
-    def get_overrides()
+    def get_overrides
       # :returns the override dictionary
       return {}
     end

data/lib/configcat/pollingmode.rb

@@ -0,0 +1,62 @@
+module ConfigCat
+  class PollingMode
+    # Creates a configured auto polling configuration.
+    #
+    # :param poll_interval_seconds: sets at least how often this policy should fetch the latest configuration and refresh the cache.
+    # :param max_init_wait_time_seconds: sets the maximum waiting time between initialization and the first config acquisition in seconds.
+    # :return [AutoPollingMode]
+    def self.auto_poll(poll_interval_seconds: 60, max_init_wait_time_seconds: 5)
+      poll_interval_seconds = 1 if poll_interval_seconds < 1
+      max_init_wait_time_seconds = 0 if max_init_wait_time_seconds < 0
+
+      AutoPollingMode.new(poll_interval_seconds, max_init_wait_time_seconds)
+    end
+
+    # Creates a configured lazy loading polling configuration.
+    #
+    # :param cache_refresh_interval_seconds: sets how long the cache will store its value before fetching the latest from the network again.
+    # :return [LazyLoadingMode]
+    def self.lazy_load(cache_refresh_interval_seconds: 60)
+      cache_refresh_interval_seconds = 1 if cache_refresh_interval_seconds < 1
+
+      LazyLoadingMode.new(cache_refresh_interval_seconds)
+    end
+
+    # Creates a configured manual polling configuration.
+    # :return [ManualPollingMode]
+    def self.manual_poll
+      ManualPollingMode.new
+    end
+  end
+
+  class AutoPollingMode < PollingMode
+    attr_reader :poll_interval_seconds, :max_init_wait_time_seconds
+
+    def initialize(poll_interval_seconds, max_init_wait_time_seconds)
+      @poll_interval_seconds = poll_interval_seconds
+      @max_init_wait_time_seconds = max_init_wait_time_seconds
+    end
+
+    def identifier
+      return "a"
+    end
+  end
+
+  class LazyLoadingMode < PollingMode
+    attr_reader :cache_refresh_interval_seconds
+
+    def initialize(cache_refresh_interval_seconds)
+      @cache_refresh_interval_seconds = cache_refresh_interval_seconds
+    end
+
+    def identifier
+      return "l"
+    end
+  end
+
+  class ManualPollingMode < PollingMode
+    def identifier
+      return "m"
+    end
+  end
+end

data/lib/configcat/refreshresult.rb

@@ -0,0 +1,3 @@
+module ConfigCat
+  RefreshResult = Struct.new(:success, :error)
+end

data/lib/configcat/rolloutevaluator.rb

@@ -7,36 +7,39 @@ module ConfigCat
   class RolloutEvaluator
     COMPARATOR_TEXTS = ["IS ONE OF", "IS NOT ONE OF", "CONTAINS", "DOES NOT CONTAIN", "IS ONE OF (SemVer)", "IS NOT ONE OF (SemVer)", "< (SemVer)", "<= (SemVer)", "> (SemVer)", ">= (SemVer)", "= (Number)", "<> (Number)", "< (Number)", "<= (Number)", "> (Number)", ">= (Number)"]
 
-    def self.evaluate(key, user, default_value, default_variation_id, config)
-      ConfigCat.logger.info("Evaluating get_value('%s')." % key)
-
-      feature_flags = config.fetch(FEATURE_FLAGS, nil)
-      if feature_flags === nil
-        ConfigCat.logger.error("Evaluating get_value('%s') failed. Value not found for key '%s' Returning default_value: [%s]." % [key, key, default_value.to_s])
-        return default_value, default_variation_id
-      end
+    def initialize(log)
+      @log = log
+    end
 
-      setting_descriptor = feature_flags.fetch(key, nil)
+    # :returns value, variation_id. matched_evaluation_rule, matched_evaluation_percentage_rule, error
+    def evaluate(key:, user:, default_value:, default_variation_id:, settings:)
+      setting_descriptor = settings[key]
       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, feature_flags.keys.join(", ")])
-        return default_value, default_variation_id
+        error = "Failed to evaluate setting '#{key}' (the key was not found in config JSON). " \
+                "Returning the `default_value` parameter that you specified in your application: '#{default_value}'. " \
+                "Available keys: [#{settings.keys.map { |s| "'#{s}'" }.join(", ")}]."
+        @log.error(1001, error)
+        return default_value, default_variation_id, nil, nil, error
       end
 
       rollout_rules = setting_descriptor.fetch(ROLLOUT_RULES, [])
       rollout_percentage_items = setting_descriptor.fetch(ROLLOUT_PERCENTAGE_ITEMS, [])
 
-      if !user.equal?(nil) && !user.class.equal?(User)
-        ConfigCat.logger.warn("Evaluating get_value('%s'). User Object is not an instance of User type." % key)
+      user_has_invalid_type = !user.equal?(nil) && !user.class.equal?(User)
+      if user_has_invalid_type
+        @log.warn(4001, "Cannot evaluate targeting rules and % options for setting '#{key}' (User Object is not an instance of User type).")
         user = nil
       end
       if user === nil
-        if rollout_rules.size > 0 || rollout_percentage_items.size > 0
-          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)
+        if !user_has_invalid_type && (rollout_rules.size > 0 || rollout_percentage_items.size > 0)
+          @log.warn(3001, "Cannot evaluate targeting rules and % options for setting '#{key}' (User Object is missing). " \
+                          "You should pass a User Object to the evaluation methods like `get_value()` in order to make targeting work properly. " \
+                          "Read more: https://configcat.com/docs/advanced/user-object/")
         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_variation_id
+        @log.info(5000, "Returning [#{return_value}]")
+        return return_value, return_variation_id, nil, nil, nil
       end
 
       log_entries = ["Evaluating get_value('%s')." % key, "User object:\n%s" % user.to_s]
@@ -61,25 +64,25 @@ module ConfigCat
           if comparator == 0
             if comparison_value.to_s.split(",").map { |x| x.strip() }.include?(user_value.to_s)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             end
           # IS NOT ONE OF
           elsif comparator == 1
             if !comparison_value.to_s.split(",").map { |x| x.strip() }.include?(user_value.to_s)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             end
           # CONTAINS
           elsif comparator == 2
             if user_value.to_s.include?(comparison_value.to_s)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             end
           # DOES NOT CONTAIN
           elsif comparator == 3
             if !user_value.to_s.include?(comparison_value.to_s)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             end
           # IS ONE OF, IS NOT ONE OF (Semantic version)
           elsif (4 <= comparator) && (comparator <= 5)
@@ -92,11 +95,11 @@ module ConfigCat
               }
               if match && comparator == 4 || !match && comparator == 5
                 log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-                return value, variation_id
+                return value, variation_id, rollout_rule, nil, nil
               end
             rescue ArgumentError => e
               message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
-              ConfigCat.logger.warn(message)
+              @log.warn(0, message)
               log_entries.push(message)
               next
             end
@@ -110,11 +113,11 @@ module ConfigCat
                  (comparator == 8 && user_value_version > comparison_value_version) ||
                  (comparator == 9 && user_value_version >= comparison_value_version)
                 log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-                return value, variation_id
+                return value, variation_id, rollout_rule, nil, nil
               end
             rescue ArgumentError => e
               message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
-              ConfigCat.logger.warn(message)
+              @log.warn(0, message)
               log_entries.push(message)
               next
             end
@@ -129,11 +132,11 @@ module ConfigCat
                  (comparator == 14 && user_value_float > comparison_value_float) ||
                  (comparator == 15 && user_value_float >= comparison_value_float)
                 log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-                return value, variation_id
+                return value, variation_id, rollout_rule, nil, nil
               end
             rescue Exception => e
               message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
-              ConfigCat.logger.warn(message)
+              @log.warn(0, message)
               log_entries.push(message)
               next
             end
@@ -141,13 +144,13 @@ module ConfigCat
           elsif comparator == 16
             if comparison_value.to_s.split(",").map { |x| x.strip() }.include?(Digest::SHA1.hexdigest(user_value).to_s)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             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)
               log_entries.push(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
-              return value, variation_id
+              return value, variation_id, rollout_rule, nil, nil
             end
           end
           log_entries.push(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
@@ -156,7 +159,7 @@ module ConfigCat
         if rollout_percentage_items.size > 0
           user_key = user.get_identifier()
           hash_candidate = ("%s%s" % [key, user_key]).encode("utf-8")
-          hash_val = Digest::SHA1.hexdigest(hash_candidate)[0...7].to_i(base=16) % 100
+          hash_val = Digest::SHA1.hexdigest(hash_candidate)[0...7].to_i(base = 16) % 100
           bucket = 0
           for rollout_percentage_item in rollout_percentage_items || []
             bucket += rollout_percentage_item.fetch(PERCENTAGE, 0)
@@ -164,34 +167,31 @@ module ConfigCat
               percentage_value = rollout_percentage_item.fetch(VALUE, nil)
               variation_id = rollout_percentage_item.fetch(VARIATION_ID, default_variation_id)
               log_entries.push("Evaluating %% options. Returning %s" % percentage_value)
-              return percentage_value, variation_id
+              return percentage_value, variation_id, nil, rollout_percentage_item, nil
             end
           end
         end
         return_value = setting_descriptor.fetch(VALUE, default_value)
         return_variation_id = setting_descriptor.fetch(VARIATION_ID, default_variation_id)
         log_entries.push("Returning %s" % return_value)
-        return return_value, return_variation_id
+        return return_value, return_variation_id, nil, nil, nil
       ensure
-        ConfigCat.logger.info(log_entries.join("\n"))
+        @log.info(5000, log_entries.join("\n"))
       end
     end
 
     private
 
-    def self.format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value)
+    def format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value)
       return "Evaluating rule: [%s:%s] [%s] [%s] => match, returning: %s" % [comparison_attribute, user_value, COMPARATOR_TEXTS[comparator], comparison_value, value]
     end
 
-    def self.format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value)
+    def format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value)
       return "Evaluating rule: [%s:%s] [%s] [%s] => no match" % [comparison_attribute, user_value, COMPARATOR_TEXTS[comparator], comparison_value]
     end
 
-    def self.format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, error)
+    def format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, error)
       return "Evaluating rule: [%s:%s] [%s] [%s] => SKIP rule. Validation error: %s" % [comparison_attribute, user_value, COMPARATOR_TEXTS[comparator], comparison_value, error]
     end
-
   end
-
 end
-

data/lib/configcat/user.rb

@@ -1,56 +1,35 @@
 module ConfigCat
-
+  #    The user object for variation evaluation
   class User
-    #
-    #    The user object for variation evaluation
-    #
-
     PREDEFINED = ["Identifier", "Email", "Country"]
 
+    attr_reader :identifier
+
     def initialize(identifier, email: nil, country: nil, custom: nil)
-      @__identifier = (!identifier.equal?(nil)) ? identifier : ""
-      @__data = {"Identifier" => identifier, "Email" => email, "Country" => country}
-      @__custom = custom
+      @identifier = (!identifier.equal?(nil)) ? identifier : ""
+      @data = { "Identifier" => identifier, "Email" => email, "Country" => country }
+      @custom = custom
     end
 
-    def get_identifier()
-      return @__identifier
+    def get_identifier
+      return @identifier
     end
 
     def get_attribute(attribute)
       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 == attribute
-            return customValue
-          end
-        end
-      end
+      return @data[attribute] if PREDEFINED.include?(attribute)
+      return @custom[attribute] if @custom
       return nil
     end
 
-    def to_s()
-      r = %Q({\n    "Identifier": "#{@__identifier}")
-      if !@__data["Email"].equal?(nil)
-        r += %Q(,\n    "Email": "#{@__data["Email"]}")
-      end
-      if !@__data["Country"].equal?(nil)
-        r += %Q(,\n    "Country": "#{@__data["Country"]}")
-      end
-      if !@__custom.equal?(nil)
-        r += %Q(,\n    "Custom": {)
-        for customField in @__custom
-          r += %Q(\n        "#{customField}": "#{@__custom[customField]}",)
-        end
-        r += "\n    }"
-      end
-      r += "\n}"
-      return r
+    def to_s
+      dump = {
+        'Identifier': @identifier,
+        'Email': @data['Email'],
+        'Country': @data['Country'],
+        'Custom': @custom,
+      }
+      return dump.to_json
     end
   end
-
 end

data/lib/configcat/utils.rb

@@ -0,0 +1,10 @@
+module ConfigCat
+  class Utils
+    DISTANT_FUTURE = Float::INFINITY
+    DISTANT_PAST = 0
+
+    def self.get_utc_now_seconds_since_epoch
+      return Time.now.utc.to_f
+    end
+  end
+end

data/lib/configcat/version.rb

@@ -1,3 +1,3 @@
 module ConfigCat
-  VERSION = "5.0.2"
+  VERSION = "6.1.0"
 end