configcat 2.0.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 805c9d54b6d9b24a12dfb2da3fdb8f7f9c22ee07a37c0be1c08e800a79fcee99
-  data.tar.gz: 5cfccd8b9225f636d2c8d5f4fb24d92658f13612fa091d8b30593a5569261891
+  metadata.gz: ed70c40f6865601f6d5476cbb12b158e359413baa9fc186a58c0bc0b1334e9a5
+  data.tar.gz: 848a6b3550eee7cdc6cb0467b0b0893e6f37ce9d1a0dffb95c77ca4f248e8d74
 SHA512:
-  metadata.gz: 06bbc69993cc02cf6912ca7e6518910ac1154049d78636597ae1431f761aa887b1ecafb665b3b93a4d1bca51ec0177dc2e59ee746ed768496dc35e31d3369bdd
-  data.tar.gz: 1bf9ca51425faf2c2a5b1346e09dfa87c8f382e7dfe0d828016607597fe28b7c29174696da41a4bb13e69befd58708c78e51fe57305bfdb79fabdb507d558d0a
+  metadata.gz: 9aa50e9733ab9ed0612d28fe2daee49ce0396feb1fab353324b2d3ae63ce67722a58d7c0c67d5884d4146106bd52859e36e08725a1a1757390bb6462baf4c1e0
+  data.tar.gz: 40a2aa9993dc5ba3cba64c944a06c9c4c15895ba4ee6f227db250abe051894956f7c3fc2fe7dff298582ce4e573190e5cc8d4e0055afcdff0e5ed278f7d2a52e

data/lib/configcat.rb

@@ -10,16 +10,16 @@ module ConfigCat
     attr_accessor :logger
   end
 
-  def ConfigCat.create_client(api_key)
+  def ConfigCat.create_client(sdk_key)
     #
     #   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.
     #
-    return create_client_with_auto_poll(api_key)
+    return create_client_with_auto_poll(sdk_key)
   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,
@@ -32,7 +32,7 @@ module ConfigCat
     #
     #   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.
@@ -44,8 +44,8 @@ module ConfigCat
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
     #
-    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 +53,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,
@@ -66,7 +66,7 @@ module ConfigCat
                                proxy_pass: proxy_pass)
   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,
@@ -77,7 +77,7 @@ module ConfigCat
     #
     #   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.
@@ -87,13 +87,13 @@ module ConfigCat
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
     #
-    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,
@@ -106,7 +106,7 @@ module ConfigCat
                                proxy_pass: proxy_pass)
   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,
@@ -116,7 +116,7 @@ module ConfigCat
     #
     #   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
@@ -125,10 +125,10 @@ module ConfigCat
     #   :param proxy_user: username for proxy authentication
     #   :param proxy_pass: password for proxy authentication
     #
-    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,

data/lib/configcat/autopollingcachepolicy.rb

@@ -81,7 +81,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/configcatclient.rb

@@ -8,7 +8,7 @@ require 'configcat/rolloutevaluator'
 
 module ConfigCat
   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,
@@ -19,10 +19,10 @@ module ConfigCat
                    proxy_port:nil,
                    proxy_user:nil,
                    proxy_pass:nil)
-      if api_key === nil
-        raise ConfigCatClientException, "API Key is required."
+      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,14 +31,14 @@ 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)
+        @_config_fetcher = CacheControlConfigFetcher.new(sdk_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)
       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)
+          @_config_fetcher = CacheControlConfigFetcher.new(sdk_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)
         else
-          @_config_fetcher = CacheControlConfigFetcher.new(api_key, "m", base_url, proxy_address, proxy_port, proxy_user, proxy_pass)
+          @_config_fetcher = CacheControlConfigFetcher.new(sdk_key, "m", base_url, proxy_address, proxy_port, proxy_user, proxy_pass)
           @_cache_policy = ManualPollingCachePolicy.new(@_config_fetcher, @_config_cache)
         end
       end

data/lib/configcat/configfetcher.rb

@@ -32,8 +32,8 @@ module ConfigCat
   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
+    def initialize(sdk_key, mode, base_url=nil, proxy_address=nil, proxy_port=nil, proxy_user=nil, proxy_pass=nil)
+      @_sdk_key = sdk_key
       @_etag = ""
       @_headers = {"User-Agent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "X-ConfigCat-UserAgent" => ((("ConfigCat-Ruby/") + mode) + ("-")) + VERSION, "Content-Type" => "application/json"}
       if !base_url.equal?(nil)
@@ -51,7 +51,7 @@ module ConfigCat
     # Returns the FetchResponse object contains configuration json Dictionary
     def get_configuration_json()
       ConfigCat.logger.debug "Fetching configuration from ConfigCat"
-      uri = URI.parse((((@_base_url + ("/")) + BASE_PATH) + @_api_key) + BASE_EXTENSION)
+      uri = URI.parse((((@_base_url + ("/")) + BASE_PATH) + @_sdk_key) + BASE_EXTENSION)
       headers = @_headers
       headers["If-None-Match"] = @_etag unless @_etag.empty?
       request = Net::HTTP::Get.new(uri.request_uri, headers)

data/lib/configcat/lazyloadingcachepolicy.rb

@@ -52,7 +52,7 @@ module ConfigCat
           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

@@ -32,7 +32,7 @@ module ConfigCat
           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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 3.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby