redcache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42b0aaf4e3410df46698c1dc6c4266a7ab085a82
+  data.tar.gz: 6168ec9abcac4a6331b313f50325d162a0cd760a
+SHA512:
+  metadata.gz: 6d1aa979354e1fcaae9126555b8a2ce34bd5529e0770958a5f3df439865f0701fb15b879b99652d79a3b1f4753acb140d986827385352e66d23b31fd44280a11
+  data.tar.gz: 00d1ba914e1c8e0facb68c26b993c0c83d2ca9c5549dd4aaea68bfe0b3fe48a4125f3023427e088dca7a722920d8fa75144665b86958a6551ba40d692d0002af

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redcache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil Middleton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Redcache
+
+A gem for caching data in Redis.
+
+This gem caches data from slow services in Redis, but ensures that the cache is
+up to date.
+
+Should the cache be cold, the result is cached.  Should the cache be warm but
+considered stale, the cache is still used, but updated subsequently via a
+threaded request, thus not blocking the original request.
+
+This gem is also able to encrypt the cached results with Fernet if required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redcache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redcache
+
+## Usage
+
+```ruby
+
+Redcache.configure do |c|
+  c.redis = $redis
+  c.secret = <some_long_hash>
+  c.encrypt = true
+end
+
+value = Redcache.cache "unique_cache_key" do
+  call_to_slow_service
+end
+```
+
+### Configuration
+
+Several configuration options are available to use that defined the behaviour of
+redcache.
+
+<table>
+  <tr>
+    <td>:redis</td>
+    <td>Connection to redis</td>
+  </tr>
+  <tr>
+    <td>:secret</td>
+    <td>If encrypting, what secret should be used.  See [Fernet](https://github.com/fernet/fernet-rb) README for more
+information</td>
+  </tr>
+  <tr>
+    <td>:encrypt</td>
+    <td>Should cached data be encrypted (boolean)</td>
+  </tr>
+  <tr>
+    <td>:skip_cache</td>
+    <td>Should the cache be skipped.  Useful in test environments (boolean)</td>
+  </tr>
+  <tr>
+    <td>:logged</td>
+    <td>Standard logger object to use for logging</td>
+  </tr>
+  <tr>
+    <td>:log_prefix</td>
+    <td>String to prefix to l2met compatible log lines</td>
+  </tr>
+  <tr>
+    <td>:cache_time</td>
+    <td>Time (in seconds) to cache data for before expiring</td>
+  </tr>
+  <tr>
+    <td>:stale_time</td>
+    <td>Time (in seconds) before cached data should be considered stale</td>
+  </tr>
+</table>
+
+## Testing
+
+Specs to come ;)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redcache/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/redcache/configuration.rb

@@ -0,0 +1,22 @@
+module Redcache
+  class Configuration
+    attr_accessor :redis
+    attr_accessor :secret
+    attr_accessor :cache_time
+    attr_accessor :stale_time
+    attr_accessor :encrypt
+    attr_accessor :skip_cache
+    attr_accessor :logger
+    attr_accessor :log_prefix
+
+    def initialize
+      @cache_time = 86400
+      @stale_time = 900
+      @encrypt = false
+      @secret = nil
+      @skip_cache = false
+      @logger = nil
+      @log_prefix = "redcache"
+    end
+  end
+end

data/lib/redcache/version.rb

@@ -0,0 +1,3 @@
+module Redcache
+  VERSION = "0.0.1"
+end

data/lib/redcache.rb

@@ -0,0 +1,125 @@
+require "redcache/version"
+require "redcache/configuration"
+
+module Redcache
+  class << self
+    attr_writer :configuration
+
+    def configure
+      yield(configuration)
+    end
+
+    def cache(redis_key, &block)
+      return block.call if skip_cache?
+      if redis_up?
+        value = read_from_cache(redis_key, block) || write_into_cache(redis_key, block)
+        return value unless value.nil?
+      else
+        block.call
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def redis
+      configuration.redis
+    end
+
+    def redis_up?
+      begin
+        redis.ping
+      rescue Redis::CannotConnectError
+        puts "Redis is DOWN! :shitsonfire:"
+        return false
+      end
+      return true
+    end
+
+    def with_redis(&block)
+      block.call if redis_up?
+    end
+
+    def cache_time
+      configuration.cache_time
+    end
+
+    def stale_time
+      configuration.stale_time
+    end
+
+    def skip_cache?
+      configuration.skip_cache
+    end
+
+    def read_from_cache(redis_key, block)
+      value = get_value(redis_key)
+      value.nil? ? log("cache.miss") : log("cache.hit")
+      refresh_cache(redis_key, block) if key_stale?(redis_key) && !value.nil?
+      return value
+    end
+
+    def test?
+      ENV["RACK_ENV"] == 'test'
+    end
+
+    def refresh_cache(redis_key, block)
+      log("cache.stale_refresh")
+      Thread.new do
+        write_into_cache(redis_key, block)
+      end
+    end
+
+    def write_into_cache(redis_key, block)
+      json = block.call
+      with_redis do
+        log("cache.write")
+        set_value(redis_key, json)
+      end
+      json
+    end
+
+    def key_stale?(redis_key)
+      ttl = redis.ttl(redis_key)
+      return  ttl < (configuration.cache_time - configuration.stale_time)
+    end
+
+    def get_value(key)
+      decrypt redis.get(key)
+    end
+
+    def set_value(key, value)
+      redis.setex key, configuration.cache_time, encrypt(value)
+    end
+
+    def encrypt(value)
+      return value unless encrypt?
+      Fernet.generate(secret, MultiJson.encode(value))
+    end
+
+    def encrypt?
+      configuration.encrypt
+    end
+
+    def decrypt(value)
+      return nil if value.nil?
+      return value unless encrypt?
+      verifier = Fernet.verifier(secret, value)
+      return MultiJson.load(verifier.message) if verifier.valid?
+      return nil
+    end
+
+    def secret
+      configuration.secret
+    end
+
+    def log(str)
+      configuration.logger.log(log_prefix(str) => 1)
+    end
+
+    def log_prefix(str)
+      [configuration.log_prefix, str].join(".")
+    end
+  end
+end

data/redcache.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redcache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redcache"
+  spec.version       = Redcache::VERSION
+  spec.authors       = ["Neil Middleton"]
+  spec.email         = ["neil@neilmiddleton.com"]
+  spec.summary       = %q{A gem for caching values in redis and encrypting them}
+  spec.description   = %q{A wrapper for Redis, for caching and encryption with Fernet}
+  spec.homepage      = "http://www.neilmiddleton.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "fakeredis", "~> 0.5"
+  spec.add_development_dependency "pliny", "~> 0.0"
+
+  spec.add_dependency "fernet", "~> 2.1"
+  spec.add_dependency "redis", "~> 3.1"
+  spec.add_dependency "multi_json", "~> 1.10"
+end

data/spec/redcache_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+Redcache.configure do |c|
+  c.redis = Redis.new
+  c.logger = Pliny
+end
+
+class Dummy
+  def self.run
+    Redcache.cache "foo" do
+      get_value
+    end
+  end
+
+  def self.get_value
+    "bar"
+  end
+end
+
+describe Redcache do
+
+  context 'when skipping caching' do
+    before do
+      allow(Redcache.configuration).to receive(:skip_cache){true}
+    end
+    it 'does not use the cache' do
+      expect(Redcache).to_not receive(:read_from_cache)
+      Dummy.run
+    end
+  end
+
+  context 'when caching' do
+    before do
+      allow(Redcache.configuration).to receive(:skip_cache){false}
+    end
+
+    it 'uses the cached' do
+      expect(Redcache).to receive(:read_from_cache){ {} }
+      Dummy.run
+    end
+
+    it 'triggers a cache write if the cache is cold' do
+      allow(Redcache).to receive(:read_from_cache){ nil }
+      expect(Redcache).to receive(:write_into_cache) { "" }
+      Dummy.run
+    end
+
+    it 'skips cache when redis is down' do
+      allow(Redcache).to receive(:redis_up?){ false }
+      expect(Redcache).to_not receive(:read_from_cache)
+      expect(Dummy).to receive(:get_value)
+      Dummy.run
+    end
+
+    it 'triggers a cache refresh with a stale warm cache' do
+      allow(Redcache).to receive(:key_stale?){ true }
+      allow(Redcache).to receive(:get_value){ "" }
+      expect(Redcache).to receive(:refresh_cache).once
+      Dummy.run
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+Bundler.require
+
+require 'redcache'
+require 'redis'
+require 'fakeredis'
+require 'pliny'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: redcache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neil Middleton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pliny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: fernet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: A wrapper for Redis, for caching and encryption with Fernet
+email:
+- neil@neilmiddleton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redcache.rb
+- lib/redcache/configuration.rb
+- lib/redcache/version.rb
+- redcache.gemspec
+- spec/redcache_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.neilmiddleton.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for caching values in redis and encrypting them
+test_files:
+- spec/redcache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: