configcat 2.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 216277c9c25debbe5d07c33f6c73c850f774c5115b0dd324ee4973514f83d6b9
-  data.tar.gz: 5e94aca770e2888ccc887befd5681950bf4dc6d6dc1819e57e731cf8e02e5793
+  metadata.gz: 118a3db79c8d7d9a0795897380a4dfaf14fecda8a636024abfd9d2433b3af924
+  data.tar.gz: 4c85c82b81fe08fcf9b6eed0a40bea06369939301aa09bc12e82b33a3b2176eb
 SHA512:
-  metadata.gz: 308f9b0d6fcebebded88f6945aaf4ae025329e9ab21711f587f8fee366024788da514c2e30d1b875b025de12b692783a26ab163732a6c333e6513789a04ca496
-  data.tar.gz: 8f73ab03c23e10d961564663078574839a91758108b02c8511c449e1d3fd12347186857871e3cd048d7d526fbffd204adbe0d950f55a589cd2d9f501854edd04
+  metadata.gz: afe03eda0affc92755ae0eb91196a15bfe61f68a12244270bb5d19b3870bc023fe9ccf3231d8f11f414c4439b49fd2f9481e9a64295c3ab87697511ebcf57b25
+  data.tar.gz: 5ac8e3beef89cbc84ef89f2eb5b071fcf5cb348db1c302755ba4fc619c759f9919f80785b2b08a4a583725d35ea6b9ef038d869706956485eec3b4a9d4cadbaa

data/lib/configcat.rb

@@ -10,29 +10,34 @@ module ConfigCat
     attr_accessor :logger
   end
 
-  def ConfigCat.create_client(api_key)
+  def ConfigCat.create_client(sdk_key, data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Auto Poll mode with default options
     #
-    #   :param api_key: ConfigCat ApiKey to access your configuration.
+    #   :param sdk_key: ConfigCat SDK Key to access your configuration.
+    #   :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
+    #   (Only Organization Admins have access)
     #
-    return create_client_with_auto_poll(api_key)
+    return create_client_with_auto_poll(sdk_key, data_governance: data_governance)
   end
 
-  def ConfigCat.create_client_with_auto_poll(api_key,
+  def ConfigCat.create_client_with_auto_poll(sdk_key,
                                              poll_interval_seconds: 60,
                                              max_init_wait_time_seconds: 5,
                                              on_configuration_changed_callback: nil,
                                              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,
+                                             data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Auto Poll mode with custom options
     #
-    #   :param api_key: ConfigCat ApiKey to access your configuration.
+    #   :param sdk_key: ConfigCat SDK Key to access your configuration.
     #   :param poll_interval_seconds: The client's poll interval in seconds. Default: 60 seconds.
     #   :param on_configuration_changed_callback: You can subscribe to configuration changes with this callback
     #   :param max_init_wait_time_seconds: maximum waiting time for first configuration fetch in polling mode.
@@ -43,9 +48,13 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :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
+    #   (Only Organization Admins have access)
     #
-    if api_key === nil
-      raise ConfigCatClientException, "API Key is required."
+    if sdk_key === nil
+      raise ConfigCatClientException, "SDK Key is required."
     end
     if poll_interval_seconds < 1
       poll_interval_seconds = 1
@@ -53,7 +62,7 @@ module ConfigCat
     if max_init_wait_time_seconds < 0
       max_init_wait_time_seconds = 0
     end
-    return ConfigCatClient.new(api_key,
+    return ConfigCatClient.new(sdk_key,
                                poll_interval_seconds: poll_interval_seconds,
                                max_init_wait_time_seconds: max_init_wait_time_seconds,
                                on_configuration_changed_callback: on_configuration_changed_callback,
@@ -63,21 +72,23 @@ module ConfigCat
                                proxy_address: proxy_address,
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
-                               proxy_pass: proxy_pass)
+                               proxy_pass: proxy_pass,
+                               data_governance: data_governance)
   end
 
-  def ConfigCat.create_client_with_lazy_load(api_key,
+  def ConfigCat.create_client_with_lazy_load(sdk_key,
                                              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)
+                                             proxy_address: nil,
+                                             proxy_port: nil,
+                                             proxy_user: nil,
+                                             proxy_pass: nil,
+                                             data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Lazy Load mode with custom options
     #
-    #   :param api_key: ConfigCat ApiKey to access your configuration.
+    #   :param sdk_key: ConfigCat SDK Key to access your configuration.
     #   :param cache_time_to_live_seconds: The cache TTL.
     #   :param config_cache_class: If you want to use custom caching instead of the client's default InMemoryConfigCache,
     #   You can provide an implementation of ConfigCache.
@@ -86,14 +97,18 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :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
+    #   (Only Organization Admins have access)
     #
-    if api_key === nil
-      raise ConfigCatClientException, "API Key is required."
+    if sdk_key === nil
+      raise ConfigCatClientException, "SDK Key is required."
     end
     if cache_time_to_live_seconds < 1
       cache_time_to_live_seconds = 1
     end
-    return ConfigCatClient.new(api_key,
+    return ConfigCatClient.new(sdk_key,
                                poll_interval_seconds: 0,
                                max_init_wait_time_seconds: 0,
                                on_configuration_changed_callback: nil,
@@ -103,20 +118,22 @@ module ConfigCat
                                proxy_address: proxy_address,
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
-                               proxy_pass: proxy_pass)
+                               proxy_pass: proxy_pass,
+                               data_governance: data_governance)
   end
 
-  def ConfigCat.create_client_with_manual_poll(api_key,
+  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_pass:nil,
+                                               data_governance: DataGovernance::GLOBAL)
     #
     #   Create an instance of ConfigCatClient and setup Manual Poll mode with custom options
     #
-    #   :param api_key: ConfigCat ApiKey to access your configuration.
+    #   :param sdk_key: ConfigCat SDK Key to access your configuration.
     #   :param config_cache_class: If you want to use custom caching instead of the client's default InMemoryConfigCache,
     #   You can provide an implementation of ConfigCache.
     #   :param base_url: You can set a base_url if you want to use a proxy server between your application and ConfigCat
@@ -124,11 +141,15 @@ module ConfigCat
     #   :param proxy_port: Proxy port
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
+    #   :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
+    #   (Only Organization Admins have access)
     #
-    if api_key === nil
-      raise ConfigCatClientException, "API Key is required."
+    if sdk_key === nil
+      raise ConfigCatClientException, "SDK Key is required."
     end
-    return ConfigCatClient.new(api_key,
+    return ConfigCatClient.new(sdk_key,
                                poll_interval_seconds: 0,
                                max_init_wait_time_seconds: 0,
                                on_configuration_changed_callback: nil,
@@ -138,7 +159,8 @@ module ConfigCat
                                proxy_address: proxy_address,
                                proxy_port: proxy_port,
                                proxy_user: proxy_user,
-                               proxy_pass: proxy_pass)
+                               proxy_pass: proxy_pass,
+                               data_governance: data_governance)
   end
 
 end

data/lib/configcat/autopollingcachepolicy.rb

@@ -1,9 +1,10 @@
 require 'configcat/interfaces'
+require 'configcat/constants'
 require 'concurrent'
 
 module ConfigCat
   class AutoPollingCachePolicy < CachePolicy
-    def initialize(config_fetcher, config_cache, poll_interval_seconds=60, max_init_wait_time_seconds=5, on_configuration_changed_callback=nil)
+    def initialize(config_fetcher, config_cache, cache_key, poll_interval_seconds=60, max_init_wait_time_seconds=5, on_configuration_changed_callback=nil)
       if poll_interval_seconds < 1
         poll_interval_seconds = 1
       end
@@ -12,6 +13,7 @@ module ConfigCat
       end
       @_config_fetcher = config_fetcher
       @_config_cache = config_cache
+      @_cache_key = cache_key
       @_poll_interval_seconds = poll_interval_seconds
       @_max_init_wait_time_seconds = max_init_wait_time_seconds
       @_on_configuration_changed_callback = on_configuration_changed_callback
@@ -40,7 +42,7 @@ module ConfigCat
       end
       begin
         @_lock.acquire_read_lock()
-        return @_config_cache.get()
+        return @_config_cache.get(@_cache_key)
       ensure
         @_lock.release_read_lock()
       end
@@ -48,29 +50,32 @@ module ConfigCat
 
     def force_refresh()
       begin
-        configuration = @_config_fetcher.get_configuration_json()
+        configuration_response = @_config_fetcher.get_configuration_json()
 
         begin
           @_lock.acquire_read_lock()
-          old_configuration = @_config_cache.get()
+          old_configuration = @_config_cache.get(@_cache_key)
         ensure
           @_lock.release_read_lock()
         end
 
-        if configuration != old_configuration
-          begin
-            @_lock.acquire_write_lock()
-            @_config_cache.set(configuration)
-            @_initialized = true
-          ensure
-            @_lock.release_write_lock()
-          end
-          begin
-            if !@_on_configuration_changed_callback.equal?(nil)
-              @_on_configuration_changed_callback.()
+        if configuration_response.is_fetched()
+          configuration = configuration_response.json()
+          if configuration != old_configuration
+            begin
+              @_lock.acquire_write_lock()
+              @_config_cache.set(@_cache_key, configuration)
+              @_initialized = true
+            ensure
+              @_lock.release_write_lock()
+            end
+            begin
+              if !@_on_configuration_changed_callback.equal?(nil)
+                @_on_configuration_changed_callback.()
+              end
+            rescue Exception => e
+              ConfigCat.logger.error("Exception in on_configuration_changed_callback: #{e.class}:'#{e}'")
             end
-          rescue Exception => e
-            ConfigCat.logger.error("Exception in on_configuration_changed_callback: #{e.class}:'#{e}'")
           end
         end
 
@@ -78,7 +83,7 @@ module ConfigCat
           @_initialized = true
         end
       rescue Exception => e
-        ConfigCat.logger.error("Double-check your API KEY at https://app.configcat.com/apikey.")
+        ConfigCat.logger.error("Double-check your SDK Key at https://app.configcat.com/sdkkey.")
         ConfigCat.logger.error "threw exception #{e.class}:'#{e}'"
         ConfigCat.logger.error "stacktrace: #{e.backtrace}"
       end

data/lib/configcat/configcache.rb

@@ -3,15 +3,15 @@ require 'configcat/interfaces'
 module ConfigCat
   class InMemoryConfigCache < ConfigCache
     def initialize()
-      @_value = nil
+      @_value = {}
     end
 
-    def get()
-      return @_value
+    def get(key)
+      return @_value.fetch(key, nil)
     end
 
-    def set(value)
-      @_value = value
+    def set(key, value)
+      @_value[key] = value
     end
   end
 end

data/lib/configcat/configcatclient.rb

@@ -5,10 +5,12 @@ require 'configcat/autopollingcachepolicy'
 require 'configcat/manualpollingcachepolicy'
 require 'configcat/lazyloadingcachepolicy'
 require 'configcat/rolloutevaluator'
+require 'configcat/datagovernance'
 
 module ConfigCat
+  KeyValue = Struct.new(:key, :value)
   class ConfigCatClient
-    def initialize(api_key,
+    def initialize(sdk_key,
                    poll_interval_seconds:60,
                    max_init_wait_time_seconds:5,
                    on_configuration_changed_callback:nil,
@@ -18,11 +20,12 @@ module ConfigCat
                    proxy_address:nil,
                    proxy_port:nil,
                    proxy_user:nil,
-                   proxy_pass:nil)
-      if api_key === nil
-        raise ConfigCatClientException, "API Key is required."
+                   proxy_pass:nil,
+                   data_governance: DataGovernance::GLOBAL)
+      if sdk_key === nil
+        raise ConfigCatClientException, "SDK Key is required."
       end
-      @_api_key = api_key
+      @_sdk_key = sdk_key
 
       if config_cache_class
         @_config_cache = config_cache_class.new()
@@ -31,15 +34,15 @@ module ConfigCat
       end
 
       if poll_interval_seconds > 0
-        @_config_fetcher = CacheControlConfigFetcher.new(api_key, "p", base_url, proxy_address, proxy_port, proxy_user, proxy_pass)
-        @_cache_policy = AutoPollingCachePolicy.new(@_config_fetcher, @_config_cache, poll_interval_seconds, max_init_wait_time_seconds, on_configuration_changed_callback)
+        @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "p", base_url, proxy_address, proxy_port, proxy_user, proxy_pass, 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)
       else
         if cache_time_to_live_seconds > 0
-          @_config_fetcher = CacheControlConfigFetcher.new(api_key, "l", base_url, proxy_address, proxy_port, proxy_user, proxy_pass)
-          @_cache_policy = LazyLoadingCachePolicy.new(@_config_fetcher, @_config_cache, cache_time_to_live_seconds)
+          @_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(api_key, "m", base_url, proxy_address, proxy_port, proxy_user, proxy_pass)
-          @_cache_policy = ManualPollingCachePolicy.new(@_config_fetcher, @_config_cache)
+          @_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
       end
     end
@@ -49,7 +52,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()
@@ -57,7 +61,69 @@ module ConfigCat
       if config === nil
         return []
       end
-      return config.keys
+      feature_flags = config.fetch(FEATURE_FLAGS, nil)
+      if feature_flags === nil
+        return []
+      end
+      return feature_flags.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
+
+      feature_flags = config.fetch(FEATURE_FLAGS, nil)
+      if feature_flags === nil
+        ConfigCat.logger.warn("Evaluating get_key_and_value('%s') failed. Cache is empty. Returning None." % variation_id)
+        return nil
+      end
+
+      for key, value in feature_flags
+        if variation_id == value.fetch(VARIATION_ID, nil)
+          return KeyValue.new(key, value[VALUE])
+        end
+
+        rollout_rules = value.fetch(ROLLOUT_RULES, [])
+        for rollout_rule in rollout_rules
+          if variation_id == rollout_rule.fetch(VARIATION_ID, nil)
+            return KeyValue.new(key, rollout_rule[VALUE])
+          end
+        end
+
+        rollout_percentage_items = value.fetch(ROLLOUT_PERCENTAGE_ITEMS, [])
+        for rollout_percentage_item in rollout_percentage_items
+          if variation_id == rollout_percentage_item.fetch(VARIATION_ID, nil)
+            return KeyValue.new(key, rollout_percentage_item[VALUE])
+          end
+        end
+      end
     end
 
     def force_refresh()
@@ -69,5 +135,11 @@ module ConfigCat
       @_config_fetcher.close()
     end
 
+    private
+
+    def _get_cache_key()
+      return Digest::SHA1.hexdigest("ruby_" + CONFIG_FILE_NAME + "_" + @_sdk_key)
+    end
+
   end
 end

data/lib/configcat/configfetcher.rb

@@ -1,41 +1,129 @@
 require 'configcat/interfaces'
 require 'configcat/version'
+require 'configcat/datagovernance'
+require 'configcat/constants'
 require 'net/http'
 require 'uri'
 require 'json'
 
 module ConfigCat
-  BASE_URL = "https://cdn.configcat.com"
+  BASE_URL_GLOBAL = "https://cdn-global.configcat.com"
+  BASE_URL_EU_ONLY = "https://cdn-eu.configcat.com"
   BASE_PATH = "configuration-files/"
-  BASE_EXTENSION = "/config_v3.json"
+  BASE_EXTENSION = "/" + CONFIG_FILE_NAME + ".json"
+
+  class RedirectMode
+    NO_REDIRECT = 0
+    SHOULD_REDIRECT = 1
+    FORCE_REDIRECT = 2
+  end
+
+  class FetchResponse
+    def initialize(response)
+      @_response = response
+    end
+
+    # Returns the json-encoded content of a response, if any
+    def json()
+      return JSON.parse(@_response.body)
+    end
+
+    # Gets whether a new configuration value was fetched or not
+    def is_fetched()
+      code = @_response.code.to_i
+      return 200 <= code && code < 300
+    end
+
+    # Gets whether the fetch resulted a '304 Not Modified' or not
+    def is_not_modified()
+      return @_response.code == "304"
+    end
+  end
 
   class CacheControlConfigFetcher < ConfigFetcher
-    def initialize(api_key, mode, base_url=nil, proxy_address=nil, proxy_port=nil, proxy_user=nil, proxy_pass=nil)
-      @_api_key = api_key
-      @_etag = nil
+    def initialize(sdk_key, mode, base_url=nil, proxy_address=nil, proxy_port=nil, proxy_user=nil, proxy_pass=nil,
+                   data_governance=DataGovernance::GLOBAL)
+      @_sdk_key = sdk_key
+      @_proxy_address = proxy_address
+      @_proxy_port = proxy_port
+      @_proxy_user = proxy_user
+      @_proxy_pass = proxy_pass
+      @_etag = ""
       @_headers = {"User-Agent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "X-ConfigCat-UserAgent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "Content-Type" => "application/json"}
       if !base_url.equal?(nil)
+        @_base_url_overridden = true
         @_base_url = base_url.chomp("/")
       else
-        @_base_url = BASE_URL
+        @_base_url_overridden = false
+        if data_governance == DataGovernance::EU_ONLY
+          @_base_url = BASE_URL_EU_ONLY
+        else
+          @_base_url = BASE_URL_GLOBAL
+        end
       end
-      uri = URI.parse(@_base_url)
-      @_http = Net::HTTP.new(uri.host, uri.port, proxy_address, proxy_port, proxy_user, proxy_pass)
-      @_http.use_ssl = true if uri.scheme == 'https'
-      @_http.open_timeout = 10 # in seconds
-      @_http.read_timeout = 30 # in seconds
     end
 
-    def get_configuration_json()
+    # Returns the FetchResponse object contains configuration json Dictionary
+    def get_configuration_json(retries=0)
       ConfigCat.logger.debug "Fetching configuration from ConfigCat"
-      uri = URI.parse((((@_base_url + ("/")) + BASE_PATH) + @_api_key) + BASE_EXTENSION)
-      @_headers["If-None-Match"] = @_etag unless @_etag.nil?
-      request = Net::HTTP::Get.new(uri.request_uri, @_headers)
+      uri = URI.parse((((@_base_url + ("/")) + BASE_PATH) + @_sdk_key) + BASE_EXTENSION)
+      headers = @_headers
+      headers["If-None-Match"] = @_etag unless @_etag.empty?
+      _create_http()
+      request = Net::HTTP::Get.new(uri.request_uri, headers)
       response = @_http.request(request)
-      json = JSON.parse(response.body)
-      @_etag = response["ETag"]
+      etag = response["ETag"]
+      @_etag = etag unless etag.nil? || etag.empty?
       ConfigCat.logger.debug "ConfigCat configuration json fetch response code:#{response.code} Cached:#{response['ETag']}"
-      return json
+      fetch_response = FetchResponse.new(response)
+
+      # If there wasn't a config change, we return the response.
+      if !fetch_response.is_fetched()
+        return fetch_response
+      end
+
+      preferences = fetch_response.json().fetch(PREFERENCES, nil)
+      if preferences === nil
+        return fetch_response
+      end
+
+      base_url = preferences.fetch(BASE_URL, nil)
+
+      # If the base_url is the same as the last called one, just return the response.
+      if base_url.equal?(nil) || @_base_url == base_url
+        return fetch_response
+      end
+
+      redirect = preferences.fetch(REDIRECT, nil)
+      # If the base_url is overridden, and the redirect parameter is not 2 (force),
+      # the SDK should not redirect the calls and it just have to return the response.
+      if @_base_url_overridden && redirect != RedirectMode::FORCE_REDIRECT
+        return fetch_response
+      end
+
+      # The next call should use the base_url provided in the config json
+      @_base_url = base_url
+
+      # If the redirect property == 0 (redirect not needed), return the response
+      if redirect == RedirectMode::NO_REDIRECT
+        # Return the response
+        return fetch_response
+      end
+
+      # Try to download again with the new url
+
+      if redirect == RedirectMode::SHOULD_REDIRECT
+        ConfigCat.logger.warn("Your data_governance parameter at ConfigCatClient initialization is not in sync with your preferences on the ConfigCat Dashboard: https://app.configcat.com/organization/data-governance. Only Organization Admins can set this preference.")
+      end
+
+      # To prevent loops we check if we retried at least 3 times with the new base_url
+      if retries >= 2
+        ConfigCat.logger.error("Redirect loop during config.json fetch. Please contact support@configcat.com.")
+        return fetch_response
+      end
+
+      # Retry the config download with the new base_url
+      return get_configuration_json(retries + 1)
     end
 
     def close()
@@ -43,5 +131,19 @@ module ConfigCat
         @_http = nil
       end
     end
+
+    private
+
+    def _create_http()
+      uri = URI.parse(@_base_url)
+      use_ssl = true if uri.scheme == 'https'
+      if @_http.equal?(nil) || @_http.address != uri.host || @_http.port != uri.port || @_http.use_ssl? != use_ssl
+        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
+      end
+    end
   end
 end

data/lib/configcat/constants.rb

@@ -0,0 +1,17 @@
+module ConfigCat
+  CONFIG_FILE_NAME = "config_v5"
+
+  PREFERENCES = "p"
+  BASE_URL = "u"
+  REDIRECT = "r"
+
+  FEATURE_FLAGS = "f"
+  VALUE = "v"
+  COMPARATOR = "t"
+  COMPARISON_ATTRIBUTE = "a"
+  COMPARISON_VALUE = "c"
+  ROLLOUT_PERCENTAGE_ITEMS = "p"
+  PERCENTAGE = "p"
+  ROLLOUT_RULES = "r"
+  VARIATION_ID = "i"
+end

data/lib/configcat/datagovernance.rb

@@ -0,0 +1,10 @@
+module ConfigCat
+  class DataGovernance
+    # Control the location of the config.json files containing your feature flags
+    # and settings within the ConfigCat CDN.
+    # Global: Select this if your feature flags are published to all global CDN nodes.
+    # EuOnly: Select this if your feature flags are published to CDN nodes only in the EU.
+    GLOBAL = 0
+    EU_ONLY = 1
+  end
+end

data/lib/configcat/interfaces.rb

@@ -23,13 +23,13 @@ module ConfigCat
     #       Config cache interface
     #
 
-    def get()
+    def get(key)
       #
       #     :returns the config json object from the cache
       #
     end
 
-    def set(value)
+    def set(key, value)
       #
       #     Sets the config json cache.
       #

data/lib/configcat/lazyloadingcachepolicy.rb

@@ -1,15 +1,18 @@
 require 'configcat/interfaces'
+require 'configcat/constants'
 require 'concurrent'
 
+
 module ConfigCat
   class LazyLoadingCachePolicy < CachePolicy
 
-    def initialize(config_fetcher, config_cache, cache_time_to_live_seconds=60)
+    def initialize(config_fetcher, config_cache, cache_key, cache_time_to_live_seconds=60)
       if cache_time_to_live_seconds < 1
         cache_time_to_live_seconds = 1
       end
       @_config_fetcher = config_fetcher
       @_config_cache = config_cache
+      @_cache_key = cache_key
       @_cache_time_to_live = cache_time_to_live_seconds
       @_lock = Concurrent::ReadWriteLock.new()
       @_last_updated = nil
@@ -20,7 +23,7 @@ module ConfigCat
         @_lock.acquire_read_lock()
         utc_now = Time.now.utc
         if !@_last_updated.equal?(nil) && (@_last_updated + @_cache_time_to_live > utc_now)
-          config = @_config_cache.get()
+          config = @_config_cache.get(@_cache_key)
           if !config.equal?(nil)
             return config
           end
@@ -31,7 +34,7 @@ module ConfigCat
       force_refresh()
       begin
         @_lock.acquire_read_lock()
-        config = @_config_cache.get()
+        config = @_config_cache.get(@_cache_key)
         return config
       ensure
         @_lock.release_read_lock()
@@ -40,16 +43,19 @@ module ConfigCat
 
     def force_refresh()
       begin
-        configuration = @_config_fetcher.get_configuration_json()
-        begin
-          @_lock.acquire_write_lock()
-          @_config_cache.set(configuration)
-          @_last_updated = Time.now.utc
-        ensure
-          @_lock.release_write_lock()
+        configuration_response = @_config_fetcher.get_configuration_json()
+        if configuration_response.is_fetched()
+          configuration = configuration_response.json()
+          begin
+            @_lock.acquire_write_lock()
+            @_config_cache.set(@_cache_key, configuration)
+            @_last_updated = Time.now.utc
+          ensure
+            @_lock.release_write_lock()
+          end
         end
       rescue StandardError => e
-        ConfigCat.logger.error("Double-check your API KEY at https://app.configcat.com/apikey.")
+        ConfigCat.logger.error("Double-check your SDK Key at https://app.configcat.com/sdkkey.")
         ConfigCat.logger.error "threw exception #{e.class}:'#{e}'"
         ConfigCat.logger.error "stacktrace: #{e.backtrace}"
       end

data/lib/configcat/manualpollingcachepolicy.rb

@@ -1,18 +1,20 @@
 require 'configcat/interfaces'
+require 'configcat/constants'
 require 'concurrent'
 
 module ConfigCat
   class ManualPollingCachePolicy < CachePolicy
-    def initialize(config_fetcher, config_cache)
+    def initialize(config_fetcher, config_cache, cache_key)
       @_config_fetcher = config_fetcher
       @_config_cache = config_cache
+      @_cache_key = cache_key
       @_lock = Concurrent::ReadWriteLock.new()
     end
 
     def get()
       begin
         @_lock.acquire_read_lock()
-        config = @_config_cache.get()
+        config = @_config_cache.get(@_cache_key)
         return config
       ensure
         @_lock.release_read_lock()
@@ -21,15 +23,18 @@ module ConfigCat
 
     def force_refresh()
       begin
-        configuration = @_config_fetcher.get_configuration_json()
-        begin
-          @_lock.acquire_write_lock()
-          @_config_cache.set(configuration)
-        ensure
-          @_lock.release_write_lock()
+        configuration_response = @_config_fetcher.get_configuration_json()
+        if configuration_response.is_fetched()
+          configuration = configuration_response.json()
+          begin
+            @_lock.acquire_write_lock()
+            @_config_cache.set(@_cache_key, configuration)
+          ensure
+            @_lock.release_write_lock()
+          end
         end
       rescue StandardError => e
-        ConfigCat.logger.error("Double-check your API KEY at https://app.configcat.com/apikey.")
+        ConfigCat.logger.error("Double-check your SDK Key at https://app.configcat.com/sdkkey.")
         ConfigCat.logger.error "threw exception #{e.class}:'#{e}'"
         ConfigCat.logger.error "stacktrace: #{e.backtrace}"
       end

data/lib/configcat/rolloutevaluator.rb

@@ -1,4 +1,5 @@
 require 'configcat/user'
+require 'configcat/constants'
 require 'digest'
 require 'semantic'
 
@@ -6,21 +7,19 @@ 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)"]
 
-    VALUE = "v"
-    COMPARATOR = "t"
-    COMPARISON_ATTRIBUTE = "a"
-    COMPARISON_VALUE = "c"
-    ROLLOUT_PERCENTAGE_ITEMS = "p"
-    PERCENTAGE = "p"
-    ROLLOUT_RULES = "r"
-
-    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)
+      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
+
+      setting_descriptor = feature_flags.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
+        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
       end
 
       rollout_rules = setting_descriptor.fetch(ROLLOUT_RULES, [])
@@ -35,8 +34,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 +54,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 +91,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 +107,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 +124,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 +134,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 +155,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 = "2.0.2"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: semantic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +56,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Feature Flags created by developers for developers with ❤️. ConfigCat
   lets you manage feature flags across frontend, backend, mobile, and desktop apps
   without (re)deploying code. % rollouts, user targeting, segmentation. Feature toggle
@@ -96,6 +110,8 @@ files:
 - lib/configcat/configcache.rb
 - lib/configcat/configcatclient.rb
 - lib/configcat/configfetcher.rb
+- lib/configcat/constants.rb
+- lib/configcat/datagovernance.rb
 - lib/configcat/interfaces.rb
 - lib/configcat/lazyloadingcachepolicy.rb
 - lib/configcat/manualpollingcachepolicy.rb
@@ -112,7 +128,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -121,8 +137,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.