cache_store_redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92f703da03a8da304163a24e31b71fe1379736af
+  data.tar.gz: d683eefcaec661c61fbf96b8f39a3c523b8ebf91
+SHA512:
+  metadata.gz: 7a5d9f6ad0c5be2f20be8f1f7570a609aad4dd466d39b8199111e962c5cfb77df79d0fb69d964cabadd3083d2cf9c11cfd6b2b3aab8b04cce435c0d057b9caf1
+  data.tar.gz: 0ce6f8ba58c4bf58d7b25b68d2e7c863eb93916a98d7477f58a029e924ee9314f950d481885486dec2ec780ca6ec002d9837935e73d1f3a7b4905dd6994ae6a6

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cache_store"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/cache_store_redis/version.rb

@@ -0,0 +1,3 @@
+module CacheStoreRedis
+  VERSION = "0.1.0"
+end

data/lib/cache_store_redis.rb

@@ -0,0 +1,96 @@
+require "cache_store_redis/version"
+require 'redis'
+require 'oj'
+
+#This class is used to implement a redis cache store.
+#This class is used for interacting with a redis based cache store.
+class RedisCacheStore
+
+  def initialize(namespace = nil)
+    @namespace = namespace
+    @client = Redis.new
+  end
+
+  #This method is called to configure the connection to the cache store.
+  def configure(host = 'localhost', port = 6379, db = 'default', password = nil)
+    config = { :host => host, :port => port, :db => db }
+    if password != nil
+      config[:password] = password
+    end
+    @client = Redis.new(config)
+  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)
+    v = nil
+    k = build_key(key)
+
+    if value != nil
+      v = Oj.dump(value)
+    end
+
+    @client.set(k, v)
+
+    if expires_in > 0
+      @client.expire(k, expires_in)
+    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 = @client.get(k)
+    value = Oj.load(value) unless value == nil
+
+    if value.nil? && block_given?
+      value = yield
+      set(k, value, expires_in)
+    end
+
+    return 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)
+
+    @client.del(build_key(key))
+
+  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)
+
+    @client.exists(build_key(key))
+
+  end
+
+  private
+
+  def build_key(key)
+    k = ''
+    if @namespace != nil
+      k = @namespace + ':' + key.to_s
+    elsif
+      k = key.to_s
+    end
+    k
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: cache_store_redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vaughanbrittonsage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
+    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: oj
+  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'
+description: This is the redis cache_store implementation.
+email:
+- vaughan.britton@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- lib/cache_store_redis.rb
+- lib/cache_store_redis/version.rb
+homepage: https://github.com/vaughanbrittonsage/cache_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: This is the redis cache_store implementation.
+test_files: []
+has_rdoc: