greencache 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd924fd562c22233595cde3eca25cdd69da88f22
-  data.tar.gz: b9e4e115ba90713299eafcb38fa6a300b37a9370
+  metadata.gz: e4c83976dd73945a021cc5c23a22c16e6654771e
+  data.tar.gz: 60b7fedbe8db7abb295d2e67b29c5d80b0e3f32b
 SHA512:
-  metadata.gz: ceb54a296bac09558022ec22c29ccb91ead6de930055d7726c778835e3cb9bc79834d2fa141f0ef92437558a058b9e0cec14f876308460b460a4c73429cf09f3
-  data.tar.gz: 1fe8b49123c5a006b232278d3547d6387bf9def0a708d8d6ed9523504ea53b4e2aecd1a2936654a2f30d086836ab720d1f195332ef5b6328b23ed81963f747a6
+  metadata.gz: ce7746c74b41b9b5ad7ca8441a77313d5ca6f72877d9e5ad75b98b0dec68a94cead40d0fc094d958e119e26355f56bbd5df99467632efd890ac2de0d73fc009f
+  data.tar.gz: af8df99f8ee8eb5d14af40058dfc4d43db1bf50cc15ccf6613c81114029b9409a1e81ea49a9722dd1163ad2e262dba288895b52b96c85dd03275cffb7abd4f18

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 
 ```ruby
 
-GreenCache.configure do |c|
+Greencache.configure do |c|
   c.redis = $redis
   c.secret = <some_long_hash>
   c.encrypt = true

data/greencache.gemspec

@@ -22,9 +22,8 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_dependency "multi_json", "~> 1.9", ">= 1.9.3"
 end

data/lib/greencache/configuration.rb

@@ -18,5 +18,18 @@ module Greencache
       @logger = nil
       @log_prefix = "greencache"
     end
+
+    def to_hash
+      {
+        cache_time: cache_time,
+        encrypt:    encrypt,
+        secret:     secret,
+        skip_cache: skip_cache,
+        silent:     silent,
+        logger:     logger,
+        log_prefix: log_prefix,
+        redis:      redis
+      }
+    end
   end
 end

data/lib/greencache/version.rb

@@ -1,3 +1,3 @@
 module Greencache
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/greencache.rb

@@ -7,6 +7,7 @@ Fernet::Configuration.run do |config|
 end
 
 module Greencache
+  class CacheMiss < RuntimeError; end
   class << self
     attr_writer :configuration
 
@@ -14,46 +15,65 @@ module Greencache
       yield(configuration)
     end
 
-    def cache(redis_key, &block)
-      return block.call if skip_cache? || !redis_up?
-      value = read_from_cache(redis_key)
-      return value if value
+    def cache(redis_key, config = {}, &block)
+      config = merge_config(config)
+      return block.call if config[:skip_cache] || !redis_up?
+      read_from_cache!(redis_key, config)
+    rescue CacheMiss
       value = block.call
-      write_into_cache(redis_key, value)
+      write_into_cache(redis_key, value, config)
       value
     end
 
-    def read_from_cache(redis_key, &block)
-      value = get_value(redis_key)
-      value.nil? ? log("cache.miss", redis_key) : log("cache.hit", redis_key)
-      return value
+    private def read_from_cache!(redis_key, config)
+      value = get_value!(redis_key, config)
+      log("cache.hit", redis_key, config)
+      value
+    rescue CacheMiss
+      log("cache.miss", redis_key, config)
+      raise
+    end
+
+    def read_from_cache
+      read_from_cache!(redis_key)
+    rescue CacheMiss
     end
 
-    def write_into_cache(redis_key, value)
+    def write_into_cache(redis_key, value, config)
       with_redis do
-        log("cache.write", redis_key)
-        set_value(redis_key, value)
+        log("cache.write", redis_key, config)
+        set_value(redis_key, value, config)
       end
       value
     end
 
-    def get_value(key)
-      decrypt redis.get(key)
+    private def get_value!(key, config)
+      raise CacheMiss unless redis.exists(key)
+      decrypt redis.get(key), config
+    end
+
+    def get_value(key, config)
+      get_value!(key, config)
+    rescue CacheMiss
+    end
+
+    def set_value(key, value, config)
+      redis.setex key, config[:cache_time], encrypt(value, config)
     end
 
-    def set_value(key, value)
-      redis.setex key, configuration.cache_time, encrypt(value)
+    def merge_config(config)
+      configuration.to_hash.merge(config)
     end
 
-    def encrypt(value)
-      return prep_value(value) unless encrypt?
-      fernet.generate(secret, prep_value(value))
+    def encrypt(value, config)
+      return prep_value(value) unless config[:encrypt]
+      fernet.generate(config[:secret], prep_value(value))
     end
 
-    def decrypt(value)
+    def decrypt(value, config)
       return nil if value.nil?
-      return value unless encrypt?
-      verifier = fernet.verifier(secret, value)
+      return value unless config[:encrypt]
+      verifier = fernet.verifier(config[:secret], value)
       return MultiJson.load(verifier.message) if verifier.valid?
       return nil
     end
@@ -80,14 +100,6 @@ module Greencache
       block.call if redis_up?
     end
 
-    def cache_time
-      configuration.cache_time
-    end
-
-    def skip_cache?
-      configuration.skip_cache
-    end
-
     def test?
       ENV["RACK_ENV"] == 'test'
     end
@@ -96,20 +108,12 @@ module Greencache
       MultiJson.encode(value)
     end
 
-    def encrypt?
-      configuration.encrypt
-    end
-
-    def secret
-      configuration.secret
-    end
-
-    def log(str, key)
-      configuration.logger.log(log_prefix(str) => 1, :key => key) unless configuration.silent
+    def log(str, key, config)
+      config[:logger].log(log_prefix(str, config) => 1, :key => key) unless config[:silent]
     end
 
-    def log_prefix(str)
-      [configuration.log_prefix, str].join(".")
+    def log_prefix(str, config)
+      [config[:log_prefix], str].join(".")
     end
 
     def fernet

data/spec/greencache_spec.rb

@@ -1,9 +1,11 @@
 require 'spec_helper'
 require 'fernet'
+require 'logger'
+require 'multi_json'
 
 Greencache.configure do |c|
   c.redis = Redis.new
-  c.logger = Pliny
+  c.logger = Logger.new(StringIO.new)
   c.silent = true
 end
 
@@ -48,7 +50,7 @@ describe Greencache do
     end
 
     it 'uses the cached' do
-      expect(rc).to receive(:read_from_cache){ {} }
+      expect(rc).to receive(:read_from_cache!){ {} }
       Dummy.run
     end
 
@@ -63,49 +65,48 @@ describe Greencache do
       expect(Dummy).to receive(:get_value){ "bar" }
       Dummy.run
     end
-
   end
 
-  describe 'configuration' do
-    it 'respects cache_time' do
-      config.cache_time = 100
-      expect(rc.cache_time).to eq(100)
-    end
+  context 'merging the configuration' do
 
-    it 'respects skip_cache' do
+    it 'keeps the global config' do
       config.skip_cache = true
-      expect(rc.skip_cache?).to eq(true)
+
+      config = rc.merge_config({})
+      expect(config).to be_a(Hash)
+      expect(config[:skip_cache]).to eql(true)
     end
 
-    it 'knows the secret' do
-      config.secret = "bar"
-      expect(rc.secret).to eq("bar")
+    it 'overrides provided values' do
+      config.skip_cache = true
+
+      config = rc.merge_config({skip_cache: false})
+      expect(config).to be_a(Hash)
+      expect(config[:skip_cache]).to eql(false)
     end
   end
 
   it 'can write into the cache' do
     p = Proc.new { "" }
-    expect(rc).to receive(:set_value).with("foo", "")
-    rc.write_into_cache("foo", p.call)
+    config = rc.merge_config({})
+    expect(rc).to receive(:set_value).with("foo", "", config)
+    rc.write_into_cache("foo", p.call, config)
   end
 
-  it 'can get a value' do
+  it "can get a value that's been set" do
+    rc.redis.set "foo", "bar"
     expect(rc.redis).to receive(:get).with("foo"){ "bar" }
-    expect(rc).to receive(:decrypt).with("bar")
-    rc.get_value("foo")
+    expect(rc).to receive(:decrypt).with("bar", {encrypt: true})
+    rc.get_value("foo", {encrypt: true})
   end
 
   it 'can set a value' do
-    config.cache_time = 100
-    config.encrypt = false
     expect(rc.redis).to receive(:setex).with("foo", 100, '"bar"')
-    rc.set_value("foo", "bar")
+    rc.set_value("foo", "bar", {cache_time: 100, encrypt: false})
   end
 
   it 'encrypts' do
-    config.encrypt = true
-    config.secret = "foo"
     expect(rc.fernet).to receive(:generate).with("foo", '"bar"'){ "abc" }
-    rc.encrypt("bar")
+    rc.encrypt("bar", {encrypt: true, secret: 'foo'})
   end
 end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ Bundler.require
 require 'greencache'
 require 'redis'
 require 'fakeredis'
-require 'pliny'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greencache
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Neil Middleton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,20 +67,6 @@ dependencies:
     - - "~>"
       - !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
@@ -115,14 +101,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
 description: A wrapper for Redis, for caching and encryption with Fernet
 email:
 - neil@neilmiddleton.com
@@ -162,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A gem for caching values in redis and encrypting them