splitclient-rb 6.0.1 → 6.1.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aab1aa3e329b992c7861e5bbedec99b1cb88cac36beaef4066d26a5b507c273
-  data.tar.gz: eb5cc6e1c13c306b6c836ed9c5b31b16b38c53236f4d77cfef3c8d08d085b26e
+  metadata.gz: 7f253d1b85393689589b06dbf61824e7f1287e71b1f817c0b040628e5d79d3e3
+  data.tar.gz: 10cf34fcdc34f3050d424afd2c127d5b42312e933bfe582cba8279889092a030
 SHA512:
-  metadata.gz: 39c5812d26d8151f11a21d0d8a7d2c55f05fb87bc70eb21ecaa0e51ac0b2062ab8d7c565b67b10bbfe358bed24bfe15080d7732b9cb4812c1d9a8f903493dc22
-  data.tar.gz: a0227f046e4e46e069e1ef1df708ba1c55463c23c0155da54cbc58f4aff86df13a16613947319c7c73094b90bd0a1aacce87d76530e8f4bed533f2acf6029f76
+  metadata.gz: 2085b899c076c4e7e581bf94273a797747204db850eca6405b8d94e59fb6466dc63db790614e108e6d0bb9d7670cefced490ca0094692a129d26de1626ad7d15
+  data.tar.gz: 869897749f978d8e30bfd13a582741bbe3c4461be0bc2d90b797e1298ceba440e96f2af3fe26533176863f9cceb5a02a96d33b9be78420114ffd37b8462608ef

data/.rubocop.yml

@@ -17,5 +17,16 @@ Naming/FileName:
     - splitclient-rb.gemspec
 
 AllCops:
+  TargetRubyVersion: 2.3.6
   Exclude:
-    - lib/**/* #TODO Apply rubocop to the library
+    - lib/*
+    - lib/murmurhash/**/*
+    - lib/splitclient-rb/*
+    - lib/splitclient-rb/cache/**/*
+    - lib/splitclient-rb/clients/**/*
+    - lib/splitclient-rb/managers/**/*
+    - lib/splitclient-rb/engine/api/**/*
+    - lib/splitclient-rb/engine/evaluator/**/*
+    - lib/splitclient-rb/engine/metrics/**/*
+    - lib/splitclient-rb/engine/models/**/*
+    - lib/splitclient-rb/engine/parser/**/*

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start { add_filter %r{^/spec/} }

data/README.md

@@ -30,8 +30,8 @@ Split has built and maintains a SDKs for:
 * PHP [Github](https://github.com/splitio/php-client) [Docs](http://docs.split.io/docs/php-sdk-overview)
 * Python [Github](https://github.com/splitio/python-client) [Docs](http://docs.split.io/docs/python-sdk-overview)
 * GO [Github](https://github.com/splitio/go-client) [Docs](http://docs.split.io/docs/go-sdk-overview)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/v1/docs/android-sdk-overview)
-* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/v1/docs/ios-sdk-overview)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/docs/android-sdk-overview)
+* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/docs/ios-sdk-overview)
 
 For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

data/lib/splitclient-rb.rb

@@ -51,6 +51,7 @@ require 'splitclient-rb/engine/parser/condition'
 require 'splitclient-rb/engine/parser/partition'
 require 'splitclient-rb/engine/parser/split_adapter'
 require 'splitclient-rb/engine/parser/evaluator'
+require 'splitclient-rb/engine/matchers/matcher'
 require 'splitclient-rb/engine/matchers/combiners'
 require 'splitclient-rb/engine/matchers/combining_matcher'
 require 'splitclient-rb/engine/matchers/all_keys_matcher'

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

@@ -13,18 +13,18 @@ module SplitIoClient
       @impressions_repository = impressions_repository
       @metrics_repository = metrics_repository
       @events_repository = events_repository
+      @destroyed = false
 
       @adapter = adapter
     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')
+        SplitIoClient.configuration.logger.error('get_treatments: split_names must be a non-empty Array')
         return {}
       end
 
@@ -73,15 +73,23 @@ module SplitIoClient
         key, split_name, attributes = {}, split_data = nil, store_impressions = true,
         multiple = false, evaluator = nil
       )
+
       control_treatment = { label: Engine::Models::Label::EXCEPTION, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL }
       parsed_control_treatment = parsed_treatment(multiple, control_treatment)
 
       bucketing_key, matching_key = keys_from_key(key)
 
-      return parsed_control_treatment unless SplitIoClient::Validators.valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key)
+      return parsed_control_treatment unless valid_client && SplitIoClient::Validators.valid_get_treatment_parameters(key, split_name, matching_key, bucketing_key, attributes)
 
       bucketing_key = bucketing_key ? bucketing_key.to_s : nil
       matching_key = matching_key.to_s
+      sanitized_split_name = split_name.to_s.strip
+
+      if split_name.to_s != sanitized_split_name
+        SplitIoClient.configuration.logger.warn("get_treatment: split_name #{split_name} has extra whitespace, trimming")
+        split_name = sanitized_split_name
+      end
+
       evaluator ||= Engine::Parser::Evaluator.new(@segments_repository, @splits_repository)
 
       begin
@@ -117,18 +125,18 @@ module SplitIoClient
 
     def destroy
       SplitIoClient.configuration.logger.info('Split client shutdown started...') if SplitIoClient.configuration.debug_enabled
-
       SplitIoClient.configuration.threads[:impressions_sender].raise(SplitIoClient::ImpressionShutdownException)
       SplitIoClient.configuration.threads.reject { |k, _| k == :impressions_sender }.each do |name, thread|
         Thread.kill(thread)
       end
-
       @metrics_repository.clear
       @splits_repository.clear
       @segments_repository.clear
       @events_repository.clear
 
       SplitIoClient.configuration.logger.info('Split client shutdown complete') if SplitIoClient.configuration.debug_enabled
+      SplitIoClient.configuration.valid_mode = false
+      @destroyed = true
     end
 
     def store_impression(split_name, matching_key, bucketing_key, treatment, store_impressions, attributes)
@@ -177,9 +185,9 @@ module SplitIoClient
     end
 
     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)
+      return false unless valid_client && 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)
+        @events_repository.add(key.to_s, traffic_type_name.downcase, 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)
@@ -210,13 +218,26 @@ module SplitIoClient
 
     def sanitize_split_names(split_names)
       split_names.compact.uniq.select do |split_name|
-        if split_name.is_a?(String) && !split_name.empty?
+        if (split_name.is_a?(String) || split_name.is_a?(Symbol)) && !split_name.empty?
           true
+        elsif split_name.is_a?(String) && split_name.empty?
+          SplitIoClient.configuration.logger.warn('get_treatments: you passed an empty split_name, split_name must be a non-empty String or a Symbol')
+          false
         else
-          SplitIoClient.configuration.logger.warn('get_treatments: split_name has to be a non empty string')
+          SplitIoClient.configuration.logger.warn('get_treatments: you passed an invalid split_name, split_name must be a non-empty String or a Symbol')
           false
         end
       end
     end
+
+    private
+
+    def valid_client
+      if @destroyed
+        SplitIoClient.configuration.logger.error('Client has already been destroyed - no calls possible')
+        return false
+      end
+      SplitIoClient.configuration.valid_mode
+    end
   end
 end

data/lib/splitclient-rb/engine/api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http/persistent'
 
 module SplitIoClient
@@ -12,7 +14,7 @@ module SplitIoClient
           req.options[:timeout] = SplitIoClient.configuration.read_timeout
           req.options[:open_timeout] = SplitIoClient.configuration.connection_timeout
 
-          SplitIoClient.configuration.logger.debug("GET #{url} proxy: #{api_client.proxy}") if SplitIoClient.configuration.debug_enabled
+          SplitLogger.log_if_debug("GET #{url} proxy: #{api_client.proxy}")
         end
       rescue StandardError => e
         SplitIoClient.configuration.logger.warn("#{e}\nURL:#{url}\nparams:#{params}")
@@ -22,23 +24,20 @@ module SplitIoClient
       def post_api(url, api_key, data, headers = {}, params = {})
         api_client.post(url) do |req|
           req.headers = common_headers(api_key)
-            .merge('Content-Type' => 'application/json')
-            .merge(headers)
+                        .merge('Content-Type' => 'application/json')
+                        .merge(headers)
 
           req.body = data.to_json
 
           req.options[:timeout] = SplitIoClient.configuration.read_timeout
           req.options[:open_timeout] = SplitIoClient.configuration.connection_timeout
 
-          if SplitIoClient.configuration.transport_debug_enabled
-            SplitIoClient.configuration.logger.debug("POST #{url} #{req.body}")
-          elsif SplitIoClient.configuration.debug_enabled
-            SplitIoClient.configuration.logger.debug("POST #{url}")
-          end
+          SplitLogger.log_if_transport("POST #{url} #{req.body}")
+          SplitLogger.log_if_debug("POST #{url}")
         end
       rescue StandardError => e
         SplitIoClient.configuration.logger.warn("#{e}\nURL:#{url}\ndata:#{data}\nparams:#{params}")
-        raise 'Split SDK failed to connect to backend to retrieve information'
+        raise 'Split SDK failed to connect to backend to post information'
       end
 
       private

data/lib/splitclient-rb/engine/api/events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Api
     class Events < Client
@@ -7,7 +9,7 @@ module SplitIoClient
 
       def post(events)
         if events.empty?
-          SplitIoClient.configuration.logger.debug('No events to report') if SplitIoClient.configuration.debug_enabled
+          SplitLogger.log_if_debug('No events to report')
           return
         end
 
@@ -25,7 +27,7 @@ module SplitIoClient
             SplitLogger.log_if_debug("Events reported: #{events_slice.size}")
           else
             SplitLogger.log_error("Unexpected status code while posting events: #{response.status}." \
-            " - Check your API key and base URI")
+            ' - Check your API key and base URI')
             raise 'Split SDK failed to connect to backend to post events'
           end
         end

data/lib/splitclient-rb/engine/api/faraday_middleware/gzip.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module SplitIoClient
   module FaradayMiddleware
     class Gzip < Faraday::Middleware
-      ACCEPT_ENCODING = 'Accept-Encoding'.freeze
-      CONTENT_ENCODING = 'Content-Encoding'.freeze
-      CONTENT_LENGTH = 'Content-Length'.freeze
-      SUPPORTED_ENCODINGS = 'gzip,deflate'.freeze
+      ACCEPT_ENCODING = 'Accept-Encoding'
+      CONTENT_ENCODING = 'Content-Encoding'
+      CONTENT_LENGTH = 'Content-Length'
+      SUPPORTED_ENCODINGS = 'gzip,deflate'
       RUBY_ENCODING = '1.9'.respond_to?(:force_encoding)
 
       def call(env)
@@ -30,10 +32,10 @@ module SplitIoClient
       def uncompress_gzip(body)
         io = StringIO.new(body)
         gzip_reader = if RUBY_ENCODING
-          Zlib::GzipReader.new(io, :encoding => 'ASCII-8BIT')
-        else
-          Zlib::GzipReader.new(io)
-        end
+                        Zlib::GzipReader.new(io, encoding: 'ASCII-8BIT')
+                      else
+                        Zlib::GzipReader.new(io)
+                      end
         gzip_reader.read
       end
 

data/lib/splitclient-rb/engine/api/impressions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Api
     class Impressions < Client
@@ -7,7 +9,7 @@ module SplitIoClient
 
       def post(impressions)
         if impressions.empty?
-          SplitIoClient.configuration.logger.debug('No impressions to report') if SplitIoClient.configuration.debug_enabled
+          SplitLogger.log_if_debug('No impressions to report')
           return
         end
 
@@ -18,7 +20,7 @@ module SplitIoClient
             SplitLogger.log_if_debug("Impressions reported: #{total_impressions(impressions)}")
           else
             SplitLogger.log_error("Unexpected status code while posting impressions: #{response.status}." \
-            " - Check your API key and base URI")
+            ' - Check your API key and base URI')
             raise 'Split SDK failed to connect to backend to post impressions'
           end
         end

data/lib/splitclient-rb/engine/api/metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Api
     class Metrics < Client
@@ -15,7 +17,7 @@ module SplitIoClient
 
       def post_latencies
         if @metrics_repository.latencies.empty?
-          SplitIoClient.configuration.logger.debug('No latencies to report.') if SplitIoClient.configuration.debug_enabled
+          SplitLogger.log_if_debug('No latencies to report.')
         else
           @metrics_repository.latencies.each do |name, latencies|
             metrics_time = { name: name, latencies: latencies }
@@ -31,7 +33,7 @@ module SplitIoClient
 
       def post_counts
         if @metrics_repository.counts.empty?
-          SplitIoClient.configuration.logger.debug('No counts to report.') if SplitIoClient.configuration.debug_enabled
+          SplitLogger.log_if_debug('No counts to report.')
         else
           @metrics_repository.counts.each do |name, count|
             metrics_count = { name: name, delta: count }
@@ -44,14 +46,12 @@ module SplitIoClient
         @metrics_repository.clear_counts
       end
 
-      private
-
       def log_status(response, info_to_log)
         if response.success?
           SplitLogger.log_if_debug("Metric time reported: #{info_to_log}")
         else
           SplitLogger.log_error("Unexpected status code while posting time metrics: #{response.status}" \
-          " - Check your API key and base URI")
+          ' - Check your API key and base URI')
           raise 'Split SDK failed to connect to backend to post metrics'
         end
       end

data/lib/splitclient-rb/engine/api/segments.rb

@@ -27,6 +27,7 @@ module SplitIoClient
               till: #{@segments_repository.get_change_number(name)}")
 
             break if since.to_i >= @segments_repository.get_change_number(name).to_i
+
             since = @segments_repository.get_change_number(name)
           end
         end
@@ -39,7 +40,6 @@ module SplitIoClient
 
       def fetch_segment_changes(name, since)
         response = get_api("#{SplitIoClient.configuration.base_uri}/segmentChanges/#{name}", @api_key, since: since)
-
         if response.success?
           segment = JSON.parse(response.body, symbolize_names: true)
           @segments_repository.set_change_number(name, segment[:till])
@@ -55,6 +55,10 @@ module SplitIoClient
           SplitLogger.log_if_transport(segment.to_s)
 
           segment
+        elsif response.status == 403
+            SplitIoClient.configuration.logger.error('Factory Instantiation: You passed a browser type api_key, ' \
+              'please grab an api key from the Split console that is of type sdk')
+            SplitIoClient.configuration.valid_mode =  false
         else
           SplitLogger.log_error("Unexpected status code while fetching segments: #{response.status}." \
           "Since #{since} - Check your API key and base URI")

data/lib/splitclient-rb/engine/api/splits.rb

@@ -30,10 +30,10 @@ module SplitIoClient
 
           result
         else
-            @metrics.count(METRICS_PREFIX + '.status.' + response.status.to_s, 1)
-              SplitLogger.log_error("Unexpected status code while fetching splits: #{response.status}. " \
-              'Check your API key and base URI')
-            raise 'Split SDK failed to connect to backend to fetch split definitions'
+          @metrics.count(METRICS_PREFIX + '.status.' + response.status.to_s, 1)
+          SplitLogger.log_error("Unexpected status code while fetching splits: #{response.status}. " \
+          'Check your API key and base URI')
+          raise 'Split SDK failed to connect to backend to fetch split definitions'
         end
       end
 

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

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   #
   # class to implement the all keys matcher
   #
-  class AllKeysMatcher
-    MATCHER_TYPE = 'ALL_KEYS'.freeze
+  class AllKeysMatcher < Matcher
+    MATCHER_TYPE = 'ALL_KEYS'
 
     #
     # evaluates if the key matches the matcher
     #
     # @return [boolean] true for all instances
     def match?(_args)
+      SplitLogger.log_if_debug('[AllKeysMatcher] is always -> true')
       true
     end
 
@@ -20,25 +23,17 @@ module SplitIoClient
     #
     # @return [boolean] true if obj equals the matcher
     def equals?(obj)
-      if obj.nil?
-        false
-      elsif equal?(obj)
+      if obj.instance_of?(AllKeysMatcher)
         true
-      elsif !obj.instance_of?(AllKeysMatcher)
-        false
       else
-        true
+        super(obj)
       end
     end
 
-    def string_type?
-      false
-    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
       'in segment all'
     end

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

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SplitIoClient
-  class BetweenMatcher
-    MATCHER_TYPE = 'BETWEEN'.freeze
+  class BetweenMatcher < Matcher
+    MATCHER_TYPE = 'BETWEEN'
 
     attr_reader :attribute
 
@@ -12,30 +14,17 @@ 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?
+      SplitLogger.log_if_debug('[BetweenMatcher] evaluating value and attributes.')
+
+      return false unless SplitIoClient::Validators.valid_matcher_arguments(args)
 
       value = formatted_value(args[:value] || args[:attributes][@attribute.to_sym])
+      SplitLogger.log_if_debug("[BetweenMatcher] Value from parameters: #{value}.")
       return false unless value.is_a?(Integer)
 
-      (@start_value..@end_value).include? value
-    end
-
-    def equals?(obj)
-      if obj.nil?
-        false
-      elsif !obj.instance_of?(BetweenMatcher)
-        false
-      elsif self.equal?(obj)
-        true
-      else
-        false
-      end
-    end
-
-    def string_type?
-      false
+      matches = (@start_value..@end_value).cover? value
+      SplitLogger.log_if_debug("[BetweenMatcher] is #{value} between #{@start_value} and #{@end_value} -> #{matches} .")
+      matches
     end
 
     private
@@ -45,7 +34,7 @@ module SplitIoClient
       when 'NUMBER'
         value
       when 'DATETIME'
-        value = value / 1000 if sdk_data
+        value /= 1000 if sdk_data
 
         SplitIoClient::Utilities.to_milis_zero_out_from_seconds(value)
       else