splitclient-rb 5.0.3 → 5.1.0.pre.rc1

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in splitclient-rb.gemspec

data/Rakefile

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 Dir['tasks/**/*.rake'].each { |rake| load rake }
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task :spec => :compile
+task spec: :compile
 case RUBY_PLATFORM
 when 'java'
   require 'rake/javaextensiontask'
@@ -21,4 +25,4 @@ else
   end
 end
 
-task :default => :spec
+task default: %i[spec rubocop]

data/exe/splitio

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'optparse'
@@ -12,65 +13,65 @@ require_relative '../lib/splitclient-rb'
 config_path = ''
 options = {}
 opt_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: splitio [options]"
+  opts.banner = 'Usage: splitio [options]'
 
-  opts.on("-cPATH", "--config=PATH", "Set the path to splitio.yml config file") do |c|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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|
+  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
+  opts.on('--transport-debug', 'Enable transport debug') do
     options[:transport_debug_enabled] = true
   end
 
-  opts.on("-d", "--debug", "Enable debug mode") do
+  opts.on('-d', '--debug', 'Enable debug mode') do
     options[:debug_enabled] = true
   end
 
-  opts.on_tail("-h", "--help", "Prints this help") do
+  opts.on_tail('-h', '--help', 'Prints this help') do
     puts opts
     exit
   end
@@ -89,8 +90,7 @@ 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])
-  .merge!(events_uri: ENV['EVENTS_URI'] || config[:events_uri])
-  # IDENTIFY_BASE_URI
+  .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/ext/murmurhash/extconf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mkmf'
 
-create_makefile('murmurhash/murmurhash')
+create_makefile('murmurhash/murmurhash')

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

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

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

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Api
+    # Retrieves segment changes from the Split Backend
     class Segments < Client
+      METRICS_PREFIX = 'segmentChangeFetcher'
+
       def initialize(api_key, config, metrics, segments_repository)
         @config = config
         @metrics = metrics
@@ -10,52 +15,53 @@ module SplitIoClient
 
       def store_segments_by_names(names)
         start = Time.now
-        prefix = 'segmentChangeFetcher'
 
         return if names.nil? || names.empty?
 
         names.each do |name|
           since = @segments_repository.get_change_number(name)
-          while true
-            fetch_segments(name, prefix, since).each { |segment| @segments_repository.add_to_segment(segment) }
-            @config.logger.debug("Segment #{name} fetched before: #{since}, till: #{@segments_repository.get_change_number(name)}") if @config.debug_enabled
+          loop do
+            segment = fetch_segment_changes(name, since)
+            @segments_repository.add_to_segment(segment)
 
-            break if (since.to_i >= @segments_repository.get_change_number(name).to_i)
+            SplitLogger.log_if_debug("Segment #{name} fetched before: #{since}, \
+              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
 
         latency = (Time.now - start) * 1000.0
-        @metrics.time(prefix + '.time', latency)
+        @metrics.time(METRICS_PREFIX + '.time', latency)
       end
 
       private
 
-      def fetch_segments(name, prefix, since)
-        segments = []
-        segment = get_api("#{@config.base_uri}/segmentChanges/#{name}", @config, @api_key, since: since)
-
-        if segment == false
-          @config.logger.error("Failed to make a http request")
-        elsif segment.status / 100 == 2
-          segment_content = JSON.parse(segment.body, symbolize_names: true)
-          @segments_repository.set_change_number(name, segment_content[:till])
-          @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
-
-          if @config.debug_enabled
-            @config.logger.debug("\'#{segment_content[:name]}\' segment retrieved.")
-            @config.logger.debug("\'#{segment_content[:name]}\' #{segment_content[:added].size} added keys") if segment_content[:added].size > 0
-            @config.logger.debug("\'#{segment_content[:name]}\' #{segment_content[:removed].size} removed keys") if segment_content[:removed].size > 0
+      def fetch_segment_changes(name, since)
+        response = get_api("#{@config.base_uri}/segmentChanges/#{name}", @config, @api_key, since: since)
+
+        if response.success?
+          segment = JSON.parse(response.body, symbolize_names: true)
+          @segments_repository.set_change_number(name, segment[:till])
+          @metrics.count(METRICS_PREFIX + '.status.' + response.status.to_s, 1)
+
+          SplitLogger.log_if_debug("\'#{segment[:name]}\' segment retrieved.")
+          unless segment[:added].empty?
+            SplitLogger.log_if_debug("\'#{segment[:name]}\' #{segment[:added].size} added keys")
+          end
+          unless segment[:removed].empty?
+            SplitLogger.log_if_debug("\'#{segment[:name]}\' #{segment[:removed].size} removed keys")
           end
-          @config.logger.debug("#{segment_content}") if @config.transport_debug_enabled
+          SplitLogger.log_if_transport(segment.to_s)
 
-          segments << segment_content
+          segment
         else
-          @config.logger.error("Unexpected result from API Call for Segment #{name} status #{segment.status.to_s} since #{since.to_s}")
-          @metrics.count(prefix + '.status.' + segment.status.to_s, 1)
+          SplitLogger.log_error("Unexpected status code while fetching segments: #{response.status}." \
+          "Since #{since} - Check your API key and base URI")
+          @metrics.count(METRICS_PREFIX + '.status.' + response.status.to_s, 1)
+          raise 'Split SDK failed to connect to backend to fetch segments'
         end
-
-        segments
       end
     end
   end

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

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module SplitIoClient
   module Api
+    # Retrieves split definitions from the Split Backend
     class Splits < Client
+      METRICS_PREFIX = 'splitChangeFetcher'
+
       def initialize(api_key, config, metrics)
         @api_key = api_key
         @config = config
@@ -9,28 +14,28 @@ module SplitIoClient
 
       def since(since)
         start = Time.now
-        prefix = 'splitChangeFetcher'
-        splits = get_api("#{@config.base_uri}/splitChanges", @config, @api_key, since: since)
 
-        if splits == false
-          @config.logger.error("Failed to make a http request")
-        elsif splits.status / 100 == 2
-          result = splits_with_segment_names(splits.body)
+        response = get_api("#{@config.base_uri}/splitChanges", @config, @api_key, since: since)
 
-          @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
-
-          @config.logger.debug("#{result[:splits].length} splits retrieved. since=#{since}") if @config.debug_enabled and result[:splits].length > 0
-          @config.logger.debug("#{result}") if @config.transport_debug_enabled
-        else
-          @metrics.count(prefix + '.status.' + splits.status.to_s, 1)
+        if response.success?
+          result = splits_with_segment_names(response.body)
 
-          @config.logger.error('Unexpected result from Splits API call')
-        end
+          @metrics.count(METRICS_PREFIX + '.status.' + response.status.to_s, 1)
+          unless result[:splits].empty?
+            SplitLogger.log_if_debug("#{result[:splits].length} splits retrieved. since=#{since}")
+          end
+          SplitLogger.log_if_transport(result.to_s)
 
-        latency = (Time.now - start) * 1000.0
-        @metrics.time(prefix + '.time', latency)
+          latency = (Time.now - start) * 1000.0
+          @metrics.time(METRICS_PREFIX + '.time', latency)
 
-        result
+          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'
+        end
       end
 
       private

data/lib/splitclient-rb/split_config.rb

@@ -76,7 +76,7 @@ module SplitIoClient
       @events_adapter = SplitConfig.init_cache_adapter(
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @redis_url, @events_queue_size
       )
-
+      SplitIoClient::SplitLogger.split_config(self)
       startup_log
     end
 

data/lib/splitclient-rb/split_logger.rb

@@ -0,0 +1,29 @@
+require 'singleton'
+
+module SplitIoClient
+  class SplitLogger
+      attr_accessor :config
+      include Singleton
+
+      def self.split_config(config)
+        instance.config = config
+      end
+
+      def log_if_debug(message)
+        config.logger.debug(message) if config.debug_enabled
+      end
+
+      def log_if_transport(message)
+        config.logger.debug(message) if config.transport_debug_enabled
+      end
+
+      def log_error(message)
+        config.logger.error(message)
+      end
+
+      class << self
+        extend Forwardable
+        def_delegators :instance, *SplitLogger.instance_methods(false)
+      end
+  end
+end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.0.3'
+  VERSION = '5.1.0.pre.rc1'
 end

data/lib/splitclient-rb.rb

@@ -38,6 +38,7 @@ require 'splitclient-rb/split_factory'
 require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
+require 'splitclient-rb/split_logger'
 
 require 'splitclient-rb/engine/api/faraday_middleware/gzip'
 require 'splitclient-rb/engine/api/client'

data/splitclient-rb.gemspec

@@ -1,53 +1,57 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'splitclient-rb/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "splitclient-rb"
+  spec.name          = 'splitclient-rb'
   spec.version       = SplitIoClient::VERSION
-  spec.authors       = ["Split Software"]
-  spec.email         = ["pato@split.io"]
+  spec.authors       = ['Split Software']
+  spec.email         = ['pato@split.io']
 
-  spec.summary       = %q{Ruby client for split SDK.}
-  spec.description   = %q{Ruby client for using split SDK.}
-  spec.homepage      = "https://github.com/splitio/ruby-client"
-  spec.license       = "Apache 2.0"
+  spec.summary       = 'Ruby client for split SDK.'
+  spec.description   = 'Ruby client for using split SDK.'
+  spec.homepage      = 'https://github.com/splitio/ruby-client'
+  spec.license       = 'Apache 2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features|ext)/}) }
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   if defined?(JRUBY_VERSION)
     spec.platform = 'java'
-    spec.files.concat(%w(
-      ext/murmurhash/MurmurHash3.java
-      lib/murmurhash/murmurhash.jar)
+    spec.files.concat(
+      %w[ext/murmurhash/MurmurHash3.java
+         lib/murmurhash/murmurhash.jar]
     )
   else
-    spec.files.concat(%w(
-      ext/murmurhash/3_x86_32.c
-      ext/murmurhash/extconf.rb
-      ext/murmurhash/murmurhash.c
-      ext/murmurhash/murmurhash.h)
+    spec.files.concat(
+      %w[ext/murmurhash/3_x86_32.c
+         ext/murmurhash/extconf.rb
+         ext/murmurhash/murmurhash.c
+         ext/murmurhash/murmurhash.h]
     )
-    spec.extensions = ["ext/murmurhash/extconf.rb"]
+    spec.extensions = ['ext/murmurhash/extconf.rb']
   end
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rake-compiler"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "allocation_stats"
-
-  spec.add_runtime_dependency "json", ">= 1.8"
-  spec.add_runtime_dependency "thread_safe", ">= 0.3"
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
-  spec.add_runtime_dependency "faraday", ">= 0.8"
-  spec.add_runtime_dependency "net-http-persistent", "~> 2.9"
-  spec.add_runtime_dependency "redis", ">= 3.2"
+  spec.add_development_dependency 'allocation_stats'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_runtime_dependency 'faraday', '>= 0.8'
+  spec.add_runtime_dependency 'json', '>= 1.8'
+  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

data/tasks/benchmark_get_treatment.rake

@@ -1,13 +1,17 @@
-desc "Benchmark the get_treatment method call in 4 threads"
+# frozen_string_literal: true
+
+desc 'Benchmark the get_treatment method call in 4 threads'
 
 # Usage:
-# rake concurrent_benchmark api_key=YOUR_API_KEY base_uri=YOUR_API_BASE_URI [iterations=NUMBER_OF_ITERATIONS] [user_id=A_USER_ID] [feature_id=A_FEATURE_ID]
+# rake concurrent_benchmark api_key=YOUR_API_KEY base_uri=YOUR_API_BASE_URI
+# [iterations=NUMBER_OF_ITERATIONS] [user_id=A_USER_ID] [feature_id=A_FEATURE_ID]
 task :concurrent_benchmark do
   require 'benchmark'
   require 'splitclient-rb'
 
-  usage_message = "Usage: rake concurrent_benchmark api_key=YOUR_API_KEY base_uri=YOUR_API_BASE_URI [iterations=NUMBER_OF_ITERATIONS] [user_id=A_USER_ID] [feature_id=A_FEATURE_ID]"
-  valid_params = validate_params
+  usage_message = 'Usage: rake concurrent_benchmark api_key=YOUR_API_KEY base_uri=YOUR_API_BASE_URI \
+  [iterations=NUMBER_OF_ITERATIONS] [user_id=A_USER_ID] [feature_id=A_FEATURE_ID]'
+
   if validate_params
     execute
   else
@@ -19,25 +23,35 @@ def validate_params
   !ENV['api_key'].nil? && !ENV['base_uri'].nil?
 end
 
-def execute
-  api_key = ENV['api_key'].nil? ? "fake_api_key" : ENV['api_key']
-  base_uri = ENV['base_uri'].nil? ? "fake/api/" : ENV['base_uri']
-  iterations = ENV['iterations'].nil? ? 1000000 : ENV['iterations'].to_i
-  user_id = ENV['user_id'].nil? ? "fake_id_1" : ENV['user_id']
-  feature_id = ENV['feature_id'].nil? ? "sample_feature" : ENV['feature_id']
+def split_client
+  api_key = ENV['api_key'].nil? ? 'fake_api_key' : ENV['api_key']
+  base_uri = ENV['base_uri'].nil? ? 'fake/api/' : ENV['base_uri']
+  SplitIoClient::SplitFactory.new(api_key, base_uri: base_uri, logger: Logger.new('/dev/null').client)
+end
 
-  threads = []
-  times_per_thread = iterations / 4
-  split_client = SplitIoClient::SplitFactory.new(api_key, {base_uri: base_uri, logger: Logger.new("/dev/null").client })
+def times_per_thread
+  iterations = ENV['iterations'].nil? ? 1_000_000 : ENV['iterations'].to_i
+  iterations / 4
+end
 
-  puts Benchmark.measure{
-    4.times do |i|
+def feature_id
+  ENV['feature_id'].nil? ? 'sample_feature' : ENV['feature_id']
+end
+
+def user_id
+  ENV['user_id'].nil? ? 'fake_id_1' : ENV['user_id']
+end
+
+def execute
+  threads = []
+  puts Benchmark.measure do
+    4.times do |_i|
       threads << Thread.new do
         times_per_thread.times do
-          split_client.get_treatment user_id, feature_id, {attr: 123}
+          split_client.get_treatment user_id, feature_id, attr: 123
         end
       end
     end
     threads.map(&:join)
-  }
+  end
 end

data/tasks/irb.rake

@@ -1,4 +1,6 @@
-desc "Open an irb session preloaded with this library"
+# frozen_string_literal: true
+
+desc 'Open an irb session preloaded with this library'
 task :irb do
-  sh "irb -rubygems -I lib -r splitclient-rb.rb"
-end
+  sh 'irb -rubygems -I lib -r splitclient-rb.rb'
+end

data/tasks/rspec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)