module Trophonius::RedisManager

the RedisManager module is used to create a (single) connection to a redis store.

Public Class Methods

connect() click to toggle source
# File lib/trophonius_redis_manager.rb, line 4
def self.connect
  if Trophonius.config.redis_connection
    if ENV['REDIS_URL'] && ENV['REDIS_URL'] != ''
      @redis ||= Redis.new(url: ENV['REDIS_URL'])
    else
      @redis ||= Redis.new
    end
  end
  return nil
end
connected?() click to toggle source

Checks whether we are connected to redis

@return [Boolean] true or false depending on whether a connection to redis has been established

# File lib/trophonius_redis_manager.rb, line 50
def self.connected?
  @redis.nil? == false && @redis.connected?
end
disconnect() click to toggle source

Disconnects from redis as quickly and as silently as possible

@return [NilClass] nil

# File lib/trophonius_redis_manager.rb, line 58
def self.disconnect
  @redis.disconnect!
end
get_key(key:) click to toggle source

Get the value corresponding with the key

@param [String] key: the key to find @return [String] the value corresponding with the key

# File lib/trophonius_redis_manager.rb, line 30
def self.get_key(key:)
  connect unless connected?
  @redis.get(key)
end
key_exists?(key:) click to toggle source

Checks whether the given key exists

@param [String] key: the key to check @return [Boolean] true or false depending on whether the key exists in the redis store or not

# File lib/trophonius_redis_manager.rb, line 20
def self.key_exists?(key:)
  connect unless connected?
  !(@redis.get(key).nil? || @redis.get(key).empty?)
end
set_key(key:, value:) click to toggle source

Set the value corresponding with a key

@param [String] key: the key to store in redis @param [any] value: the value for the key @return [String] the value corresponding with the key

# File lib/trophonius_redis_manager.rb, line 41
def self.set_key(key:, value:)
  connect unless connected?
  @redis.set(key, value)
end