redis-rack-cache 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1c23b6c5393e28ef68e57bfae874015956fdf8e
-  data.tar.gz: 3e8ea63a5474411a7ea800342e398a2606141e5d
+  metadata.gz: 2b5230f97382eccbaacff83196ec80685cd91787
+  data.tar.gz: cdf39ba1459ec99a691e40343e924179cbe8e69c
 SHA512:
-  metadata.gz: aa1e4180b9f1ddcfa75c76cf4f6666719e02b5cfd9a01e3972b7e2888869af7c04a954e3e760b3059b6dc3457dde510172f7c8af10da9dcd8b356a83ab248e8c
-  data.tar.gz: b957047d38075303aa834d053e051917efc52b874d2070b7649ddb578c6aa3e3a2229dbbecc071f8f8d6127df8d69b0d30fe8124ea1e33655e061dae70646114
+  metadata.gz: b6f40646f5eecf1276afe30345d1e15f62cdc4cc04f924e1cddae8a689a965ac0146d5884795768e7bc3cf49cc146e0e1c479a2621b1aaf99babad2558eb4db3
+  data.tar.gz: 289a3c824840723a7e16c271a0c8451af2fadde18f8637089982ea93fc4be266f179eddbdb1877319c8a9fbcf31e4d8a973b802976f8f94bfa04b270ebccaec7

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
-before_install: gem install bundler
-script: 'bundle exec rake'
+script: bundle exec rake
 rvm:
   - 2.2
   - 2.3

data/CODEOWNERS

@@ -0,0 +1 @@
+* @tubbo

data/Gemfile

@@ -5,5 +5,3 @@ git_source :github do |name|
   repo = name =~ %r{/} ? name : "#{name}/#{name}"
   "https://github.com/#{repo}.git"
 end
-
-gem 'redis-store-testing', github: 'redis-store/testing'

data/README.md

@@ -5,6 +5,12 @@
 
 __`redis-rack-cache`__ provides a Redis backed store for __Rack::Cache__, an HTTP cache. See the main [redis-store readme](https://github.com/redis-store/redis-store) for general guidelines.
 
+**NOTE:** This gem is necessary in addition to
+[redis-rails](https://github.com/redis-store/redis-rails) if you use
+Redis to store the Rails cache. `redis-rails` does not pull in this gem
+by default since not all applications use `Rack::Cache` as their HTTP
+cache.
+
 ## Installation
 
 ```ruby
@@ -14,7 +20,34 @@ gem 'redis-rack-cache'
 
 ## Usage
 
-If you are using redis-store with Rails, consider using the [redis-rails gem](https://github.com/redis-store/redis-rails) instead. For standalone usage:
+In a Rails app, you can configure your `Rack::Cache` stores like this:
+
+```ruby
+# config/environments/production.rb
+Rails.application.configure do
+  config.action_dispatch.rack_cache = {
+    metastore: "#{Rails.credentials.redis_url}/1/rack_cache_metastore",
+    entitystore: "#{Rails.credentials.redis_url}/1/rack_cache_entitystore"
+    # NOTE: `:meta_store` and `:entity_store` are also supported.
+  }
+end
+```
+
+For more complicated setups, like when using custom options, the
+following syntax can also be used:
+
+```ruby
+# config/environments/production.rb
+Rails.application.configure do
+  config.action_dispatch.rack_cache = {
+    meta_store: ::Rack::Cache::MetaStore::Redis.new("#{Rails.credentials.redis_url}/1/rack_cache_metastore", default_ttl: 10.days.to_i),
+    entity_store: ::Rack::Cache::EntityStore::Redis.new("#{Rails.credentials.redis_url}/1/rack_cache_entitystore", default_ttl: 120.days.to_i)
+    # NOTE: `:metastore` and `:entitystore` are also supported.
+  }
+end
+```
+
+For standalone usage (in non-Rails apps):
 
 ```ruby
 # config.ru

data/lib/rack/cache/redis_base.rb

@@ -0,0 +1,33 @@
+require 'rack/utils'
+
+module Rack
+  module Cache
+    module RedisBase
+      def self.included(base)
+        base.extend ClassMethods
+        base.instance_eval do
+          extend Rack::Utils
+
+          attr_reader :cache, :options, :default_ttl
+        end
+      end
+
+      module ClassMethods
+        def resolve(uri)
+          new ::Redis::Store::Factory.resolve(uri.to_s)
+        end
+      end
+
+      def initialize(server, options = {})
+        @cache = ::Redis::Store::Factory.create(server)
+        @options = options
+        @default_ttl = options[:default_ttl] || ::Redis::Rack::Cache::DEFAULT_TTL
+      end
+
+      def open(key)
+        data = read(key)
+        data && [data]
+      end
+    end
+  end
+end

data/lib/rack/cache/redis_entitystore.rb

@@ -1,29 +1,12 @@
 require 'rack/cache/entity_store'
 require 'redis-rack-cache/constants'
+require 'rack/cache/redis_base'
 
 module Rack
   module Cache
     class EntityStore
-      class RedisBase < self
-        # The underlying ::Redis instance used to communicate with the Redis daemon.
-        attr_reader :cache
-
-        extend Rack::Utils
-
-        def open(key)
-          data = read(key)
-          data && [data]
-        end
-
-        def self.resolve(uri)
-          new ::Redis::Store::Factory.resolve(uri.to_s)
-        end
-      end
-
-      class Redis < RedisBase
-        def initialize(server, options = {})
-          @cache = ::Redis::Store::Factory.create(server)
-        end
+      class Redis < self
+        include RedisBase
 
         def exist?(key)
           cache.exists key
@@ -35,10 +18,11 @@ module Rack
 
         def write(body, ttl=0)
           buf = StringIO.new
-          key, size = slurp(body){|part| buf.write(part) }
+          key, size = slurp(body) {|part| buf.write(part) }
+          ttl = ttl.to_i.zero? ? default_ttl : ttl
 
-          ttl = ::Redis::Rack::Cache::DEFAULT_TTL if ttl.zero?
-          [key, size] if cache.setex(key, ttl, buf.string)
+          return unless cache.setex(key, ttl, buf.string)
+          [key, size]
         end
 
         def purge(key)
@@ -47,7 +31,7 @@ module Rack
         end
       end
 
-      REDIS = Redis
+      REDIS = REDISS = Redis
     end
   end
 end

data/lib/rack/cache/redis_metastore.rb

@@ -1,37 +1,21 @@
 require 'digest/sha1'
-require 'rack/utils'
 require 'rack/cache/key'
 require 'rack/cache/meta_store'
 require 'redis-rack-cache/constants'
+require 'rack/cache/redis_base'
 
 module Rack
   module Cache
     class MetaStore
-      class RedisBase < self
-        extend Rack::Utils
-
-        # The Redis::Store object used to communicate with the Redis daemon.
-        attr_reader :cache
-
-        def self.resolve(uri)
-          new ::Redis::Store::Factory.resolve(uri.to_s)
-        end
-      end
-
-      class Redis < RedisBase
-        # The Redis instance used to communicated with the Redis daemon.
-        attr_reader :cache
-
-        def initialize(server, options = {})
-          @cache = ::Redis::Store::Factory.create(server)
-        end
+      class Redis < self
+        include RedisBase
 
         def read(key)
           cache.get(hexdigest(key)) || []
         end
 
         def write(key, entries, ttl=0)
-          ttl = ::Redis::Rack::Cache::DEFAULT_TTL if ttl.zero?
+          ttl = ttl.to_i.zero? ? default_ttl : ttl
           cache.setex(hexdigest(key), ttl, entries)
         end
 
@@ -41,7 +25,7 @@ module Rack
         end
       end
 
-      REDIS = Redis
+      REDIS = REDISS = Redis
     end
   end
 end

data/lib/redis-rack-cache/version.rb

@@ -1,7 +1,7 @@
 class Redis
   module Rack
     module Cache
-      VERSION = '2.0.2'
+      VERSION = '2.1.0'
     end
   end
 end

data/redis-rack-cache.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'redis-store', '>= 1.2', '< 2'
+  s.add_dependency 'redis-store', '>= 1.6', '< 2'
   s.add_dependency 'rack-cache',  '>= 1.6', '< 2'
 
   s.add_development_dependency 'rake',     '~> 10'
-  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'mocha',    '~> 0.14.0'
   s.add_development_dependency 'minitest', '~> 5'
   s.add_development_dependency 'redis-store-testing'

data/test/rack/cache/entitystore/redis_test.rb

@@ -11,6 +11,17 @@ describe Rack::Cache::EntityStore::Redis do
     @store = ::Rack::Cache::EntityStore::Redis.new :host => 'localhost'
   end
 
+  it 'respects the default_tll options' do
+    @store = ::Rack::Cache::EntityStore::Redis.new({ :host => 'localhost' }, { :default_ttl => 120 })
+    @store.default_ttl.must_equal(120)
+  end
+
+  it 'properly delegates the TTL to redis' do
+    @store = ::Rack::Cache::EntityStore::Redis.new({ :host => 'localhost' }, { :default_ttl => 120 })
+    key, size = @store.write(['She rode to the devil,'])
+    assert @store.cache.ttl(key) <= 120
+  end
+
   it 'has the class referenced by homonym constant' do
     ::Rack::Cache::EntityStore::REDIS.must_equal(::Rack::Cache::EntityStore::Redis)
   end
@@ -20,6 +31,10 @@ describe Rack::Cache::EntityStore::Redis do
     cache.must_be_kind_of(::Redis)
     cache.id.must_equal("redis://127.0.0.1:6379/0")
 
+    cache = ::Rack::Cache::EntityStore::Redis.resolve(uri("rediss://127.0.0.1")).cache
+    cache.must_be_kind_of(::Redis)
+    cache.instance_variable_get(:@client).scheme.must_equal('rediss')
+
     cache = ::Rack::Cache::EntityStore::Redis.resolve(uri("redis://127.0.0.1:6380")).cache
     cache.id.must_equal("redis://127.0.0.1:6380/0")
 

data/test/rack/cache/metastore/redis_test.rb

@@ -13,6 +13,26 @@ describe Rack::Cache::MetaStore::Redis do
     @entity_store.cache.flushall
   end
 
+  it "respects the default_tll options" do
+    @store = ::Rack::Cache::MetaStore::Redis.new({ :host => "localhost" }, { :default_ttl => 120 })
+    @store.default_ttl.must_equal(120)
+
+    @entity_store = ::Rack::Cache::EntityStore::Redis.new({ :host => "localhost" }, { :default_ttl => 120 })
+    @entity_store.default_ttl.must_equal(120)
+  end
+
+  it "properly delegates the TTL to redis" do
+    key = '/test/'
+    @store = ::Rack::Cache::MetaStore::Redis.new({ :host => "localhost" }, { :default_ttl => 120 })
+
+    @store.write(key, [[{},{}]])
+    assert @store.cache.ttl(key) <= 120
+
+    @entity_store = ::Rack::Cache::EntityStore::Redis.new({ :host => "localhost" }, { :default_ttl => 120 })
+    key, size = @entity_store.write(['She rode to the devil,'])
+    assert @entity_store.cache.ttl(key) <= 120
+  end
+
   it "has the class referenced by homonym constant" do
     ::Rack::Cache::MetaStore::REDIS.must_equal(::Rack::Cache::MetaStore::Redis)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-rack-cache
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-store
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -68,16 +68,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
+- CODEOWNERS
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -152,12 +153,14 @@ files:
 - bin/appraisal
 - gemfiles/rack_cache_1.6.gemfile
 - gemfiles/rack_cache_1.7.gemfile
+- lib/rack/cache/redis_base.rb
 - lib/rack/cache/redis_entitystore.rb
 - lib/rack/cache/redis_metastore.rb
 - lib/redis-rack-cache.rb
 - lib/redis-rack-cache/constants.rb
 - lib/redis-rack-cache/version.rb
 - redis-rack-cache.gemspec
+- stdout
 - test/rack/cache/entitystore/pony.jpg
 - test/rack/cache/entitystore/redis_test.rb
 - test/rack/cache/metastore/redis_test.rb
@@ -183,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: redis-rack-cache
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A Redis backend store for Rack::Cache