splitclient-rb 5.1.2.pre.rc21 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d36b2f03dcee114ffe3e6bcd1ec6a1c6c4d669f716d15cf4a183c01992ce538e
-  data.tar.gz: 3ccd0c7f21220c57802f81a9024723b528c8e6762d3ba9075dcf9db1ae92953d
+  metadata.gz: aac78f1a43b52720c039260ceb19474cb8fd03fd473cbf0054c590c7e8d45e57
+  data.tar.gz: d0cc36d7647956efbb9f0d455d1bf7aacfebca6960aa4fe304bd98e166d9752d
 SHA512:
-  metadata.gz: 3c6f4efc722392ec4c3f8cbc7fe671cdd5c2b85dfa00fb81ca36135812da3a55092453f5d2f8608295e524f73221636be155741ac9fbd536d2e99a9a7e160044
-  data.tar.gz: 6e5e4ceade46af4af60b82ffdfe6c26c2f8e5432092a1cdf42d7827b3c6e40f364518ad52536e4ab988141a43575b10fb7d6cd17b85f3f574c44db4222f5ee56
+  metadata.gz: 48898f6530d4dfeea94dd20475bc204c1f4cbfe5c6d560565ad6ea3b33c756fa3c3e0f0cfa80a28919c5e88fc00a0bbc6e22d7a0031ca03b652bf8241d7ca651
+  data.tar.gz: 14af6c54d0e1d164a59e2b735518f5bfdf80eb47b33d6fdb78415a056adf8ea2747ee7ee6a16f15c905611c8263ef5e48c964db8f4d3ad68395cecf6894106ae

data/.gitignore

@@ -44,5 +44,8 @@ lib/murmurhash/murmurhash.so
 ext/murmurhash/murmurhash.bundle
 ext/murmurhash/murmurhash.so
 
-#Ignore dump.rdb
+# Ignore dump.rdb
 dump.rdb
+
+# Ignore Mac OS generated files
+.DS_Store

data/CHANGES.txt

@@ -1,3 +1,6 @@
+5.1.2 (October 26th, 2018)
+- Add input validation for client API methods
+
 5.1.1 (October 4th, 2018)
 - Change get_treatments so that it sends a single latency metric
 - Removed unused call to Redis#scan when adding latencies

data/NEWS

@@ -1,3 +1,7 @@
+5.1.2
+
+Add input validation for client API methods: get_treatment, get_treatments, track, manager
+
 5.1.1
 
 Reduces the number of calls to Redis when calling #client.get_treatments using such cache adapter.

data/lib/splitclient-rb.rb

@@ -2,8 +2,7 @@ require 'forwardable'
 
 require 'splitclient-rb/version'
 
-require 'splitclient-rb/exceptions/impressions_shutdown_exception'
-require 'splitclient-rb/exceptions/sdk_blocker_timeout_expired_exception'
+require 'splitclient-rb/exceptions'
 require 'splitclient-rb/cache/routers/impression_router'
 require 'splitclient-rb/cache/adapters/memory_adapters/map_adapter'
 require 'splitclient-rb/cache/adapters/memory_adapters/queue_adapter'
@@ -80,6 +79,7 @@ require 'splitclient-rb/engine/models/split'
 require 'splitclient-rb/engine/models/label'
 require 'splitclient-rb/engine/models/treatment'
 require 'splitclient-rb/utilitites'
+require 'splitclient-rb/validators'
 
 # C extension
 require 'murmurhash/murmurhash_mri'

data/lib/splitclient-rb/cache/repositories/splits_repository.rb

@@ -26,7 +26,7 @@ module SplitIoClient
 
         def get_splits(names)
           splits = {}
-          split_names = names.reject(&:empty?).uniq.map { |name| namespace_key(".split.#{name}") }
+          split_names = names.map { |name| namespace_key(".split.#{name}") }
           splits.merge!(
             @adapter
               .multiple_strings(split_names)

data/lib/splitclient-rb/clients/split_client.rb

@@ -1,4 +1,5 @@
 module SplitIoClient
+
   class SplitClient
     #
     # Creates a new split client instance that connects to split.io API.
@@ -17,11 +18,24 @@ module SplitIoClient
     end
 
     def get_treatments(key, split_names, attributes = {})
+
+      return nil unless SplitIoClient::Validators.valid_get_treatments_parameters(split_names)
+
+      sanitized_split_names = sanitize_split_names(split_names)
+
+      if sanitized_split_names.empty?
+        SplitIoClient.configuration.logger.warn('get_treatments: split_names is an empty array or has null values')
+        return {}
+      end
+
       bucketing_key, matching_key = keys_from_key(key)
+      bucketing_key = bucketing_key ? bucketing_key.to_s : nil
+      matching_key = matching_key ? matching_key.to_s : nil
+
       evaluator = Engine::Parser::Evaluator.new(@segments_repository, @splits_repository, true)
       start = Time.now
       treatments_labels_change_numbers =
-        @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
+        @splits_repository.get_splits(sanitized_split_names).each_with_object({}) do |(name, data), memo|
           memo.merge!(name => get_treatment(key, name, attributes, data, false, true, evaluator))
         end
       latency = (Time.now - start) * 1000.0
@@ -34,13 +48,13 @@ module SplitIoClient
           matching_key, bucketing_key, treatments_labels_change_numbers, time
         )
 
-        route_impressions(split_names, matching_key, bucketing_key, time, treatments_labels_change_numbers, attributes)
+        route_impressions(sanitized_split_names, matching_key, bucketing_key, time, treatments_labels_change_numbers, attributes)
       end
 
-      split_names = treatments_labels_change_numbers.keys
+      split_names_keys = treatments_labels_change_numbers.keys
       treatments = treatments_labels_change_numbers.values.map { |v| v[:treatment] }
 
-      Hash[split_names.zip(treatments)]
+      Hash[split_names_keys.zip(treatments)]
     end
 
     #
@@ -59,68 +73,43 @@ module SplitIoClient
         key, split_name, attributes = {}, split_data = nil, store_impressions = true,
         multiple = false, evaluator = nil
       )
-      bucketing_key, matching_key = keys_from_key(key)
-      treatment_data = { label: Engine::Models::Label::DEFINITION_NOT_FOUND, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL }
-      evaluator ||= Engine::Parser::Evaluator.new(@segments_repository, @splits_repository)
+      control_treatment = { label: Engine::Models::Label::EXCEPTION, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL }
+      parsed_control_treatment = parsed_treatment(multiple, control_treatment)
 
-      if matching_key.nil?
-        SplitIoClient.configuration.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
-        return parsed_treatment(multiple, treatment_data)
-      end
+      bucketing_key, matching_key = keys_from_key(key)
 
-      if split_name.nil?
-        SplitIoClient.configuration.logger.warn('split_name was null for key: ' + key)
-        return parsed_treatment(multiple, treatment_data)
-      end
+      return parsed_control_treatment unless SplitIoClient::Validators.valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key)
 
-      start = Time.now
+      bucketing_key = bucketing_key ? bucketing_key.to_s : nil
+      matching_key = matching_key.to_s
+      evaluator ||= Engine::Parser::Evaluator.new(@segments_repository, @splits_repository)
 
       begin
+        start = Time.now
+
         split = multiple ? split_data : @splits_repository.get_split(split_name)
 
         if split.nil?
-          SplitIoClient.configuration.logger.debug("split_name: #{split_name} does not exist. Returning CONTROL")
-          return parsed_treatment(multiple, treatment_data)
-        else
-          treatment_data =
-            evaluator.call(
-            { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
-          )
+          SplitIoClient.configuration.logger.warn("split_name: #{split_name} does not exist. Returning CONTROL")
+          return parsed_control_treatment
         end
-      rescue StandardError => error
-        SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
 
-        store_impression(
-          split_name, matching_key, bucketing_key,
-          {
-            treatment: SplitIoClient::Engine::Models::Treatment::CONTROL,
-            label: SplitIoClient::Engine::Models::Label::EXCEPTION
-          },
-          store_impressions, attributes
+        treatment_data =
+          evaluator.call(
+          { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
         )
 
-        return parsed_treatment(multiple, treatment_data)
-      end
-
-      begin
         latency = (Time.now - start) * 1000.0
-        split && store_impression(split_name, matching_key, bucketing_key, treatment_data, store_impressions, attributes)
+        store_impression(split_name, matching_key, bucketing_key, treatment_data, store_impressions, attributes)
 
         # Measure
         @adapter.metrics.time('sdk.get_treatment', latency) unless multiple
       rescue StandardError => error
         SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
 
-        store_impression(
-          split_name, matching_key, bucketing_key,
-          {
-            treatment: SplitIoClient::Engine::Models::Treatment::CONTROL,
-            label: SplitIoClient::Engine::Models::Label::EXCEPTION
-          },
-          store_impressions, attributes
-        )
+        store_impression(split_name, matching_key, bucketing_key, control_treatment, store_impressions, attributes)
 
-        return parsed_treatment(multiple, treatment_data)
+        return parsed_control_treatment
       end
 
       parsed_treatment(multiple, treatment_data)
@@ -188,16 +177,23 @@ module SplitIoClient
       @impression_router ||= SplitIoClient::ImpressionRouter.new
     end
 
-    def track(key, traffic_type, event_type, value = nil)
-      @events_repository.add(key, traffic_type, event_type, (Time.now.to_f * 1000).to_i, value)
+    def track(key, traffic_type_name, event_type, value = nil)
+      return false unless SplitIoClient::Validators.valid_track_parameters(key, traffic_type_name, event_type, value)
+      begin
+        @events_repository.add(key.to_s, traffic_type_name, event_type.to_s, (Time.now.to_f * 1000).to_i, value)
+        true
+      rescue StandardError => error
+        SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
+        false
+      end
     end
 
     def keys_from_key(key)
       case key.class.to_s
       when 'Hash'
-        key.values_at(:bucketing_key, :matching_key).map { |k| k.nil? ? nil : k.to_s }
+        key.values_at(:bucketing_key, :matching_key).map { |k| k.nil? ? nil : k }
       else
-        [nil, key].map { |k| k.nil? ? nil : k.to_s }
+        [nil, key].map { |k| k.nil? ? nil : k }
       end
     end
 
@@ -212,5 +208,16 @@ module SplitIoClient
         treatment_data[:treatment]
       end
     end
+
+    def sanitize_split_names(split_names)
+      split_names.compact.uniq.select do |split_name|
+        if split_name.is_a?(String) && !split_name.empty?
+          true
+        else
+          SplitIoClient.configuration.logger.warn('get_treatments: split_name has to be a non empty string')
+          false
+        end
+      end
+    end
   end
 end

data/lib/splitclient-rb/engine/models/label.rb

@@ -4,5 +4,4 @@ class SplitIoClient::Engine::Models::Label
   EXCEPTION = 'exception'.freeze
   KILLED = 'killed'.freeze
   NOT_IN_SPLIT = 'not in split'.freeze
-  DEFINITION_NOT_FOUND = 'definition not found'.freeze
 end

data/lib/splitclient-rb/exceptions.rb

@@ -0,0 +1,7 @@
+module SplitIoClient
+  class SplitIoError < StandardError; end
+
+  class ImpressionShutdownException < SplitIoError; end
+
+  class SDKBlockerTimeoutExpiredException < SplitIoError; end
+end

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

@@ -43,7 +43,7 @@ module SplitIoClient
     #
     # @returns a split view
     def split(split_name)
-      return unless @splits_repository
+      return unless @splits_repository && SplitIoClient::Validators.valid_split_parameters(split_name)
 
       split = @splits_repository.get_split(split_name)
 
@@ -63,7 +63,6 @@ module SplitIoClient
         treatments = []
       end
 
-
         {
           name: name,
           traffic_type_name: split[:trafficTypeName],

data/lib/splitclient-rb/validators.rb

@@ -0,0 +1,185 @@
+module SplitIoClient
+  module Validators
+    extend self
+
+    def valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key)
+      valid_key?(key) && valid_split_name?(split_name) && valid_matching_key?(matching_key) && valid_bucketing_key?(bucketing_key)
+    end
+
+    def valid_get_treatments_parameters(split_names)
+      valid_split_names?(split_names)
+    end
+
+    def valid_track_parameters(key, traffic_type_name, event_type, value)
+      valid_track_key?(key) && valid_traffic_type_name?(traffic_type_name) && valid_event_type?(event_type) && valid_value?(value)
+    end
+
+    def valid_split_parameters(split_name)
+      valid_split_name?(split_name, :split)
+    end
+
+    private
+
+    def string?(value)
+      value.is_a?(String) || value.is_a?(Symbol)
+    end
+
+    def number_or_string?(value)
+      value.is_a?(Numeric) || string?(value)
+    end
+
+    def log_nil(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: #{key} cannot be nil")
+    end
+
+    def log_string(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String or a Symbol")
+    end
+
+    def log_number_or_string(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String")
+    end
+
+    def log_convert_numeric(key, method)
+      SplitIoClient.configuration.logger.warn("#{method}: #{key} is not of type String, converting to String")
+    end
+
+    def valid_split_name?(split_name, method=:get_treatment)
+      if split_name.nil?
+        log_nil(:split_name, method)
+        return false
+      end
+
+      unless string?(split_name)
+        log_string(:split_name, method)
+        return false
+      end
+
+      return true
+    end
+
+    def valid_key?(key)
+      if key.nil?
+        log_nil(:key, :get_treatment)
+        return false
+      end
+
+      return true
+    end
+
+    def valid_matching_key?(matching_key)
+      if matching_key.nil?
+        log_nil(:matching_key, :get_treatment)
+        return false
+      end
+
+      unless number_or_string?(matching_key)
+        log_number_or_string(:matching_key, :get_treatment)
+        return false
+      end
+
+      if matching_key.is_a? Numeric
+        log_convert_numeric(:matching_key, :get_treatment)
+      end
+
+      return true
+    end
+
+    def valid_bucketing_key?(bucketing_key)
+      if bucketing_key.nil?
+        SplitIoClient.configuration.logger.warn('get_treatment: key object should have bucketing_key set')
+        return true
+      end
+
+      unless number_or_string?(bucketing_key)
+        log_number_or_string(:bucketing_key, :get_treatment)
+        return false
+      end
+
+      if bucketing_key.is_a? Numeric
+        log_convert_numeric(:bucketing_key, :get_treatment)
+      end
+
+      return true
+    end
+
+    def valid_split_names?(split_names)
+      if split_names.nil?
+        log_nil(:split_names, :get_treatments)
+        return false
+      end
+
+      unless split_names.is_a? Array
+        SplitIoClient.configuration.logger.warn('get_treatments: split_names must be an Array')
+        return false
+      end
+
+      return true
+    end
+
+    def valid_track_key?(key)
+      if key.nil?
+        log_nil(:key, :track)
+        return false
+      end
+
+      unless number_or_string?(key)
+        log_number_or_string(:key, :track)
+        return false
+      end
+
+      if key.is_a? Numeric
+        log_convert_numeric(:key, :track)
+      end
+
+      return true
+    end
+
+    def valid_event_type?(event_type)
+      if event_type.nil?
+        log_nil(:event_type, :track)
+        return false
+      end
+
+      unless string?(event_type)
+        log_string(:event_type, :track)
+        return false
+      end
+
+      if (event_type.to_s =~ /[a-zA-Z0-9][-_\.a-zA-Z0-9]{0,62}/).nil?
+        SplitIoClient.configuration.logger.error('track: event_type must adhere to [a-zA-Z0-9][-_\.a-zA-Z0-9]{0,62}')
+        return false
+      end
+
+      return true
+    end
+
+    def valid_traffic_type_name?(traffic_type_name)
+      if traffic_type_name.nil?
+        log_nil(:traffic_type_name, :track)
+        return false
+      end
+
+      unless string?(traffic_type_name)
+        log_string(:traffic_type_name, :track)
+        return false
+      end
+
+      if traffic_type_name.empty?
+        SplitIoClient.configuration.logger.error('track: traffic_type_name must not be an empty String')
+        return false
+      end
+
+      return true
+    end
+
+    def valid_value?(value)
+      unless value.is_a?(Numeric) || value.nil?
+        SplitIoClient.configuration.logger.error('track: value must be a number')
+        return false
+      end
+
+      return true
+    end
+  end
+end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.1.2.pre.rc21'
+  VERSION = '5.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.1.2.pre.rc21
+  version: 5.1.2
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -325,8 +325,7 @@ files:
 - lib/splitclient-rb/engine/parser/evaluator.rb
 - lib/splitclient-rb/engine/parser/partition.rb
 - lib/splitclient-rb/engine/parser/split_adapter.rb
-- lib/splitclient-rb/exceptions/impressions_shutdown_exception.rb
-- lib/splitclient-rb/exceptions/sdk_blocker_timeout_expired_exception.rb
+- lib/splitclient-rb/exceptions.rb
 - lib/splitclient-rb/localhost_split_factory.rb
 - lib/splitclient-rb/localhost_utils.rb
 - lib/splitclient-rb/managers/localhost_split_manager.rb
@@ -336,6 +335,7 @@ files:
 - lib/splitclient-rb/split_factory_builder.rb
 - lib/splitclient-rb/split_logger.rb
 - lib/splitclient-rb/utilitites.rb
+- lib/splitclient-rb/validators.rb
 - lib/splitclient-rb/version.rb
 - splitclient-rb.gemspec
 - splitio.yml.example
@@ -357,9 +357,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/lib/splitclient-rb/exceptions/impressions_shutdown_exception.rb

@@ -1,4 +0,0 @@
-module SplitIoClient
-  class ImpressionShutdownException < StandardError
-  end
-end

data/lib/splitclient-rb/exceptions/sdk_blocker_timeout_expired_exception.rb

@@ -1,4 +0,0 @@
-module SplitIoClient
-  class SDKBlockerTimeoutExpiredException < StandardError
-  end
-end