configcat 6.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6979b91044d036414367912894396e332a9fdd10b4239e72294a74949d8e5c82
-  data.tar.gz: fd58f1ea297a2fce1cf47e4bfe521724677617a32163d7b5bde3f2f80234482e
+  metadata.gz: 360b940ee0e89f6e86195d9ba17d4b08df9a8c3dedb237dc3c57e162f7c5cf22
+  data.tar.gz: bf281cf73d78d460e7c9d327f5518d707064920f4ee74b15b2db8730b9e69628
 SHA512:
-  metadata.gz: ae734ae5e04ae73c6ea7eb62c48a5633a943ac009c2f7b59729028a141932cdfdfceabbdef207d774153f586c0c418df939c0042ea288debe6bfccf877765ff7
-  data.tar.gz: 50b222dd87b113807f72ab24f3e0dfd01bb752639ab394094e40c34461e57ca0637d59038883b78d02dcdcfcd0469bfc21c6b6a5f74ab0b4658c17fcd8d7e8bc
+  metadata.gz: 8bbaae3fba88573a213cbd9d71e512f1ef9bb6b8d59c0a84ce77a867b4df610aaa1a2d5cdfa0fb252db78b53e4522fcd1bb450f7e232b233e4a8f422beab0c39
+  data.tar.gz: 23172cbd4aa0e5620bfd8b18ce6274f28b9b3ab8c10b13033d545ddf02e1c7dad95bba4f77add31a5b6013395760862841d718ff8a0b5d5b510a778d94889434

data/lib/configcat/config.rb

@@ -0,0 +1,317 @@
+module ConfigCat
+  CONFIG_FILE_NAME = 'config_v6'
+  SERIALIZATION_FORMAT_VERSION = 'v2'
+
+  # Config
+  PREFERENCES = 'p'
+  SEGMENTS = 's'
+  FEATURE_FLAGS = 'f'
+
+  # Preferences
+  BASE_URL = 'u'
+  REDIRECT = 'r'
+  SALT = 's'
+
+  # Segment
+  SEGMENT_NAME = 'n'  # The first 4 characters of the Segment's name
+  SEGMENT_CONDITIONS = 'r'  # The list of segment rule conditions (has a logical AND relation between the items).
+
+  # Segment Condition (User Condition)
+  COMPARISON_ATTRIBUTE = 'a'  # The attribute of the user object that should be used to evaluate this rule
+  COMPARATOR = 'c'
+
+  # Feature flag (Evaluation Formula)
+  SETTING_TYPE = 't'  # 0 = bool, 1 = string, 2 = int, 3 = double
+  PERCENTAGE_RULE_ATTRIBUTE = 'a'  # Percentage rule evaluation hashes this attribute of the User object to calculate the buckets
+  TARGETING_RULES = 'r'  # Targeting Rules (Logically connected by OR)
+  PERCENTAGE_OPTIONS = 'p'  # Percentage Options without conditions
+  VALUE = 'v'
+  VARIATION_ID = 'i'
+  INLINE_SALT = 'inline_salt'
+
+  # Targeting Rule (Evaluation Rule)
+  CONDITIONS = 'c'
+  SERVED_VALUE = 's'  # Value and Variation ID
+  TARGETING_RULE_PERCENTAGE_OPTIONS = 'p'
+
+  # Condition
+  USER_CONDITION = 'u'
+  SEGMENT_CONDITION = 's'  # Segment targeting rule
+  PREREQUISITE_FLAG_CONDITION = 'p'  # Prerequisite flag targeting rule
+
+  # Segment Condition
+  SEGMENT_INDEX = 's'
+  SEGMENT_COMPARATOR = 'c'
+  INLINE_SEGMENT = 'inline_segment'
+
+  # Prerequisite Flag Condition
+  PREREQUISITE_FLAG_KEY = 'f'
+  PREREQUISITE_COMPARATOR = 'c'
+
+  # Percentage Option
+  PERCENTAGE = 'p'
+
+  # Value
+  BOOL_VALUE = 'b'
+  STRING_VALUE = 's'
+  INT_VALUE = 'i'
+  DOUBLE_VALUE = 'd'
+  STRING_LIST_VALUE = 'l'
+  UNSUPPORTED_VALUE = 'unsupported_value'
+
+  module Config
+    def self.is_type_mismatch(value, ruby_type)
+      is_float_int_mismatch = \
+        (value.is_a?(Float) && ruby_type == Integer) || \
+          (value.is_a?(Integer) && ruby_type == Float)
+
+      is_bool_mismatch = value.is_a?(TrueClass) && ruby_type == FalseClass || \
+        value.is_a?(FalseClass) && ruby_type == TrueClass
+
+      if value.class != ruby_type && !is_float_int_mismatch && !is_bool_mismatch
+        return true
+      end
+
+      return false
+    end
+
+    def self.get_value(dictionary, setting_type)
+      value_descriptor = dictionary[VALUE]
+      if value_descriptor.nil?
+        raise 'Value is missing'
+      end
+
+      expected_value_type, expected_ruby_type = SettingType.get_type_info(setting_type)
+      if expected_value_type.nil?
+        raise 'Unsupported setting type'
+      end
+
+      value = value_descriptor[expected_value_type]
+      if value.nil? || is_type_mismatch(value, expected_ruby_type)
+        raise "Setting value is not of the expected type #{expected_ruby_type}"
+      end
+
+      return value
+    end
+
+    def self.get_value_type(dictionary)
+      value = dictionary[VALUE]
+      if !value.nil?
+        if !value[BOOL_VALUE].nil?
+          return TrueClass
+        end
+        if !value[STRING_VALUE].nil?
+          return String
+        end
+        if !value[INT_VALUE].nil?
+          return Integer
+        end
+        if !value[DOUBLE_VALUE].nil?
+          return Float
+        end
+      end
+
+      return nil
+    end
+
+    def self.fixup_config_salt_and_segments(config)
+      """
+      Adds the inline salt and segment to the config.
+      When using flag overrides, the original salt and segment indexes may become invalid. Therefore, we copy the
+      object references to the locations where they are referenced and use these references instead of the indexes.
+      """
+      salt = config.fetch(PREFERENCES, {}).fetch(SALT, '')
+      segments = config[SEGMENTS] || []
+      settings = config[FEATURE_FLAGS] || {}
+      settings.each do |_, setting|
+        next unless setting.is_a?(Hash)
+
+        # add salt
+        setting[INLINE_SALT] = salt
+
+        # add segment to the segment conditions
+        targeting_rules = setting[TARGETING_RULES] || []
+        targeting_rules.each do |targeting_rule|
+          conditions = targeting_rule[CONDITIONS] || []
+          conditions.each do |condition|
+            segment_condition = condition[SEGMENT_CONDITION]
+            if segment_condition
+              segment_index = segment_condition[SEGMENT_INDEX]
+              segment = segments[segment_index]
+              segment_condition[INLINE_SEGMENT] = segment
+            end
+          end
+        end
+      end
+    end
+  end
+
+  class SettingType
+    BOOL = 0
+    STRING = 1
+    INT = 2
+    DOUBLE = 3
+
+    @@setting_type_mapping = {
+      SettingType::BOOL => [BOOL_VALUE, TrueClass],
+      SettingType::STRING => [STRING_VALUE, String],
+      SettingType::INT => [INT_VALUE, Integer],
+      SettingType::DOUBLE => [DOUBLE_VALUE, Float]
+    }
+
+    def self.get_type_info(setting_type)
+      return @@setting_type_mapping[setting_type] || [nil, nil]
+    end
+
+    def self.from_type(object_type)
+      if object_type == TrueClass || object_type == FalseClass
+        return BOOL
+      elsif object_type == String
+        return STRING
+      elsif object_type == Integer
+        return INT
+      elsif object_type == Float
+        return DOUBLE
+      end
+
+      return nil
+    end
+
+    def self.to_type(setting_type)
+      return get_type_info(setting_type)[1]
+    end
+
+    def self.to_value_type(setting_type)
+      return get_type_info(setting_type)[0]
+    end
+  end
+
+  module PrerequisiteComparator
+    EQUALS = 0
+    NOT_EQUALS = 1
+  end
+
+  module SegmentComparator
+    IS_IN = 0
+    IS_NOT_IN = 1
+  end
+
+  module Comparator
+    IS_ONE_OF = 0
+    IS_NOT_ONE_OF = 1
+    CONTAINS_ANY_OF = 2
+    NOT_CONTAINS_ANY_OF = 3
+    IS_ONE_OF_SEMVER = 4
+    IS_NOT_ONE_OF_SEMVER = 5
+    LESS_THAN_SEMVER = 6
+    LESS_THAN_OR_EQUAL_SEMVER = 7
+    GREATER_THAN_SEMVER = 8
+    GREATER_THAN_OR_EQUAL_SEMVER = 9
+    EQUALS_NUMBER = 10
+    NOT_EQUALS_NUMBER = 11
+    LESS_THAN_NUMBER = 12
+    LESS_THAN_OR_EQUAL_NUMBER = 13
+    GREATER_THAN_NUMBER = 14
+    GREATER_THAN_OR_EQUAL_NUMBER = 15
+    IS_ONE_OF_HASHED = 16
+    IS_NOT_ONE_OF_HASHED = 17
+    BEFORE_DATETIME = 18
+    AFTER_DATETIME = 19
+    EQUALS_HASHED = 20
+    NOT_EQUALS_HASHED = 21
+    STARTS_WITH_ANY_OF_HASHED = 22
+    NOT_STARTS_WITH_ANY_OF_HASHED = 23
+    ENDS_WITH_ANY_OF_HASHED = 24
+    NOT_ENDS_WITH_ANY_OF_HASHED = 25
+    ARRAY_CONTAINS_ANY_OF_HASHED = 26
+    ARRAY_NOT_CONTAINS_ANY_OF_HASHED = 27
+    EQUALS = 28
+    NOT_EQUALS = 29
+    STARTS_WITH_ANY_OF = 30
+    NOT_STARTS_WITH_ANY_OF = 31
+    ENDS_WITH_ANY_OF = 32
+    NOT_ENDS_WITH_ANY_OF = 33
+    ARRAY_CONTAINS_ANY_OF = 34
+    ARRAY_NOT_CONTAINS_ANY_OF = 35
+  end
+
+  COMPARATOR_TEXTS = [
+    'IS ONE OF',                  # IS_ONE_OF
+    'IS NOT ONE OF',              # IS_NOT_ONE_OF
+    'CONTAINS ANY OF',            # CONTAINS_ANY_OF
+    'NOT CONTAINS ANY OF',        # NOT_CONTAINS_ANY_OF
+    'IS ONE OF',                  # IS_ONE_OF_SEMVER
+    'IS NOT ONE OF',              # IS_NOT_ONE_OF_SEMVER
+    '<',                          # LESS_THAN_SEMVER
+    '<=',                         # LESS_THAN_OR_EQUAL_SEMVER
+    '>',                          # GREATER_THAN_SEMVER
+    '>=',                         # GREATER_THAN_OR_EQUAL_SEMVER
+    '=',                          # EQUALS_NUMBER
+    '!=',                         # NOT_EQUALS_NUMBER
+    '<',                          # LESS_THAN_NUMBER
+    '<=',                         # LESS_THAN_OR_EQUAL_NUMBER
+    '>',                          # GREATER_THAN_NUMBER
+    '>=',                         # GREATER_THAN_OR_EQUAL_NUMBER
+    'IS ONE OF',                  # IS_ONE_OF_HASHED
+    'IS NOT ONE OF',              # IS_NOT_ONE_OF_HASHED
+    'BEFORE',                     # BEFORE_DATETIME
+    'AFTER',                      # AFTER_DATETIME
+    'EQUALS',                     # EQUALS_HASHED
+    'NOT EQUALS',                 # NOT_EQUALS_HASHED
+    'STARTS WITH ANY OF',         # STARTS_WITH_ANY_OF_HASHED
+    'NOT STARTS WITH ANY OF',     # NOT_STARTS_WITH_ANY_OF_HASHED
+    'ENDS WITH ANY OF',           # ENDS_WITH_ANY_OF_HASHED
+    'NOT ENDS WITH ANY OF',       # NOT_ENDS_WITH_ANY_OF_HASHED
+    'ARRAY CONTAINS ANY OF',      # ARRAY_CONTAINS_ANY_OF_HASHED
+    'ARRAY NOT CONTAINS ANY OF',  # ARRAY_NOT_CONTAINS_ANY_OF_HASHED
+    'EQUALS',                     # EQUALS
+    'NOT EQUALS',                 # NOT_EQUALS
+    'STARTS WITH ANY OF',         # STARTS_WITH_ANY_OF
+    'NOT STARTS WITH ANY OF',     # NOT_STARTS_WITH_ANY_OF
+    'ENDS WITH ANY OF',           # ENDS_WITH_ANY_OF
+    'NOT ENDS WITH ANY OF',       # NOT_ENDS_WITH_ANY_OF
+    'ARRAY CONTAINS ANY OF',      # ARRAY_CONTAINS_ANY_OF
+    'ARRAY NOT CONTAINS ANY OF'   # ARRAY_NOT_CONTAINS_ANY_OF
+  ]
+
+  COMPARISON_VALUES = [
+    STRING_LIST_VALUE,  # IS_ONE_OF
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF
+    STRING_LIST_VALUE,  # CONTAINS_ANY_OF
+    STRING_LIST_VALUE,  # NOT_CONTAINS_ANY_OF
+    STRING_LIST_VALUE,  # IS_ONE_OF_SEMVER
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF_SEMVER
+    STRING_VALUE,       # LESS_THAN_SEMVER
+    STRING_VALUE,       # LESS_THAN_OR_EQUAL_SEMVER
+    STRING_VALUE,       # GREATER_THAN_SEMVER
+    STRING_VALUE,       # GREATER_THAN_OR_EQUAL_SEMVER
+    DOUBLE_VALUE,       # EQUALS_NUMBER
+    DOUBLE_VALUE,       # NOT_EQUALS_NUMBER
+    DOUBLE_VALUE,       # LESS_THAN_NUMBER
+    DOUBLE_VALUE,       # LESS_THAN_OR_EQUAL_NUMBER
+    DOUBLE_VALUE,       # GREATER_THAN_NUMBER
+    DOUBLE_VALUE,       # GREATER_THAN_OR_EQUAL_NUMBER
+    STRING_LIST_VALUE,  # IS_ONE_OF_HASHED
+    STRING_LIST_VALUE,  # IS_NOT_ONE_OF_HASHED
+    DOUBLE_VALUE,       # BEFORE_DATETIME
+    DOUBLE_VALUE,       # AFTER_DATETIME
+    STRING_VALUE,       # EQUALS_HASHED
+    STRING_VALUE,       # NOT_EQUALS_HASHED
+    STRING_LIST_VALUE,  # STARTS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # NOT_STARTS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # ENDS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # NOT_ENDS_WITH_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # ARRAY_CONTAINS_ANY_OF_HASHED
+    STRING_LIST_VALUE,  # ARRAY_NOT_CONTAINS_ANY_OF_HASHED
+    STRING_VALUE,       # EQUALS
+    STRING_VALUE,       # NOT_EQUALS
+    STRING_LIST_VALUE,  # STARTS_WITH_ANY_OF
+    STRING_LIST_VALUE,  # NOT_STARTS_WITH_ANY_OF
+    STRING_LIST_VALUE,  # ENDS_WITH_ANY_OF
+    STRING_LIST_VALUE,  # NOT_ENDS_WITH_ANY_OF
+    STRING_LIST_VALUE,  # ARRAY_CONTAINS_ANY_OF
+    STRING_LIST_VALUE   # ARRAY_NOT_CONTAINS_ANY_OF
+  ]
+  SEGMENT_COMPARATOR_TEXTS = ['IS IN SEGMENT', 'IS NOT IN SEGMENT']
+  PREREQUISITE_COMPARATOR_TEXTS = ['EQUALS', 'DOES NOT EQUAL']
+end

data/lib/configcat/configcatclient.rb

@@ -60,15 +60,26 @@ module ConfigCat
         raise ConfigCatClientException, "SDK Key is required."
       end
 
-      @_sdk_key = sdk_key
-      @_default_user = options.default_user
-      @_rollout_evaluator = RolloutEvaluator.new(@log)
       if options.flag_overrides
         @_override_data_source = options.flag_overrides.create_data_source(@log)
       else
         @_override_data_source = nil
       end
 
+      # In case of local only flag overrides mode, we accept any SDK Key format.
+      if @_override_data_source.nil? || @_override_data_source.get_behaviour() != OverrideBehaviour::LOCAL_ONLY
+        is_valid_sdk_key = /^.{22}\/.{22}$/.match?(sdk_key) ||
+          /^configcat-sdk-1\/.{22}\/.{22}$/.match?(sdk_key) ||
+          (options.base_url && /^configcat-proxy\/.+$/.match?(sdk_key))
+        unless is_valid_sdk_key
+          raise ConfigCatClientException, "SDK Key `#{sdk_key}` is invalid."
+        end
+      end
+
+      @_sdk_key = sdk_key
+      @_default_user = options.default_user
+      @_rollout_evaluator = RolloutEvaluator.new(@log)
+
       config_cache = options.config_cache.nil? ? NullConfigCache.new : options.config_cache
 
       if @_override_data_source && @_override_data_source.get_behaviour() == OverrideBehaviour::LOCAL_ONLY
@@ -104,14 +115,14 @@ module ConfigCat
     # :param user [User] the user object to identify the caller.
     # :return the value.
     def get_value(key, default_value, user = nil)
-      settings, fetch_time = _get_settings()
-      if settings.nil?
+      config, fetch_time = _get_config()
+      if config.nil? || config[FEATURE_FLAGS].nil?
         message = "Config JSON is not present when evaluating setting '#{key}'. Returning the `default_value` parameter that you specified in your application: '#{default_value}'."
         @log.error(1000, message)
         @hooks.invoke_on_flag_evaluated(EvaluationDetails.from_error(key, default_value, error: message))
         return default_value
       end
-      details = _evaluate(key, user, default_value, nil, settings, fetch_time)
+      details = _evaluate(key, user, default_value, nil, config, fetch_time)
       return details.value
     end
 
@@ -122,15 +133,15 @@ module ConfigCat
     # :param user [User] the user object to identify the caller.
     # :return [EvaluationDetails] the evaluation details.
     def get_value_details(key, default_value, user = nil)
-      settings, fetch_time = _get_settings()
-      if settings.nil?
+      config, fetch_time = _get_config()
+      if config.nil? || config[FEATURE_FLAGS].nil?
         message = "Config JSON is not present when evaluating setting '#{key}'. Returning the `default_value` parameter that you specified in your application: '#{default_value}'."
         @log.error(1000, message)
         details = EvaluationDetails.from_error(key, default_value, error: message)
         @hooks.invoke_on_flag_evaluated(details)
         return details
       end
-      details = _evaluate(key, user, default_value, nil, settings, fetch_time)
+      details = _evaluate(key, user, default_value, nil, config, fetch_time)
       return details
     end
 
@@ -138,89 +149,61 @@ module ConfigCat
     #
     # :return list of keys.
     def get_all_keys
-      settings, _ = _get_settings()
-      if settings === nil
+      config, _ = _get_config()
+      if config.nil?
         @log.error(1000, "Config JSON is not present. Returning empty list.")
         return []
       end
+      settings = config.fetch(FEATURE_FLAGS, {})
       return settings.keys
     end
 
-    # Gets the Variation ID (analytics) of a feature flag or setting based on it's key.
-    #
-    # :param key [String] the identifier of the feature flag or setting.
-    # :param default_variation_id in case of any failure, this value will be returned.
-    # :param user [User] the user object to identify the caller.
-    # :return the variation ID.
-    def get_variation_id(key, default_variation_id, user = nil)
-      ConfigCat.logger.warn("get_variation_id is deprecated and will be removed in a future major version. " \
-                            "Please use [get_value_details] instead.")
-
-      settings, fetch_time = _get_settings()
-      if settings === nil
-        message = "Config JSON is not present when evaluating setting '#{key}'. Returning the `default_variation_id` parameter that you specified in your application: '#{default_variation_id}'."
-        @log.error(1000, message)
-        @hooks.invoke_on_flag_evaluated(EvaluationDetails.from_error(key, nil, error: message,
-                                                                     variation_id: default_variation_id))
-        return default_variation_id
-      end
-      details = _evaluate(key, user, nil, default_variation_id, settings, fetch_time)
-      return details.variation_id
-    end
-
-    # Gets the Variation IDs (analytics) of all feature flags or settings.
-    #
-    # :param user [User] the user object to identify the caller.
-    # :return list of variation IDs
-    def get_all_variation_ids(user = nil)
-      ConfigCat.logger.warn("get_all_variation_ids is deprecated and will be removed in a future major version. " \
-                            "Please use [get_value_details] instead.")
-
-      settings, _ = _get_settings()
-      if settings === nil
-        @log.error(1000, "Config JSON is not present. Returning empty list.")
-        return []
-      end
-
-      variation_ids = []
-      for key in settings.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
-
     # Gets the key of a setting, and it's value identified by the given Variation ID (analytics)
     #
     # :param variation_id [String] variation ID
     # :return key and value
     def get_key_and_value(variation_id)
-      settings, _ = _get_settings()
-      if settings === nil
+      config, _ = _get_config()
+      if config.nil?
         @log.error(1000, "Config JSON is not present. Returning nil.")
         return nil
       end
 
-      for key, value in settings
-        if variation_id == value.fetch(VARIATION_ID, nil)
-          return KeyValue.new(key, value[VALUE])
-        end
+      settings = config.fetch(FEATURE_FLAGS, {})
+      begin
+        settings.each do |key, value|
+          setting_type = value.fetch(SETTING_TYPE, nil)
+          if variation_id == value.fetch(VARIATION_ID, nil)
+            return KeyValue.new(key, Config.get_value(value, setting_type))
+          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])
+          targeting_rules = value.fetch(TARGETING_RULES, [])
+          targeting_rules.each do |targeting_rule|
+            served_value = targeting_rule.fetch(SERVED_VALUE, nil)
+            if !served_value.nil?
+              if variation_id == served_value.fetch(VARIATION_ID, nil)
+                return KeyValue.new(key, Config.get_value(served_value, setting_type))
+              end
+            else
+              percentage_options = targeting_rule.fetch(PERCENTAGE_OPTIONS, [])
+              percentage_options.each do |percentage_option|
+                if variation_id == percentage_option.fetch(VARIATION_ID, nil)
+                  return KeyValue.new(key, Config.get_value(percentage_option, setting_type))
+                end
+              end
+            end
           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])
+          percentage_options = value.fetch(PERCENTAGE_OPTIONS, [])
+          percentage_options.each do |percentage_option|
+            if variation_id == percentage_option.fetch(VARIATION_ID, nil)
+              return KeyValue.new(key, Config.get_value(percentage_option, setting_type))
+            end
           end
         end
+      rescue => e
+        @log.error("Error occurred in the `#{self.class.name}` method. Returning nil.", event_id: 1002)
+        return nil
       end
 
       @log.error(2011, "Could not find the setting for the specified variation ID: '#{variation_id}'.")
@@ -231,12 +214,13 @@ module ConfigCat
     # :param user [User] the user object to identify the caller.
     # :return dictionary of values
     def get_all_values(user = nil)
-      settings, _ = _get_settings()
-      if settings === nil
+      config, _ = _get_config()
+      if config.nil?
         @log.error(1000, "Config JSON is not present. Returning empty dictionary.")
         return {}
       end
 
+      settings = config.fetch(FEATURE_FLAGS, {})
       all_values = {}
       for key in settings.keys
         value = get_value(key, nil, user)
@@ -252,15 +236,16 @@ module ConfigCat
     # :param user [User] the user object to identify the caller.
     # :return list of all evaluation details
     def get_all_value_details(user = nil)
-      settings, fetch_time = _get_settings()
-      if settings.nil?
+      config, fetch_time = _get_config()
+      if config.nil?
         @log.error(1000, "Config JSON is not present. Returning empty list.")
         return []
       end
 
       details_result = []
+      settings = config.fetch(FEATURE_FLAGS, {})
       for key in settings.keys
-        details = _evaluate(key, user, nil, nil, settings, fetch_time)
+        details = _evaluate(key, user, nil, nil, config, fetch_time)
         details_result.push(details)
       end
 
@@ -273,8 +258,8 @@ module ConfigCat
     def force_refresh
       return @_config_service.refresh if @_config_service
 
-      return RefreshResult(false,
-                           "The SDK uses the LocalOnly flag override behavior which prevents making HTTP requests.")
+      return RefreshResult.new(false,
+                               "The SDK uses the LocalOnly flag override behavior which prevents making HTTP requests.")
     end
 
     # Sets the default user.
@@ -324,44 +309,57 @@ module ConfigCat
       @hooks.clear
     end
 
-    def _get_settings
+    def _get_config
       if !@_override_data_source.nil?
         behaviour = @_override_data_source.get_behaviour()
         if behaviour == OverrideBehaviour::LOCAL_ONLY
           return @_override_data_source.get_overrides(), Utils::DISTANT_PAST
         elsif behaviour == OverrideBehaviour::REMOTE_OVER_LOCAL
-          remote_settings, fetch_time = @_config_service.get_settings()
-          local_settings = @_override_data_source.get_overrides()
-          remote_settings ||= {}
-          local_settings ||= {}
-          result = local_settings.clone()
-          result.update(remote_settings)
+          remote_config, fetch_time = @_config_service.get_config()
+          local_config = @_override_data_source.get_overrides()
+          remote_config ||= { FEATURE_FLAGS => {} }
+          local_config ||= { FEATURE_FLAGS => {} }
+          result = local_config.clone()
+          result[FEATURE_FLAGS].update(remote_config[FEATURE_FLAGS])
           return result, fetch_time
         elsif behaviour == OverrideBehaviour::LOCAL_OVER_REMOTE
-          remote_settings, fetch_time = @_config_service.get_settings()
-          local_settings = @_override_data_source.get_overrides()
-          remote_settings ||= {}
-          local_settings ||= {}
-          result = remote_settings.clone()
-          result.update(local_settings)
+          remote_config, fetch_time = @_config_service.get_config()
+          local_config = @_override_data_source.get_overrides()
+          remote_config ||= { FEATURE_FLAGS => {} }
+          local_config ||= { FEATURE_FLAGS => {} }
+          result = remote_config.clone()
+          result[FEATURE_FLAGS].update(local_config[FEATURE_FLAGS])
           return result, fetch_time
         end
       end
-      return @_config_service.get_settings()
+      return @_config_service.get_config()
     end
 
-    def _get_cache_key
-      return Digest::SHA1.hexdigest("ruby_" + CONFIG_FILE_NAME + "_" + @_sdk_key)
+    def _check_type_mismatch(value, default_value)
+      if !default_value.nil? && Config.is_type_mismatch(value, default_value.class)
+        @log.warn(4002, "The type of a setting does not match the type of the specified default value (#{default_value}). " \
+                  "Setting's type was #{value.class} but the default value's type was #{default_value.class}. " \
+                  "Please make sure that using a default value not matching the setting's type was intended.")
+      end
     end
 
-    def _evaluate(key, user, default_value, default_variation_id, settings, fetch_time)
-      user = user || @_default_user
+    def _evaluate(key, user, default_value, default_variation_id, config, fetch_time)
+      user ||= @_default_user
+
+      # Skip building the evaluation log if it won't be logged.
+      log_builder = EvaluationLogBuilder.new if @log.enabled_for?(Logger::INFO)
+
       value, variation_id, rule, percentage_rule, error = @_rollout_evaluator.evaluate(
         key: key,
         user: user,
         default_value: default_value,
         default_variation_id: default_variation_id,
-        settings: settings)
+        config: config,
+        log_builder: log_builder)
+
+      _check_type_mismatch(value, default_value)
+
+      @log.info(5000, log_builder.to_s) if log_builder
 
       details = EvaluationDetails.new(key: key,
                                       value: value,
@@ -370,8 +368,8 @@ module ConfigCat
                                       user: user,
                                       is_default_value: error.nil? || error.empty? ? false : true,
                                       error: error,
-                                      matched_evaluation_rule: rule,
-                                      matched_evaluation_percentage_rule: percentage_rule)
+                                      matched_targeting_rule: rule,
+                                      matched_percentage_option: percentage_rule)
       @hooks.invoke_on_flag_evaluated(details)
       return details
     end

data/lib/configcat/configcatlogger.rb

@@ -4,6 +4,10 @@ module ConfigCat
       @hooks = hooks
     end
 
+    def enabled_for?(log_level)
+      ConfigCat.logger.level <= log_level
+    end
+
     def debug(message)
       ConfigCat.logger.debug("[0] " + message)
     end