cache_store_redis 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ebd228f9ba985300f08b1a31e39ad8c0e9e3bb9
-  data.tar.gz: a73b3b3aa4a049002e406d13529c6f3a0ee18828
+  metadata.gz: 27eeddfa958f35d2bace14b86093d3dfab8c2a23
+  data.tar.gz: ac17f9dd859655f8493f8d4abc9e7f98223c91e1
 SHA512:
-  metadata.gz: eb2335cd65d257aa940009102d88f420febc1e0246c29b0da6a2c4ca7fe5720ded70f23a66b7bddc5d74dc7ba46466fa95d5b16a9fff00fe02079088ec72085c
-  data.tar.gz: 80563955310c6f6ce12f867a690adeaf586e0950eabef2be3b4048e8bc016c8c08a33af97300a907228114cd23d25f33525d93e0d470b678957822ae68d92bc4
+  metadata.gz: 7f04c7cc83c4d9fa6a8b49b443029909a56d6fb2760f387aaafaae6af9745309ac7d5081e546d39edaa2a2329ab50a2387d4bde5c6e7c73cdb40eb27e6d27892
+  data.tar.gz: a78cda144717405ffe7987e781afadb76cc4d093af26f122851dadb99a0dcd93842e9f271161b5dfd13154ed61defeaba27c3082dc042e7003f23f061996d10a

data/lib/cache_store_redis/optional_redis_cache_store.rb

@@ -0,0 +1,97 @@
+require 'logger'
+
+# This class is used to define a redis cache store that logs failures as warnings but does not raise errors for
+# cache connections
+class OptionalRedisCacheStore
+  def initialize(namespace: nil, config: nil, logger: nil)
+    @cache_store = RedisCacheStore.new(namespace, config)
+    @logger = logger || Logger.new(STDOUT)
+  end
+  
+  def redis_store
+    @cache_store
+  end
+
+  # This method is called to configure the connection to the cache store.
+  def configure(
+    host = 'localhost',
+    port = 6379,
+    db = 'default',
+    password = nil,
+    driver: nil,
+    url: nil,
+    connect_timeout: 0.5,
+    read_timeout: 1,
+    write_timeout: 0.5)
+    redis_store.configure(
+      host,
+      port,
+      db,
+      password,
+      driver: driver,
+      url: url,
+      connect_timeout: connect_timeout,
+      read_timeout: read_timeout,
+      write_timeout: write_timeout
+    )
+  end
+
+  def optional_get(key, expires_in = 0)
+    redis_store.get(key, expires_in)
+  rescue => e
+    @logger.error(
+      "[#{self.class}] - An error occurred requesting data from the cache. " \
+"Key: #{key} | Error: #{e.message} | Backtrace: #{e.backtrace}"
+    )
+    nil
+  end
+
+  def get(key, expires_in = 0, &block)
+    value = optional_get(key, expires_in)
+
+    if value.nil? && block_given?
+      value = yield
+      set(key, value, expires_in)
+    end
+
+    value
+  end
+
+  def set(key, value, expires_in = 0)
+    redis_store.set(key, value, expires_in)
+  rescue => e
+    @logger.error(
+      "[#{self.class}] - An error occurred storing data in the cache. " \
+"Key: #{key} | Error: #{e.message} | Backtrace: #{e.backtrace}"
+    )
+  end
+
+  def remove(key)
+    redis_store.remove(key)
+  rescue => e
+    @logger.error(
+      "[#{self.class}] - An error occurred removing data from the cache. " \
+"Key: #{key} | Error: #{e.message} | Backtrace: #{e.backtrace}"
+    )
+  end
+
+  def exist?(key)
+    redis_store.exist?(key)
+  rescue => e
+    @logger.error(
+      "[#{self.class}] - An error occurred checking if a key exists in the cache. " \
+"Key: #{key} | Error: #{e.message} | Backtrace: #{e.backtrace}"
+    )
+    false
+  end
+
+  def ping
+    redis_store.ping
+  rescue => e
+    @logger.error(
+      "[#{self.class}] - An error occurred checking pinging the cache. " \
+"Error: #{e.message} | Backtrace: #{e.backtrace}"
+    )
+    false
+  end
+end

data/lib/cache_store_redis/redis_cache_store.rb

@@ -0,0 +1,209 @@
+# This class is used to implement a redis cache store.
+class RedisCacheStore
+  def initialize(namespace = nil, config = nil)
+    unless RUBY_PLATFORM == 'java'
+      require 'oj'
+    end
+
+    @namespace = namespace
+    @config = config
+    @queue = Queue.new
+
+    @connections_created = 0
+    @connections_in_use = 0
+    @mutex = Mutex.new
+    @enable_stats = false
+  end
+
+  def enable_stats=(value)
+    @enable_stats = value
+  end
+
+  def increment_created_stat
+    @mutex.synchronize do
+      @connections_created += 1
+    end
+  end
+
+  def increment_using_stat
+    @mutex.synchronize do
+      @connections_in_use += 1
+    end
+  end
+
+  def decrement_using_stat
+    @mutex.synchronize do
+      @connections_in_use -= 1
+    end
+  end
+
+  # This method is called to configure the connection to the cache store.
+  def configure(host = 'localhost',
+                port = 6379,
+                db = 'default',
+                password = nil,
+                driver: nil,
+                url: nil,
+                connect_timeout: 0.5,
+                read_timeout: 1,
+                write_timeout: 0.5)
+    if !url.nil?
+      @config = {}
+      @config[:url] = url
+      @config[:db] = db
+    else
+      @config = { host: host, port: port, db: db }
+    end
+
+    @config[:password] = password unless password.nil?
+    @config[:driver] = driver unless driver.nil?
+
+    @config[:connect_timeout] = connect_timeout
+    @config[:read_timeout] = read_timeout
+    @config[:write_timeout] = write_timeout
+  end
+
+  def fetch_client
+    begin
+      @queue.pop(true)
+    rescue
+      increment_created_stat
+      Redis.new(@config)
+    end
+  end
+
+  def clean
+    while @queue.length.positive?
+      client = @queue.pop(true)
+      client.close
+    end
+  end
+
+  def log_stats
+    return unless @enable_stats == true
+    S1Logging.logger.debug do
+      "[#{self.class}] - REDIS Connection Stats. Process: #{Process.pid} | " \
+"Created: #{@connections_created} | Pending: #{@queue.length} | In use: #{@connections_in_use}"
+    end
+  end
+
+  def with_client
+    log_stats
+    begin
+      client = fetch_client
+      increment_using_stat
+      log_stats
+      yield client
+    ensure
+      @queue.push(client)
+      decrement_using_stat
+      log_stats
+    end
+  end
+
+  # This method is called to set a value within this cache store by it's key.
+  #
+  # @param key [String] This is the unique key to reference the value being set within this cache store.
+  # @param value [Object] This is the value to set within this cache store.
+  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
+  def set(key, value, expires_in = 0)
+    k = build_key(key)
+
+    v = if value.nil? || (value.is_a?(String) && value.strip.empty?)
+      nil
+    else
+      serialize(value)
+    end
+
+    with_client do |client|
+      client.multi do
+        client.set(k, v)
+
+        client.expire(k, expires_in) if expires_in.positive?
+      end
+    end
+  end
+
+  # This method is called to get a value from this cache store by it's unique key.
+  #
+  # @param key [String] This is the unique key to reference the value to fetch from within this cache store.
+  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
+  # (This is used in conjunction with the block to hydrate the cache key if it is empty.)
+  # @param &block [Block] This block is provided to hydrate this cache store with the value for the request key
+  # when it is not found.
+  # @return [Object] The value for the specified unique key within the cache store.
+  def get(key, expires_in = 0, &block)
+    k = build_key(key)
+
+    value = with_client do |client|
+      client.get(k)
+    end
+
+    if !value.nil? && value.strip.empty?
+      value = nil
+    else
+      value = deserialize(value) unless value.nil?
+    end
+
+    if value.nil? && block_given?
+      value = yield
+      set(key, value, expires_in)
+    end
+
+    value
+  end
+
+  # This method is called to remove a value from this cache store by it's unique key.
+  #
+  # @param key [String] This is the unique key to reference the value to remove from this cache store.
+  def remove(key)
+    with_client do |client|
+      client.del(build_key(key))
+    end
+  end
+
+  # This method is called to check if a value exists within this cache store for a specific key.
+  #
+  # @param key [String] This is the unique key to reference the value to check for within this cache store.
+  # @return [Boolean] True or False to specify if the key exists in the cache store.
+  def exist?(key)
+    with_client do |client|
+      client.exists(build_key(key))
+    end
+  end
+
+  # Ping the cache store.
+  #
+  # @return [String] `PONG`
+  def ping
+    with_client do |client|
+      client.ping
+    end
+  end
+
+  private
+
+  def serialize(object)
+    if RUBY_PLATFORM == 'java'
+      Marshal::dump(object)
+    else
+      Oj.dump(object)
+    end
+  end
+
+  def deserialize(object)
+    if RUBY_PLATFORM == 'java'
+      Marshal::load(object)
+    else
+      Oj.load(object)
+    end
+  end
+
+  def build_key(key)
+    if !@namespace.nil?
+      @namespace + ':' + key.to_s
+    else
+      key.to_s
+    end
+  end
+end

data/lib/cache_store_redis/version.rb

@@ -1,3 +1,3 @@
 module CacheStoreRedis
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

data/lib/cache_store_redis.rb

@@ -5,212 +5,5 @@ require 'cache_store_redis/version'
 require 'redis'
 require 'securerandom'
 
-# This class is used to implement a redis cache store.
-class RedisCacheStore
-  def initialize(namespace = nil, config = nil)
-    unless RUBY_PLATFORM == 'java'
-      require 'oj'
-    end
-
-    @namespace = namespace
-    @config = config
-    @queue = Queue.new
-
-    @connections_created = 0
-    @connections_in_use = 0
-    @mutex = Mutex.new
-    @enable_stats = false
-  end
-
-  def enable_stats=(value)
-    @enable_stats = value
-  end
-
-  def increment_created_stat
-    @mutex.synchronize do
-      @connections_created += 1
-    end
-  end
-
-  def increment_using_stat
-    @mutex.synchronize do
-      @connections_in_use += 1
-    end
-  end
-
-  def decrement_using_stat
-    @mutex.synchronize do
-      @connections_in_use -= 1
-    end
-  end
-
-  # This method is called to configure the connection to the cache store.
-  def configure(host = 'localhost',
-                port = 6379,
-                db = 'default',
-                password = nil,
-                driver: nil,
-                url: nil,
-                connect_timeout: 0.5,
-                read_timeout: 1,
-                write_timeout: 0.5)
-    if !url.nil?
-      @config = {}
-      @config[:url] = url
-      @config[:db] = db
-    else
-      @config = { host: host, port: port, db: db }
-    end
-
-    @config[:password] = password unless password.nil?
-    @config[:driver] = driver unless driver.nil?
-
-    @config[:connect_timeout] = connect_timeout
-    @config[:read_timeout] = read_timeout
-    @config[:write_timeout] = write_timeout
-  end
-
-  def fetch_client
-    begin
-      @queue.pop(true)
-    rescue
-      increment_created_stat
-      Redis.new(@config)
-    end
-  end
-
-  def clean
-    while @queue.length.positive?
-      client = @queue.pop(true)
-      client.close
-    end
-  end
-
-  def log_stats
-    return unless @enable_stats == true
-    S1Logging.logger.debug do
-      "[#{self.class}] - REDIS Connection Stats. Process: #{Process.pid} | " \
-"Created: #{@connections_created} | Pending: #{@queue.length} | In use: #{@connections_in_use}"
-    end
-  end
-
-  def with_client
-    log_stats
-    begin
-      client = fetch_client
-      increment_using_stat
-      log_stats
-      yield client
-    ensure
-      @queue.push(client)
-      decrement_using_stat
-      log_stats
-    end
-  end
-
-  # This method is called to set a value within this cache store by it's key.
-  #
-  # @param key [String] This is the unique key to reference the value being set within this cache store.
-  # @param value [Object] This is the value to set within this cache store.
-  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
-  def set(key, value, expires_in = 0)
-    k = build_key(key)
-
-    v = if value.nil? || (value.is_a?(String) && value.strip.empty?)
-          nil
-        else
-          serialize(value)
-        end
-
-    with_client do |client|
-      client.multi do
-        client.set(k, v)
-
-        client.expire(k, expires_in) if expires_in.positive?
-      end
-    end
-  end
-
-  # This method is called to get a value from this cache store by it's unique key.
-  #
-  # @param key [String] This is the unique key to reference the value to fetch from within this cache store.
-  # @param expires_in [Integer] This is the number of seconds from the current time that this value should expire.
-  # (This is used in conjunction with the block to hydrate the cache key if it is empty.)
-  # @param &block [Block] This block is provided to hydrate this cache store with the value for the request key
-  # when it is not found.
-  # @return [Object] The value for the specified unique key within the cache store.
-  def get(key, expires_in = 0, &block)
-    k = build_key(key)
-
-    value = with_client do |client|
-      client.get(k)
-    end
-
-    if !value.nil? && value.strip.empty?
-      value = nil
-    else
-      value = deserialize(value) unless value.nil?
-    end
-
-    if value.nil? && block_given?
-      value = yield
-      set(key, value, expires_in)
-    end
-
-    value
-  end
-
-  # This method is called to remove a value from this cache store by it's unique key.
-  #
-  # @param key [String] This is the unique key to reference the value to remove from this cache store.
-  def remove(key)
-    with_client do |client|
-      client.del(build_key(key))
-    end
-  end
-
-  # This method is called to check if a value exists within this cache store for a specific key.
-  #
-  # @param key [String] This is the unique key to reference the value to check for within this cache store.
-  # @return [Boolean] True or False to specify if the key exists in the cache store.
-  def exist?(key)
-    with_client do |client|
-      client.exists(build_key(key))
-    end
-  end
-
-  # Ping the cache store.
-  #
-  # @return [String] `PONG`
-  def ping
-    with_client do |client|
-      client.ping
-    end
-  end
-
-  private
-
-  def serialize(object)
-    if RUBY_PLATFORM == 'java'
-      Marshal::dump(object)
-    else
-      Oj.dump(object)
-    end
-  end
-
-  def deserialize(object)
-    if RUBY_PLATFORM == 'java'
-      Marshal::load(object)
-    else
-      Oj.load(object)
-    end
-  end
-
-  def build_key(key)
-    if !@namespace.nil?
-      @namespace + ':' + key.to_s
-    else
-      key.to_s
-    end
-  end
-end
+require_relative 'cache_store_redis/redis_cache_store'
+require_relative 'cache_store_redis/optional_redis_cache_store'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_store_redis
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,8 @@ files:
 - bin/console
 - bin/setup
 - lib/cache_store_redis.rb
+- lib/cache_store_redis/optional_redis_cache_store.rb
+- lib/cache_store_redis/redis_cache_store.rb
 - lib/cache_store_redis/version.rb
 homepage: https://github.com/vaughanbrittonsage/cache_store
 licenses:
@@ -111,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: This is the redis cache_store implementation.