splitclient-rb 2.0.1 → 3.0.2

data/lib/engine/parser/split_treatment.rb

@@ -0,0 +1,65 @@
+module SplitIoClient
+  module Engine
+    module Parser
+      class SplitTreatment
+        def initialize(splits_repository, segments_repository)
+          @splits_repository = splits_repository
+          @segments_repository = segments_repository
+        end
+
+        def call(keys, split_name, default_treatment, attributes = nil)
+          split = @splits_repository.get_split(split_name)
+
+          return Treatments::CONTROL if archived?(split)
+
+          matchable?(split) ? match(split, keys, attributes, default_treatment) : default_treatment
+        end
+
+        private
+
+        def match(split, keys, attributes, default_treatment)
+          split[:conditions].each do |c|
+            condition = SplitIoClient::Condition.new(c)
+
+            next if condition.empty?
+
+            if matcher_type(condition).match?(keys[:matching_key], attributes)
+              treatment = Splitter.get_treatment(keys[:bucketing_key], split[:seed], condition.partitions)
+
+              return treatment.nil? ? default_treatment : treatment
+            end
+          end
+
+          default_treatment
+        end
+
+        def matcher_type(condition)
+          matchers = []
+
+          condition.matchers.each do |matcher|
+            matchers << condition.send(
+              "matcher_#{matcher[:matcherType].downcase}",
+              matcher: matcher, segments_repository: @segments_repository
+            )
+          end
+
+          final_matcher = condition.create_condition_matcher(matchers)
+
+          if final_matcher.nil?
+            @logger.error('Invalid matcher type')
+          else
+            final_matcher
+          end
+        end
+
+        def matchable?(split)
+          !split.nil? && split[:status] == 'ACTIVE' && split[:killed] == false
+        end
+
+        def archived?(split)
+          !split.nil? && split[:status] == 'ARCHIVED'
+        end
+      end
+    end
+  end
+end

data/lib/exceptions/sdk_blocker_timeout_expired_exception.rb

@@ -0,0 +1,4 @@
+module SplitIoClient
+  class SDKBlockerTimeoutExpiredException < StandardError
+  end
+end

data/lib/splitclient-rb.rb

@@ -4,27 +4,35 @@ require 'splitclient-rb/split_factory_builder'
 require 'splitclient-rb/localhost_split_factory_builder'
 require 'splitclient-rb/localhost_split_factory'
 require 'splitclient-rb/split_config'
-require 'splitclient-cache/local_store'
-require 'splitclient-engine/parser/split'
-require 'splitclient-engine/parser/condition'
-require 'splitclient-engine/parser/partition'
-require 'splitclient-engine/parser/segment'
-require 'splitclient-engine/parser/split_adapter'
-require 'splitclient-engine/parser/split_parser'
-require 'splitclient-engine/parser/segment_parser'
-require 'splitclient-engine/partitions/treatments'
-require 'splitclient-engine/matchers/combiners'
-require 'splitclient-engine/matchers/combining_matcher'
-require 'splitclient-engine/matchers/all_keys_matcher'
-require 'splitclient-engine/matchers/negation_matcher'
-require 'splitclient-engine/matchers/user_defined_segment_matcher'
-require 'splitclient-engine/matchers/whitelist_matcher'
-require 'splitclient-engine/matchers/equal_to_matcher'
-require 'splitclient-engine/matchers/greater_than_or_equal_to_matcher'
-require 'splitclient-engine/matchers/less_than_or_equal_to_matcher'
-require 'splitclient-engine/matchers/between_matcher'
-require 'splitclient-engine/evaluator/splitter'
-require 'splitclient-engine/impressions/impressions'
-require 'splitclient-engine/metrics/metrics'
-require 'splitclient-engine/metrics/binary_search_latency_tracker'
+require 'exceptions/sdk_blocker_timeout_expired_exception'
+require 'cache/adapters/adapter'
+require 'cache/adapters/memory_adapter'
+require 'cache/repositories/repository'
+require 'cache/repositories/segments_repository'
+require 'cache/repositories/splits_repository'
+require 'cache/stores/sdk_blocker'
+require 'cache/stores/segment_store'
+require 'cache/stores/split_store'
+require 'engine/api/client'
+require 'engine/api/segments'
+require 'engine/api/splits'
+require 'engine/parser/condition'
+require 'engine/parser/partition'
+require 'engine/parser/split_adapter'
+require 'engine/parser/split_treatment'
+require 'engine/partitions/treatments'
+require 'engine/matchers/combiners'
+require 'engine/matchers/combining_matcher'
+require 'engine/matchers/all_keys_matcher'
+require 'engine/matchers/negation_matcher'
+require 'engine/matchers/user_defined_segment_matcher'
+require 'engine/matchers/whitelist_matcher'
+require 'engine/matchers/equal_to_matcher'
+require 'engine/matchers/greater_than_or_equal_to_matcher'
+require 'engine/matchers/less_than_or_equal_to_matcher'
+require 'engine/matchers/between_matcher'
+require 'engine/evaluator/splitter'
+require 'engine/impressions/impressions'
+require 'engine/metrics/metrics'
+require 'engine/metrics/binary_search_latency_tracker'
 require 'splitclient-rb_utilitites'

data/lib/splitclient-rb/split_config.rb

@@ -27,7 +27,7 @@ module SplitIoClient
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || SplitConfig.default_base_uri).chomp('/')
       @events_uri = (opts[:events_uri] || SplitConfig.default_events_uri).chomp('/')
-      @local_store = opts[:local_store] || SplitConfig.default_local_store
+      @cache_adapter = opts[:cache_adapter] || SplitConfig.default_cache_adapter
       @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
@@ -36,8 +36,12 @@ module SplitIoClient
       @impressions_refresh_rate = opts[:impressions_refresh_rate] || SplitConfig.default_impressions_refresh_rate
       @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 = opts[:block_until_ready] || false
       @machine_name = SplitConfig.get_hostname
       @machine_ip = SplitConfig.get_ip
+
+      log_loaded_cache
     end
 
     #
@@ -65,6 +69,12 @@ module SplitIoClient
     # @return [Int] The timeout in seconds.
     attr_reader :read_timeout
 
+    #
+    # The cache adapter to store splits/segments in
+    #
+    # @return [Object] Cache adapter instance
+    attr_reader :cache_adapter
+
     #
     # The connection timeout for network connections in seconds.
     #
@@ -84,6 +94,18 @@ module SplitIoClient
     # @return [Boolean] The value for the debug flag
     attr_reader :debug_enabled
 
+    #
+    # Enable to log the content retrieved from endpoints
+    #
+    # @return [Boolean] The value for the debug flag
+    attr_reader :transport_debug_enabled
+
+    #
+    # The number of seconds to wait for SDK readiness
+    # or false to disable waiting
+    # @return [Integer]/[FalseClass]
+    attr_reader :block_until_ready
+
     attr_reader :machine_ip
     attr_reader :machine_name
 
@@ -113,8 +135,8 @@ module SplitIoClient
     end
 
     # @return [LocalStore] configuration value for local cache store
-    def self.default_local_store
-      defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : LocalStore.new
+    def self.default_cache_adapter
+      SplitIoClient::Cache::Adapters::MemoryAdapter.new
     end
 
     #
@@ -165,6 +187,14 @@ module SplitIoClient
       false
     end
 
+    #
+    # The default transport_debug_enabled value
+    #
+    # @return [boolean]
+    def self.transport_debug
+      false
+    end
+
     #
     # custom logger of exceptions
     #
@@ -175,6 +205,14 @@ module SplitIoClient
       @logger.error(error)
     end
 
+    #
+    # log which cache class was loaded
+    #
+    # @return [void]
+    def log_loaded_cache
+      @logger.info("Loaded cache class: #{@cache_adapter.class}")
+    end
+
     #
     # gets the hostname where the sdk gem is running
     #
@@ -200,6 +238,5 @@ module SplitIoClient
         '127.0.0.0'
       end
     end
-
   end
 end

data/lib/splitclient-rb/split_factory.rb

@@ -84,12 +84,15 @@ module SplitIoClient
       # @param api_key [String] the API key for your split account
       #
       # @return [SplitIoClient] split.io client instance
-      def initialize(api_key, config = {}, adapter = nil, localhost_mode = false)
+      def initialize(api_key, config = {}, adapter = nil, localhost_mode = false, splits_repository, segments_repository)
         @localhost_mode = localhost_mode
         @localhost_mode_features = []
 
         @config = config
 
+        @splits_repository = splits_repository
+        @segments_repository = segments_repository
+
         if api_key == LOCALHOST_MODE
           @localhost_mode = true
           load_localhost_mode_features
@@ -101,18 +104,21 @@ module SplitIoClient
       #
       # obtains the treatment for a given feature
       #
-      # @param id [string] user id
+      # @param key [string/hash] user id or hash with matching_key/bucketing_key
       # @param feature [string] name of the feature that is being validated
       #
       # @return [Treatment]  treatment constant value
-      def get_treatment(id, feature, attributes = nil)
-        unless id
-          @config.logger.warn('id was null for feature: ' + feature)
+      def get_treatment(key, feature, attributes = nil)
+        bucketing_key, matching_key = keys_from_key(key)
+        bucketing_key = matching_key if bucketing_key.nil?
+
+        if matching_key.nil?
+          @config.logger.warn('matching_key was null for feature: ' + feature)
           return Treatments::CONTROL
         end
 
-        unless feature
-          @config.logger.warn('feature was null for id: ' + id)
+        if feature.nil?
+          @config.logger.warn('feature was null for key: ' + key)
           return Treatments::CONTROL
         end
 
@@ -123,7 +129,7 @@ module SplitIoClient
           result = nil
 
           begin
-            result = get_treatment_without_exception_handling(id, feature, attributes)
+            result = get_treatment_without_exception_handling({ bucketing_key: bucketing_key, matching_key: matching_key }, feature, attributes)
           rescue StandardError => error
             @config.log_found_exception(__method__.to_s, error)
           end
@@ -131,7 +137,7 @@ module SplitIoClient
           result = result.nil? ? Treatments::CONTROL : result
 
           begin
-            @adapter.impressions.log(id, feature, result, (Time.now.to_f * 1000.0))
+            @adapter.impressions.log(matching_key, feature, result, (Time.now.to_f * 1000.0))
             latency = (Time.now - start) * 1000.0
             if (@adapter.impressions.queue.length >= @adapter.impressions.max_number_of_keys)
               @adapter.impressions_producer.wakeup
@@ -145,22 +151,33 @@ module SplitIoClient
         result
       end
 
+      def keys_from_key(key)
+        case key.class.to_s
+        when 'Hash'
+          key.values_at(:bucketing_key, :matching_key)
+        when 'String'
+          [key, key]
+        end
+      end
+
       #
       # auxiliary method to get the treatments avoding exceptions
       #
-      # @param id [string] user id
+      # @param key [string/hash] user id or hash with matching_key/bucketing_key
       # @param feature [string] name of the feature that is being validated
       #
       # @return [Treatment]  tretment constant value
-      def get_treatment_without_exception_handling(id, feature, attributes = nil)
-        @adapter.parsed_splits.segments = @adapter.parsed_segments
-        split = @adapter.parsed_splits.get_split(feature)
+      def get_treatment_without_exception_handling(key, feature, attributes = nil)
+        split = @splits_repository.get_split(feature)
 
         if split.nil?
-          return Treatments::CONTROL
+          Treatments::CONTROL
         else
-          default_treatment = split.data[:defaultTreatment]
-          return @adapter.parsed_splits.get_split_treatment(id, feature, default_treatment, attributes)
+          default_treatment = split[:defaultTreatment]
+
+          SplitIoClient::Engine::Parser::SplitTreatment
+            .new(@splits_repository, @segments_repository)
+            .call(key, feature, default_treatment, attributes)
         end
       end
 
@@ -208,7 +225,6 @@ module SplitIoClient
 
       private :get_treatment_without_exception_handling, :is_localhost_mode?,
               :load_localhost_mode_features, :get_localhost_treatment
-
     end
 
     private_constant :SplitClient
@@ -217,18 +233,24 @@ module SplitIoClient
     def initialize(api_key, config = {})
       @api_key = api_key
       @config = SplitConfig.new(config)
+      @cache_adapter = @config.cache_adapter
+      @splits_repository = SplitIoClient::Cache::Repositories::SplitsRepository.new(@cache_adapter)
+      @segments_repository = SplitIoClient::Cache::Repositories::SegmentsRepository.new(@cache_adapter)
+      @sdk_blocker = SplitIoClient::Cache::Stores::SDKBlocker.new(@config)
       @adapter = api_key != 'localhost' \
-      ? SplitAdapter.new(api_key, @config)
+      ? SplitAdapter.new(api_key, @config, @splits_repository, @segments_repository, @sdk_blocker)
       : nil
       @localhost_mode = api_key == 'localhost'
+
+      @sdk_blocker.block if @config.block_until_ready
     end
 
     def client
-      @client ||= SplitClient.new(@api_key, @config, @adapter, @localhost_mode)
+      @client ||= init_client
     end
 
     def manager
-      @manager ||= SplitManager.new(@api_key, @config, @adapter, @localhost_mode)
+      @manager ||= init_manager
     end
 
     #
@@ -241,5 +263,13 @@ module SplitIoClient
 
     private
       attr_reader :adapter
+
+    def init_client
+      SplitClient.new(@api_key, @config, @adapter, @localhost_mode, @splits_repository, @segments_repository)
+    end
+
+    def init_manager
+      SplitManager.new(@api_key, @config, @adapter, @localhost_mode)
+    end
   end
 end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '2.0.1'
+  VERSION = '3.0.2'
 end

data/splitclient-rb.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "json", "~> 1.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -206,29 +234,38 @@ files:
 - NEWS
 - README.md
 - Rakefile
-- lib/splitclient-cache/local_store.rb
-- lib/splitclient-engine/evaluator/splitter.rb
-- lib/splitclient-engine/impressions/impressions.rb
-- lib/splitclient-engine/matchers/all_keys_matcher.rb
-- lib/splitclient-engine/matchers/between_matcher.rb
-- lib/splitclient-engine/matchers/combiners.rb
-- lib/splitclient-engine/matchers/combining_matcher.rb
-- lib/splitclient-engine/matchers/equal_to_matcher.rb
-- lib/splitclient-engine/matchers/greater_than_or_equal_to_matcher.rb
-- lib/splitclient-engine/matchers/less_than_or_equal_to_matcher.rb
-- lib/splitclient-engine/matchers/negation_matcher.rb
-- lib/splitclient-engine/matchers/user_defined_segment_matcher.rb
-- lib/splitclient-engine/matchers/whitelist_matcher.rb
-- lib/splitclient-engine/metrics/binary_search_latency_tracker.rb
-- lib/splitclient-engine/metrics/metrics.rb
-- lib/splitclient-engine/parser/condition.rb
-- lib/splitclient-engine/parser/partition.rb
-- lib/splitclient-engine/parser/segment.rb
-- lib/splitclient-engine/parser/segment_parser.rb
-- lib/splitclient-engine/parser/split.rb
-- lib/splitclient-engine/parser/split_adapter.rb
-- lib/splitclient-engine/parser/split_parser.rb
-- lib/splitclient-engine/partitions/treatments.rb
+- lib/cache/adapters/adapter.rb
+- lib/cache/adapters/memory_adapter.rb
+- lib/cache/repositories/repository.rb
+- lib/cache/repositories/segments_repository.rb
+- lib/cache/repositories/splits_repository.rb
+- lib/cache/stores/sdk_blocker.rb
+- lib/cache/stores/segment_store.rb
+- lib/cache/stores/split_store.rb
+- lib/engine/api/client.rb
+- lib/engine/api/segments.rb
+- lib/engine/api/splits.rb
+- lib/engine/evaluator/splitter.rb
+- lib/engine/impressions/impressions.rb
+- lib/engine/matchers/all_keys_matcher.rb
+- lib/engine/matchers/between_matcher.rb
+- lib/engine/matchers/combiners.rb
+- lib/engine/matchers/combining_matcher.rb
+- lib/engine/matchers/equal_to_matcher.rb
+- lib/engine/matchers/greater_than_or_equal_to_matcher.rb
+- lib/engine/matchers/less_than_or_equal_to_matcher.rb
+- lib/engine/matchers/negation_matcher.rb
+- lib/engine/matchers/user_defined_segment_matcher.rb
+- lib/engine/matchers/whitelist_matcher.rb
+- lib/engine/metrics/binary_search_latency_tracker.rb
+- lib/engine/metrics/metrics.rb
+- lib/engine/parser/condition.rb
+- lib/engine/parser/partition.rb
+- lib/engine/parser/split.rb
+- lib/engine/parser/split_adapter.rb
+- lib/engine/parser/split_treatment.rb
+- lib/engine/partitions/treatments.rb
+- lib/exceptions/sdk_blocker_timeout_expired_exception.rb
 - lib/splitclient-rb.rb
 - lib/splitclient-rb/localhost_split_factory.rb
 - lib/splitclient-rb/localhost_split_factory_builder.rb