splitclient-rb 5.1.4.pre.rc1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ea725e730afe8d72d88cd7c487574b4ce96fcc2665c79f4e502b7feeb7dfb0
-  data.tar.gz: 38dec802cae4a567d979495fc5a4ca4181cc09eaff79a159cdb64d7db8de6809
+  metadata.gz: 37e343cf9f550bfb1989fc78d36c1bbd19ad1f6e9dc66d31b9eb330866dc5a95
+  data.tar.gz: 9ed27d3f9a249881f7ea73f3862696f93feb71145a3c8a78a8d0a970b1955cea
 SHA512:
-  metadata.gz: 9beeddbd8808e39c1168e675cfd887f181a6c77b8c726e37fab12c1ce1142eeda07a89a088d09def94b1e640161c1cb74179972af2aa79ec01d2c2ebb257a21a
-  data.tar.gz: 4baeabd635d137f795a60f3a022856d3ade60fd33a299c8d41a4e62d0de0ea6a09e015363f420ee428cb4833d3d267d08bdf67ecb29bb1176da0ae684579207c
+  metadata.gz: ca9dc9efc7ea8938d22fd3024b3fcb4699815ca8bd9acbd4c00b28e4d7eb3000fcda432e0d631422a9b006295d4f82c101f5d65304b0089a56d7f02e4464f273
+  data.tar.gz: 1640356edd237280e2089d229f651d24e473e146bdfbb13fbec85ad3baa83ea2b5fe3ad6af08a9c7c0d697de7068d2b3ae476f6311243efbafa811b616316edb

data/.rubocop.yml

@@ -1,3 +1,6 @@
+Documentation:
+    Enabled: false
+
 Metrics/MethodLength:
   Max: 15
 
@@ -8,7 +11,6 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
     - splitclient-rb.gemspec
-    - exe/splitio
 
 Naming/FileName:
   Exclude:

data/CHANGES.txt

@@ -1,5 +1,10 @@
-5.1.3
-- Add cache wrapper to splits and segments.
+6.0.0 (December 17th, 2018)
+- Change `sender` and `store` classes to reuse Faraday connections, preventing issues with net-http-persistent 3.0
+- Remove producer mode and make `memory + standalone` and `Redis + consumer` the only valid SDK modes. This is a breaking change
+- Fix `evaluator` bucket calculation when traffic allocation is set to 1%
+- Change format used to store impressions in repositories to reduce the number of Redis operations
+- Add cache wrapper to `segments_repository` and `splits_repository` to reduce the number of Redis operations
+- Add `cache_ttl` and `max_cache_size` options to setup the memory cache wrapper when using redis
 
 5.1.2 (October 26th, 2018)
 - Add input validation for client API methods

data/Detailed-README.md

@@ -72,6 +72,17 @@ else
 end
 ```
 
+**Note**: You can ensure the SDK resources are loaded before querying for treatments by using `block_until_ready`. See [Advanced Configuration](#advanced-configuration).
+``` ruby
+options = {
+  block_until_ready: 10
+}
+
+# Then init the factory passing the options hash
+factory  = SplitIoClient::SplitFactoryBuilder.build('YOUR_API_KEY', options)
+split_client = factory.client
+```
+
 For features that use targeting rules based on user attributes, you can call the `get_treatment` method the following way:
 
 ```ruby
@@ -239,7 +250,7 @@ The following values can be customized:
 
 *default value* = `60`
 
-**impressions_queue_size** : The size of the impressions queue in case of `cache_adapter == :memory`.
+**impressions_queue_size** : The size of the impressions queue in case of `cache_adapter == :memory`. When the queue is full, existing impressions will be dropped.
 
 *default value* = 5000
 
@@ -247,6 +258,10 @@ The following values can be customized:
 
 *default value* = defaults to `impressions_queue_size`
 
+**events_queue_size** : The size of the events queue in case of `cache_adapter == :memory`. When the queue is full, existing events will be dropped.
+
+*default value* = 500
+
 **debug_enabled** : Enables extra logging (verbose mode).
 
 *default value* = `false`
@@ -329,15 +344,9 @@ options = {
 
 ```ruby
 options = {
-  connection_timeout: 10,
-  read_timeout: 5,
-  features_refresh_rate: 120,
-  segments_refresh_rate: 120,
-  metrics_refresh_rate: 360,
-  impressions_refresh_rate: 360,
-  logger: Logger.new('logfile.log'),
+  # other options
   cache_adapter: :redis,
-  mode: :standalone,
+  mode: :consumer,
   redis_url: 'redis://127.0.0.1:6379/0'
 }
 begin
@@ -388,10 +397,10 @@ In the example above, the listener simply takes an impression and logs it to the
 
 The SDK is capable of running in two different modes to fit in different infrastructure configurations:
 
-- `:standalone` - (default) : The SDK will retrieve information (e.g. split definitions) periodically from the Split servers, and store it in the chosen cache (memory / Redis). It'll also store the application execution information (e.g. impressions) in the cache and send it periodically to the Split servers. As it name implies, in this mode, the SDK neither relies nor synchronizes with any other component.
-- `:consumer` - If using a load balancer or more than one SDK in your application, guaranteeing that all changes in split definitions are picked up by all SDK instances at the same time is highly recommended in order to ensure consistent results across your infrastructure (i.e. getting the same treatment for a specific split and user pair). To achieve this, use the [Split Synchronizer](https://docs.split.io/docs/split-synchronizer)) and setup your SDKs to work in the `consumer` mode. Setting the components this way, all communication with the Split server is orchestrated by the Synchronizer, while the SDKs pick up definitions and store the execution information from / into a shared Redis data store.
+- `:standalone` - (default) : The SDK will retrieve information (e.g. split definitions) periodically from the Split servers, and store it in the memory cache. It'll also store the application execution information (e.g. impressions) in the cache and send it periodically to the Split servers. As it name implies, in this mode, the SDK neither relies nor synchronizes with any other component. _This mode is only available when using the `memory` cache adapter._
+- `:consumer` - If using a load balancer or more than one SDK in your application, guaranteeing that all changes in split definitions are picked up by all SDK instances at the same time is highly recommended in order to ensure consistent results across your infrastructure (i.e. getting the same treatment for a specific split and user pair). To achieve this, use the [Split Synchronizer](https://docs.split.io/docs/split-synchronizer)) and setup your SDKs to work in the `consumer` mode. Setting the components this way, all communication with the Split server is orchestrated by the Synchronizer, while the SDKs pick up definitions and store the execution information from / into a shared Redis data store. _This mode is only available when using the `redis` cache adapter._
 
-_You can choose between these 2 modes setting the `mode` option in the config._
+_You can choose between these 2 modes setting the `mode` option in the config. An invalid combination of `cache_adaper` and `mode` will result in an Invalid Mode exception being raised._
 
 ## SDK Server Compatibility
 

data/NEWS

@@ -1,6 +1,7 @@
-5.1.3
-
-Add cache wrapper to splits and segments.
+6.0.0
+Remove producer mode, make memory adapter mandatory in standalone mode, and Redis adapter mandatory in consumer mode. This is a breaking change.
+Reduce the total number of Redis operations of the SDK by changing the impressions storage format and adding a memory cache for splits and segments.
+SDK is now compatible with net-http-persistent 3.0.
 
 5.1.2
 

data/lib/splitclient-rb/cache/adapters/redis_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module SplitIoClient
@@ -85,8 +87,8 @@ module SplitIoClient
         end
 
         # Set
-        alias_method :initialize_set, :initialize_map
-        alias_method :find_sets_by_prefix, :find_strings_by_prefix
+        alias initialize_set initialize_map
+        alias find_sets_by_prefix find_strings_by_prefix
 
         def add_to_set(key, val)
           @redis.sadd(key, val)
@@ -126,7 +128,7 @@ module SplitIoClient
         def get_from_queue(key, count)
           items = @redis.lrange(key, 0, count - 1)
           fetched_count = items.size
-          items_to_remove = (fetched_count == count) ? count : fetched_count
+          items_to_remove = fetched_count == count ? count : fetched_count
 
           @redis.ltrim(key, items_to_remove, -1)
 
@@ -148,9 +150,9 @@ module SplitIoClient
           @redis.incrby(key, inc)
         end
 
-        def pipelined(&block)
+        def pipelined
           @redis.pipelined do
-            block.call
+            yield
           end
         end
 
@@ -159,6 +161,10 @@ module SplitIoClient
 
           keys.map { |key| @redis.del(key) }
         end
+
+        def expire(key, seconds)
+          @redis.expire(key, seconds)
+        end
       end
     end
   end

data/lib/splitclient-rb/cache/repositories/impressions/memory_repository.rb

@@ -1,42 +1,44 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       module Impressions
-        class MemoryRepository
-
+        class MemoryRepository < ImpressionsRepository
           def initialize(adapter)
             @adapter = adapter
           end
 
           # Store impression data in the selected adapter
-          def add(split_name, data)
-            @adapter.add_to_queue(feature: split_name, impressions: data)
+          def add(matching_key, bucketing_key, split_name, treatment, time)
+            @adapter.add_to_queue(
+              m: metadata,
+              i: impression_data(
+                matching_key,
+                bucketing_key,
+                split_name,
+                treatment,
+                time
+              )
+            )
           rescue ThreadError # queue is full
             if random_sampler.rand(1..1000) <= 2 # log only 0.2 % of the time
-              SplitIoClient.configuration.logger.warn("Dropping impressions. Current size is #{SplitIoClient.configuration.impressions_queue_size}. " \
-                                  "Consider increasing impressions_queue_size")
+              SplitIoClient.configuration.logger.warn("Dropping impressions. Current size is \
+                #{SplitIoClient.configuration.impressions_queue_size}. " \
+                'Consider increasing impressions_queue_size')
             end
           end
 
           def add_bulk(key, bucketing_key, treatments, time)
             treatments.each do |split_name, treatment|
-              add(
-                split_name,
-                'keyName' => key,
-                'bucketingKey' => bucketing_key,
-                'treatment' => treatment[:treatment],
-                'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-                'changeNumber' => treatment[:change_number],
-                'time' => time
-              )
+              add(key, bucketing_key, split_name, treatment, time)
             end
           end
 
-          def get_batch
-            return [] if SplitIoClient.configuration.impressions_bulk_size == 0
-            @adapter.get_batch(SplitIoClient.configuration.impressions_bulk_size).map do |impression|
-              impression.update(ip: SplitIoClient.configuration.machine_ip)
-            end
+          def batch
+            return [] if SplitIoClient.configuration.impressions_bulk_size.zero?
+
+            @adapter.get_batch(SplitIoClient.configuration.impressions_bulk_size)
           end
 
           private

data/lib/splitclient-rb/cache/repositories/impressions/redis_repository.rb

@@ -1,75 +1,53 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       module Impressions
-        class RedisRepository < Repository
+        class RedisRepository < ImpressionsRepository
+          EXPIRE_SECONDS = 3600
 
           def initialize(adapter)
             @adapter = adapter
           end
 
-          # Store impression data in Redis
-          def add(split_name, data)
-            @adapter.add_to_set(
-              impressions_metrics_key("impressions.#{split_name}"),
-              data.to_json
-            )
+          def add(matching_key, bucketing_key, split_name, treatment, time)
+            add_bulk(matching_key, bucketing_key, { split_name => treatment }, time)
           end
 
-          def add_bulk(key, bucketing_key, treatments, time)
-            @adapter.redis.pipelined do
-              treatments.each do |split_name, treatment|
-                add(split_name,
-                    'keyName' => key,
-                    'bucketingKey' => bucketing_key,
-                    'treatment' => treatment[:treatment],
-                    'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-                    'changeNumber' => treatment[:change_number],
-                    'time' => time)
-              end
+          def add_bulk(matching_key, bucketing_key, treatments, time)
+            impressions = treatments.map do |split_name, treatment|
+              {
+                m: metadata,
+                i: impression_data(
+                  matching_key,
+                  bucketing_key,
+                  split_name,
+                  treatment,
+                  time
+                )
+              }.to_json
             end
-          end
-
-          # Get random impressions from redis in batches of size SplitIoClient.configuration.impressions_bulk_size,
-          # delete fetched impressions afterwards
-          def get_batch
-            impressions = impression_keys.each_with_object([]) do |key, memo|
-              ip = key.split('/')[-2] # 'prefix/sdk_lang/ip/impressions.name' -> ip
-              if ip.nil?
-                SplitIoClient.configuration.logger.warn("Impressions IP parse error for key: #{key}")
-                next
-              end
-              split_name = key.split('.').last
-              members = @adapter.random_set_elements(key, SplitIoClient.configuration.impressions_bulk_size)
-              members.each do |impression|
-                parsed_impression = JSON.parse(impression)
 
-                memo << {
-                  feature: split_name.to_sym,
-                  impressions: parsed_impression,
-                  ip: ip
-                }
-              end
+            impressions_list_size = @adapter.add_to_queue(key, impressions)
 
-              @adapter.delete_from_set(key, members)
+            # Synchronizer might not be running
+            @adapter.expire(key, EXPIRE_SECONDS) if impressions.size == impressions_list_size
+          end
 
+          def batch
+            @adapter.get_from_queue(key, SplitIoClient.configuration.impressions_bulk_size).map do |e|
+              impression = JSON.parse(e, symbolize_names: true)
+              impression[:i][:f] = impression[:i][:f].to_sym
+              impression
             end
-            impressions
           rescue StandardError => e
             SplitIoClient.configuration.logger.error("Exception while clearing impressions cache: #{e}")
-
             []
           end
 
-          private
-
-          # Get all sets by prefix
-          def impression_keys
-            @adapter.find_sets_by_prefix("#{SplitIoClient.configuration.redis_namespace}/*/impressions.*")
-          rescue StandardError => e
-            SplitIoClient.configuration.logger.error("Exception while fetching impression_keys: #{e}")
-
-            []
+          def key
+            @key ||= namespace_key('.impressions')
           end
         end
       end

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

@@ -1,18 +1,46 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Repositories
       # Repository which forwards impressions interface to the selected adapter
       class ImpressionsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :add_bulk, :get_batch, :empty?
+        def_delegators :@adapter, :add, :add_bulk, :batch, :empty?
 
         def initialize(adapter)
           @adapter = case adapter.class.to_s
-          when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
-            Repositories::Impressions::MemoryRepository.new(adapter)
-          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
-            Repositories::Impressions::RedisRepository.new(adapter)
-          end
+                     when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
+                       Repositories::Impressions::MemoryRepository.new(adapter)
+                     when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+                       Repositories::Impressions::RedisRepository.new(adapter)
+                     end
+        end
+
+        protected
+
+        def impression_data(matching_key, bucketing_key, split_name, treatment, timestamp)
+          {
+            k: matching_key,
+            b: bucketing_key,
+            f: split_name,
+            t: treatment[:treatment],
+            r: applied_rule(treatment[:label]),
+            c: treatment[:change_number],
+            m: timestamp
+          }
+        end
+
+        def metadata
+          {
+            s: "#{SplitIoClient.configuration.language}-#{SplitIoClient.configuration.version}",
+            i: SplitIoClient.configuration.machine_ip,
+            n: SplitIoClient.configuration.machine_name
+          }
+        end
+
+        def applied_rule(label)
+          SplitIoClient.configuration.labels_enabled ? label : nil
         end
       end
     end

data/lib/splitclient-rb/cache/senders/events_sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders
@@ -36,10 +38,14 @@ module SplitIoClient
         end
 
         def post_events
-          SplitIoClient::Api::Events.new(@api_key, @events_repository.clear).post
+          events_api.post(@events_repository.clear)
         rescue StandardError => error
           SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
         end
+
+        def events_api
+          @events_api ||= SplitIoClient::Api::Events.new(@api_key)
+        end
       end
     end
   end

data/lib/splitclient-rb/cache/senders/impressions_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders
@@ -7,29 +9,15 @@ module SplitIoClient
         end
 
         def call(raw_impressions)
-          impressions = raw_impressions ? raw_impressions : @impressions_repository.get_batch
-          formatted_impressions = []
+          impressions = raw_impressions || @impressions_repository.batch
           filtered_impressions = filter_impressions(impressions)
 
           return [] if impressions.empty? || filtered_impressions.empty?
 
           formatted_impressions = unique_features(filtered_impressions).each_with_object([]) do |feature, memo|
-            ip = nil
-            current_impressions =
-              filtered_impressions
-                .select { |impression| impression[:feature] == feature }
-                .map do |impression|
-                  ip = impression[:ip]
-                  {
-                    keyName: impression[:impressions]['keyName'] || impression[:impressions]['key_name'],
-                    treatment: impression[:impressions]['treatment'],
-                    time: impression[:impressions]['time'],
-                    bucketingKey: impression[:impressions]['bucketingKey'] || impression[:impressions]['bucketing_key'],
-                    label: impression[:impressions]['label'],
-                    changeNumber: impression[:impressions]['changeNumber'] || impression[:impressions]['change_number'],
-                  }
-                end
-
+            feature_impressions = feature_impressions(filtered_impressions, feature)
+            ip = feature_impressions.first[:m][:i]
+            current_impressions = current_impressions(feature_impressions)
             memo << {
               testName: feature.to_sym,
               keyImpressions: current_impressions,
@@ -42,8 +30,27 @@ module SplitIoClient
 
         private
 
+        def feature_impressions(filtered_impressions, feature)
+          filtered_impressions.select do |impression|
+            impression[:i][:f] == feature
+          end
+        end
+
+        def current_impressions(feature_impressions)
+          feature_impressions.map do |impression|
+            {
+              keyName: impression[:i][:k],
+              treatment: impression[:i][:t],
+              time: impression[:i][:m],
+              bucketingKey: impression[:i][:b],
+              label: impression[:i][:r],
+              changeNumber: impression[:i][:c]
+            }
+          end
+        end
+
         def unique_features(impressions)
-          impressions.map { |impression| impression[:feature] }.uniq
+          impressions.map { |impression| impression[:i][:f] }.uniq
         end
 
         # Filter seen impressions by impression_hash
@@ -61,11 +68,11 @@ module SplitIoClient
         end
 
         def impression_hash(impression)
-          "#{impression[:feature]}:" \
-          "#{impression[:impressions]['keyName']}:" \
-          "#{impression[:impressions]['bucketingKey']}:" \
-          "#{impression[:impressions]['changeNumber']}:" \
-          "#{impression[:impressions]['treatment']}"
+          "#{impression[:i][:f]}:" \
+          "#{impression[:i][:k]}:" \
+          "#{impression[:i][:b]}:" \
+          "#{impression[:i][:c]}:" \
+          "#{impression[:i][:t]}"
         end
       end
     end

data/lib/splitclient-rb/cache/senders/impressions_sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders
@@ -47,7 +49,7 @@ module SplitIoClient
         end
 
         def post_impressions
-          impressions_client.post
+          impressions_api.post(formatted_impressions)
         rescue StandardError => error
           SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
         end
@@ -56,8 +58,8 @@ module SplitIoClient
           ImpressionsFormatter.new(@impressions_repository).call(raw_impressions)
         end
 
-        def impressions_client
-          SplitIoClient::Api::Impressions.new(@api_key, formatted_impressions)
+        def impressions_api
+          @impressions_api ||= SplitIoClient::Api::Impressions.new(@api_key)
         end
       end
     end

data/lib/splitclient-rb/cache/senders/metrics_sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Cache
     module Senders
@@ -34,13 +36,13 @@ module SplitIoClient
         end
 
         def post_metrics
-          metrics_client.post
+          metrics_api.post
         rescue StandardError => error
           SplitIoClient.configuration.log_found_exception(__method__.to_s, error)
         end
 
-        def metrics_client
-          SplitIoClient::Api::Metrics.new(@api_key, @metrics_repository)
+        def metrics_api
+          @metrics_api ||= SplitIoClient::Api::Metrics.new(@api_key, @metrics_repository)
         end
       end
     end

data/lib/splitclient-rb/cache/stores/segment_store.rb

@@ -73,7 +73,7 @@ module SplitIoClient
         end
 
         def segments_api
-          SplitIoClient::Api::Segments.new(@api_key, @metrics, @segments_repository)
+          @segments_api ||= SplitIoClient::Api::Segments.new(@api_key, @metrics, @segments_repository)
         end
       end
     end

data/lib/splitclient-rb/cache/stores/split_store.rb

@@ -66,7 +66,7 @@ module SplitIoClient
         end
 
         def splits_since(since)
-          SplitIoClient::Api::Splits.new(@api_key, @metrics).since(since)
+          splits_api.since(since)
         end
 
         def add_split_unless_archived(split)
@@ -90,6 +90,12 @@ module SplitIoClient
 
           @splits_repository.add_split(split)
         end
+
+        private
+
+        def splits_api
+          @splits_api ||= SplitIoClient::Api::Splits.new(@api_key, @metrics)
+        end
       end
     end
   end

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

@@ -136,13 +136,12 @@ module SplitIoClient
 
       return if SplitIoClient.configuration.disable_impressions || !store_impressions
 
-      @impressions_repository.add(split_name,
-        'keyName' => matching_key,
-        'bucketingKey' => bucketing_key,
-        'treatment' => treatment[:treatment],
-        'label' => SplitIoClient.configuration.labels_enabled ? treatment[:label] : nil,
-        'time' => time,
-        'changeNumber' => treatment[:change_number]
+      @impressions_repository.add(
+        matching_key,
+        bucketing_key,
+        split_name,
+        treatment,
+        time
       )
 
       route_impression(split_name, matching_key, bucketing_key, time, treatment, attributes)

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

@@ -38,8 +38,7 @@ module SplitIoClient
         end
       rescue StandardError => e
         SplitIoClient.configuration.logger.warn("#{e}\nURL:#{url}\ndata:#{data}\nparams:#{params}")
-
-        false
+        raise 'Split SDK failed to connect to backend to retrieve information'
       end
 
       private

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

@@ -1,31 +1,32 @@
 module SplitIoClient
   module Api
     class Events < Client
-      def initialize(api_key, events)
+      def initialize(api_key)
         @api_key = api_key
-        @events = events
       end
 
-      def post
-        if @events.empty?
+      def post(events)
+        if events.empty?
           SplitIoClient.configuration.logger.debug('No events to report') if SplitIoClient.configuration.debug_enabled
           return
         end
 
-        @events.each_slice(SplitIoClient.configuration.events_queue_size) do |event_slice|
+        events.each_slice(SplitIoClient.configuration.events_queue_size) do |events_slice|
           result = post_api(
             "#{SplitIoClient.configuration.events_uri}/events/bulk",
             @api_key,
-            event_slice.map { |event| formatted_event(event[:e]) },
-            'SplitSDKMachineIP' => event_slice[0][:m][:i],
-            'SplitSDKMachineName' => event_slice[0][:m][:n],
-            'SplitSDKVersion' => event_slice[0][:m][:s]
+            events_slice.map { |event| formatted_event(event[:e]) },
+            'SplitSDKMachineIP' => events_slice[0][:m][:i],
+            'SplitSDKMachineName' => events_slice[0][:m][:n],
+            'SplitSDKVersion' => events_slice[0][:m][:s]
           )
 
-          if (200..299).include? result.status
-            SplitIoClient.configuration.logger.debug("Events reported: #{event_slice.size}") if SplitIoClient.configuration.debug_enabled
+          if response.success?
+            SplitLogger.log_if_debug("Events reported: #{events_slice.size}")
           else
-            SplitIoClient.configuration.logger.error("Unexpected status code while posting events: #{result.status}")
+            SplitLogger.log_error("Unexpected status code while posting events: #{response.status}." \
+            " - Check your API key and base URI")
+            raise 'Split SDK failed to connect to backend to post events'
           end
         end
       end

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

@@ -1,24 +1,25 @@
 module SplitIoClient
   module Api
     class Impressions < Client
-      def initialize(api_key, impressions)
+      def initialize(api_key)
         @api_key = api_key
-        @impressions = impressions
       end
 
-      def post
-        if @impressions.empty?
+      def post(impressions)
+        if impressions.empty?
           SplitIoClient.configuration.logger.debug('No impressions to report') if SplitIoClient.configuration.debug_enabled
           return
         end
 
-        impressions_by_ip.each do |ip, impressions|
-          result = post_api("#{SplitIoClient.configuration.events_uri}/testImpressions/bulk", @api_key, impressions, 'SplitSDKMachineIP' => ip)
+        impressions_by_ip(impressions).each do |ip, impressions_ip|
+          result = post_api("#{SplitIoClient.configuration.events_uri}/testImpressions/bulk", @api_key, impressions_ip, 'SplitSDKMachineIP' => ip)
 
-          if (200..299).include? result.status
-            SplitIoClient.configuration.logger.debug("Impressions reported: #{total_impressions(@impressions)}") if SplitIoClient.configuration.debug_enabled
+          if response.success?
+            SplitLogger.log_if_debug("Impressions reported: #{total_impressions(impressions)}")
           else
-            SplitIoClient.configuration.logger.error("Unexpected status code while posting impressions: #{result.status}")
+            SplitLogger.log_error("Unexpected status code while posting impressions: #{response.status}." \
+            " - Check your API key and base URI")
+            raise 'Split SDK failed to connect to backend to post impressions'
           end
         end
       end
@@ -33,8 +34,8 @@ module SplitIoClient
 
       private
 
-      def impressions_by_ip
-        @impressions.group_by { |impression| impression[:ip] }
+      def impressions_by_ip(impressions)
+        impressions.group_by { |impression| impression[:ip] }
       end
     end
   end

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

@@ -20,9 +20,9 @@ module SplitIoClient
           @metrics_repository.latencies.each do |name, latencies|
             metrics_time = { name: name, latencies: latencies }
 
-            result = post_api("#{SplitIoClient.configuration.events_uri}/metrics/time", @api_key, metrics_time)
+            response = post_api("#{SplitIoClient.configuration.events_uri}/metrics/time", @api_key, metrics_time)
 
-            log_status(result, metrics_time.size)
+            log_status(response, metrics_time.size)
           end
         end
 
@@ -36,9 +36,9 @@ module SplitIoClient
           @metrics_repository.counts.each do |name, count|
             metrics_count = { name: name, delta: count }
 
-            result = post_api("#{SplitIoClient.configuration.events_uri}/metrics/counter", @api_key, metrics_count)
+            response = post_api("#{SplitIoClient.configuration.events_uri}/metrics/counter", @api_key, metrics_count)
 
-            log_status(result, metrics_count.size)
+            log_status(response, metrics_count.size)
           end
         end
         @metrics_repository.clear_counts
@@ -46,13 +46,13 @@ module SplitIoClient
 
       private
 
-      def log_status(result, info_to_log)
-        if result == false
-          SplitIoClient.configuration.logger.error("Failed to make a http request")
-        elsif (200..299).include? result.status
-          SplitIoClient.configuration.logger.debug("Metric time reported: #{info_to_log}") if SplitIoClient.configuration.debug_enabled
+      def log_status(response, info_to_log)
+        if response.success?
+          SplitLogger.log_if_debug("Metric time reported: #{info_to_log}")
         else
-          SplitIoClient.configuration.logger.error("Unexpected status code while posting time metrics: #{result.status}")
+          SplitLogger.log_error("Unexpected status code while posting time metrics: #{response.status}" \
+          " - Check your API key and base URI")
+          raise 'Split SDK failed to connect to backend to post metrics'
         end
       end
     end

data/lib/splitclient-rb/engine/parser/evaluator.rb

@@ -51,7 +51,7 @@ module SplitIoClient
               if split[:trafficAllocation] < 100
                 bucket = splitter.bucket(splitter.count_hash(key, split[:trafficAllocationSeed].to_i, legacy_algo))
 
-                if bucket >= split[:trafficAllocation]
+                if bucket > split[:trafficAllocation]
                   return treatment_hash(Models::Label::NOT_IN_SPLIT, split[:defaultTreatment], split[:changeNumber])
                 end
               end

data/lib/splitclient-rb/engine/parser/split_adapter.rb

@@ -24,7 +24,15 @@ module SplitIoClient
     # @param sdk_blocker [SDKBlocker] SDKBlocker instance which blocks splits_repository/segments_repository
     #
     # @return [SplitIoClient] split.io client instance
-    def initialize(api_key, splits_repository, segments_repository, impressions_repository, metrics_repository, events_repository, sdk_blocker)
+    def initialize(
+      api_key,
+      splits_repository,
+      segments_repository,
+      impressions_repository,
+      metrics_repository,
+      events_repository,
+      sdk_blocker
+    )
       @api_key = api_key
       @splits_repository = splits_repository
       @segments_repository = segments_repository
@@ -34,28 +42,15 @@ module SplitIoClient
       @metrics = Metrics.new(100, @metrics_repository)
       @sdk_blocker = sdk_blocker
 
-      start_based_on_mode(SplitIoClient.configuration.mode)
+      start_standalone_components if SplitIoClient.configuration.mode == :standalone
     end
 
-    def start_based_on_mode(mode)
-      case mode
-      when :standalone
-        split_store
-        segment_store
-        metrics_sender
-        impressions_sender
-        events_sender
-      when :consumer
-        # Do nothing in background
-      when :producer
-        split_store
-        segment_store
-        impressions_sender
-        metrics_sender
-        events_sender
-
-        sleep unless ENV['SPLITCLIENT_ENV'] == 'test'
-      end
+    def start_standalone_components
+      split_store
+      segment_store
+      metrics_sender
+      impressions_sender
+      events_sender
     end
 
     # Starts thread which loops constantly and stores splits in the splits_repository of choice

data/lib/splitclient-rb/split_config.rb

@@ -109,7 +109,7 @@ module SplitIoClient
     #
     # The mode SDK will run
     #
-    # @return [Symbol] One of the available SDK modes: standalone, consumer, producer
+    # @return [Symbol] One of the available SDK modes: standalone, consumer
     attr_accessor :mode
 
     # The read timeout for network connections in seconds.

data/lib/splitclient-rb/split_factory.rb

@@ -8,6 +8,9 @@ module SplitIoClient
     def initialize(api_key, config_hash = {})
       @api_key = api_key
       SplitIoClient.configure(config_hash)
+
+      raise 'Invalid SDK mode' unless valid_mode
+
       @cache_adapter = SplitIoClient.configuration.cache_adapter
 
       @splits_repository = SplitsRepository.new(@cache_adapter)
@@ -33,6 +36,34 @@ module SplitIoClient
       SplitIoClient.configuration.threads.each { |_, t| t.exit }
     end
 
+    def valid_mode
+      valid_startup_mode = false
+      case SplitIoClient.configuration.mode
+      when :consumer
+        if SplitIoClient.configuration.cache_adapter.is_a? SplitIoClient::Cache::Adapters::RedisAdapter
+          valid_startup_mode = true
+        else
+          SplitIoClient.configuration.logger.error('Consumer mode cannot be used with Memory adapter. ' \
+            'Use Redis adapter instead.')
+        end
+      when :standalone
+        if SplitIoClient.configuration.cache_adapter.is_a? SplitIoClient::Cache::Adapters::MemoryAdapter
+          valid_startup_mode = true
+        else
+          SplitIoClient.configuration.logger.error('Standalone mode cannot be used with Redis adapter. ' \
+            'Use Memory adapter instead.')
+        end
+      when :producer
+        SplitIoClient.configuration.logger.error('Producer mode is no longer supported. Use Split Synchronizer. ' \
+          'See: https://github.com/splitio/split-synchronizer')
+      else
+        SplitIoClient.configuration.logger.error('Invalid SDK mode selected. ' \
+          "Valid modes are 'standalone with memory adapter' and 'consumer with redis adapter'")
+      end
+
+      valid_startup_mode
+    end
+
     alias resume! start!
   end
 end

data/lib/splitclient-rb/validators.rb

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 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)
+      valid_key?(key) &&
+        valid_split_name?(split_name) &&
+        valid_matching_key?(matching_key) &&
+        valid_bucketing_key?(key, bucketing_key)
     end
 
     def valid_get_treatments_parameters(split_names)
@@ -11,7 +16,10 @@ module SplitIoClient
     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)
+      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)
@@ -44,7 +52,7 @@ module SplitIoClient
       SplitIoClient.configuration.logger.warn("#{method}: #{key} is not of type String, converting to String")
     end
 
-    def valid_split_name?(split_name, method=:get_treatment)
+    def valid_split_name?(split_name, method = :get_treatment)
       if split_name.nil?
         log_nil(:split_name, method)
         return false
@@ -55,7 +63,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
 
     def valid_key?(key)
@@ -64,7 +72,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
 
     def valid_matching_key?(matching_key)
@@ -78,16 +86,16 @@ module SplitIoClient
         return false
       end
 
-      if matching_key.is_a? Numeric
-        log_convert_numeric(:matching_key, :get_treatment)
-      end
+      log_convert_numeric(:matching_key, :get_treatment) if matching_key.is_a? Numeric
 
-      return true
+      true
     end
 
-    def valid_bucketing_key?(bucketing_key)
+    def valid_bucketing_key?(key, bucketing_key)
       if bucketing_key.nil?
-        SplitIoClient.configuration.logger.warn('get_treatment: key object should have bucketing_key set')
+        if key.is_a? Hash
+          SplitIoClient.configuration.logger.warn('get_treatment: key object should have bucketing_key set')
+        end
         return true
       end
 
@@ -96,11 +104,9 @@ module SplitIoClient
         return false
       end
 
-      if bucketing_key.is_a? Numeric
-        log_convert_numeric(:bucketing_key, :get_treatment)
-      end
+      log_convert_numeric(:bucketing_key, :get_treatment) if bucketing_key.is_a? Numeric
 
-      return true
+      true
     end
 
     def valid_split_names?(split_names)
@@ -114,7 +120,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
 
     def valid_track_key?(key)
@@ -128,11 +134,9 @@ module SplitIoClient
         return false
       end
 
-      if key.is_a? Numeric
-        log_convert_numeric(:key, :track)
-      end
+      log_convert_numeric(:key, :track) if key.is_a? Numeric
 
-      return true
+      true
     end
 
     def valid_event_type?(event_type)
@@ -151,7 +155,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
 
     def valid_traffic_type_name?(traffic_type_name)
@@ -170,7 +174,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
 
     def valid_value?(value)
@@ -179,7 +183,7 @@ module SplitIoClient
         return false
       end
 
-      return true
+      true
     end
   end
 end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.1.4.pre.rc1'
+  VERSION = '6.0.0'
 end

data/splitclient-rb.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features|ext)/}) }
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   if defined?(JRUBY_VERSION)
@@ -53,7 +51,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday', '>= 0.8'
   spec.add_runtime_dependency 'json', '>= 1.8'
   spec.add_runtime_dependency 'lru_redux'
-  spec.add_runtime_dependency 'net-http-persistent', '~> 3.0'
+  spec.add_runtime_dependency 'net-http-persistent', '>= 2.9'
   spec.add_runtime_dependency 'redis', '>= 3.2'
   spec.add_runtime_dependency 'thread_safe', '>= 0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.1.4.pre.rc1
+  version: 6.0.0
 platform: ruby
 authors:
 - Split Software
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -224,16 +224,16 @@ dependencies:
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -265,8 +265,7 @@ dependencies:
 description: Ruby client for using split SDK.
 email:
 - pato@split.io
-executables:
-- splitio
+executables: []
 extensions:
 - ext/murmurhash/extconf.rb
 extra_rdoc_files: []
@@ -280,7 +279,6 @@ files:
 - NEWS
 - README.md
 - Rakefile
-- exe/splitio
 - ext/murmurhash/3_x86_32.c
 - ext/murmurhash/extconf.rb
 - ext/murmurhash/murmurhash.c
@@ -367,7 +365,6 @@ files:
 - lib/splitclient-rb/validators.rb
 - lib/splitclient-rb/version.rb
 - splitclient-rb.gemspec
-- splitio.yml.example
 - tasks/benchmark_get_treatment.rake
 - tasks/irb.rake
 - tasks/rspec.rake
@@ -386,9 +383,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/exe/splitio

@@ -1,96 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-lib = File.expand_path('../lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'optparse'
-require 'yaml'
-require_relative '../lib/splitclient-rb'
-
-# ARGV << '-h' if ARGV.empty?
-
-config_path = ''
-options = {}
-opt_parser = OptionParser.new do |opts|
-  opts.banner = 'Usage: splitio [options]'
-
-  opts.on('-cPATH', '--config=PATH', 'Set the path to splitio.yml config file') do |c|
-    config_path = c
-  end
-
-  opts.on('--base-uri=BASE_URI', 'Set the base uri for Split SDK') do |c|
-    options[:base_uri] = c
-  end
-
-  opts.on('--events-uri=EVENTS_URI', 'Set the events uri for Split SDK') do |c|
-    options[:events_uri] = c
-  end
-
-  opts.on('--api-key=API_KEY', 'Set the API Key for Split SDK') do |c|
-    options[:api_key] = c
-  end
-
-  opts.on('--read-timeout=READ_TIMEOUT', 'Read timeout in seconds') do |c|
-    options[:read_timeout] = c
-  end
-
-  opts.on('--connection-timeout=CONNECTION_TIMEOUT', 'Connection timeout in seconds') do |c|
-    options[:connection_timeout] = c
-  end
-
-  opts.on('--features-refresh-rate=FEATURES_REFRESH_RATE', 'Features refresh rate in seconds') do |c|
-    options[:features_refresh_rate] = c
-  end
-
-  opts.on('--segments-refresh-rate=SEGMENTS_REFRESH_RATE', 'Segments refresh rate in seconds') do |c|
-    options[:segments_refresh_rate] = c
-  end
-
-  opts.on('--metrics-refresh-rate=METRICS_REFRESH_RATE', 'Metrics refresh rate in seconds') do |c|
-    options[:metrics_refresh_rate] = c
-  end
-
-  opts.on('--impressions-refresh-rate=IMPRESSIONS_REFRESH_RATE', 'Impressions refresh rate in seconds') do |c|
-    options[:impressions_refresh_rate] = c
-  end
-
-  opts.on('--ready=SECONDS', 'Seconds to block the app until SDK is ready or false to run in non-blocking mode') do |c|
-    options[:ready] = c
-  end
-
-  opts.on('--redis-url=REDIS_URL', 'Set base uri for Split SDK') do |c|
-    options[:redis_url] = c
-  end
-
-  opts.on('--transport-debug', 'Enable transport debug') do
-    options[:transport_debug_enabled] = true
-  end
-
-  opts.on('-d', '--debug', 'Enable debug mode') do
-    options[:debug_enabled] = true
-  end
-
-  opts.on_tail('-h', '--help', 'Prints this help') do
-    puts opts
-    exit
-  end
-end
-
-begin
-  opt_parser.parse!(ARGV)
-rescue OptionParser::InvalidOption => e
-  puts e
-  puts opt_parser
-  exit(1)
-end
-
-config = config_path != '' ? YAML.load_file(config_path) : {}
-config
-  .merge!(mode: :producer, cache_adapter: :redis)
-  .merge!(options)
-  .merge!(api_key: ENV['API_KEY'] || config[:api_key])
-  .merge!(base_uri: ENV['SDK_URI'] || config[:base_uri])[:events_uri] = ENV['EVENTS_URI'] || config[:events_uri]
-# IDENTIFY_BASE_URI
-
-SplitIoClient::SplitFactory.new(config[:api_key], config)

data/splitio.yml.example

@@ -1,7 +0,0 @@
----
-:api_key: api_key 
-:mode: :producer
-:cache_adapter: :redis
-:debug_enabled: true
-:transport_debug_enabled: true
-:impressions_refresh_rate: 30