cache_store_redis 0.5.5-java → 2.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc6c2e6bb1e88dd36e7d6ea2075be4ecb7fe0dfdd9d18bc101417ea00d57daa
-  data.tar.gz: 6c83cf91258353f0843c8156ae602dcffe25ea7125e40cfa6e7457cefe0ffd65
+  metadata.gz: f3c336fa1a5395bdaac8ac631081f502905b13f1fb171d95465e8a0bc26abd57
+  data.tar.gz: bfd8b276a84a795cebc0699d1b893f561b26e3c8568d9db92746cc50724f7d46
 SHA512:
-  metadata.gz: 33f7b9366d8d1839009c62f582a1a275643a27f7d1d4d5a24444fe520dde352b7f08fd6f4cee0ddeaad0ab12677c1db54de3bce82b166069d53d166868f8ba2a
-  data.tar.gz: 9ab7c3a42c14fcd1c08afa0fc960d6b39d3b7a4d2eddb7447f4d6f941be66e7f054d5cecc5f8a828fde1fddafa251d319cd600d4d28c2d7b54e399dbf24f583a
+  metadata.gz: c7c2d3341798bebd1c89626c0a7c6b901092cd55c09749453c4cf354c453eaebc26008cc222079c09349e09bac4f543781370c89229efeca5a2b9c719c4de7cf
+  data.tar.gz: 579efc76097b5f9cea183bf964cb5b0c50a9c5288d22240d01e93361dafe7843e31c6960c7168d30615617303593d6e84807d03366f43e5f6291929623730eec

data/lib/cache_store_redis/optional_redis_cache_store.rb

@@ -0,0 +1,100 @@
+# 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
+    handle_error(e, 'requesting data from the cache')
+    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
+    handle_error(e, 'storing data in the cache')
+  end
+
+  def remove(key)
+    redis_store.remove(key)
+  rescue => e
+    handle_error(e, 'removing data from the cache')
+  end
+
+  def exist?(key)
+    redis_store.exist?(key)
+  rescue => e
+    handle_error(e, 'checking if a key exists in the cache')
+    false
+  end
+
+  def ping
+    redis_store.ping
+  rescue => e
+    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
+
+  alias read get
+  alias write set
+  alias delete remove
+
+  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

@@ -0,0 +1,172 @@
+# This class is used to implement a redis cache store.
+class RedisCacheStore
+  # Default expiry time if not provided. (1 hour)
+  DEFAULT_TTL = 3_600
+
+  def initialize(namespace = nil, config = nil)
+    unless RUBY_PLATFORM == 'java'
+      require 'oj'
+    end
+
+    @connection_pool = RedisConnectionPool.new(namespace, config)
+
+    @namespace = namespace
+    @config = config
+
+    @connections_created = 0
+    @connections_in_use = 0
+    @mutex = Mutex.new
+    @enable_stats = false
+  end
+
+  attr_reader :connection_pool
+
+  # This method is called to configure the connection to the cache store.
+  def configure(host = 'localhost',
+                port = 6379,
+                db = 0,
+                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
+    connection_pool.config = @config
+  end
+
+  def clean
+    connection_pool.shutdown
+  end
+  alias shutdown clean
+
+  def with_client(&block)
+    connection_pool.with_connection(&block)
+  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 = DEFAULT_TTL)
+    k = build_key(key)
+
+    v = if value.nil? || (value.is_a?(String) && value.strip.empty?)
+          nil
+        else
+          serialize(value)
+        end
+
+    expiry_int = Integer(expires_in)
+    expire_value = expiry_int.positive? ? expiry_int : Integer(DEFAULT_TTL)
+
+    with_client do |client|
+      client.multi do
+        client.set(k, v)
+
+        client.expire(k, expire_value)
+      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)
+    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)).zero?
+    end
+  end
+
+  # Ping the cache store.
+  #
+  # @return [String] `PONG`
+  def ping
+    with_client do |client|
+      client.ping
+    end
+  end
+
+  alias write set
+  alias read get
+  alias delete remove
+
+  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/redis_connection.rb

@@ -0,0 +1,29 @@
+class RedisConnection
+  attr_accessor :created
+  attr_accessor :client
+
+  def initialize(config)
+    self.client = Redis.new(config)
+    self.created = Time.now
+  end
+
+  # This method is called to determine if this connection has been open for longer than the keep alive timeout or not.
+  def expired?
+    return false if self.created.nil?
+    Time.now >= (self.created + keep_alive_timeout)
+  end
+
+  def open
+    self.created = Time.now if self.created.nil?
+  end
+
+  def close
+    self.client.close
+    self.created = nil
+  end
+
+  # This method is called to get the keep alive timeout value to use for this connection.
+  def keep_alive_timeout
+    Float(ENV['REDIS_KEEP_ALIVE_TIMEOUT'] ||  30)
+  end
+end

data/lib/cache_store_redis/redis_connection_pool.rb

@@ -0,0 +1,84 @@
+# This class is used to define a pool of re-usable redis connections.
+class RedisConnectionPool
+  attr_accessor :config
+
+  def initialize(namespace = nil, config = nil)
+    @namespace = namespace
+    @config = config
+    @queue = Queue.new
+    @connections = []
+    @mutex = Mutex.new
+    @monitor_thread = Thread.new do
+      loop do
+        sleep(1)
+        @mutex.synchronize do
+          connections.select { |con| con.expired? }.each do |con|
+            con.close
+          end
+        end
+      end
+    end
+  end
+
+  # This method is called to get the namespace for redis keys.
+  def namespace
+    @namespace
+  end
+
+  # This method is called to get the idle connection queue for this pool.
+  def queue
+    @queue
+  end
+
+  # This method is called to fetch a connection from the queue or create a new connection if no idle connections
+  # are available.
+  def fetch_connection
+    queue.pop(true)
+  rescue
+    RedisConnection.new(config)
+  end
+
+  # This method is called to checkout a connection from the pool before use.
+  def check_out
+    connection = nil
+    @mutex.synchronize do
+      connection = fetch_connection
+      connections.delete(connection)
+      connection.open
+    end
+    connection
+  end
+
+  # This method is called to checkin a connection to the pool after use.
+  def check_in(connection)
+    if connection.expired?
+      connection.close
+    end
+    @mutex.synchronize do
+      connections.push(connection)
+      queue.push(connection)
+    end
+  end
+
+  # This method is called to use a connection from this pool.
+  def with_connection
+    connection = check_out
+    return yield connection.client
+  ensure
+    check_in(connection)
+  end
+
+  # This method is called to get an array of idle connections in this pool.
+  def connections
+    @connections
+  end
+
+  def shutdown
+    connections.each do |con|
+      con.client.close
+    end
+    @connections = []
+    @monitor_thread.kill
+    @queue = Queue.new
+  end
+end

data/lib/cache_store_redis/version.rb

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

data/lib/cache_store_redis.rb

@@ -4,213 +4,9 @@ require 'thread'
 require 'cache_store_redis/version'
 require 'redis'
 require 'securerandom'
+require 'logger'
 
-# 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_connection'
+require_relative 'cache_store_redis/redis_connection_pool'
+require_relative 'cache_store_redis/redis_cache_store'
+require_relative 'cache_store_redis/optional_redis_cache_store'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cache_store_redis
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 2.3.0
 platform: java
 authors:
 - vaughanbrittonsage
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -31,8 +31,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
   name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -41,17 +41,45 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   name: rspec
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: simplecov
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: timecop
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -59,8 +87,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: redis
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,8 +104,12 @@ 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/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: {}
@@ -96,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: This is the redis cache_store implementation.