splitclient-rb 3.1.2 → 3.1.3.pre.rc1

data/lib/splitclient-rb/split_config.rb

@@ -29,6 +29,7 @@ module SplitIoClient
       @events_uri = (opts[:events_uri] || SplitConfig.default_events_uri).chomp('/')
       @mode = opts[:mode] || SplitConfig.default_mode
       @redis_url = opts[:redis_url] || SplitConfig.default_redis_url
+      @redis_namespace = opts[:redis_namespace] || SplitConfig.default_redis_namespace
       @cache_adapter = SplitConfig.init_cache_adapter(
         opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, @redis_url, false
       )
@@ -145,6 +146,7 @@ module SplitIoClient
     attr_reader :impressions_queue_size
 
     attr_reader :redis_url
+    attr_reader :redis_namespace
 
     #
     # The default split client configuration
@@ -154,6 +156,14 @@ module SplitIoClient
       SplitConfig.new
     end
 
+    #
+    # method that returns the sdk gem version
+    #
+    # @return [string] version value for this sdk
+    def self.sdk_version
+      'RubyClientSDK-'+SplitIoClient::VERSION
+    end
+
     #
     # The default base uri for api calls
     #
@@ -176,6 +186,12 @@ module SplitIoClient
 
         SplitIoClient::Cache::Adapters::MemoryAdapter.new(adapter)
       when :redis
+        begin
+          require 'redis'
+        rescue LoadError
+          fail StandardError, 'To use Redis as a cache adapter you must include it in your Gemfile'
+        end
+
         SplitIoClient::Cache::Adapters::RedisAdapter.new(redis_url)
       end
     end
@@ -249,6 +265,10 @@ module SplitIoClient
       'redis://127.0.0.1:6379/0'
     end
 
+    def self.default_redis_namespace
+      "SPLITIO/ruby-#{VERSION}"
+    end
+
     #
     # The default transport_debug_enabled value
     #

data/lib/splitclient-rb/split_factory.rb

@@ -1,229 +1,28 @@
-require 'logger'
-
 module SplitIoClient
-  #
-  # main class for split client sdk
-  #
-  class SplitFactory < NoMethodError
-    class SplitManager < NoMethodError
-      #
-      # 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, config = {}, adapter = nil, splits_repository = nil)
-        @localhost_mode_features = []
-        @config = config
-        @splits_repository = splits_repository
-        @adapter = adapter
-      end
-
-      #
-      # method to get the split list from the client
-      #
-      # @returns [object] array of splits
-      def splits
-        return if @splits_repository.nil?
-
-        @splits_repository.splits.each_with_object([]) do |(name, split), memo|
-          split_model = Engine::Models::Split.new(split)
-
-          memo << build_split_view(name, split) unless split_model.archived?
-        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
-        return if @splits_repository.nil?
-
-        @splits_repository.split_names
-      end
-
-      #
-      # method to get a split view
-      #
-      # @returns a split view
-      def split(split_name)
-        if @splits_repository
-          split = @splits_repository.get_split(split_name)
-
-          build_split_view(split_name, split) unless split.nil? or split_model(split).archived?
-        end
-      end
-
-      def build_split_view(name, split)
-        treatments = split[:conditions] && split[:conditions][0][:partitions] \
-          ? split[:conditions][0][:partitions].map{ |partition| partition[:treatment] }
-          : []
-          {
-            name: name,
-            traffic_type_name: split[:trafficTypeName],
-            killed: split[:killed],
-            treatments: treatments,
-            change_number: split[:changeNumber]
-          }
-      end
-
-      private
-
-      def split_model(split)
-        split_model = Engine::Models::Split.new(split)
-      end
-    end
-
-    class SplitClient < NoMethodError
-      #
-      # Creates a new split client instance that connects to split.io API.
-      #
-      # @param api_key [String] the API key for your split account
-      #
-      # @return [SplitIoClient] split.io client instance
-      def initialize(api_key, config = {}, adapter = nil, splits_repository, segments_repository, impressions_repository, metrics_repository)
-        @config = config
-
-        @splits_repository = splits_repository
-        @segments_repository = segments_repository
-        @impressions_repository = impressions_repository
-        @metrics_repository = metrics_repository
-
-        @adapter = adapter
-      end
-
-      def get_treatments(key, split_names, attributes = nil)
-        bucketing_key, matching_key = keys_from_key(key)
-        bucketing_key = matching_key if bucketing_key.nil?
-
-        treatments = @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
-          memo.merge!(name => get_treatment(key, name, attributes, data, false))
-        end
-
-        if @config.impressions_queue_size > 0
-          @impressions_repository.add_bulk(matching_key, treatments, (Time.now.to_f * 1000.0).to_i)
-        end
-
-        treatments
-      end
-
-      #
-      # obtains the treatment for a given feature
-      #
-      # @param key [String/Hash] user id or hash with matching_key/bucketing_key
-      # @param split_name [String/Array] name of the feature that is being validated or array of them
-      #
-      # @return [String/Hash] Treatment as String or Hash of treatments in case of array of features
-      def get_treatment(key, split_name, attributes = nil, split_data = nil, store_impressions = true)
-        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 split_name: ' + split_name.to_s)
-          return Treatments::CONTROL
-        end
-
-        if split_name.nil?
-          @config.logger.warn('split_name was null for key: ' + key)
-          return Treatments::CONTROL
-        end
+  class SplitFactory
+    include SplitIoClient::Cache::Repositories
+    include SplitIoClient::Cache::Stores
 
-        start = Time.now
-        result = nil
+    attr_reader :adapter, :client, :manager
 
-        begin
-          split = split_data ? split_data : @splits_repository.get_split(split_name)
-
-          result = if split.nil?
-            Treatments::CONTROL
-          else
-            SplitIoClient::Engine::Parser::SplitTreatment.new(@segments_repository).call(
-              { bucketing_key: bucketing_key, matching_key: matching_key }, split, attributes
-            )
-          end
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
-        end
-
-        result = result.nil? ? Treatments::CONTROL : result
-
-        begin
-          latency = (Time.now - start) * 1000.0
-          if @config.impressions_queue_size > 0 && store_impressions
-            # Disable impressions if @config.impressions_queue_size == -1
-            @impressions_repository.add(split_name, 'key_name' => matching_key, 'treatment' => result, 'time' => (Time.now.to_f * 1000.0).to_i)
-          end
-
-          # Measure
-          @adapter.metrics.time("sdk.get_treatment", latency)
-        rescue StandardError => error
-          @config.log_found_exception(__method__.to_s, error)
-        end
-
-        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
-
-      #
-      # method that returns the sdk gem version
-      #
-      # @return [string] version value for this sdk
-      def self.sdk_version
-        'ruby-'+SplitIoClient::VERSION
-      end
-    end
-
-    private_constant :SplitClient
-    private_constant :SplitManager
-
-    def initialize(api_key, config = {})
+    def initialize(api_key, config_hash = {})
       @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)
-      @impressions_repository = SplitIoClient::Cache::Repositories::ImpressionsRepository.new(@config.impressions_adapter, @config)
-      @metrics_repository = SplitIoClient::Cache::Repositories::MetricsRepository.new(@config.metrics_adapter, @config)
-      @sdk_blocker = SplitIoClient::Cache::Stores::SDKBlocker.new(@config)
-      @adapter = SplitAdapter.new(api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @sdk_blocker)
+      @config = SplitConfig.new(config_hash)
 
-      @sdk_blocker.block if @config.block_until_ready
-    end
-
-    def client
-      @client ||= init_client
-    end
-
-    def manager
-      @manager ||= init_manager
-    end
+      @cache_adapter = @config.cache_adapter
 
-    #
-    # method that returns the sdk gem version
-    #
-    # @return [string] version value for this sdk
-    def self.sdk_version
-      'RubyClientSDK-'+SplitIoClient::VERSION
-    end
+      @splits_repository = SplitsRepository.new(@cache_adapter, @config)
+      @segments_repository = SegmentsRepository.new(@cache_adapter, @config)
+      @impressions_repository = ImpressionsRepository.new(@config.impressions_adapter, @config)
+      @metrics_repository = MetricsRepository.new(@config.metrics_adapter, @config)
 
-    private
-      attr_reader :adapter
+      @sdk_blocker = SDKBlocker.new(@config, @splits_repository, @segments_repository)
+      @adapter = SplitAdapter.new(@api_key, @config, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository, @sdk_blocker)
 
-    def init_client
-      SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
-    end
+      @client = SplitClient.new(@api_key, @config, @adapter, @splits_repository, @segments_repository, @impressions_repository, @metrics_repository)
+      @manager = SplitManager.new(@api_key, @config, @adapter, @splits_repository)
 
-    def init_manager
-      SplitManager.new(@api_key, @config, @adapter, @splits_repository)
+      @sdk_blocker.block if @config.block_until_ready
     end
   end
 end

data/lib/splitclient-rb/split_factory_builder.rb

@@ -1,12 +1,13 @@
+require 'logger'
+
 module SplitIoClient
   class SplitFactoryBuilder
     def self.build(api_key, config = {})
       case api_key
       when 'localhost'
         splits_file = config[:path]? config[:path] : File.join(Dir.home, '.split')
-        puts("Filename #{splits_file}")
 
-        LocalhostSplitFactory.new(splits_file)
+        LocalhostSplitFactory.new(splits_file, config[:reload_rate])
       else
         SplitFactory.new(api_key, config)
       end

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '3.1.2'
+  VERSION = '3.1.3-rc1'
 end

data/lib/splitclient-rb_utilitites.rb

@@ -2,33 +2,38 @@ module Utilities
   extend self
 
   # Convert String with Time info to its epoch FixNum previously setting to zero the seconds
-  def to_epoch value
+  def to_epoch(value)
     parsed = Time.parse(value)
     zeroed = Time.new(parsed.year, parsed.month, parsed.day, parsed.hour, parsed.min, 0, 0)
+
     zeroed.to_i
   end
 
-  def to_epoch_milis value
-    (to_epoch (value)) * 1000
+  def to_epoch_milis(value)
+    to_epoch(value) * 1000
+  end
+
+  def to_milis_zero_out_from_seconds(value)
+    parsed_value = Time.strptime(value.to_s, '%s').utc
+    zeroed = Time.new(parsed_value.year, parsed_value.month, parsed_value.day, parsed_value.hour, parsed_value.min, 0, 0)
+
+    zeroed.to_i * 1000
+  rescue
+    return :non_valid_date_info
   end
 
-  def to_milis_zero_out_from_seconds value
-    begin
-      parsed_value = Time.strptime(value.to_s,'%s').utc
-      zeroed = Time.new(parsed_value.year, parsed_value.month, parsed_value.day, parsed_value.hour, parsed_value.min, 0, 0)
-      return zeroed.to_i*1000
-    rescue
-      return :non_valid_date_info
-    end
+  def to_milis_zero_out_from_hour(value)
+    parsed_value = Time.strptime(value.to_s, '%s').utc
+    zeroed = Time.new(parsed_value.year, parsed_value.month, parsed_value.day, 0, 0, 0, 0)
+
+    zeroed.to_i * 1000
+  rescue StandardError
+    return :non_valid_date_info
   end
 
-  def to_milis_zero_out_from_hour value
-    begin
-      parsed_value = Time.strptime(value.to_s,'%s').utc
-      zeroed = Time.new(parsed_value.year, parsed_value.month, parsed_value.day, 0, 0, 0, 0)
-      return zeroed.to_i*1000
-    rescue
-      return :non_valid_date_info
-    end
+  def randomize_interval(interval)
+    random_factor = Random.new.rand(50..100) / 100.0
+
+    interval * random_factor
   end
 end

data/splitclient-rb.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "redis"
 
   spec.add_runtime_dependency "json", "~> 1.8"
   spec.add_runtime_dependency "thread_safe"
@@ -35,5 +36,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday-http-cache"
   spec.add_runtime_dependency "faraday_middleware"
   spec.add_runtime_dependency "net-http-persistent", "<= 2.9.4"
-  spec.add_runtime_dependency "redis", "~> 3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: json
   requirement: !ruby/object:Gem::Requirement
@@ -220,20 +234,6 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: 2.9.4
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 description: Ruby client for using split SDK.
 email:
 - pato@split.io
@@ -267,11 +267,13 @@ files:
 - lib/cache/repositories/splits_repository.rb
 - lib/cache/senders/impressions_formatter.rb
 - lib/cache/senders/impressions_sender.rb
+- lib/cache/senders/metrics_sender.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/impressions.rb
+- lib/engine/api/metrics.rb
 - lib/engine/api/segments.rb
 - lib/engine/api/splits.rb
 - lib/engine/evaluator/splitter.rb
@@ -295,14 +297,19 @@ files:
 - lib/engine/partitions/treatments.rb
 - lib/exceptions/sdk_blocker_timeout_expired_exception.rb
 - lib/splitclient-rb.rb
+- lib/splitclient-rb/clients/localhost_split_client.rb
+- lib/splitclient-rb/clients/split_client.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/split_config.rb
 - lib/splitclient-rb/split_factory.rb
 - lib/splitclient-rb/split_factory_builder.rb
 - lib/splitclient-rb/version.rb
 - lib/splitclient-rb_utilitites.rb
 - splitclient-rb.gemspec
-- splitio.yml
+- splitio.yml.example
 - tasks/benchmark_get_treatment.rake
 - tasks/console.rake
 - tasks/rspec.rake
@@ -321,9 +328,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: []
 rubyforge_project: 
 rubygems_version: 2.5.2