splitclient-rb 7.0.0 → 7.0.1.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c9d6e5441382c090f658577eec8434780f09194158cdd08d594dc5f2dc964a
-  data.tar.gz: d90969f20c1ccc77cc764b157b11c989a1344905ebe5e38f8326fc94183fd1fc
+  metadata.gz: f134a9d9e88674dafbdcf9f57b77c73942664cbf14e9df1a7f55066f1fc62742
+  data.tar.gz: ee65206af2cae21099c0a1f3ab5facff024384c5698df3556ad40191d26600a7
 SHA512:
-  metadata.gz: 4cd0e62cc7cf6ae15c0efd576af57836520f33c2ac7e3223c3670cf225f1d68d82470a3e995ab06c292382ad2c2eb9c1a0f3d7eb32f168bb02b8340d3e961940
-  data.tar.gz: 53819ca8d4a0a62ad5a6b21fbe7c2eb5a6faed6aecad51b8536749ff1bd25fc5302964804988456600e16c797f7be43242c6d4cd7b255c804676017d42e7e18a
+  metadata.gz: 698f220a7d5402b844997fddbfd64275f9141bcd5a196b18477df5490d741d150cf17c2cca205626c213e68fcb57efcbea1f037c2e0f3ef39c8a476796062470
+  data.tar.gz: 8bbdf861ad7e4a58cc7a8d5a5942a1882a218f6f36d6ce49019c84f02cf5f97aa0daa64c5ddd65135aa1efe5b4c8c85c97a54b3d0821434dd0cca21581a1fd5a

data/CHANGES.txt

@@ -1,3 +1,8 @@
+7.0.1 (Sep 13, 2019)
+ - Updated localhost mode so that parsing of test files results in JSON data for splits analogous to that returned by the Split backend.
+ - Resulting localhost data is now used indifferently from actual backend data by the SDK code.
+ - Removed specific spare code dealing with localhost operations.
+
 7.0.0 (Aug 23, 2019)
  - BREAKING CHANGE: block_until_ready is now a method in both split_client and split_manager that needs to be explicitly called. The block_until_ready parameter is now ignored if passed in the configuration, and defaults to 15s unless passed as a parameter of the block_until_ready method.
  - Added warning to track calls when traffic type does not belong to an existing split (only issued in the online client and when SDK is ready).

data/lib/splitclient-rb.rb

@@ -25,18 +25,18 @@ require 'splitclient-rb/cache/senders/impressions_formatter'
 require 'splitclient-rb/cache/senders/impressions_sender'
 require 'splitclient-rb/cache/senders/metrics_sender'
 require 'splitclient-rb/cache/senders/events_sender'
+require 'splitclient-rb/cache/senders/localhost_repo_cleaner'
+require 'splitclient-rb/cache/stores/store_utils'
+require 'splitclient-rb/cache/stores/localhost_split_builder'
 require 'splitclient-rb/cache/stores/sdk_blocker'
 require 'splitclient-rb/cache/stores/segment_store'
 require 'splitclient-rb/cache/stores/split_store'
+require 'splitclient-rb/cache/stores/localhost_split_store'
 
-require 'splitclient-rb/localhost_utils'
-require 'splitclient-rb/clients/localhost_split_client'
 require 'splitclient-rb/clients/split_client'
-require 'splitclient-rb/managers/localhost_split_manager'
 require 'splitclient-rb/managers/split_manager'
 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/validators'

data/lib/splitclient-rb/cache/adapters/memory_adapters/map_adapter.rb

@@ -121,6 +121,10 @@ module SplitIoClient
             end
           end
 
+          def empty?
+            @map.empty?
+          end
+
           # This method is used in Redis adapter
           # "stubbing" it here to keep the interface
           def pipelined(&block)

data/lib/splitclient-rb/cache/adapters/memory_adapters/queue_adapter.rb

@@ -42,6 +42,10 @@ module SplitIoClient
           def length
             @current_size.value
           end
+
+          def empty?
+            @queue.empty?
+          end
         end
       end
     end

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

@@ -46,6 +46,10 @@ module SplitIoClient
             @adapter.clear
           end
 
+          def empty?
+            @adapter.empty?
+          end
+
           private
 
           def random_sampler

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

@@ -6,11 +6,11 @@ module SplitIoClient
       # Repository which forwards impressions interface to the selected adapter
       class ImpressionsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add, :add_bulk, :batch, :clear, :empty?
+        def_delegators :@repository, :add, :add_bulk, :batch, :clear, :empty?
 
         def initialize(config)
           super(config)
-          @adapter = case @config.impressions_adapter.class.to_s
+          @repository = case @config.impressions_adapter.class.to_s
                      when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
                        Repositories::Impressions::MemoryRepository.new(@config)
                      when 'SplitIoClient::Cache::Adapters::RedisAdapter'

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

@@ -4,12 +4,12 @@ module SplitIoClient
       # Repository which forwards impressions interface to the selected adapter
       class MetricsRepository < Repository
         extend Forwardable
-        def_delegators :@adapter, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
+        def_delegators :@repository, :add_count, :add_latency, :add_gauge, :counts, :latencies, :gauges,
                        :clear_counts, :clear_latencies, :clear_gauges, :clear, :fix_latencies
 
         def initialize(config)
           super(config)
-          @adapter = case @config.metrics_adapter.class.to_s
+          @repository = case @config.metrics_adapter.class.to_s
           when 'SplitIoClient::Cache::Adapters::MemoryAdapter'
             Repositories::Metrics::MemoryRepository.new(@config)
           when 'SplitIoClient::Cache::Adapters::RedisAdapter'

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Cache
+    module Senders
+      class LocalhostRepoCleaner
+        def initialize(impressions_repository, metrics_repository, events_repository, config)
+          @impressions_repository = impressions_repository
+          @metrics_repository = metrics_repository
+          @events_repository = events_repository
+          @config = config
+        end
+
+        def call
+          if ENV['SPLITCLIENT_ENV'] == 'test'
+            clear_repositories
+          else
+            cleaner_thread
+
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                cleaner_thread if forked
+              end
+            end
+          end
+        end
+
+        private
+
+        def cleaner_thread
+          @config.threads[:repo_cleaner] = Thread.new do
+            @config.logger.info('Starting repositories cleanup service')
+            loop do
+              clear_repositories
+
+              sleep(SplitIoClient::Utilities.randomize_interval(@config.features_refresh_rate))
+            end
+          end
+        end
+
+        def clear_repositories
+          @impressions_repository.clear
+          @metrics_repository.clear
+          @events_repository.clear
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Cache
+    module Stores
+      class LocalhostSplitBuilder
+        class << self
+          def build_splits(splits)
+            splits.map do |feature, treatments|
+              build_split(feature, treatments)
+            end
+          end
+
+          private
+
+          def build_split(feature, treatments)
+            {
+              name: feature,
+              status: 'ACTIVE',
+              killed: false,
+              trafficAllocation: 100,
+              seed: 2_089_907_429,
+              defaultTreatment: 'control_treatment',
+              configurations: build_configurations(treatments),
+              conditions: build_conditions(treatments)
+            }
+          end
+
+          def build_configurations(treatments)
+            treatments.reduce({}) do |hash, treatment|
+              hash.merge(treatment[:treatment].to_sym => treatment[:config])
+            end
+          end
+
+          def build_conditions(treatments)
+            conditions = treatments.map do |treatment|
+              if treatment[:keys]
+                build_whitelist_treatment(treatment[:treatment], Array(treatment[:keys]))
+              else
+                build_rollout_treatment
+              end
+                .merge(partitions: build_partitions(treatment[:treatment], treatments))
+            end
+
+            conditions.sort_by { |condition| condition[:conditionType] }.reverse!
+          end
+
+          def build_whitelist_treatment(treatment_name, whitelist_keys)
+            {
+              conditionType: 'WHITELIST',
+              matcherGroup: {
+                combiner: 'AND',
+                matchers: [{
+                  keySelector: nil,
+                  matcherType: 'WHITELIST',
+                  negate: false,
+                  whitelistMatcherData: {
+                    whitelist: whitelist_keys
+                  }
+                }]
+              },
+              label: "whitelisted #{treatment_name}"
+            }
+          end
+
+          def build_rollout_treatment
+            {
+              conditionType: 'ROLLOUT',
+              matcherGroup: {
+                combiner: 'AND',
+                matchers: [
+                  {
+                    matcherType: 'ALL_KEYS',
+                    negate: false
+                  }
+                ]
+              },
+              label: 'default rule'
+            }
+          end
+
+          def build_partitions(current_treatment_name, treatments)
+            treatments.map do |treatment|
+              {
+                treatment: treatment[:treatment],
+                size: treatment[:treatment] == current_treatment_name ? 100 : 0
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module SplitIoClient
+  module Cache
+    module Stores
+      class LocalhostSplitStore
+        attr_reader :splits_repository
+
+        def initialize(splits_repository, config, sdk_blocker = nil)
+          @splits_repository = splits_repository
+          @config = config
+          @sdk_blocker = sdk_blocker
+        end
+
+        def call
+          if ENV['SPLITCLIENT_ENV'] == 'test'
+            store_splits
+          else
+            splits_thread
+
+            if defined?(PhusionPassenger)
+              PhusionPassenger.on_event(:starting_worker_process) do |forked|
+                splits_thread if forked
+              end
+            end
+          end
+        end
+
+        private
+
+        def splits_thread
+          @config.threads[:split_store] = Thread.new do
+            @config.logger.info('Starting splits fetcher service')
+            loop do
+              store_splits
+
+              sleep(StoreUtils.random_interval(@config.features_refresh_rate))
+            end
+          end
+        end
+
+        def store_splits
+          load_features.each do |split|
+            store_split(split)
+          end
+
+          if @sdk_blocker
+            @sdk_blocker.splits_ready!
+            @sdk_blocker.segments_ready!
+          end
+        rescue StandardError => error
+          @config.logger.error('Error while parsing the split file. ' \
+            'Check that the input file matches the expected format')
+          @config.log_found_exception(__method__.to_s, error)
+        end
+
+        def store_split(split)
+          @config.logger.debug("storing split (#{split[:name]})") if @config.debug_enabled
+
+          @splits_repository.add_split(split)
+        end
+
+        def load_features
+          yaml_extensions = ['.yml', '.yaml']
+          if yaml_extensions.include? File.extname(@config.split_file)
+            parse_yaml_features
+          else
+            @config.logger.warn('Localhost mode: .split mocks ' \
+              'will be deprecated soon in favor of YAML files, which provide more ' \
+              'targeting power. Take a look in our documentation.')
+
+            parse_plain_text_features
+          end
+        end
+
+        def parse_plain_text_features
+          splits = File.open(@config.split_file).each_with_object({}) do |line, memo|
+            feature, treatment = line.strip.split(' ')
+
+            next if line.start_with?('#') || line.strip.empty?
+
+            memo[feature] = [{ treatment: treatment }]
+          end
+
+          LocalhostSplitBuilder.build_splits(splits)
+        end
+
+        def parse_yaml_features
+          splits = YAML.safe_load(File.read(@config.split_file)).each_with_object({}) do |feature, memo|
+            feat_symbolized_keys = symbolize_feat_keys(feature)
+
+            feat_name = feature.keys.first
+
+            if memo[feat_name]
+              memo[feat_name] << feat_symbolized_keys
+            else
+              memo[feat_name] = [feat_symbolized_keys]
+            end
+          end
+
+          LocalhostSplitBuilder.build_splits(splits)
+        end
+
+        def symbolize_feat_keys(yaml_feature)
+          yaml_feature.values.first.each_with_object({}) do |(k, v), memo|
+            memo[k.to_sym] = k == 'config' ? v.to_json : v
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -38,7 +38,7 @@ module SplitIoClient
               store_segments
               @config.logger.debug("Segment names: #{@segments_repository.used_segment_names.to_a}") if @config.debug_enabled
 
-              sleep_for = random_interval(@config.segments_refresh_rate)
+              sleep_for = StoreUtils.random_interval(@config.segments_refresh_rate)
               @config.logger.debug("Segments store is sleeping for: #{sleep_for} seconds") if @config.debug_enabled
               sleep(sleep_for)
             end
@@ -53,12 +53,6 @@ module SplitIoClient
           @config.log_found_exception(__method__.to_s, error)
         end
 
-        def random_interval(interval)
-          random_factor = Random.new.rand(50..100) / 100.0
-
-          interval * random_factor
-        end
-
         def segments_api
           @segments_api ||= SplitIoClient::Api::Segments.new(@api_key, @metrics, @segments_repository, @config)
         end

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

@@ -34,7 +34,7 @@ module SplitIoClient
             loop do
               store_splits
 
-              sleep(random_interval(@config.features_refresh_rate))
+              sleep(StoreUtils.random_interval(@config.features_refresh_rate))
             end
           end
         end
@@ -57,12 +57,6 @@ module SplitIoClient
           @config.log_found_exception(__method__.to_s, error)
         end
 
-        def random_interval(interval)
-          random_factor = Random.new.rand(50..100) / 100.0
-
-          interval * random_factor
-        end
-
         def splits_since(since)
           splits_api.since(since)
         end

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

@@ -0,0 +1,13 @@
+module SplitIoClient
+  module Cache
+    module Stores
+      class StoreUtils
+        def self.random_interval(interval)
+          random_factor = Random.new.rand(50..100) / 100.0
+
+          interval * random_factor
+        end
+      end
+    end
+  end
+end

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

@@ -133,7 +133,7 @@ module SplitIoClient
         end
       end
 
-      if ready? && !@splits_repository.traffic_type_exists(traffic_type_name)
+      if ready? && !@config.localhost_mode && !@splits_repository.traffic_type_exists(traffic_type_name)
         @config.logger.warn("track: Traffic Type #{traffic_type_name} " \
           "does not have any corresponding Splits in this environment, make sure you're tracking " \
           'your events to a valid traffic type defined in the Split console')

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

@@ -44,7 +44,9 @@ module SplitIoClient
       @sdk_blocker = sdk_blocker
       @config = config
 
-      start_standalone_components if @config.standalone?
+      start_localhost_components if @config.localhost_mode
+
+      start_standalone_components if @config.standalone? && !@config.localhost_mode
     end
 
     def start_standalone_components
@@ -55,6 +57,21 @@ module SplitIoClient
       events_sender
     end
 
+    def start_localhost_components
+      localhost_split_store
+      localhost_repo_cleaner
+    end
+
+    # Starts thread which loops constantly and retrieves splits from a file source
+    def localhost_split_store
+      LocalhostSplitStore.new(@splits_repository, @config, @sdk_blocker).call
+    end
+
+    # Starts thread which loops constantly and cleans up repositories to avoid memory issues in localhost mode
+    def localhost_repo_cleaner
+      LocalhostRepoCleaner.new(@impressions_repository, @metrics_repository, @events_repository, @config).call
+    end
+
     # Starts thread which loops constantly and stores splits in the splits_repository of choice
     def split_store
       SplitStore.new(@splits_repository, @api_key, @metrics, @config, @sdk_blocker).call

data/lib/splitclient-rb/managers/split_manager.rb

@@ -3,13 +3,9 @@ module SplitIoClient
     #
     # Creates a new split manager instance that connects to split.io API.
     #
-    # @param api_key [String] the API key for your split account
-    #
     # @return [SplitIoManager] split.io client instance
-    def initialize(api_key, adapter = nil, splits_repository = nil, sdk_blocker, config)
-      @localhost_mode_features = []
+    def initialize(splits_repository = nil, sdk_blocker, config)
       @splits_repository = splits_repository
-      @adapter = adapter
       @sdk_blocker = sdk_blocker
       @config = config
     end
@@ -91,13 +87,18 @@ module SplitIoClient
       return {} unless split
 
       begin
-        treatments = split[:conditions]
-          .detect { |c| c[:conditionType] == 'ROLLOUT' }[:partitions]
-          .map { |partition| partition[:treatment] }
+        if @config.localhost_mode
+          treatments = split[:conditions]
+            .first[:partitions]
+            .map { |partition| partition[:treatment] }
+        else
+          treatments = split[:conditions]
+            .detect { |c| c[:conditionType] == 'ROLLOUT' }[:partitions]
+            .map { |partition| partition[:treatment] }
+        end
       rescue StandardError
         treatments = []
       end
-
         {
           name: name,
           traffic_type_name: split[:trafficTypeName],

data/lib/splitclient-rb/split_config.rb

@@ -38,7 +38,18 @@ module SplitIoClient
       )
       @connection_timeout = opts[:connection_timeout] || SplitConfig.default_connection_timeout
       @read_timeout = opts[:read_timeout] || SplitConfig.default_read_timeout
-      @features_refresh_rate = opts[:features_refresh_rate] || SplitConfig.default_features_refresh_rate
+
+      @logger = opts[:logger] || SplitConfig.default_logger
+
+      if(opts[:reload_rate])
+        @features_refresh_rate = opts[:reload_rate]
+        @logger.warn('Localhost mode: reload_rate will be deprecated soon in favor of ' \
+          'features_refresh_rate. Take a look in our documentation.'
+        )
+      else
+        @features_refresh_rate = opts[:features_refresh_rate] || SplitConfig.default_features_refresh_rate
+      end
+
       @segments_refresh_rate = opts[:segments_refresh_rate] || SplitConfig.default_segments_refresh_rate
       @metrics_refresh_rate = opts[:metrics_refresh_rate] || SplitConfig.default_metrics_refresh_rate
 
@@ -56,7 +67,6 @@ module SplitIoClient
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, nil, @redis_url
       )
 
-      @logger = opts[:logger] || SplitConfig.default_logger
       @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
       @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
       @block_until_ready = SplitConfig.default_block_until_ready
@@ -84,9 +94,14 @@ module SplitIoClient
       @events_adapter = SplitConfig.init_cache_adapter(
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @events_queue_size, @redis_url
       )
+
+      @split_file = opts[:split_file] || SplitConfig.default_split_file
+
       @valid_mode = true
       @split_logger = SplitIoClient::SplitLogger.new(self)
       @split_validator = SplitIoClient::Validators.new(self)
+      @localhost_mode = opts[:localhost_mode]
+
       startup_log
     end
 
@@ -235,6 +250,10 @@ module SplitIoClient
     # @return [Integer]
     attr_accessor :events_queue_size
 
+    attr_accessor :split_file
+
+    attr_accessor :localhost_mode
+
     #
     # The default split client configuration
     #
@@ -340,6 +359,14 @@ module SplitIoClient
       500
     end
 
+    def self.default_split_file
+      File.join(Dir.home, '.split')
+    end
+
+    def self.default_offline_refresh_rate
+      5
+    end
+
     #
     # The default logger object
     #

data/lib/splitclient-rb/split_factory.rb

@@ -2,6 +2,8 @@ module SplitIoClient
   class SplitFactory
     ROOT_PROCESS_ID = Process.pid
     SINGLETON_WARN = 'We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'
+    LOCALHOST_API_KEY = 'localhost'
+
     include SplitIoClient::Cache::Repositories
     include SplitIoClient::Cache::Stores
 
@@ -20,10 +22,10 @@ module SplitIoClient
       end
 
       @api_key = api_key
-      @config = SplitConfig.new (config_hash)
+      @config = SplitConfig.new(config_hash.merge(localhost_mode: @api_key == LOCALHOST_API_KEY ))
 
       raise 'Invalid SDK mode' unless valid_mode
-      
+
       @splits_repository = SplitsRepository.new(@config)
       @segments_repository = SegmentsRepository.new(@config)
       @impressions_repository = ImpressionsRepository.new(@config)
@@ -35,7 +37,7 @@ module SplitIoClient
       @adapter = start!
 
       @client = SplitClient.new(@api_key, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @events_repository, @sdk_blocker, @config)
-      @manager = SplitManager.new(@api_key, @adapter, @splits_repository, @sdk_blocker, @config)
+      @manager = SplitManager.new(@splits_repository, @sdk_blocker, @config)
 
       validate_api_key
 
@@ -72,7 +74,12 @@ module SplitIoClient
       case @config.mode
       when :consumer
         if @config.cache_adapter.is_a? SplitIoClient::Cache::Adapters::RedisAdapter
-          valid_startup_mode = true
+          if !@config.localhost_mode
+            valid_startup_mode = true
+          else
+            @config.logger.error('Localhost mode cannot be used with Redis. ' \
+              'Use standalone mode and Memory adapter instead.')
+          end
         else
           @config.logger.error('Consumer mode cannot be used with Memory adapter. ' \
             'Use Redis adapter instead.')

data/lib/splitclient-rb/split_factory_builder.rb

@@ -1,27 +1,7 @@
-require 'logger'
-
 module SplitIoClient
   class SplitFactoryBuilder
     def self.build(api_key, config = {})
-      case api_key
-      when 'localhost'
-        configuration = SplitConfig.new(config)
-        LocalhostSplitFactory.new(split_file(config[:split_file], configuration.logger), configuration, config[:reload_rate])
-      else
-        SplitFactory.new(api_key, config)
-      end
-    end
-
-    private
-
-    def self.split_file(split_file_path, logger)
-      return split_file_path unless split_file_path.nil?
-
-      logger.warn('Localhost mode: .split mocks ' \
-        'will be deprecated soon in favor of YAML files, which provide more ' \
-        'targeting power. Take a look in our documentation.')
-
-      File.join(Dir.home, '.split')
+      SplitFactory.new(api_key, config)
     end
   end
 end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '7.0.0'
+  VERSION = '7.0.1.pre.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.1.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -327,11 +327,14 @@ files:
 - lib/splitclient-rb/cache/senders/events_sender.rb
 - lib/splitclient-rb/cache/senders/impressions_formatter.rb
 - lib/splitclient-rb/cache/senders/impressions_sender.rb
+- lib/splitclient-rb/cache/senders/localhost_repo_cleaner.rb
 - lib/splitclient-rb/cache/senders/metrics_sender.rb
+- lib/splitclient-rb/cache/stores/localhost_split_builder.rb
+- lib/splitclient-rb/cache/stores/localhost_split_store.rb
 - lib/splitclient-rb/cache/stores/sdk_blocker.rb
 - lib/splitclient-rb/cache/stores/segment_store.rb
 - lib/splitclient-rb/cache/stores/split_store.rb
-- lib/splitclient-rb/clients/localhost_split_client.rb
+- lib/splitclient-rb/cache/stores/store_utils.rb
 - lib/splitclient-rb/clients/split_client.rb
 - lib/splitclient-rb/engine/api/client.rb
 - lib/splitclient-rb/engine/api/events.rb
@@ -374,9 +377,6 @@ files:
 - lib/splitclient-rb/engine/parser/partition.rb
 - lib/splitclient-rb/engine/parser/split_adapter.rb
 - lib/splitclient-rb/exceptions.rb
-- lib/splitclient-rb/localhost_split_factory.rb
-- lib/splitclient-rb/localhost_utils.rb
-- lib/splitclient-rb/managers/localhost_split_manager.rb
 - lib/splitclient-rb/managers/split_manager.rb
 - lib/splitclient-rb/redis_metrics_fixer.rb
 - lib/splitclient-rb/split_config.rb
@@ -405,9 +405,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 

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

@@ -1,184 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitClient
-    include SplitIoClient::LocalhostUtils
-
-    #
-    # variables to if the sdk is being used in localhost mode and store the list of features
-    attr_reader :localhost_mode
-    attr_reader :localhost_mode_features
-
-    #
-    # Creates a new split client instance that reads from the given splits file
-    #
-    # @param splits_file [File] file that contains some splits
-    #
-    # @return [LocalhostSplitIoClient] split.io localhost client instance
-    def initialize(splits_file, config, reload_rate = nil)
-      @localhost_mode = true
-      @localhost_mode_features = []
-      load_localhost_mode_features(splits_file, reload_rate)
-      @config = config
-    end
-
-    #
-    # method that returns the sdk gem version
-    #
-    # @return [string] version value for this sdk
-    def self.sdk_version
-      'ruby-'+SplitIoClient::VERSION
-    end
-
-    #
-    # obtains the treatments and configs for a given set of features
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_names [array] name of the features being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash] map of treatments (split_name, treatment)
-    def get_treatments_with_config(key, split_names, attributes = nil)
-      get_localhost_treatments(key, split_names, attributes, 'get_treatments_with_config')
-    end
-
-    #
-    # obtains the treatments for a given set of features
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_names [array] name of the features being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash] map of treatments (split_name, treatment_name)
-    def get_treatments(key, split_names, attributes = nil)
-      treatments = get_localhost_treatments(key, split_names, attributes)
-      return treatments if treatments.nil?
-      keys = treatments.keys
-      treats = treatments.map { |_,t| t[:treatment]  }
-      Hash[keys.zip(treats)]
-    end
-
-    #
-    # obtains the treatment for a given feature
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [string] corresponding treatment
-    def get_treatment(key, split_name, attributes = nil)
-      get_localhost_treatment(key, split_name, attributes)[:treatment]
-    end
-
-    #
-    # obtains the treatment and config for a given feature
-    #
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    # @param attributes [hash] kept for consistency with actual SDK client. Omitted in calls
-    #
-    # @return [hash]  corresponding treatment and config
-    def get_treatment_with_config(key, split_name, attributes = nil)
-      get_localhost_treatment(key, split_name, attributes, 'get_treatment_with_config')
-    end
-
-    def track
-    end
-
-    private
-
-    #
-    # method to check if the sdk is running in localhost mode based on api key
-    #
-    # @return [boolean] True if is in localhost mode, false otherwise
-    def is_localhost_mode?
-      true
-    end
-
-    # @param key [string] evaluation key, only used with yaml split files
-    # @param split_name [string] name of the feature that is being validated
-    #
-    # @return [Hash] corresponding treatment and config, control otherwise
-    def get_localhost_treatment(key, split_name, attributes, calling_method = 'get_treatment')
-      control_treatment = { label: Engine::Models::Label::EXCEPTION, treatment: SplitIoClient::Engine::Models::Treatment::CONTROL, config: nil }
-      parsed_control_treatment = parsed_treatment(control_treatment)
-
-      bucketing_key, matching_key = keys_from_key(key)
-      return parsed_control_treatment unless @config.split_validator.valid_get_treatment_parameters(calling_method, key, split_name, matching_key, bucketing_key, attributes)
-
-      sanitized_split_name = split_name.to_s.strip
-
-      if split_name.to_s != sanitized_split_name
-        @config.logger.warn("get_treatment: split_name #{split_name} has extra whitespace, trimming")
-        split_name = sanitized_split_name
-      end
-
-      treatment = @localhost_mode_features.select { |h| h[:feature] == split_name && has_key(h[:keys], key) }.last
-
-      if treatment.nil?
-        treatment = @localhost_mode_features.select { |h| h[:feature] == split_name && h[:keys] == nil }.last
-      end
-
-      if treatment && treatment[:treatment]
-        {
-          treatment: treatment[:treatment],
-          config: treatment[:config]
-        }
-      else
-        parsed_control_treatment
-      end
-    end
-
-    def get_localhost_treatments(key, split_names, attributes = nil, calling_method = 'get_treatments')
-      return nil unless @config.split_validator.valid_get_treatments_parameters(calling_method, split_names)
-
-      sanitized_split_names = sanitize_split_names(calling_method, split_names)
-
-      if sanitized_split_names.empty?
-        @config.logger.error("#{calling_method}: split_names must be a non-empty Array")
-        return {}
-      end
-
-      split_names.each_with_object({}) do |split_name, memo|
-        memo.merge!(split_name => get_treatment_with_config(key, split_name, attributes))
-      end
-    end
-
-    def sanitize_split_names(calling_method, split_names)
-      split_names.compact.uniq.select do |split_name|
-        if (split_name.is_a?(String) || split_name.is_a?(Symbol)) && !split_name.empty?
-          true
-        elsif split_name.is_a?(String) && split_name.empty?
-          @config.logger.warn("#{calling_method}: you passed an empty split_name, split_name must be a non-empty String or a Symbol")
-          false
-        else
-          @config.logger.warn("#{calling_method}: you passed an invalid split_name, split_name must be a non-empty String or a Symbol")
-          false
-        end
-      end
-    end
-
-    def parsed_treatment(treatment_data)
-      {
-        treatment: treatment_data[:treatment],
-        config: treatment_data[:config]
-      }
-    end
-
-    def has_key(keys, key)
-      case keys
-        when Array then keys.include? key
-        when String then keys == key
-      else
-        false
-      end
-    end
-
-    def keys_from_key(key)
-      case key
-      when Hash
-        key.values_at(:bucketing_key, :matching_key).map { |k| k.nil? ? nil : k }
-      else
-        [nil, key].map { |k| k.nil? ? nil : k }
-      end
-    end
-  end
-end

data/lib/splitclient-rb/localhost_split_factory.rb

@@ -1,14 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitFactory
-    attr_reader :client, :manager
-
-    def initialize(splits_file, config, reload_rate = nil, logger = nil)
-      @splits_file = splits_file
-      @reload_rate = reload_rate
-      @config = config
-
-      @client = LocalhostSplitClient.new(@splits_file, @config, @reload_rate)
-      @manager = LocalhostSplitManager.new(@splits_file, @reload_rate)
-    end
-  end
-end

data/lib/splitclient-rb/localhost_utils.rb

@@ -1,59 +0,0 @@
-module SplitIoClient
-  module LocalhostUtils
-
-    require 'yaml'
-    #
-    # method to set localhost mode features by reading the given .splits
-    #
-    # @param splits_file [File] the .split file that contains the splits
-    # @param reload_rate [Integer] the number of seconds to reload splits_file
-    # @return nil
-    def load_localhost_mode_features(splits_file, reload_rate = nil)
-      return @localhost_mode_features unless File.exists?(splits_file)
-
-      store_features(splits_file)
-
-      return unless reload_rate
-
-      Thread.new do
-        loop do
-          @localhost_mode_features = []
-          store_features(splits_file)
-
-          sleep(SplitIoClient::Utilities.randomize_interval(reload_rate))
-        end
-      end
-    end
-
-    def store_features(splits_file)
-      yaml_extensions = [".yml", ".yaml"]
-      if yaml_extensions.include? File.extname(splits_file)
-        store_yaml_features(splits_file)
-      else
-        store_plain_text_features(splits_file)
-      end
-    end
-
-    private
-
-    def store_plain_text_features(splits_file)
-      File.open(splits_file).each do |line|
-        feature, treatment = line.strip.split(' ')
-
-        next if line.start_with?('#') || line.strip.empty?
-
-        @localhost_mode_features << { feature: feature, treatment: treatment, key: nil, config: nil }
-      end
-    end
-
-    def store_yaml_features(splits_file)
-      YAML.load(File.read(splits_file)).each do |feature|
-        feat_symbolized_keys = feature[feature.keys.first].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-        feat_symbolized_keys[:config] = feat_symbolized_keys[:config].to_json
-
-        @localhost_mode_features << { feature: feature.keys.first }.merge(feat_symbolized_keys)
-      end
-    end
-  end
-end

data/lib/splitclient-rb/managers/localhost_split_manager.rb

@@ -1,60 +0,0 @@
-module SplitIoClient
-  class LocalhostSplitManager
-    include SplitIoClient::LocalhostUtils
-
-    #
-    # Creates a new split manager instance that holds the splits from a given file
-    #
-    # @param splits_file [File] the .split file that contains the splits
-    # @param reload_rate [Integer] the number of seconds to reload splits_file
-    #
-    # @return [LocalhostSplitIoManager] split.io localhost manager instance
-    def initialize(splits_file, reload_rate = nil)
-      @localhost_mode = true
-      @localhost_mode_features = []
-
-      load_localhost_mode_features(splits_file, reload_rate)
-    end
-
-    #
-    # method to get a split view
-    #
-    # @returns a split view
-    def split(split_name)
-      features = @localhost_mode_features.find_all { |feat| feat[:feature] == split_name }
-
-      return nil if features.nil?
-
-      treatments = features.map { |feat| feat[:treatment] }
-
-      configs = Hash[ features.map { |feat| [ feat[:treatment].to_sym, feat[:config] ] } ]
-
-      {
-        change_number: nil,
-        killed:       false,
-        name:         split_name,
-        traffic_type:  nil,
-        treatments:   treatments,
-        configs: configs
-      }
-    end
-
-    #
-    # method to get the split list from the client
-    #
-    # @returns Array of split view
-    def splits
-      split_names.map do |split_name|
-        split(split_name)
-      end
-    end
-
-    #
-    # method to get the list of just split names. Ideal for ietrating and calling client.get_treatment
-    #
-    # @returns [object] array of split names (String)
-    def split_names
-      @localhost_mode_features.map{ |feat| feat[:feature]}.uniq
-    end
-  end
-end