splitclient-rb 3.1.0.pre.rc5 → 3.1.0.pre.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b87eb417698ad4261d7875bf106cbdd68454f44
-  data.tar.gz: bf1bbfa658d60391665cbba727552a9bf63a08ec
+  metadata.gz: 58d09e0e5a6d94a0a79c0fc5b4cea7a32e7bdd1d
+  data.tar.gz: 8bdc8dbc17fd1cfd7e6fa1d2df4445d65638d139
 SHA512:
-  metadata.gz: ac75a102f260b28e54a65354593bca386f1c603d0521c2b99b2ace068f76337454dd06834d75de7af22483dbbdacbd66a33e7d3349bfd5bc81326e0a3a8498e6
-  data.tar.gz: 11d3e31a4fb3adcc0e15dcd42c956e679a557dc2da7a423211ee44f15bc01bc5cc8537a64caee76faeab0cc3a841491d6e5ef8dd370e2daafdbd2d4529807588
+  metadata.gz: 584a396de37a5e5783f958bd6e3f93473af6b9bfc033aa47099997e9bd0a695ed05aca65e0880d5f43897928f9618cd175bd1a12ec8cb0a34b0fc7d4e799d57e
+  data.tar.gz: ec4bfc56c8fa786ba28d547d0a8198f6c4589e8ad89068f4a1fd64063bca796d7657d5e012f1b30da7366708044c221f6870a2942c25a1268d861ef74a30438a

data/CHANGES.txt

@@ -1,26 +1,32 @@
 3.1.0
-- Add RedisAdapter 
-- adds manager.splitNames()
+- Add RedisAdapter
+- adds manager.split_names()
 
 3.0.3
+
 - Fix nil ref in manager
 
 3.0.2
+
 - add ability to provide different bucketing/matching keys
 
 3.0.1
+
 - fix segments not deleting from the cache
 
 3.0.0
+
 - add new caching interface
 - add replaceable adapters to store cache in
 - add first cache adapter: MemoryAdapter
 - refactoring
 
 2.0.1
+
 - Supress warnings cause by Net::HTTP when it already exists.
 
 2.0.0
+
 - Add Factory for creation of Client and Manager interface.
 
 1.0.4

data/NEWS

@@ -1,4 +1,5 @@
 3.1.0
+
 Now supporting Redis as a cache adapter
 
 3.0.2

data/lib/cache/adapters/memory_adapter.rb

@@ -58,6 +58,12 @@ module SplitIoClient
           @map.keys.select { |str| str.start_with? prefix }
         end
 
+        def multiple_strings(keys)
+          keys.each_with_object({}) do |key, memo|
+            memo[key] = string(key)
+          end
+        end
+
         # Bool
         def set_bool(key, val)
           @map[key] = val
@@ -87,7 +93,7 @@ module SplitIoClient
         end
 
         def delete(key)
-          @map[key] = nil
+          @map.delete(key)
         end
       end
     end

data/lib/cache/adapters/redis_adapter.rb

@@ -53,6 +53,10 @@ module SplitIoClient
           @redis.keys("#{prefix}*")
         end
 
+        def multiple_strings(keys)
+          Hash[keys.zip(@redis.mget(keys))]
+        end
+
         # Bool
         def set_bool(key, val)
           @redis.set(key, val.to_s)

data/lib/cache/repositories/splits_repository.rb

@@ -4,6 +4,8 @@ module SplitIoClient
   module Cache
     module Repositories
       class SplitsRepository < Repository
+        SPLITS_SLICE = 10
+
         def initialize(adapter)
           @adapter = adapter
 
@@ -19,10 +21,27 @@ module SplitIoClient
           @adapter.delete(namespace_key("split.#{name}"))
         end
 
+        def get_splits(names, slice = SPLITS_SLICE)
+          splits = {}
+
+          names.each_slice(slice) do |splits_slice|
+            splits.merge!(
+              @adapter
+                .multiple_strings(splits_slice.map { |name| namespace_key("split.#{name}") })
+                .map { |name, data| [name.gsub(namespace_key('split.'), ''), data] }.to_h
+            )
+          end
+
+          splits.map do |name, data|
+            parsed_data = data ? JSON.parse(data, symbolize_names: true) : nil
+            [name.to_sym, parsed_data]
+          end.to_h
+        end
+
         def get_split(name)
           split = @adapter.string(namespace_key("split.#{name}"))
 
-          JSON.parse(split, symbolize_names: true)
+          JSON.parse(split, symbolize_names: true) if split
         end
 
         def splits
@@ -57,6 +76,10 @@ module SplitIoClient
             @adapter.add_to_set(namespace_key('segments.registered'), name)
           end
         end
+
+        def exists?(name)
+          @adapter.exists?(namespace_key("split.#{name}"))
+        end
       end
     end
   end

data/lib/cache/stores/split_store.rb

@@ -32,13 +32,13 @@ module SplitIoClient
           data = splits_since(@splits_repository.get_change_number)
 
           data[:splits] && data[:splits].each do |split|
-            @splits_repository.add_split(split)
+            add_split_unless_archived(split)
           end
 
           @splits_repository.set_segment_names(data[:segment_names])
           @splits_repository.set_change_number(data[:till])
 
-          @config.logger.debug("segments seen(#{data[:segment_names].length()}): #{data[:segment_names].to_a}") if @config.debug_enabled
+          @config.logger.debug("segments seen(#{data[:segment_names].length}): #{data[:segment_names].to_a}") if @config.debug_enabled
 
           if @config.block_until_ready && !@sdk_blocker.ready?
             @sdk_blocker.splits_ready!
@@ -58,6 +58,32 @@ module SplitIoClient
         def splits_since(since)
           SplitIoClient::Api::Splits.new(@api_key, @config, @metrics).since(since)
         end
+
+        def add_split_unless_archived(split)
+          if split_model(split).archived?
+            @config.logger.debug("Seeing archived split #{split[:name]}") if @config.debug_enabled
+
+            remove_archived_split(split)
+          else
+            store_split(split)
+          end
+        end
+
+        def remove_archived_split(split)
+          @config.logger.debug("removing split from store(#{split})") if @config.debug_enabled
+
+          @splits_repository.remove_split(split[:name])
+        end
+
+        def store_split(split)
+          @config.logger.debug("storing split (#{split[:name]})") if @config.debug_enabled
+
+          @splits_repository.add_split(split)
+        end
+
+        def split_model(split)
+          Engine::Models::Split.new(split)
+        end
       end
     end
   end

data/lib/engine/models/split.rb

@@ -0,0 +1,19 @@
+module SplitIoClient
+  module Engine
+    module Models
+      class Split
+        def initialize(data)
+          @data = data
+        end
+
+        def matchable?
+          @data && @data[:status] == 'ACTIVE' && @data[:killed] == false
+        end
+
+        def archived?
+          @data && @data[:status] == 'ARCHIVED'
+        end
+      end
+    end
+  end
+end

data/lib/engine/parser/split_treatment.rb

@@ -2,17 +2,17 @@ module SplitIoClient
   module Engine
     module Parser
       class SplitTreatment
-        def initialize(splits_repository, segments_repository)
-          @splits_repository = splits_repository
+        def initialize(segments_repository)
           @segments_repository = segments_repository
         end
 
-        def call(keys, split_name, default_treatment, attributes = nil)
-          split = @splits_repository.get_split(split_name)
+        def call(keys, split, attributes = nil)
+          split_model = Models::Split.new(split)
+          default_treatment = split[:defaultTreatment]
 
-          return Treatments::CONTROL if self.class.archived?(split)
+          return Treatments::CONTROL if split_model.archived?
 
-          matchable?(split) ? match(split, keys, attributes, default_treatment) : default_treatment
+          split_model.matchable? ? match(split, keys, attributes, default_treatment) : default_treatment
         end
 
         private
@@ -51,14 +51,6 @@ module SplitIoClient
             final_matcher
           end
         end
-
-        def matchable?(split)
-          !split.nil? && split[:status] == 'ACTIVE' && split[:killed] == false
-        end
-
-        def self.archived?(split)
-          !split.nil? && split[:status] == 'ARCHIVED'
-        end
       end
     end
   end

data/lib/splitclient-rb/split_factory.rb

@@ -53,7 +53,9 @@ module SplitIoClient
         return if @splits_repository.nil?
 
         @splits_repository.splits.each_with_object([]) do |(name, split), memo|
-          memo << build_split_view(name, split) unless Engine::Parser::SplitTreatment.archived?(split)
+          split_model = Engine::Models::Split.new(split)
+
+          memo << build_split_view(name, split) unless split_model.archived?
         end
       end
 
@@ -61,18 +63,18 @@ module SplitIoClient
       # 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 splitNames
+      def split_names
         if @localhost_mode
           local_feature_names = []
           @localhost_mode_features.each do  |split|
-            local_feature_names << split[:feature] 
+            local_feature_names << split[:feature]
           end
           return local_feature_names
         end
 
         return if @splits_repository.nil?
 
-        @splits_repository.splitNames
+        @splits_repository.split_names
       end
 
       #
@@ -86,10 +88,9 @@ module SplitIoClient
         end
 
         if @splits_repository
-
           split = @splits_repository.get_split(split_name)
 
-          build_split_view(split_name, split) if split and !Engine::Parser::SplitTreatment.archived?(split)
+          build_split_view(split_name, split) unless split.nil? or split_model(split).archived?
         end
       end
 
@@ -106,6 +107,11 @@ module SplitIoClient
           }
       end
 
+      private
+
+      def split_model(split)
+        split_model = Engine::Models::Split.new(split)
+      end
     end
 
 
@@ -142,35 +148,49 @@ module SplitIoClient
         end
       end
 
+      def get_treatments(key, split_names, attributes = nil)
+        @splits_repository.get_splits(split_names).each_with_object({}) do |(name, data), memo|
+          memo.merge!(name => get_treatment(key, name, attributes, data))
+        end
+      end
+
       #
       # obtains the treatment for a given feature
       #
-      # @param key [string/hash] user id or hash with matching_key/bucketing_key
-      # @param feature [string] name of the feature that is being validated
+      # @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 [Treatment]  treatment constant value
-      def get_treatment(key, feature, attributes = nil)
+      # @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)
         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)
+          @config.logger.warn('matching_key was null for split_name: ' + split_name.to_s)
           return Treatments::CONTROL
         end
 
-        if feature.nil?
-          @config.logger.warn('feature was null for key: ' + key)
+        if split_name.nil?
+          @config.logger.warn('split_name was null for key: ' + key)
           return Treatments::CONTROL
         end
 
         if is_localhost_mode?
-          result = get_localhost_treatment(feature)
+          result = get_localhost_treatment(split_name)
         else
           start = Time.now
           result = nil
 
           begin
-            result = get_treatment_without_exception_handling({ bucketing_key: bucketing_key, matching_key: matching_key }, feature, attributes)
+            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
@@ -178,7 +198,7 @@ module SplitIoClient
           result = result.nil? ? Treatments::CONTROL : result
 
           begin
-            @adapter.impressions.log(matching_key, feature, result, (Time.now.to_f * 1000.0))
+            @adapter.impressions.log(matching_key, split_name, result, (Time.now.to_f * 1000.0))
             latency = (Time.now - start) * 1000.0
           rescue StandardError => error
             @config.log_found_exception(__method__.to_s, error)
@@ -198,28 +218,6 @@ module SplitIoClient
         end
       end
 
-      #
-      # auxiliary method to get the treatments avoding exceptions
-      #
-      # @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(key, feature, attributes = nil)
-
-        split = @splits_repository.get_split(feature)
-
-        if split.nil?
-          Treatments::CONTROL
-        else
-          default_treatment = split[:defaultTreatment]
-
-          SplitIoClient::Engine::Parser::SplitTreatment
-            .new(@splits_repository, @segments_repository)
-            .call(key, feature, default_treatment, attributes)
-        end
-      end
-
       #
       # method that returns the sdk gem version
       #
@@ -228,6 +226,8 @@ module SplitIoClient
         'RubyClientSDK-'+SplitIoClient::VERSION
       end
 
+      private
+
       #
       # method to check if the sdk is running in localhost mode based on api key
       #
@@ -261,9 +261,6 @@ module SplitIoClient
         localhost_result = treatment[:treatment] if !treatment.nil?
         localhost_result
       end
-
-      private :get_treatment_without_exception_handling, :is_localhost_mode?,
-              :load_localhost_mode_features, :get_localhost_treatment
     end
 
     private_constant :SplitClient

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '3.1.0-rc5'
+  VERSION = '3.1.0-rc6'
 end

data/lib/splitclient-rb.rb

@@ -35,4 +35,5 @@ require 'engine/evaluator/splitter'
 require 'engine/impressions/impressions'
 require 'engine/metrics/metrics'
 require 'engine/metrics/binary_search_latency_tracker'
+require 'engine/models/split'
 require 'splitclient-rb_utilitites'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 3.1.0.pre.rc5
+  version: 3.1.0.pre.rc6
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -275,9 +275,9 @@ files:
 - lib/engine/matchers/whitelist_matcher.rb
 - lib/engine/metrics/binary_search_latency_tracker.rb
 - lib/engine/metrics/metrics.rb
+- lib/engine/models/split.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

data/lib/engine/parser/split.rb

@@ -1,76 +0,0 @@
-module SplitIoClient
-  #
-  # acts as dto for a split structure
-  #
-  class Split < NoMethodError
-    #
-    # definition of the split
-    #
-    # @returns [object] split values
-    attr_accessor :data
-
-    def initialize(split)
-      @data = split
-      @conditions = set_conditions
-    end
-
-    #
-    # @returns [string] name of the split
-    def name
-      @data[:name]
-    end
-
-    #
-    # @returns [int] seed value of the split
-    def seed
-      @data[:seed]
-    end
-
-    #
-    # @returns [string] status value of the split
-    def status
-      @data[:status]
-    end
-
-    #
-    # @returns [string] killed value of the split
-    def killed?
-      @data[:killed]
-    end
-
-    #
-    # @returns [object] array of condition objects for this split
-    def conditions
-      @conditions
-    end
-
-    #
-    # @return [boolean] true if the condition is empty false otherwise
-    def empty?
-      @data.empty?
-    end
-
-    #
-    # converts the conditions data into an array of condition objects for this split
-    #
-    # @return [object] array of condition objects
-    def set_conditions
-      conditions_list = []
-      @data[:conditions].each do |c|
-        condition = SplitIoClient::Condition.new(c)
-        conditions_list << condition
-      end
-      conditions_list
-    end
-
-    def to_h
-      {
-        name: name,
-        seed: seed,
-        status: status,
-        killed: killed?,
-        conditions: conditions
-      }
-    end
-  end
-end