splitclient-rb 5.1.2 → 5.1.3.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac78f1a43b52720c039260ceb19474cb8fd03fd473cbf0054c590c7e8d45e57
-  data.tar.gz: d0cc36d7647956efbb9f0d455d1bf7aacfebca6960aa4fe304bd98e166d9752d
+  metadata.gz: 7470b6e84f8bf0cef00815acc17c0fa9d1f8ab81e6746676b19e9119ce12ba1f
+  data.tar.gz: 7d95234b01d68aa0da0bdf8a3dd07849836ca3a9194e9a56094bb054e597c0d4
 SHA512:
-  metadata.gz: 48898f6530d4dfeea94dd20475bc204c1f4cbfe5c6d560565ad6ea3b33c756fa3c3e0f0cfa80a28919c5e88fc00a0bbc6e22d7a0031ca03b652bf8241d7ca651
-  data.tar.gz: 14af6c54d0e1d164a59e2b735518f5bfdf80eb47b33d6fdb78415a056adf8ea2747ee7ee6a16f15c905611c8263ef5e48c964db8f4d3ad68395cecf6894106ae
+  metadata.gz: bc1135d77d83d1c037716ce4aaa2f9a9f40bcb386cc0efa1665bcd82e2fa2294907d1bc1f42e8fa72541179761d22965c0daee1b51a354677a5ca4bc5d20dc26
+  data.tar.gz: 9bc52d47fb482081015c4849e15105142de7033880f5d3de1cbef5a8766636389a055e35b4dfa5986a6e63136cc760ba945c702d80a31ae16cde8ad655a71906

data/CHANGES.txt

@@ -1,3 +1,6 @@
+5.1.3
+- Add cache wrapper to treatments and segments.
+
 5.1.2 (October 26th, 2018)
 - Add input validation for client API methods
 

data/Detailed-README.md

@@ -301,6 +301,14 @@ _To use Redis, include `redis-rb` in your app's Gemfile._
 
 *default value* = (your current hostname)
 
+**cache_ttl** : Time to live in seconds for the memory cache values when using Redis.
+
+*default value* = `5`
+
+**max_cache_size** : Maximum number of items held in the memory cache values when using Redis. When cache is full an LRU strategy for pruning shall be used.
+
+*default value* = `500`
+
 **redis_url** : Redis URL or hash with configuration for the SDK to connect to. See [Redis#initialize](https://www.rubydoc.info/github/redis/redis-rb/Redis%3Ainitialize) for detailed information.
 
 *default value* = `'redis://127.0.0.1:6379/0'`

data/NEWS

@@ -1,3 +1,7 @@
+5.1.3
+
+Add cache wrapper to treatments and segments.
+
 5.1.2
 
 Add input validation for client API methods: get_treatment, get_treatments, track, manager

data/lib/splitclient-rb.rb

@@ -6,6 +6,7 @@ require 'splitclient-rb/exceptions'
 require 'splitclient-rb/cache/routers/impression_router'
 require 'splitclient-rb/cache/adapters/memory_adapters/map_adapter'
 require 'splitclient-rb/cache/adapters/memory_adapters/queue_adapter'
+require 'splitclient-rb/cache/adapters/cache_adapter'
 require 'splitclient-rb/cache/adapters/memory_adapter'
 require 'splitclient-rb/cache/adapters/redis_adapter'
 require 'splitclient-rb/cache/repositories/repository'

data/lib/splitclient-rb/cache/adapters/cache_adapter.rb

@@ -0,0 +1,131 @@
+require 'lru_redux'
+
+module SplitIoClient
+  module Cache
+    module Adapters
+      class CacheAdapter
+        extend Forwardable
+        def_delegators :@adapter, :initialize_set, :set_bool, :pipelined
+
+        def initialize(adapter)
+          @cache = LruRedux::TTL::ThreadSafeCache.new(SplitIoClient.configuration.max_cache_size, SplitIoClient.configuration.cache_ttl)
+          @adapter = adapter
+        end
+
+        def delete(key)
+          @cache.delete(key)
+          @adapter.delete(key)
+        end
+
+        def clear(namespace_key)
+          @cache.clear
+          @adapter.clear(namespace_key)
+        end
+
+        def string(key)
+          value = get(key)
+          return value if value
+          value = @adapter.string(key)
+          add(key, value)
+          value
+        end
+
+        def set_string(key, value)
+          add(key, value)
+          @adapter.set_string(key, value)
+        end
+
+        def multiple_strings(keys)
+          cached_values = keys.each_with_object({}) do |key, memo|
+             memo[key] = get(key)
+          end
+
+          non_cached_keys = []
+          cached_values.delete_if{ |k,v| v.nil? ? non_cached_keys << k : false }
+
+          if non_cached_keys.any?
+            new_values = @adapter.multiple_strings(non_cached_keys)
+
+            new_values.keys.each do |key, value|
+              add(key, value)
+            end
+
+            cached_values.merge!(new_values)
+          end
+
+          cached_values
+        end
+
+        def find_strings_by_prefix(prefix)
+          @adapter.find_strings_by_prefix(prefix)
+        end
+
+        def exists?(key)
+          cached_value = get(key)
+          if cached_value.nil?
+            @adapter.exists?(key)
+          else
+            true
+          end
+        end
+
+        def add_to_set(key, values)
+          if values.is_a? Array
+            values.each { |value| add_to_map(key, value, 1) }
+          else
+            add_to_map(key, values, 1)
+          end
+          @adapter.add_to_set(key, values)
+        end
+
+        def in_set?(key, field)
+          cached_value = get(key)
+          if cached_value.nil?
+            return @adapter.in_set?(key, field)
+          end
+          cached_value.key?(field)
+        end
+
+        def get_set(key)
+          cached_value = get(key)
+          if cached_value.nil?
+            return @adapter.get_set(key)
+          end
+          cached_value.keys
+        end
+
+        def delete_from_set(key, fields)
+          cached_value = get(key)
+          if cached_value
+            if fields.is_a? Array
+              fields.each { |field| cached_value.delete(field) }
+            else
+              cached_value.delete(fields)
+            end
+          end
+
+          @adapter.delete_from_set(key, fields)
+        end
+
+        def initialize_map(key)
+          @cache[key] = Concurrent::Map.new
+        end
+
+        private
+
+        def add_to_map(key, field, value)
+          initialize_map(key) unless get(key)
+          get(key).put(field.to_s, value.to_s)
+        end
+
+        def add(key, value)
+          @cache[key] = value.to_s unless value.nil?
+        end
+
+        def get(key)
+          @cache[key]
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,12 @@ module SplitIoClient
         attr_reader :adapter
 
         def initialize(adapter)
-          @adapter = adapter
+          @adapter = case adapter.class.to_s
+          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+            SplitIoClient::Cache::Adapters::CacheAdapter.new(adapter)
+          else
+            adapter
+          end
           @adapter.set_bool(namespace_key('.ready'), false) unless SplitIoClient.configuration.mode == :consumer
         end
 

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

@@ -7,7 +7,12 @@ module SplitIoClient
         attr_reader :adapter
 
         def initialize(adapter)
-          @adapter = adapter
+          @adapter = case adapter.class.to_s
+          when 'SplitIoClient::Cache::Adapters::RedisAdapter'
+            SplitIoClient::Cache::Adapters::CacheAdapter.new(adapter)
+          else
+            adapter
+          end
           unless SplitIoClient.configuration.mode == :consumer
             @adapter.set_string(namespace_key('.splits.till'), '-1')
             @adapter.initialize_map(namespace_key('.segments.registered'))

data/lib/splitclient-rb/split_config.rb

@@ -33,6 +33,8 @@ module SplitIoClient
     # @option opts [Int] :impressions_queue_size Size of the impressions queue in the memory repository. Once reached, newer impressions will be dropped
     # @option opts [Int] :impressions_bulk_size Max number of impressions to be sent to the backend on each post
     # @option opts [#log] :impression_listener this object will capture all impressions and process them through `#log`
+    # @option opts [Int] :cache_ttl Time to live in seconds for the memory cache values when using Redis.
+    # @option opts [Int] :max_cache_size Max number of items to be held in the memory cache before prunning when using Redis.
     # @return [type] SplitConfig with configuration options
     def initialize(opts = {})
       @base_uri = (opts[:base_uri] || SplitConfig.default_base_uri).chomp('/')
@@ -70,6 +72,9 @@ module SplitIoClient
       @machine_name = opts[:machine_name] || SplitConfig.machine_hostname
       @machine_ip = opts[:machine_ip] || SplitConfig.machine_ip
 
+      @cache_ttl = opts[:cache_ttl] || SplitConfig.cache_ttl
+      @max_cache_size = opts[:max_cache_size] || SplitConfig.max_cache_size
+
       @language = opts[:language] || 'ruby'
       @version = opts[:version] || SplitIoClient::VERSION
 
@@ -176,6 +181,9 @@ module SplitIoClient
     attr_accessor :machine_ip
     attr_accessor :machine_name
 
+    attr_accessor :cache_ttl
+    attr_accessor :max_cache_size
+
     attr_accessor :language
     attr_accessor :version
 
@@ -357,6 +365,21 @@ module SplitIoClient
       false
     end
 
+    #
+    # The default cache time to live
+    #
+    # @return [boolean]
+    def self.cache_ttl
+      5
+    end
+
+    # The default max cache size
+    #
+    # @return [boolean]
+    def self.max_cache_size
+      500
+    end
+
     #
     # custom logger of exceptions
     #

data/lib/splitclient-rb/version.rb

@@ -1,3 +1,3 @@
 module SplitIoClient
-  VERSION = '5.1.2'
+  VERSION = '5.1.3.pre.rc1'
 end

data/splitclient-rb.gemspec

@@ -46,11 +46,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '0.59.0'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'timecop'
   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 'lru_redux'
   spec.add_runtime_dependency 'net-http-persistent', '~> 2.9'
   spec.add_runtime_dependency 'redis', '>= 3.2'
   spec.add_runtime_dependency 'thread_safe', '>= 0.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splitclient-rb
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.1.3.pre.rc1
 platform: ruby
 authors:
 - Split Software
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allocation_stats
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +289,7 @@ files:
 - lib/murmurhash/murmurhash.jar
 - lib/murmurhash/murmurhash_mri.rb
 - lib/splitclient-rb.rb
+- lib/splitclient-rb/cache/adapters/cache_adapter.rb
 - lib/splitclient-rb/cache/adapters/memory_adapter.rb
 - lib/splitclient-rb/cache/adapters/memory_adapters/map_adapter.rb
 - lib/splitclient-rb/cache/adapters/memory_adapters/queue_adapter.rb
@@ -357,9 +386,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.7.6