rack-cache 1.0.3 → 1.1

data/CHANGES

@@ -1,3 +1,25 @@
+## 1.1 / September 2011
+
+  * Allow (INM/IMS) validation requests through to backend on miss. Makes it
+    possible to use validation for private / uncacheable responses. A number of
+    people using Rails's stale?() helper reported that their validation logic was
+    never kicking in.
+
+  * Add rack env rack-cache.force-pass option to bypass rack-cache on
+    per request basis
+
+  * Fix an issue with memcache namespace not being set when using the
+    :namespace option instead of :prefix_key.
+
+  * Fix test failures due to MockResponse changes in recent Rack
+    version (issue #34)
+
+## 1.0.3 / August 2011
+
+  * Fix bug passing options to memcached and dalli
+
+  * Document cache_key
+
 ## 1.0.1 / April 2011
 
   * Added lib/rack-cache.rb to match package name for auto-requiring machinery.

data/Gemfile

@@ -1,7 +1,2 @@
 source :rubygems
-
-gem 'bacon'
-gem 'memcached'
-gem 'dalli'
-gem 'rack', '>= 0.4'
-gem 'rdiscount'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bacon (1.1.0)
+    dalli (1.0.5)
+    memcached (1.3)
+    rack (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  dalli
+  memcached
+  rack-cache!

data/Rakefile

@@ -1,10 +1,15 @@
 require 'rake/clean'
 
-task :default => :test
+task :default => [:setup, :test]
 
 CLEAN.include %w[coverage/ doc/api tags]
 CLOBBER.include %w[dist]
 
+desc "Install gem dependencies"
+task :setup do
+  sh "bundle check >/dev/null || bundle install", :verbose => false
+end
+
 # SPECS =====================================================================
 
 desc 'Run specs with unit test style output'

data/doc/faq.markdown

@@ -110,6 +110,13 @@ frameworks are based entirely on manual purge and do not support validation at
 the cache level.
 
 
+<a class='hash' id='force-pass' href='#force-pass'>#</a>
+
+### Q: How do I bypass rack-cache on a per-request basis?
+
+Set the `rack-cache.force-pass` variable in the rack environment to `true`.
+
+
 <a class='hash' id='efficient-validation' href='#efficient-validation'>#</a>
 
 ### Q: What does "Efficient Validation" mean?

data/lib/rack/cache/context.rb

@@ -61,7 +61,7 @@ module Rack::Cache
 
       response =
         if @request.get? || @request.head?
-          if !@env['HTTP_EXPECT']
+          if !@env['HTTP_EXPECT'] && !@env['rack-cache.force-pass']
             lookup
           else
             pass
@@ -231,15 +231,13 @@ module Rack::Cache
     end
 
     # The cache missed or a reload is required. Forward the request to the
-    # backend and determine whether the response should be stored.
+    # backend and determine whether the response should be stored. This allows
+    # conditional / validation requests through to the backend but performs no
+    # caching of the response when the backend returns a 304.
     def fetch
       # send no head requests because we want content
       @env['REQUEST_METHOD'] = 'GET'
 
-      # avoid that the backend sends no content
-      @env.delete('HTTP_IF_MODIFIED_SINCE')
-      @env.delete('HTTP_IF_NONE_MATCH')
-
       response = forward
 
       # Mark the response as explicitly private if any of the private

data/lib/rack/cache/entitystore.rb

@@ -58,7 +58,7 @@ module Rack::Cache
       end
 
       # Write the Rack response body immediately and return the SHA1 key.
-      def write(body)
+      def write(body, ttl=nil)
         buf = []
         key, size = slurp(body) { |part| buf << part }
         @hash[key] = buf
@@ -119,7 +119,7 @@ module Rack::Cache
         nil
       end
 
-      def write(body)
+      def write(body, ttl=nil)
         filename = ['buf', $$, Thread.current.object_id].join('-')
         temp_file = storage_path(filename)
         key, size =
@@ -227,10 +227,10 @@ module Rack::Cache
         data
       end
 
-      def write(body)
+      def write(body, ttl=nil)
         buf = StringIO.new
         key, size = slurp(body){|part| buf.write(part) }
-        [key, size] if cache.set(key, buf.string)
+        [key, size] if cache.set(key, buf.string, ttl)
       end
 
       def purge(key)
@@ -267,10 +267,10 @@ module Rack::Cache
         nil
       end
 
-      def write(body)
+      def write(body, ttl=0)
         buf = StringIO.new
         key, size = slurp(body){|part| buf.write(part) }
-        cache.set(key, buf.string, 0, false)
+        cache.set(key, buf.string, ttl, false)
         [key, size]
       end
 
@@ -315,10 +315,10 @@ module Rack::Cache
         end
       end
 
-      def write(body)
+      def write(body, ttl=nil)
         buf = StringIO.new
         key, size = slurp(body){|part| buf.write(part) }
-        cache.put(key, buf.string)
+        cache.put(key, buf.string, ttl)
         [key, size]
       end
 

data/lib/rack/cache/metastore.rb

@@ -57,7 +57,11 @@ module Rack::Cache
       # write the response body to the entity store if this is the
       # original response.
       if response.headers['X-Content-Digest'].nil?
-        digest, size = entity_store.write(response.body)
+        if request.env['rack-cache.use_native_ttl'] && response.fresh?
+          digest, size = entity_store.write(response.body, response.ttl)
+        else
+          digest, size = entity_store.write(response.body)
+        end
         response.headers['X-Content-Digest'] = digest
         response.headers['Content-Length'] = size.to_s unless response.headers['Transfer-Encoding']
         response.body = entity_store.open(digest)
@@ -337,6 +341,7 @@ module Rack::Cache
       attr_reader :cache
 
       def initialize(server="localhost:11211", options={})
+        options[:prefix_key] ||= options.delete(:namespace) if options.key?(:namespace)
         @cache =
           if server.respond_to?(:stats)
             server

data/lib/rack/cache/options.rb

@@ -8,6 +8,8 @@ module Rack::Cache
   # below are stored in the Rack Environment as "rack-cache.<option>", where
   # <option> is the option name.
   module Options
+    extend self
+
     def self.option_accessor(key)
       name = option_name(key)
       define_method(key) { || options[name] }
@@ -95,6 +97,10 @@ module Rack::Cache
     # default for compliance with RFC 2616.
     option_accessor :allow_revalidate
 
+    # Specifies whether the underlying entity store's native expiration should
+    # be used.
+    option_accessor :use_native_ttl
+
     # The underlying options Hash. During initialization (or outside of a
     # request), this is a default values Hash. During a request, this is the
     # Rack environment Hash. The default values Hash is merged in underneath
@@ -134,7 +140,8 @@ module Rack::Cache
         'rack-cache.default_ttl'      => 0,
         'rack-cache.private_headers'  => ['Authorization', 'Cookie'],
         'rack-cache.allow_reload'     => false,
-        'rack-cache.allow_revalidate' => false
+        'rack-cache.allow_revalidate' => false,
+        'rack-cache.use_native_ttl'   => false,
       }
       self.options = options
     end

data/rack-cache.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'rack-cache'
-  s.version = '1.0.3'
-  s.date = '2011-08-27'
+  s.version = '1.1'
+  s.date = '2011-09-18'
 
   s.description = "HTTP Caching for Rack"
   s.summary     = "HTTP Caching for Rack"
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     CHANGES
     COPYING
     Gemfile
+    Gemfile.lock
     README
     Rakefile
     TODO

data/test/context_test.rb

@@ -15,6 +15,16 @@ describe 'Rack::Cache::Context' do
     response.headers.should.not.include 'Age'
   end
 
+  it 'passes on rack-cache.force-pass' do
+    respond_with 200
+    get '/', {"rack-cache.force-pass" => true}
+
+    app.should.be.called
+    response.should.be.ok
+    cache.trace.should == [:pass]
+    response.headers.should.not.include 'Age'
+  end
+
   %w[post put delete].each do |request_method|
     it "invalidates on #{request_method} requests" do
       respond_with 200
@@ -88,8 +98,8 @@ describe 'Rack::Cache::Context' do
       'HTTP_IF_MODIFIED_SINCE' => timestamp
     app.should.be.called
     response.status.should.equal 304
-    response.headers.should.not.include 'Content-Length'
-    response.headers.should.not.include 'Content-Type'
+    response.original_headers.should.not.include 'Content-Length'
+    response.original_headers.should.not.include 'Content-Type'
     response.body.should.empty
     cache.trace.should.include :miss
     cache.trace.should.include :store
@@ -107,8 +117,8 @@ describe 'Rack::Cache::Context' do
       'HTTP_IF_NONE_MATCH' => '12345'
     app.should.be.called
     response.status.should.equal 304
-    response.headers.should.not.include 'Content-Length'
-    response.headers.should.not.include 'Content-Type'
+    response.original_headers.should.not.include 'Content-Length'
+    response.original_headers.should.not.include 'Content-Type'
     response.headers.should.include 'ETag'
     response.body.should.empty
     cache.trace.should.include :miss

data/test/entitystore_test.rb

@@ -24,6 +24,15 @@ shared 'A Rack::Cache::EntityStore Implementation' do
     data.should.equal 'My wild love went riding,'
   end
 
+  it 'takes a ttl parameter for #write' do
+    key, size = @store.write(['My wild love went riding,'], 0)
+    key.should.not.be.nil
+    key.should.be.sha_like
+
+    data = @store.read(key)
+    data.should.equal 'My wild love went riding,'
+  end
+
   it 'correctly determines whether cached body exists for key with #exist?' do
     key, size = @store.write(['She rode to the devil,'])
     @store.should.exist key
@@ -185,10 +194,20 @@ describe 'Rack::Cache::EntityStore' do
       end
       behaves_like 'A Rack::Cache::EntityStore Implementation'
     end
-    
-    it 'passes options from uri' do
-      memcached = Rack::Cache::EntityStore::Dalli.resolve URI.parse("memcached://#{ENV['MEMCACHED']}?show_backtraces=true")
-      memcached.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+
+    describe 'options parsing' do
+      before do
+        uri = URI.parse("memcached://#{ENV['MEMCACHED']}/obj_ns1?show_backtraces=true")
+        @memcached_metastore = Rack::Cache::MetaStore::MemCached.resolve uri
+      end
+
+      it 'passes options from uri' do
+        @memcached_metastore.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+      end
+
+      it 'takes namespace into account' do
+        @memcached_metastore.cache.instance_variable_get(:@options)[:prefix_key].should.equal 'obj_ns1'
+      end
     end
   end
 
@@ -203,10 +222,20 @@ describe 'Rack::Cache::EntityStore' do
         @store = nil
       end
       behaves_like 'A Rack::Cache::EntityStore Implementation'
-      
+    end
+
+    describe 'options parsing' do
+      before do
+        uri = URI.parse("memcached://#{ENV['MEMCACHED']}/obj_ns1?show_backtraces=true")
+        @dalli_metastore = Rack::Cache::MetaStore::Dalli.resolve uri
+      end
+
       it 'passes options from uri' do
-        dalli = Rack::Cache::EntityStore::Dalli.resolve URI.parse("memcached://#{ENV['MEMCACHED']}?compression=true")
-        dalli.cache.instance_variable_get(:@options)[:compression].should.equal true
+        @dalli_metastore.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+      end
+
+      it 'takes namespace into account' do
+        @dalli_metastore.cache.instance_variable_get(:@options)[:namespace].should.equal 'obj_ns1'
       end
     end
   end

data/test/metastore_test.rb

@@ -265,10 +265,20 @@ describe 'Rack::Cache::MetaStore' do
       end
       behaves_like 'A Rack::Cache::MetaStore Implementation'
     end
-    
-    it 'passes options from uri' do
-      memcached = Rack::Cache::EntityStore::Dalli.resolve URI.parse("memcached://#{ENV['MEMCACHED']}?show_backtraces=true")
-      memcached.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+
+    describe 'options parsing' do
+      before do
+        uri = URI.parse("memcached://#{ENV['MEMCACHED']}/meta_ns1?show_backtraces=true")
+        @memcached_metastore = Rack::Cache::MetaStore::MemCached.resolve uri
+      end
+
+      it 'passes options from uri' do
+        @memcached_metastore.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+      end
+
+      it 'takes namespace into account' do
+        @memcached_metastore.cache.instance_variable_get(:@options)[:prefix_key].should.equal 'meta_ns1'
+      end
     end
   end
 
@@ -282,10 +292,20 @@ describe 'Rack::Cache::MetaStore' do
       end
       behaves_like 'A Rack::Cache::MetaStore Implementation'
     end
-    
-    it 'passes options from uri' do
-      dalli = Rack::Cache::EntityStore::Dalli.resolve URI.parse("memcached://#{ENV['MEMCACHED']}?compression=true")
-      dalli.cache.instance_variable_get(:@options)[:compression].should.equal true
+
+    describe 'options parsing' do
+      before do
+        uri = URI.parse("memcached://#{ENV['MEMCACHED']}/meta_ns1?show_backtraces=true")
+        @dalli_metastore = Rack::Cache::MetaStore::Dalli.resolve uri
+      end
+
+      it 'passes options from uri' do
+        @dalli_metastore.cache.instance_variable_get(:@options)[:show_backtraces].should.equal true
+      end
+
+      it 'takes namespace into account' do
+        @dalli_metastore.cache.instance_variable_get(:@options)[:namespace].should.equal 'meta_ns1'
+      end
     end
   end
 

metadata

@@ -1,73 +1,94 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rack-cache
-version: !ruby/object:Gem::Version
-  version: 1.0.3
+version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
 platform: ruby
-authors:
+authors: 
 - Ryan Tomayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-27 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-09-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &70303071454760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.4'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
   type: :runtime
-  prerelease: false
-  version_requirements: *70303071454760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bacon
-  requirement: &70303071454380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70303071454380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: memcached
-  requirement: &70303071453920 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70303071453920
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: dalli
-  requirement: &70303071453500 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70303071453500
+  version_requirements: *id004
 description: HTTP Caching for Rack
 email: r@tomayko.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README
 - COPYING
 - TODO
 - CHANGES
-files:
+files: 
 - CHANGES
 - COPYING
 - Gemfile
+- Gemfile.lock
 - README
 - Rakefile
 - TODO
@@ -108,35 +129,43 @@ files:
 - test/storage_test.rb
 homepage: http://tomayko.com/src/rack-cache/
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --line-numbers
 - --inline-source
 - --title
 - Rack::Cache
 - --main
 - Rack::Cache
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 2
 summary: HTTP Caching for Rack
-test_files:
+test_files: 
 - test/cache_test.rb
 - test/cachecontrol_test.rb
 - test/context_test.rb