configcat 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 118a3db79c8d7d9a0795897380a4dfaf14fecda8a636024abfd9d2433b3af924
-  data.tar.gz: 4c85c82b81fe08fcf9b6eed0a40bea06369939301aa09bc12e82b33a3b2176eb
+  metadata.gz: 84a383f0a76b49e3daf0072676592b23836937e54430b16fc3183c8f517c0dac
+  data.tar.gz: 8d56fcce1d537ce84360a4f9cdc36ac795102ed37015c6efc9e872b8d44cb765
 SHA512:
-  metadata.gz: afe03eda0affc92755ae0eb91196a15bfe61f68a12244270bb5d19b3870bc023fe9ccf3231d8f11f414c4439b49fd2f9481e9a64295c3ab87697511ebcf57b25
-  data.tar.gz: 5ac8e3beef89cbc84ef89f2eb5b071fcf5cb348db1c302755ba4fc619c759f9919f80785b2b08a4a583725d35ea6b9ef038d869706956485eec3b4a9d4cadbaa
+  metadata.gz: 4bf91c58c110054015a41062f23dfd8d48b4998b892a255bc8872eab5c7a87209f244a99a1f0dd4face989d1da8cd73c64e3de0efa6154f01bf48f8a1e635f81
+  data.tar.gz: 52669ab34441b4abae836c0b474358a78ebbb1c0c1d56447d823eb51a1cfa2c32e999c27f2d5e904aba53a6dc925bf77e227f5e1897d087b585a7655cb07dc6c

data/lib/configcat/autopollingcachepolicy.rb

@@ -82,6 +82,9 @@ module ConfigCat
         if !@_initialized && !old_configuration.equal?(nil)
           @_initialized = true
         end
+      rescue Timeout::Error => e
+        ConfigCat.logger.error("Request timed out. Timeout values: [open: %ss, read: %ss]" %
+                               [@_config_fetcher.get_open_timeout(), @_config_fetcher.get_read_timeout()])
       rescue Exception => e
         ConfigCat.logger.error("Double-check your SDK Key at https://app.configcat.com/sdkkey.")
         ConfigCat.logger.error "threw exception #{e.class}:'#{e}'"

data/lib/configcat/configcatclient.rb

@@ -7,25 +7,41 @@ require 'configcat/lazyloadingcachepolicy'
 require 'configcat/rolloutevaluator'
 require 'configcat/datagovernance'
 
+
 module ConfigCat
   KeyValue = Struct.new(:key, :value)
   class ConfigCatClient
+    @@sdk_keys = []
+
     def initialize(sdk_key,
-                   poll_interval_seconds:60,
-                   max_init_wait_time_seconds:5,
-                   on_configuration_changed_callback:nil,
-                   cache_time_to_live_seconds:60,
-                   config_cache_class:nil,
-                   base_url:nil,
-                   proxy_address:nil,
-                   proxy_port:nil,
-                   proxy_user:nil,
-                   proxy_pass:nil,
+                   poll_interval_seconds: 60,
+                   max_init_wait_time_seconds: 5,
+                   on_configuration_changed_callback: nil,
+                   cache_time_to_live_seconds: 60,
+                   config_cache_class: nil,
+                   base_url: nil,
+                   proxy_address: nil,
+                   proxy_port: nil,
+                   proxy_user: nil,
+                   proxy_pass: nil,
+                   open_timeout: 10,
+                   read_timeout: 30,
+                   flag_overrides: nil,
                    data_governance: DataGovernance::GLOBAL)
       if sdk_key === nil
         raise ConfigCatClientException, "SDK Key is required."
       end
+
+      if @@sdk_keys.include?(sdk_key)
+        ConfigCat.logger.warn("A ConfigCat Client is already initialized with sdk_key %s. "\
+                              "We strongly recommend you to use the ConfigCat Client as "\
+                              "a Singleton object in your application." % sdk_key)
+      else
+        @@sdk_keys.push(sdk_key)
+      end
+
       @_sdk_key = sdk_key
+      @_override_data_source = flag_overrides
 
       if config_cache_class
         @_config_cache = config_cache_class.new()
@@ -33,23 +49,35 @@ module ConfigCat
         @_config_cache = InMemoryConfigCache.new()
       end
 
-      if poll_interval_seconds > 0
-        @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "p", base_url, proxy_address, proxy_port, proxy_user, proxy_pass, data_governance)
+      if !@_override_data_source.equal?(nil) && @_override_data_source.get_behaviour() == OverrideBehaviour::LOCAL_ONLY
+        @_config_fetcher = nil
+        @_cache_policy = nil
+      elsif poll_interval_seconds > 0
+        @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "p", base_url: base_url,
+                                                         proxy_address: proxy_address, proxy_port: proxy_port, proxy_user: proxy_user, proxy_pass: proxy_pass,
+                                                         open_timeout: open_timeout, read_timeout: read_timeout,
+                                                         data_governance: data_governance)
         @_cache_policy = AutoPollingCachePolicy.new(@_config_fetcher, @_config_cache, _get_cache_key(), poll_interval_seconds, max_init_wait_time_seconds, on_configuration_changed_callback)
+      elsif cache_time_to_live_seconds > 0
+        @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "l", base_url: base_url,
+                                                         proxy_address: proxy_address, proxy_port: proxy_port, proxy_user: proxy_user, proxy_pass: proxy_pass,
+                                                         open_timeout: open_timeout, read_timeout: read_timeout,
+                                                         data_governance: data_governance)
+        @_cache_policy = LazyLoadingCachePolicy.new(@_config_fetcher, @_config_cache, _get_cache_key(), cache_time_to_live_seconds)
       else
-        if cache_time_to_live_seconds > 0
-          @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "l", base_url, proxy_address, proxy_port, proxy_user, proxy_pass, data_governance)
-          @_cache_policy = LazyLoadingCachePolicy.new(@_config_fetcher, @_config_cache, _get_cache_key(), cache_time_to_live_seconds)
-        else
-          @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "m", base_url, proxy_address, proxy_port, proxy_user, proxy_pass, data_governance)
-          @_cache_policy = ManualPollingCachePolicy.new(@_config_fetcher, @_config_cache, _get_cache_key())
-        end
+        @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "m", base_url: base_url,
+                                                         proxy_address: proxy_address, proxy_port: proxy_port, proxy_user: proxy_user, proxy_pass: proxy_pass,
+                                                         open_timeout: open_timeout, read_timeout: read_timeout,
+                                                         data_governance: data_governance)
+        @_cache_policy = ManualPollingCachePolicy.new(@_config_fetcher, @_config_cache, _get_cache_key())
       end
     end
 
     def get_value(key, default_value, user=nil)
-      config = @_cache_policy.get()
+      config = _get_settings()
       if config === nil
+        ConfigCat.logger.warn("Evaluating get_value('%s') failed. Cache is empty. "\
+                              "Returning default_value in your get_value call: [%s]." % [key, default_value.to_s])
         return default_value
       end
       value, variation_id = RolloutEvaluator.evaluate(key, user, default_value, nil, config)
@@ -57,7 +85,7 @@ module ConfigCat
     end
 
     def get_all_keys()
-      config = @_cache_policy.get()
+      config = _get_settings()
       if config === nil
         return []
       end
@@ -69,7 +97,7 @@ module ConfigCat
     end
 
     def get_variation_id(key, default_variation_id, user=nil)
-      config = @_cache_policy.get()
+      config = _get_settings()
       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]." %
@@ -93,7 +121,7 @@ module ConfigCat
     end
 
     def get_key_and_value(variation_id)
-      config = @_cache_policy.get()
+      config = _get_settings()
       if config === nil
         ConfigCat.logger.warn("Evaluating get_variation_id('%s') failed. Cache is empty. Returning nil." % variation_id)
         return nil
@@ -126,17 +154,56 @@ module ConfigCat
       end
     end
 
+    def get_all_values(user: nil)
+      keys = get_all_keys()
+      all_values = {}
+      for key in keys
+        value = get_value(key, nil, user)
+        if !value.equal?(nil)
+          all_values[key] = value
+        end
+      end
+      return all_values
+    end
+
     def force_refresh()
       @_cache_policy.force_refresh()
     end
 
     def stop()
-      @_cache_policy.stop()
-      @_config_fetcher.close()
+      @_cache_policy.stop() if @_cache_policy
+      @_config_fetcher.close() if @_config_fetcher
+      @@sdk_keys.delete(@_sdk_key)
     end
 
     private
 
+    def _get_settings()
+      if !@_override_data_source.nil?
+        behaviour = @_override_data_source.get_behaviour()
+        if behaviour == OverrideBehaviour::LOCAL_ONLY
+          return @_override_data_source.get_overrides()
+        elsif behaviour == OverrideBehaviour::REMOTE_OVER_LOCAL
+          remote_settings = @_cache_policy.get()
+          local_settings = @_override_data_source.get_overrides()
+          result = local_settings.clone()
+          if remote_settings.key?(FEATURE_FLAGS) && local_settings.key?(FEATURE_FLAGS)
+            result[FEATURE_FLAGS] = result[FEATURE_FLAGS].merge(remote_settings[FEATURE_FLAGS])
+          end
+          return result
+        elsif behaviour == OverrideBehaviour::LOCAL_OVER_REMOTE
+          remote_settings = @_cache_policy.get()
+          local_settings = @_override_data_source.get_overrides()
+          result = remote_settings.clone()
+          if remote_settings.key?(FEATURE_FLAGS) && local_settings.key?(FEATURE_FLAGS)
+            result[FEATURE_FLAGS] = result[FEATURE_FLAGS].merge(local_settings[FEATURE_FLAGS])
+          end
+          return result
+        end
+      end
+      return @_cache_policy.get()
+    end
+
     def _get_cache_key()
       return Digest::SHA1.hexdigest("ruby_" + CONFIG_FILE_NAME + "_" + @_sdk_key)
     end

data/lib/configcat/configfetcher.rb

@@ -41,13 +41,16 @@ module ConfigCat
   end
 
   class CacheControlConfigFetcher < ConfigFetcher
-    def initialize(sdk_key, mode, base_url=nil, proxy_address=nil, proxy_port=nil, proxy_user=nil, proxy_pass=nil,
-                   data_governance=DataGovernance::GLOBAL)
+    def initialize(sdk_key, mode, base_url:nil, proxy_address:nil, proxy_port:nil, proxy_user:nil, proxy_pass:nil,
+                   open_timeout:10, read_timeout:30,
+                   data_governance:DataGovernance::GLOBAL)
       @_sdk_key = sdk_key
       @_proxy_address = proxy_address
       @_proxy_port = proxy_port
       @_proxy_user = proxy_user
       @_proxy_pass = proxy_pass
+      @_open_timeout = open_timeout
+      @_read_timeout = read_timeout
       @_etag = ""
       @_headers = {"User-Agent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "X-ConfigCat-UserAgent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "Content-Type" => "application/json"}
       if !base_url.equal?(nil)
@@ -63,6 +66,14 @@ module ConfigCat
       end
     end
 
+    def get_open_timeout()
+      return @_open_timeout
+    end
+
+    def get_read_timeout()
+      return @_read_timeout
+    end
+
     # Returns the FetchResponse object contains configuration json Dictionary
     def get_configuration_json(retries=0)
       ConfigCat.logger.debug "Fetching configuration from ConfigCat"
@@ -141,8 +152,8 @@ module ConfigCat
         close()
         @_http = Net::HTTP.new(uri.host, uri.port, @_proxy_address, @_proxy_port, @_proxy_user, @_proxy_pass)
         @_http.use_ssl = use_ssl
-        @_http.open_timeout = 10 # in seconds
-        @_http.read_timeout = 30 # in seconds
+        @_http.open_timeout = @_open_timeout
+        @_http.read_timeout = @_read_timeout
       end
     end
   end

data/lib/configcat/localdictionarydatasource.rb

@@ -0,0 +1,20 @@
+require 'configcat/overridedatasource'
+require 'configcat/constants'
+
+
+module ConfigCat
+  class LocalDictionaryDataSource < OverrideDataSource
+    def initialize(source, override_behaviour)
+      super(override_behaviour)
+      dictionary = {}
+      source.each do |key, value|
+        dictionary[key] = {VALUE => value}
+      end
+      @_settings = {FEATURE_FLAGS => dictionary}
+    end
+
+    def get_overrides()
+      return @_settings
+    end
+  end
+end

data/lib/configcat/localfiledatasource.rb

@@ -0,0 +1,49 @@
+require 'configcat/overridedatasource'
+require 'configcat/constants'
+
+
+module ConfigCat
+  class LocalFileDataSource < OverrideDataSource
+    def initialize(file_path, override_behaviour)
+      super(override_behaviour)
+      if File.exists?(file_path)
+        ConfigCat.logger.error("The file '%s' does not exists." % file_path)
+      end
+      @_file_path = file_path
+      @_settings = nil
+      @_cached_file_stamp = 0
+    end
+
+    def get_overrides()
+      reload_file_content()
+      return @_settings
+    end
+
+    private
+
+    def reload_file_content()
+      begin
+        stamp = File.mtime(@_file_path)
+        if stamp != @_cached_file_stamp
+          @_cached_file_stamp = stamp
+          file = File.read(@_file_path)
+          data = JSON.parse(file)
+          if data.key?("flags")
+            dictionary = {}
+            source = data["flags"]
+            source.each do |key, value|
+              dictionary[key] = {VALUE => value}
+            end
+            @_settings = {FEATURE_FLAGS => dictionary}
+          else
+            @_settings = data
+          end
+        end
+      rescue JSON::ParserError => e
+        ConfigCat.logger.error("Could not decode json from file %s. %s" % [@_file_path, e.to_s])
+      rescue Exception => e
+        ConfigCat.logger.error("Could not read the content of the file %s. %s" % [@_file_path, e.to_s])
+      end
+    end
+  end
+end

data/lib/configcat/overridedatasource.rb

@@ -0,0 +1,32 @@
+module ConfigCat
+  class OverrideBehaviour
+    # When evaluating values, the SDK will not use feature flags & settings from the ConfigCat CDN, but it will use
+    # all feature flags & settings that are loaded from local-override sources.
+    LOCAL_ONLY = 0
+
+    # When evaluating values, the SDK will use all feature flags & settings that are downloaded from the ConfigCat CDN,
+    # plus all feature flags & settings that are loaded from local-override sources. If a feature flag or a setting is
+    # defined both in the fetched and the local-override source then the local-override version will take precedence.
+    LOCAL_OVER_REMOTE = 1
+
+    # When evaluating values, the SDK will use all feature flags & settings that are downloaded from the ConfigCat CDN,
+    # plus all feature flags & settings that are loaded from local-override sources. If a feature flag or a setting is
+    # defined both in the fetched and the local-override source then the fetched version will take precedence.
+    REMOTE_OVER_LOCAL = 2
+  end
+
+  class OverrideDataSource
+    def initialize(override_behaviour)
+      @_override_behaviour = override_behaviour
+    end
+
+    def get_behaviour()
+      return @_override_behaviour
+    end
+
+    def get_overrides()
+      # :returns the override dictionary
+      return {}
+    end
+  end
+end

data/lib/configcat/rolloutevaluator.rb

@@ -39,132 +39,142 @@ module ConfigCat
         return return_value, return_variation_id
       end
 
-      ConfigCat.logger.info("User object:\n%s" % user.to_s)
-
-      # Evaluate targeting rules
-      for rollout_rule in rollout_rules
-        comparison_attribute = rollout_rule.fetch(COMPARISON_ATTRIBUTE)
-        comparison_value = rollout_rule.fetch(COMPARISON_VALUE, nil)
-        comparator = rollout_rule.fetch(COMPARATOR, nil)
-
-        user_value = user.get_attribute(comparison_attribute)
-        if user_value === nil || !user_value
-          ConfigCat.logger.info(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
-          next
-        end
+      log_entries = ["Evaluating get_value('%s')." % key, "User object:\n%s" % user.to_s]
+
+      begin
+        # Evaluate targeting rules
+        for rollout_rule in rollout_rules
+          comparison_attribute = rollout_rule.fetch(COMPARISON_ATTRIBUTE)
+          comparison_value = rollout_rule.fetch(COMPARISON_VALUE, nil)
+          comparator = rollout_rule.fetch(COMPARATOR, nil)
+
+          user_value = user.get_attribute(comparison_attribute)
+          if user_value === nil || !user_value
+            log_entries.push(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
+            next
+          end
 
-        value = rollout_rule.fetch(VALUE, nil)
-        variation_id = rollout_rule.fetch(VARIATION_ID, default_variation_id)
+          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, 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, 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, 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, variation_id
-          end
-        # IS ONE OF, IS NOT ONE OF (Semantic version)
-        elsif (4 <= comparator) && (comparator <= 5)
-          begin
-            match = false
-            user_value_version = Semantic::Version.new(user_value.to_s.strip())
-            ((comparison_value.to_s.split(",").map { |x| x.strip() }).reject { |c| c.empty? }).each { |x|
-              version = Semantic::Version.new(x)
-              match = (user_value_version == version) || match
-            }
-            if match && comparator == 4 || !match && comparator == 5
-              ConfigCat.logger.info(format_match_rule(comparison_attribute, user_value, comparator, comparison_value, value))
+          # IS ONE OF
+          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
             end
-          rescue ArgumentError => e
-            ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
-            next
-          end
-        # LESS THAN, LESS THAN OR EQUALS TO, GREATER THAN, GREATER THAN OR EQUALS TO (Semantic version)
-        elsif (6 <= comparator) && (comparator <= 9)
-          begin
-            user_value_version = Semantic::Version.new(user_value.to_s.strip())
-            comparison_value_version = Semantic::Version.new(comparison_value.to_s.strip())
-            if (comparator == 6 && user_value_version < comparison_value_version) ||
-               (comparator == 7 && user_value_version <= comparison_value_version) ||
-               (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))
+          # 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
             end
-          rescue ArgumentError => e
-            ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
-            next
-          end
-        elsif (10 <= comparator) && (comparator <= 15)
-          begin
-            user_value_float = Float(user_value.to_s.gsub(",", "."))
-            comparison_value_float = Float(comparison_value.to_s.gsub(",", "."))
-            if (comparator == 10 && user_value_float == comparison_value_float) ||
-               (comparator == 11 && user_value_float != comparison_value_float) ||
-               (comparator == 12 && user_value_float < comparison_value_float) ||
-               (comparator == 13 && user_value_float <= comparison_value_float) ||
-               (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))
+          # 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
+            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
+            end
+          # IS ONE OF, IS NOT ONE OF (Semantic version)
+          elsif (4 <= comparator) && (comparator <= 5)
+            begin
+              match = false
+              user_value_version = Semantic::Version.new(user_value.to_s.strip())
+              ((comparison_value.to_s.split(",").map { |x| x.strip() }).reject { |c| c.empty? }).each { |x|
+                version = Semantic::Version.new(x)
+                match = (user_value_version == version) || match
+              }
+              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
+              end
+            rescue ArgumentError => e
+              message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
+              ConfigCat.logger.warn(message)
+              log_entries.push(message)
+              next
+            end
+          # LESS THAN, LESS THAN OR EQUALS TO, GREATER THAN, GREATER THAN OR EQUALS TO (Semantic version)
+          elsif (6 <= comparator) && (comparator <= 9)
+            begin
+              user_value_version = Semantic::Version.new(user_value.to_s.strip())
+              comparison_value_version = Semantic::Version.new(comparison_value.to_s.strip())
+              if (comparator == 6 && user_value_version < comparison_value_version) ||
+                 (comparator == 7 && user_value_version <= comparison_value_version) ||
+                 (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
+              end
+            rescue ArgumentError => e
+              message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
+              ConfigCat.logger.warn(message)
+              log_entries.push(message)
+              next
+            end
+          elsif (10 <= comparator) && (comparator <= 15)
+            begin
+              user_value_float = Float(user_value.to_s.gsub(",", "."))
+              comparison_value_float = Float(comparison_value.to_s.gsub(",", "."))
+              if (comparator == 10 && user_value_float == comparison_value_float) ||
+                 (comparator == 11 && user_value_float != comparison_value_float) ||
+                 (comparator == 12 && user_value_float < comparison_value_float) ||
+                 (comparator == 13 && user_value_float <= comparison_value_float) ||
+                 (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
+              end
+            rescue Exception => e
+              message = format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s)
+              ConfigCat.logger.warn(message)
+              log_entries.push(message)
+              next
+            end
+          # IS ONE OF (Sensitive)
+          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
+            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
             end
-          rescue Exception => e
-            ConfigCat.logger.warn(format_validation_error_rule(comparison_attribute, user_value, comparator, comparison_value, e.to_s))
-            next
-          end
-        # IS ONE OF (Sensitive)
-        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, 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, variation_id
           end
+          log_entries.push(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
         end
-        ConfigCat.logger.info(format_no_match_rule(comparison_attribute, user_value, comparator, comparison_value))
-      end
 
-      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
-        bucket = 0
-        for rollout_percentage_item in rollout_percentage_items || []
-          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, variation_id
+        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
+          bucket = 0
+          for rollout_percentage_item in rollout_percentage_items || []
+            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)
+              log_entries.push("Evaluating %% options. Returning %s" % percentage_value)
+              return percentage_value, variation_id
+            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
+      ensure
+        ConfigCat.logger.info(log_entries.join("\n"))
       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)
-      return return_value, return_variation_id
     end
 
     private

data/lib/configcat/user.rb

@@ -32,6 +32,25 @@ module ConfigCat
       end
       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
+    end
   end
 
 end

data/lib/configcat/version.rb

@@ -1,3 +1,3 @@
 module ConfigCat
-  VERSION = "4.0.0"
+  VERSION = "5.0.0"
 end

data/lib/configcat.rb

@@ -33,6 +33,9 @@ module ConfigCat
                                              proxy_port: nil,
                                              proxy_user: nil,
                                              proxy_pass: nil,
+                                             open_timeout: 10,
+                                             read_timeout: 30,
+                                             flag_overrides: nil,
                                              data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Auto Poll mode with custom options
@@ -48,6 +51,9 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :param open_timeout: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
+    #   :param read_timeout: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
+    #   :param flag_overrides: An OverrideDataSource implementation used to override feature flags & settings.
     #   :param data_governance:
     #   Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
     #   https://app.configcat.com/organization/data-governance
@@ -73,6 +79,9 @@ module ConfigCat
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
                                proxy_pass: proxy_pass,
+                               open_timeout: open_timeout,
+                               read_timeout: read_timeout,
+                               flag_overrides: flag_overrides,
                                data_governance: data_governance)
   end
 
@@ -84,6 +93,9 @@ module ConfigCat
                                              proxy_port: nil,
                                              proxy_user: nil,
                                              proxy_pass: nil,
+                                             open_timeout: 10,
+                                             read_timeout: 30,
+                                             flag_overrides: nil,
                                              data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Lazy Load mode with custom options
@@ -97,6 +109,9 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :param open_timeout: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
+    #   :param read_timeout: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
+    #   :param flag_overrides: An OverrideDataSource implementation used to override feature flags & settings.
     #   :param data_governance:
     #   Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
     #   https://app.configcat.com/organization/data-governance
@@ -119,16 +134,22 @@ module ConfigCat
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
                                proxy_pass: proxy_pass,
+                               open_timeout: open_timeout,
+                               read_timeout: read_timeout,
+                               flag_overrides: flag_overrides,
                                data_governance: data_governance)
   end
 
   def ConfigCat.create_client_with_manual_poll(sdk_key,
                                                config_cache_class: nil,
                                                base_url: nil,
-                                               proxy_address:nil,
-                                               proxy_port:nil,
-                                               proxy_user:nil,
-                                               proxy_pass:nil,
+                                               proxy_address: nil,
+                                               proxy_port: nil,
+                                               proxy_user: nil,
+                                               proxy_pass: nil,
+                                               open_timeout: 10,
+                                               read_timeout: 30,
+                                               flag_overrides: nil,
                                                data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Manual Poll mode with custom options
@@ -141,6 +162,9 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :param open_timeout: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
+    #   :param read_timeout: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
+    #   :param flag_overrides: An OverrideDataSource implementation used to override feature flags & settings.
     #   :param data_governance:
     #   Default: Global. Set this parameter to be in sync with the Data Governance preference on the Dashboard:
     #   https://app.configcat.com/organization/data-governance
@@ -160,6 +184,9 @@ module ConfigCat
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
                                proxy_pass: proxy_pass,
+                               open_timeout: open_timeout,
+                               read_timeout: read_timeout,
+                               flag_overrides: flag_overrides,
                                data_governance: data_governance)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,10 @@ files:
 - lib/configcat/datagovernance.rb
 - lib/configcat/interfaces.rb
 - lib/configcat/lazyloadingcachepolicy.rb
+- lib/configcat/localdictionarydatasource.rb
+- lib/configcat/localfiledatasource.rb
 - lib/configcat/manualpollingcachepolicy.rb
+- lib/configcat/overridedatasource.rb
 - lib/configcat/rolloutevaluator.rb
 - lib/configcat/user.rb
 - lib/configcat/version.rb
@@ -137,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: ConfigCat SDK for Ruby.