splitclient-rb 6.0.1 → 6.1.0.pre.rc1

data/lib/splitclient-rb/split_factory.rb

@@ -1,5 +1,6 @@
 module SplitIoClient
   class SplitFactory
+    ROOT_PROCESS_ID = Process.pid
     include SplitIoClient::Cache::Repositories
     include SplitIoClient::Cache::Stores
 
@@ -25,7 +26,21 @@ module SplitIoClient
       @client = SplitClient.new(@api_key, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository)
       @manager = SplitManager.new(@api_key, @adapter, @splits_repository)
 
+      validate_api_key
+
       @sdk_blocker.block if SplitIoClient.configuration.block_until_ready > 0
+
+
+      at_exit do
+        unless ENV['SPLITCLIENT_ENV'] == 'test'
+          if (Process.pid == ROOT_PROCESS_ID)
+            SplitIoClient.configuration.logger.info('Split SDK shutdown started...')
+            @client.destroy
+            stop!
+            SplitIoClient.configuration.logger.info('Split SDK shutdown complete')
+          end
+        end
+      end
     end
 
     def start!
@@ -65,5 +80,17 @@ module SplitIoClient
     end
 
     alias resume! start!
+
+    private
+
+    def validate_api_key
+      if(@api_key.nil?)
+        SplitIoClient.configuration.logger.error('Factory Instantiation: you passed a nil api_key, api_key must be a non-empty String')
+        SplitIoClient.configuration.valid_mode =  false
+      elsif (@api_key.empty?)
+        SplitIoClient.configuration.logger.error('Factory Instantiation: you passed and empty api_key, api_key must be a non-empty String')
+        SplitIoClient.configuration.valid_mode =  false
+      end
+    end
   end
 end

data/lib/splitclient-rb/validators.rb

@@ -4,11 +4,12 @@ module SplitIoClient
   module Validators
     extend self
 
-    def valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key)
+    def valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key, attributes)
       valid_key?(key) &&
         valid_split_name?(split_name) &&
         valid_matching_key?(matching_key) &&
-        valid_bucketing_key?(key, bucketing_key)
+        valid_bucketing_key?(key, bucketing_key) &&
+        valid_attributes?(attributes)
     end
 
     def valid_get_treatments_parameters(split_names)
@@ -26,30 +27,45 @@ module SplitIoClient
       valid_split_name?(split_name, :split)
     end
 
+    def valid_matcher_arguments(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?
+      true
+    end
+
     private
 
     def string?(value)
       value.is_a?(String) || value.is_a?(Symbol)
     end
 
+    def empty_string?(value)
+      value.is_a?(String) && value.empty?
+    end
+
     def number_or_string?(value)
-      value.is_a?(Numeric) || string?(value)
+      (value.is_a?(Numeric) && !value.to_f.nan?) || string?(value)
     end
 
     def log_nil(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} cannot be nil")
+      SplitIoClient.configuration.logger.error("#{method}: you passed a nil #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_string(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String or a Symbol")
+    def log_empty_string(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: you passed an empty #{key}, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_number_or_string(key, method)
-      SplitIoClient.configuration.logger.error("#{method}: #{key} must be a String")
+    def log_invalid_type(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: you passed an invalid #{key} type, #{key} must be a non-empty String or a Symbol")
     end
 
-    def log_convert_numeric(key, method)
-      SplitIoClient.configuration.logger.warn("#{method}: #{key} is not of type String, converting to String")
+    def log_convert_numeric(key, method, value)
+      SplitIoClient.configuration.logger.warn("#{method}: #{key} \"#{value}\" is not of type String, converting")
+    end
+
+    def log_key_too_long(key, method)
+      SplitIoClient.configuration.logger.error("#{method}: #{key} is too long - must be #{SplitIoClient.configuration.max_key_size} characters or less")
     end
 
     def valid_split_name?(split_name, method = :get_treatment)
@@ -59,7 +75,12 @@ module SplitIoClient
       end
 
       unless string?(split_name)
-        log_string(:split_name, method)
+        log_invalid_type(:split_name, method)
+        return false
+      end
+
+      if empty_string?(split_name)
+        log_empty_string(:split_name, method)
         return false
       end
 
@@ -82,41 +103,65 @@ module SplitIoClient
       end
 
       unless number_or_string?(matching_key)
-        log_number_or_string(:matching_key, :get_treatment)
+        log_invalid_type(:matching_key, :get_treatment)
         return false
       end
 
-      log_convert_numeric(:matching_key, :get_treatment) if matching_key.is_a? Numeric
+      if empty_string?(matching_key)
+        log_empty_string(:matching_key, :get_treatment)
+        return false
+      end
+
+      log_convert_numeric(:matching_key, :get_treatment, matching_key) if matching_key.is_a? Numeric
+
+      if matching_key.size > SplitIoClient.configuration.max_key_size
+        log_key_too_long(:matching_key, :get_treatment)
+        return false
+      end
 
       true
     end
 
     def valid_bucketing_key?(key, bucketing_key)
-      if bucketing_key.nil?
-        if key.is_a? Hash
-          SplitIoClient.configuration.logger.warn('get_treatment: key object should have bucketing_key set')
+      if key.is_a? Hash
+        if bucketing_key.nil?
+          log_nil(:bucketing_key, :get_treatment)
+          return false
         end
-        return true
-      end
 
-      unless number_or_string?(bucketing_key)
-        log_number_or_string(:bucketing_key, :get_treatment)
-        return false
-      end
+        unless number_or_string?(bucketing_key)
+          log_invalid_type(:bucketing_key, :get_treatment)
+          return false
+        end
 
-      log_convert_numeric(:bucketing_key, :get_treatment) if bucketing_key.is_a? Numeric
+        if empty_string?(bucketing_key)
+          log_empty_string(:bucketing_key, :get_treatment)
+          return false
+        end
+
+        log_convert_numeric(:bucketing_key, :get_treatment, bucketing_key) if bucketing_key.is_a? Numeric
+
+        if bucketing_key.size > SplitIoClient.configuration.max_key_size
+          log_key_too_long(:bucketing_key, :get_treatment)
+          return false
+        end
+      end
 
       true
     end
 
     def valid_split_names?(split_names)
-      if split_names.nil?
-        log_nil(:split_names, :get_treatments)
+      unless !split_names.nil? && split_names.is_a?(Array)
+        SplitIoClient.configuration.logger.error('get_treatments: split_names must be a non-empty Array')
         return false
       end
 
-      unless split_names.is_a? Array
-        SplitIoClient.configuration.logger.warn('get_treatments: split_names must be an Array')
+      true
+    end
+
+    def valid_attributes?(attributes)
+      unless attributes.nil? || attributes.is_a?(Hash)
+        SplitIoClient.configuration.logger.error('get_treatment: attributes must be of type Hash')
         return false
       end
 
@@ -130,11 +175,21 @@ module SplitIoClient
       end
 
       unless number_or_string?(key)
-        log_number_or_string(:key, :track)
+        log_invalid_type(:key, :track)
         return false
       end
 
-      log_convert_numeric(:key, :track) if key.is_a? Numeric
+      if empty_string?(key)
+        log_empty_string(:key, :track)
+        return false
+      end
+
+      log_convert_numeric(:key, :track, key) if key.is_a? Numeric
+
+      if key.size > SplitIoClient.configuration.max_key_size
+        log_key_too_long(:key, :track)
+        return false
+      end
 
       true
     end
@@ -146,12 +201,20 @@ module SplitIoClient
       end
 
       unless string?(event_type)
-        log_string(:event_type, :track)
+        log_invalid_type(: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}')
+      if event_type.empty?
+        log_empty_string(:event_type, :track)
+        return false
+      end
+
+      if (event_type.to_s =~ /^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$/).nil?
+        SplitIoClient.configuration.logger.error("track: you passed '#{event_type}', " \
+          'event_type must adhere to the regular expression ^[a-zA-Z0-9][-_.:a-zA-Z0-9]{0,79}$. ' \
+          'This means an event name must be alphanumeric, cannot be more than 80 characters long, ' \
+          'and can only include a dash, underscore, period, or colon as separators of alphanumeric characters')
         return false
       end
 
@@ -165,21 +228,26 @@ module SplitIoClient
       end
 
       unless string?(traffic_type_name)
-        log_string(:traffic_type_name, :track)
+        log_invalid_type(: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')
+        log_empty_string(:traffic_type_name, :track)
         return false
       end
 
+      unless traffic_type_name == traffic_type_name.downcase
+        SplitIoClient.configuration.logger.warn('track: traffic_type_name should be all lowercase - ' \
+          'converting string to lowercase')
+      end
+
       true
     end
 
     def valid_value?(value)
-      unless value.is_a?(Numeric) || value.nil?
-        SplitIoClient.configuration.logger.error('track: value must be a number')
+      unless (value.is_a?(Numeric) && !value.to_f.nan?) || value.nil?
+        SplitIoClient.configuration.logger.error('track: value must be Numeric')
         return false
       end
 

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '6.0.1'
+  VERSION = '6.1.0.pre.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -272,6 +272,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".simplecov"
 - CHANGES.txt
 - Detailed-README.md
 - Gemfile
@@ -336,6 +337,7 @@ files:
 - lib/splitclient-rb/engine/matchers/equal_to_set_matcher.rb
 - lib/splitclient-rb/engine/matchers/greater_than_or_equal_to_matcher.rb
 - lib/splitclient-rb/engine/matchers/less_than_or_equal_to_matcher.rb
+- lib/splitclient-rb/engine/matchers/matcher.rb
 - lib/splitclient-rb/engine/matchers/matches_string_matcher.rb
 - lib/splitclient-rb/engine/matchers/negation_matcher.rb
 - lib/splitclient-rb/engine/matchers/part_of_set_matcher.rb
@@ -383,9 +385,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6