cache_store_redis 1.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be38ccc0055190deb7d7285fa68c0a82c8d5598e
-  data.tar.gz: 43d959f9ac031653d52f717186bd3b7abddec1a5
+SHA256:
+  metadata.gz: edb347a21c9194be5a503cd49269450999464c8b6b9e0d76301db09378070877
+  data.tar.gz: 91c4895a3b68615a107401357bb851a2228b7f3fcbe0cf539764bc53e10aff43
 SHA512:
-  metadata.gz: 1f90ae3a590d10b6034df72719966252ef1caf6b0b14a1564b5fb53a22cb54c24c989f583d04a069cb3910973425cfbcf30b9d9d37f2b30a2175630485bbb87a
-  data.tar.gz: 78a73c402e500a51c9d3aceb080de57e7daf40ef80fce5b9b6cf3166b87531ec72c58dd95c5c37fda4162164f311bd4cee3e5a239a28910daf0ce2377a62c362
+  metadata.gz: 3baf73be272515d4a80e2e05dc3adec633187c5066571d7e00efb9087814d442afed6257d213cf67dba855f5f3c3501ab369232c07a3fdabd8397684f4575817
+  data.tar.gz: 3c8363c6745d33f3f782c3ee87cb0d2a54b7bd6c63e5bfc26ebabf92ba91a13e0128d3878fdc724cc53a79cc44ca174723d71591deaf856401b181abe7a2d392

data/lib/cache_store_redis.rb

@@ -4,6 +4,8 @@ require 'thread'
 require 'cache_store_redis/version'
 require 'redis'
 require 'securerandom'
+require 'oj'
+require 'logger'
 
 require_relative 'cache_store_redis/redis_connection'
 require_relative 'cache_store_redis/redis_connection_pool'

data/lib/cache_store_redis/optional_redis_cache_store.rb

@@ -1,5 +1,3 @@
-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
@@ -7,7 +5,7 @@ class OptionalRedisCacheStore
     @cache_store = RedisCacheStore.new(namespace, config)
     @logger = logger || Logger.new(STDOUT)
   end
-  
+
   def redis_store
     @cache_store
   end
@@ -39,10 +37,7 @@ class OptionalRedisCacheStore
   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}"
-    )
+    handle_error(e, 'requesting data from the cache')
     nil
   end
 
@@ -60,38 +55,42 @@ class OptionalRedisCacheStore
   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}"
-    )
+    handle_error(e, 'storing data in the cache')
   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}"
-    )
+    handle_error(e, 'removing data from the cache')
   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}"
-    )
+    handle_error(e, 'checking if a key exists in the cache')
     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}"
-    )
+    handle_error(e, 'pinging the cache')
     false
   end
+
+  def shutdown
+    redis_store.shutdown
+  rescue => e
+    handle_error(e, 'shutting down the connection pool')
+    false
+  end
+
+  private
+
+  def handle_error(ex, msg)
+    @logger.error do
+      "[#{self.class}] - An error occurred #{msg}. " \
+      "Error: #{ex.message} | Backtrace: #{ex.backtrace}"
+    end
+  end
 end

data/lib/cache_store_redis/redis_cache_store.rb

@@ -1,11 +1,10 @@
 # This class is used to implement a redis cache store.
 class RedisCacheStore
-  def initialize(namespace = nil, config = nil)
-    @connection_pool = RedisConnectionPool.new(config)
+  # Default expiry time if not provided. (1 hour)
+  DEFAULT_TTL = 3_600
 
-    unless RUBY_PLATFORM == 'java'
-      require 'oj'
-    end
+  def initialize(namespace = nil, config = nil)
+    @connection_pool = RedisConnectionPool.new(namespace, config)
 
     @namespace = namespace
     @config = config
@@ -63,7 +62,7 @@ class RedisCacheStore
   # @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 = 3_600)
+  def set(key, value, expires_in = DEFAULT_TTL)
     k = build_key(key)
 
     v = if value.nil? || (value.is_a?(String) && value.strip.empty?)
@@ -72,11 +71,14 @@ class RedisCacheStore
       serialize(value)
     end
 
+    expiry_int = Integer(expires_in)
+    expire_value = expiry_int.positive? ? expiry_int : DEFAULT_TTL
+
     with_client do |client|
       client.multi do
         client.set(k, v)
 
-        client.expire(k, expires_in) if expires_in.positive?
+        client.expire(k, expire_value)
       end
     end
   end
@@ -141,19 +143,11 @@ class RedisCacheStore
   private
 
   def serialize(object)
-    if RUBY_PLATFORM == 'java'
-      Marshal::dump(object)
-    else
-      Oj.dump(object)
-    end
+    Oj.dump(object)
   end
 
   def deserialize(object)
-    if RUBY_PLATFORM == 'java'
-      Marshal::load(object)
-    else
-      Oj.load(object)
-    end
+    Oj.load(object)
   end
 
   def build_key(key)

data/lib/cache_store_redis/version.rb

@@ -1,3 +1,3 @@
 module CacheStoreRedis
-  VERSION = '1.0.0'
+  VERSION = '2.1.1'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cache_store_redis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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: redis
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +123,7 @@ files:
 - lib/cache_store_redis/redis_connection.rb
 - lib/cache_store_redis/redis_connection_pool.rb
 - lib/cache_store_redis/version.rb
-homepage: https://github.com/vaughanbrittonsage/cache_store
+homepage: https://github.com/sage/cache_store
 licenses:
 - MIT
 metadata: {}
@@ -114,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This is the redis cache_store implementation.