splitclient-rb 5.1.3.pre.rc2-java → 5.1.3.pre.rc3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cb0311b168fb12d22bf8b707f307095383b9017
-  data.tar.gz: 90da2fd289742ed147bc2f1ba4604f94bf7b877f
+  metadata.gz: e9e8ced8272ff8af84bff37888fa388901c59304
+  data.tar.gz: 6ce3fd691a9672b809fa561dd3e38d63fad509e8
 SHA512:
-  metadata.gz: ab58655555d5889e00b4eea5c1e7a851f412e3c6b23845eed34f2c44725762fbb518c3acbc9edf738ec37901049db3c23a61de28aaf132ab34bd6f39af83e5c8
-  data.tar.gz: 6067f1366ccbe092b5b4595d57b001c630c9f7d0e7101888f17bbc3670699bb002ba1a82ee479c03483aa35f5dc1caafe43e2ab6bc6447287aa92d6da91ea28a
+  metadata.gz: 27e35704774d40d32e0d0c2a334c131711a571cac58c7718e0ea536680ef2b21f901dbadf4faf1dd21b4d67b6fab7904e15172652cffc28eebf446f36c45bdf1
+  data.tar.gz: d8249bcb7e494061d864eff9fe5aaf8e3db6dbd5eb589c9ce540f2856be89fa881c550cacd45da8e3a7bd71b7c8b441df30eec49687f2cc12e05494352b95760

data/.rubocop.yml

@@ -11,7 +11,6 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
     - splitclient-rb.gemspec
-    - exe/splitio
 
 Naming/FileName:
   Exclude:

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/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

@@ -13,7 +13,7 @@ module SplitIoClient
         end
 
         @events.each_slice(SplitIoClient.configuration.events_queue_size) do |event_slice|
-          result = post_api(
+          response = post_api(
             "#{SplitIoClient.configuration.events_uri}/events/bulk",
             @api_key,
             event_slice.map { |event| formatted_event(event[:e]) },
@@ -22,10 +22,12 @@ module SplitIoClient
             'SplitSDKVersion' => event_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: #{event_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

@@ -13,12 +13,14 @@ module SplitIoClient
         end
 
         impressions_by_ip.each do |ip, impressions|
-          result = post_api("#{SplitIoClient.configuration.events_uri}/testImpressions/bulk", @api_key, impressions, 'SplitSDKMachineIP' => ip)
+          response = post_api("#{SplitIoClient.configuration.events_uri}/testImpressions/bulk", @api_key, impressions, '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

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.3.pre.rc2'
+  VERSION = '5.1.3.pre.rc3'
 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.1.3.pre.rc2
+  version: 5.1.3.pre.rc3
 platform: java
 authors:
 - Split Software
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   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: []
 extra_rdoc_files: []
 files:
@@ -279,7 +278,6 @@ files:
 - NEWS
 - README.md
 - Rakefile
-- exe/splitio
 - ext/murmurhash/MurmurHash3.java
 - lib/murmurhash/base.rb
 - lib/murmurhash/murmurhash.jar
@@ -363,7 +361,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

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