configcat 6.1.0 → 8.0.0

data/lib/configcat/user.rb

@@ -1,10 +1,45 @@
 module ConfigCat
-  #    The user object for variation evaluation
+  # User Object. Contains user attributes which are used for evaluating targeting rules and percentage options.
   class User
     PREDEFINED = ["Identifier", "Email", "Country"]
 
     attr_reader :identifier
 
+    # Initialize a User object.
+    # Args:
+    #     identifier: The unique identifier of the user or session (e.g. email address, primary key, session ID, etc.)
+    #     email: Email address of the user.
+    #     country: Country of the user.
+    #     custom: Custom attributes of the user for advanced targeting rule definitions (e.g. role, subscription type, etc.)
+    #     All comparators support string values as User Object attribute (in some cases they need to be provided in a
+    #     specific format though, see below), but some of them also support other types of values. It depends on the
+    #     comparator how the values will be handled. The following rules apply:
+    #     Text-based comparators (EQUALS, IS_ONE_OF, etc.)
+    #     * accept string values,
+    #     * all other values are automatically converted to string
+    #       (a warning will be logged but evaluation will continue as normal).
+    #     SemVer-based comparators (IS_ONE_OF_SEMVER, LESS_THAN_SEMVER, GREATER_THAN_SEMVER, etc.)
+    #     * accept string values containing a properly formatted, valid semver value,
+    #     * all other values are considered invalid
+    #       (a warning will be logged and the currently evaluated targeting rule will be skipped).
+    #     Number-based comparators (EQUALS_NUMBER, LESS_THAN_NUMBER, GREATER_THAN_OR_EQUAL_NUMBER, etc.)
+    #     * accept float values and all other numeric values which can safely be converted to float,
+    #     * accept string values containing a properly formatted, valid float value,
+    #     * all other values are considered invalid
+    #       (a warning will be logged and the currently evaluated targeting rule will be skipped).
+    #     Date time-based comparators (BEFORE_DATETIME / AFTER_DATETIME)
+    #     * accept datetime values, which are automatically converted to a second-based Unix timestamp
+    #       (datetime values with naive timezone are considered to be in UTC),
+    #     * accept float values representing a second-based Unix timestamp
+    #       and all other numeric values which can safely be converted to float,
+    #     * accept string values containing a properly formatted, valid float value,
+    #     * all other values are considered invalid
+    #       (a warning will be logged and the currently evaluated targeting rule will be skipped).
+    #     String array-based comparators (ARRAY_CONTAINS_ANY_OF / ARRAY_NOT_CONTAINS_ANY_OF)
+    #     * accept arrays of strings,
+    #     * accept string values containing a valid JSON string which can be deserialized to an array of strings,
+    #     * all other values are considered invalid
+    #       (a warning will be logged and the currently evaluated targeting rule will be skipped).
     def initialize(identifier, email: nil, country: nil, custom: nil)
       @identifier = (!identifier.equal?(nil)) ? identifier : ""
       @data = { "Identifier" => identifier, "Email" => email, "Country" => country }
@@ -26,10 +61,14 @@ module ConfigCat
       dump = {
         'Identifier': @identifier,
         'Email': @data['Email'],
-        'Country': @data['Country'],
-        'Custom': @custom,
+        'Country': @data['Country']
       }
-      return dump.to_json
+      dump.merge!(@custom) if @custom
+      filtered_dump = dump.reject { |_, v| v.nil? }
+      formatted_dump = filtered_dump.transform_values do |value|
+        value.is_a?(DateTime) ? value.strftime('%Y-%m-%dT%H:%M:%S.%L%z') : value
+      end
+      return JSON.generate(formatted_dump, ascii_only: false, separators: %w[, :])
     end
   end
 end

data/lib/configcat/utils.rb

@@ -3,8 +3,28 @@ module ConfigCat
     DISTANT_FUTURE = Float::INFINITY
     DISTANT_PAST = 0
 
+    def self.get_date_time(seconds_since_epoch)
+      Time.at(seconds_since_epoch).utc
+    end
+
     def self.get_utc_now_seconds_since_epoch
-      return Time.now.utc.to_f
+      Time.now.utc.to_f
+    end
+
+    def self.get_seconds_since_epoch(date_time)
+      date_time.to_time.to_f
+    end
+
+    def self.is_string_list(value)
+      # Check if the value is an Array
+      return false unless value.is_a?(Array)
+
+      # Check if all elements in the Array are Strings
+      value.each do |item|
+        return false unless item.is_a?(String)
+      end
+
+      return true
     end
   end
 end

data/lib/configcat/version.rb

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

data/lib/configcat.rb

@@ -24,164 +24,4 @@ module ConfigCat
   def ConfigCat.close_all
     ConfigCatClient.close_all
   end
-
-  def ConfigCat.create_client(sdk_key, data_governance: DataGovernance::GLOBAL)
-    #
-    #   Create an instance of ConfigCatClient and setup Auto Poll mode with default options
-    #
-    #   :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(sdk_key, data_governance: data_governance)
-  end
-
-  # Create an instance of ConfigCatClient and setup Auto Poll mode with custom options
-  #
-  # :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.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # 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
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides 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
-  # (Only Organization Admins have access)
-  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: nil,
-                                             base_url: nil,
-                                             proxy_address: nil,
-                                             proxy_port: nil,
-                                             proxy_user: nil,
-                                             proxy_pass: nil,
-                                             open_timeout_seconds: 10,
-                                             read_timeout_seconds: 30,
-                                             flag_overrides: nil,
-                                             data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.auto_poll(poll_interval_seconds: poll_interval_seconds, max_init_wait_time_seconds: max_init_wait_time_seconds),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_auto_poll is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    client.hooks.add_on_config_changed(on_configuration_changed_callback) if on_configuration_changed_callback
-    return client
-  end
-
-  # Create an instance of ConfigCatClient and setup Lazy Load mode with custom options
-  #
-  # :param sdk_key: ConfigCat SDK Key to access your configuration.
-  # :param cache_time_to_live_seconds: The cache TTL.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # 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
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides 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
-  # (Only Organization Admins have access)
-  def ConfigCat.create_client_with_lazy_load(sdk_key,
-                                             cache_time_to_live_seconds: 60,
-                                             config_cache: nil,
-                                             base_url: nil,
-                                             proxy_address: nil,
-                                             proxy_port: nil,
-                                             proxy_user: nil,
-                                             proxy_pass: nil,
-                                             open_timeout_seconds: 10,
-                                             read_timeout_seconds: 30,
-                                             flag_overrides: nil,
-                                             data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.lazy_load(cache_refresh_interval_seconds: cache_time_to_live_seconds),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_lazy_load is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    return client
-  end
-
-  # Create an instance of ConfigCatClient and setup Manual Poll mode with custom options
-  #
-  # :param sdk_key: ConfigCat SDK Key to access your configuration.
-  # :param config_cache: If you want to use custom caching instead of the client's default,
-  # 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
-  # :param proxy_address: Proxy address
-  # :param proxy_port: Proxy port
-  # :param proxy_user: username for proxy authentication
-  # :param proxy_pass: password for proxy authentication
-  # :param open_timeout_seconds: The number of seconds to wait for the server to make the initial connection. Default: 10 seconds.
-  # :param read_timeout_seconds: The number of seconds to wait for the server to respond before giving up. Default: 30 seconds.
-  # :param flag_overrides: A FlagOverrides 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
-  # (Only Organization Admins have access)
-  def ConfigCat.create_client_with_manual_poll(sdk_key,
-                                               config_cache: nil,
-                                               base_url: nil,
-                                               proxy_address: nil,
-                                               proxy_port: nil,
-                                               proxy_user: nil,
-                                               proxy_pass: nil,
-                                               open_timeout_seconds: 10,
-                                               read_timeout_seconds: 30,
-                                               flag_overrides: nil,
-                                               data_governance: DataGovernance::GLOBAL)
-    options = ConfigCatOptions.new(
-      base_url: base_url,
-      polling_mode: PollingMode.manual_poll(),
-      config_cache: config_cache,
-      proxy_address: proxy_address,
-      proxy_port: proxy_port,
-      proxy_user: proxy_user,
-      proxy_pass: proxy_pass,
-      open_timeout_seconds: open_timeout_seconds,
-      read_timeout_seconds: read_timeout_seconds,
-      flag_overrides: flag_overrides,
-      data_governance: data_governance
-    )
-    ConfigCat.logger.warn('create_client_with_manual_poll is deprecated. Create the ConfigCat Client as a Singleton object with `configcatclient.get()` instead')
-    client = ConfigCatClient.get(sdk_key, options)
-    return client
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configcat
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - ConfigCat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -120,6 +120,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/configcat.rb
+- lib/configcat/config.rb
 - lib/configcat/configcache.rb
 - lib/configcat/configcatclient.rb
 - lib/configcat/configcatlogger.rb
@@ -127,9 +128,10 @@ files:
 - lib/configcat/configentry.rb
 - lib/configcat/configfetcher.rb
 - lib/configcat/configservice.rb
-- lib/configcat/constants.rb
 - lib/configcat/datagovernance.rb
+- lib/configcat/evaluationcontext.rb
 - lib/configcat/evaluationdetails.rb
+- lib/configcat/evaluationlogbuilder.rb
 - lib/configcat/interfaces.rb
 - lib/configcat/localdictionarydatasource.rb
 - lib/configcat/localfiledatasource.rb

data/lib/configcat/constants.rb

@@ -1,17 +0,0 @@
-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