splitclient-rb 6.0.1 → 6.1.0.pre.rc1

data/lib/splitclient-rb/engine/matchers/less_than_or_equal_to_matcher.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SplitIoClient
-  class LessThanOrEqualToMatcher
-    MATCHER_TYPE = 'LESS_THAN_OR_EQUAL_TO'.freeze
+  class LessThanOrEqualToMatcher < Matcher
+    MATCHER_TYPE = 'LESS_THAN_OR_EQUAL_TO'
 
     attr_reader :attribute
 
@@ -11,29 +13,15 @@ module SplitIoClient
     end
 
     def match?(args)
-      return false if !args.key?(:attributes) && !args.key?(:value)
-      return false if args.key?(:value) && args[:value].nil?
-      return false if args.key?(:attributes) && args[:attributes].nil?
-
-      value = formatted_value(args[:value] || args[:attributes][@attribute.to_sym])
+      SplitLogger.log_if_debug('[LessThanOrEqualToMatcher] evaluating value and attributes.')
 
-      value.is_a?(Integer) ? (value <= @value) : false
-    end
+      return false unless SplitIoClient::Validators.valid_matcher_arguments(args)
 
-    def equals?(obj)
-      if obj.nil?
-        false
-      elsif !obj.instance_of?(LessThanOrEqualToMatcher)
-        false
-      elsif self.equal?(obj)
-        true
-      else
-        false
-      end
-    end
+      value = formatted_value(args[:value] || args[:attributes][@attribute.to_sym])
 
-    def string_type?
-      false
+      matches = value.is_a?(Integer) ? (value <= @value) : false
+      SplitLogger.log_if_debug("[LessThanOrEqualToMatcher] #{value} less than or equal to #{@value} -> #{matches}")
+      matches
     end
 
     private
@@ -41,10 +29,10 @@ module SplitIoClient
     def formatted_value(value, sdk_data = false)
       case @data_type
       when 'NUMBER'
-        return value
+        value
       when 'DATETIME'
-        value = value / 1000 if sdk_data # sdk returns already miliseconds, turning to seconds to do a correct zero_our
-        return SplitIoClient::Utilities.to_milis_zero_out_from_seconds(value)
+        value /= 1000 if sdk_data # sdk returns already miliseconds, turning to seconds to do a correct zero_hour
+        SplitIoClient::Utilities.to_milis_zero_out_from_seconds(value)
       else
         @logger.error('Invalid data type')
       end

data/lib/splitclient-rb/engine/matchers/matcher.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  #
+  # class to implement the all keys matcher
+  #
+  class Matcher
+    #
+    # evaluates if the given object equals the matcher
+    #
+    # @param obj [object] object to be evaluated
+    #
+    # @return [boolean] true if obj equals the matcher
+    def equals?(obj)
+      if obj.nil?
+        false
+      elsif !obj.instance_of?(self.class)
+        false
+      elsif equal?(obj)
+        true
+      else
+        false
+      end
+    end
+
+    def string_type?
+      false
+    end
+  end
+end

data/lib/splitclient-rb/engine/matchers/matches_string_matcher.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   class MatchesStringMatcher
-    MATCHER_TYPE = 'MATCHES_STRING'.freeze
+    MATCHER_TYPE = 'MATCHES_STRING'
 
     attr_reader :attribute
 
@@ -14,7 +16,9 @@ module SplitIoClient
         args[:attributes][a.to_s] || args[:attributes][a.to_sym]
       end
 
-      (value =~ @regexp_string) != nil
+      matches = !(value =~ @regexp_string).nil?
+      SplitLogger.log_if_debug("[MatchesStringMatcher] #{value} matches #{@regexp_string} -> #{matches}")
+      matches
     end
 
     def string_type?

data/lib/splitclient-rb/engine/matchers/negation_matcher.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   #
   # class to implement the negation of a matcher
   #
-  class NegationMatcher
-    MATCHER_TYPE = 'NEGATION_MATCHER'.freeze
+  class NegationMatcher < Matcher
+    MATCHER_TYPE = 'NEGATION_MATCHER'
 
     def initialize(matcher = nil)
       @matcher = matcher
@@ -16,7 +18,9 @@ module SplitIoClient
     #
     # @return [boolean] evaluation of the negation matcher
     def match?(args)
-      !@matcher.match?(args)
+      matches = !@matcher.match?(args)
+      SplitLogger.log_if_debug("[NegationMatcherMatcher] Matcher #{@matcher} Arguments #{args} -> #{matches}")
+      matches
     end
 
     def respond_to?(method)
@@ -31,28 +35,10 @@ module SplitIoClient
       @matcher.string_type?
     end
 
-    #
-    # evaluates if the given object equals the matcher
-    #
-    # @param obj [object] object to be evaluated
-    #
-    # @returns [boolean] true if obj equals the matcher
-    def equals?(obj)
-      if obj.nil?
-        false
-      elsif !obj.instance_of?(NegationMatcher)
-        false
-      elsif self.equal?(obj)
-        true
-      else
-        false
-      end
-    end
-
     #
     # function to print string value for this matcher
     #
-    # @reutrn [string] string value of this matcher
+    # @return [string] string value of this matcher
     def to_s
       "not #{@matcher}"
     end

data/lib/splitclient-rb/engine/matchers/part_of_set_matcher.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   class PartOfSetMatcher < SetMatcher
-    MATCHER_TYPE = 'PART_OF_SET'.freeze
+    MATCHER_TYPE = 'PART_OF_SET'
 
     attr_reader :attribute
 
@@ -11,13 +13,14 @@ module SplitIoClient
     def match?(args)
       @local_set = local_set(args[:attributes], @attribute)
 
-      return false if @local_set.empty?
-
-      @local_set.subset? @remote_set
-    end
+      if @local_set.empty?
+        SplitLogger.log_if_debug('[PartOfSetMatcher] Local Set is empty.')
+        return false
+      end
 
-    def string_type?
-      false
+      matches = @local_set.subset? @remote_set
+      SplitLogger.log_if_debug("[PartOfSetMatcher] Local Set #{@local_set} is a subset of #{@remote_set} -> #{matches}")
+      matches
     end
   end
 end

data/lib/splitclient-rb/engine/matchers/set_matcher.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module SplitIoClient
   class SetMatcher
+    def string_type?
+      false
+    end
+
     protected
 
     def initialize(attribute, remote_array)
@@ -12,7 +18,7 @@ module SplitIoClient
     def local_set(data, attribute)
       data = data.fetch(attribute) { |a| data[a.to_s] || data[a.to_sym] }
       # Allow user to pass individual elements as well
-      local_array = data.kind_of?(Array) ? data : [data]
+      local_array = data.is_a?(Array) ? data : [data]
 
       local_array.to_set
     end

data/lib/splitclient-rb/engine/matchers/starts_with_matcher.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   class StartsWithMatcher
-    MATCHER_TYPE = 'STARTS_WITH'.freeze
+    MATCHER_TYPE = 'STARTS_WITH'
 
     attr_reader :attribute
 
@@ -10,17 +12,28 @@ module SplitIoClient
     end
 
     def match?(args)
-      value = args[:value] || args[:attributes].fetch(@attribute) do |a|
-        args[:attributes][a.to_s] || args[:attributes][a.to_sym]
+      if @prefix_list.empty?
+        SplitLogger.log_if_debug('[StartsWithMatcher] Prefix List is empty.')
+        return false
       end
 
-      return false if @prefix_list.empty?
+      value = get_value(args)
 
-      @prefix_list.any? { |prefix| value.to_s.start_with? prefix }
+      matches = @prefix_list.any? { |prefix| value.to_s.start_with? prefix }
+      SplitLogger.log_if_debug("[StartsWithMatcher] #{value} matches any of #{@prefix_list} -> #{matches}")
+      matches
     end
 
     def string_type?
       true
     end
+
+    private
+
+    def get_value(args)
+      args[:value] || args[:attributes].fetch(@attribute) do |a|
+        args[:attributes][a.to_s] || args[:attributes][a.to_sym]
+      end
+    end
   end
 end

data/lib/splitclient-rb/engine/matchers/user_defined_segment_matcher.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   #
   # class to implement the user defined matcher
   #
-  class UserDefinedSegmentMatcher
-    MATCHER_TYPE = 'IN_SEGMENT'.freeze
+  class UserDefinedSegmentMatcher < Matcher
+    MATCHER_TYPE = 'IN_SEGMENT'
 
     def initialize(segments_repository, segment_name)
       @segments_repository = segments_repository
@@ -17,29 +19,9 @@ module SplitIoClient
     #
     # @return [boolean] evaluation of the key against the segment
     def match?(args)
-      @segments_repository.in_segment?(@segment_name, args[:value] || args[:matching_key])
-    end
-
-    #
-    # evaluates if the given object equals the matcher
-    #
-    # @param obj [object] object to be evaluated
-    #
-    # @returns [boolean] true if obj equals the matcher
-    def equals?(obj)
-      if obj.nil?
-        false
-      elsif !obj.instance_of?(UserDefinedSegmentMatcher)
-        false
-      elsif self.equal?(obj)
-        true
-      else
-        false
-      end
-    end
-
-    def string_type?
-      false
+      matches = @segments_repository.in_segment?(@segment_name, args[:value] || args[:matching_key])
+      SplitLogger.log_if_debug("[InSegmentMatcher] #{@segment_name} is in segment -> #{matches}")
+      matches
     end
   end
 end

data/lib/splitclient-rb/engine/matchers/whitelist_matcher.rb

@@ -1,54 +1,36 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   #
   # class to implement the user defined matcher
   #
-  class WhitelistMatcher < NoMethodError
+  class WhitelistMatcher < Matcher
     MATCHER_TYPE = 'WHITELIST_MATCHER'
 
     attr_reader :attribute
 
     def initialize(whitelist_data)
       @whitelist = case whitelist_data
-      when Array
-        whitelist_data
-      when Hash
-        @matcher_type = 'ATTR_WHITELIST'
-        @attribute = whitelist_data[:attribute]
+                   when Array
+                     whitelist_data
+                   when Hash
+                     @matcher_type = 'ATTR_WHITELIST'
+                     @attribute = whitelist_data[:attribute]
 
-        whitelist_data[:value]
-      else
-        []
-      end
+                     whitelist_data[:value]
+                   else
+                     []
+                   end
     end
 
     def match?(args)
-      return @whitelist.include?(args[:value] || args[:matching_key]) unless @matcher_type == 'ATTR_WHITELIST'
-
-      return false if !args.key?(:attributes) && !args.key?(:value)
-      return false if args.key?(:value) && args[:value].nil?
-      return false if args.key?(:attributes) && args[:attributes].nil?
+      return matches_user_whitelist(args) unless @matcher_type == 'ATTR_WHITELIST'
 
-      return @whitelist.include?(args[:value] || args[:attributes][@attribute.to_sym])
+      SplitLogger.log_if_debug('[WhitelistMatcher] evaluating value and attributes.')
 
-      false
-    end
+      return false unless SplitIoClient::Validators.valid_matcher_arguments(args)
 
-    #
-    # evaluates if the given object equals the matcher
-    #
-    # @param obj [object] object to be evaluated
-    #
-    # @returns [boolean] true if obj equals the matcher
-    def equals?(obj)
-      if obj.nil?
-        false
-      elsif !obj.instance_of?(WhitelistMatcher)
-        false
-      elsif self.equal?(obj)
-        true
-      else
-        false
-      end
+      matches_attr_whitelist(args)
     end
 
     def string_type?
@@ -58,9 +40,25 @@ module SplitIoClient
     #
     # function to print string value for this matcher
     #
-    # @reutrn [string] string value of this matcher
+    # @return [string] string value of this matcher
     def to_s
       "in segment #{@whitelist}"
     end
+
+    private
+
+    def matches_user_whitelist(args)
+      matches = @whitelist.include?(args[:value] || args[:matching_key])
+      SplitLogger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
+        #{args[:value] || args[:matching_key]} -> #{matches}")
+      matches
+    end
+
+    def matches_attr_whitelist(args)
+      matches = @whitelist.include?(args[:value] || args[:attributes][@attribute.to_sym])
+      SplitLogger.log_if_debug("[WhitelistMatcher] #{@whitelist} include \
+        #{args[:value] || args[:attributes][@attribute.to_sym]} -> #{matches}")
+      matches
+    end
   end
 end

data/lib/splitclient-rb/managers/split_manager.rb

@@ -17,7 +17,7 @@ module SplitIoClient
     #
     # @returns [object] array of splits
     def splits
-      return if @splits_repository.nil?
+      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
 
       @splits_repository.splits.each_with_object([]) do |(name, split), memo|
         split_view = build_split_view(name, split)
@@ -33,7 +33,7 @@ module SplitIoClient
     #
     # @returns [object] array of split names (String)
     def split_names
-      return if @splits_repository.nil?
+      return [] if !SplitIoClient.configuration.valid_mode || @splits_repository.nil?
 
       @splits_repository.split_names
     end
@@ -43,7 +43,14 @@ module SplitIoClient
     #
     # @returns a split view
     def split(split_name)
-      return unless @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+      return unless SplitIoClient.configuration.valid_mode && @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
+
+      sanitized_split_name= split_name.to_s.strip
+
+      if split_name.to_s != sanitized_split_name
+        SplitIoClient.configuration.logger.warn("split: split_name #{split_name} has extra whitespace, trimming")
+        split_name = sanitized_split_name
+      end
 
       split = @splits_repository.get_split(split_name)
 

data/lib/splitclient-rb/split_config.rb

@@ -43,7 +43,7 @@ module SplitIoClient
       @redis_url = opts[:redis_url] || SplitConfig.default_redis_url
       @redis_namespace = opts[:redis_namespace] ? "#{opts[:redis_namespace]}.#{SplitConfig.default_redis_namespace}" : SplitConfig.default_redis_namespace
       @cache_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, nil, @redis_url
       )
       @connection_timeout = opts[:connection_timeout] || SplitConfig.default_connection_timeout
       @read_timeout = opts[:read_timeout] || SplitConfig.default_read_timeout
@@ -54,7 +54,7 @@ module SplitIoClient
       @impressions_refresh_rate = opts[:impressions_refresh_rate] || SplitConfig.default_impressions_refresh_rate
       @impressions_queue_size = opts[:impressions_queue_size] || SplitConfig.default_impressions_queue_size
       @impressions_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @impressions_queue_size
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @impressions_queue_size, @redis_url
       )
       #Safeguard for users of older SDK versions.
       @disable_impressions = @impressions_queue_size == -1
@@ -62,13 +62,16 @@ module SplitIoClient
       @impressions_bulk_size = opts[:impressions_bulk_size] || @impressions_queue_size > 0 ? @impressions_queue_size : 0
 
       @metrics_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, nil, @redis_url
       )
 
       @logger = opts[:logger] || SplitConfig.default_logger
       @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
       @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
       @block_until_ready = opts[:ready] || opts[:block_until_ready] || 0
+
+      @logger.warn 'no ready parameter has been set - incorrect control treatments could be logged' if block_until_ready == 0
+
       @machine_name = opts[:machine_name] || SplitConfig.machine_hostname
       @machine_ip = opts[:machine_ip] || SplitConfig.machine_ip
 
@@ -83,13 +86,16 @@ module SplitIoClient
       @impression_listener = opts[:impression_listener]
       @impression_listener_refresh_rate = opts[:impression_listener_refresh_rate] || SplitConfig.default_impression_listener_refresh_rate
 
+      @max_key_size = SplitConfig.max_key_size
+
       @threads = {}
 
       @events_push_rate = opts[:events_push_rate] || SplitConfig.default_events_push_rate
       @events_queue_size = opts[:events_queue_size] || SplitConfig.default_events_queue_size
       @events_adapter = SplitConfig.init_cache_adapter(
-        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size
+        opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size, @redis_url
       )
+      @valid_mode = true
 
       startup_log
     end
@@ -184,6 +190,8 @@ module SplitIoClient
     attr_accessor :cache_ttl
     attr_accessor :max_cache_size
 
+    attr_accessor :max_key_size
+
     attr_accessor :language
     attr_accessor :version
 
@@ -208,6 +216,8 @@ module SplitIoClient
 
     attr_accessor :threads
 
+    attr_accessor :valid_mode
+
     #
     # The schedule time for events flush after the first one
     #
@@ -240,7 +250,7 @@ module SplitIoClient
       'https://events.split.io/api/'
     end
 
-    def self.init_cache_adapter(adapter, data_structure, queue_size = nil)
+    def self.init_cache_adapter(adapter, data_structure, queue_size = nil, redis_url = nil)
       case adapter
       when :memory
         SplitIoClient::Cache::Adapters::MemoryAdapter.new(map_memory_adapter(data_structure, queue_size))
@@ -251,7 +261,7 @@ module SplitIoClient
           fail StandardError, 'To use Redis as a cache adapter you must include it in your Gemfile'
         end
 
-        SplitIoClient::Cache::Adapters::RedisAdapter.new(@redis_url)
+        SplitIoClient::Cache::Adapters::RedisAdapter.new(redis_url)
       end
     end
 
@@ -330,9 +340,17 @@ module SplitIoClient
     #
     # @return [object]
     def self.default_logger
-      (defined?(Rails) && Rails.logger) ? Rails.logger : Logger.new($stdout)
+      if defined?(Rails) && Rails.logger
+        Rails.logger
+      elsif ENV['SPLITCLIENT_ENV'] == 'test'
+        Logger.new('/dev/null')  
+      else
+       Logger.new($stdout)
+       end
     end
 
+
+
     #
     # The default debug value
     #
@@ -368,18 +386,25 @@ module SplitIoClient
     #
     # The default cache time to live
     #
-    # @return [boolean]
+    # @return [int]
     def self.cache_ttl
       5
     end
 
     # The default max cache size
     #
-    # @return [boolean]
+    # @return [int]
     def self.max_cache_size
       500
     end
 
+    # The default max key size
+    #
+    # @return [int]
+    def self.max_key_size
+      250
+    end
+
     #
     # custom logger of exceptions
     #