rtomayko-rack-cache 0.2.0 → 0.3.0

data/lib/rack/cache/metastore.rb

@@ -32,18 +32,18 @@ module Rack::Cache
 
       # find a cached entry that matches the request.
       env = request.env
-      match = entries.detect{ |req,res| requests_match?(res['Vary'], env, req)}
-      if match
-        # TODO what if body doesn't exist in entity store?
-        # reconstruct response object
-        req, res = match
-        status = res['X-Status']
-        body = entity_store.open(res['X-Content-Digest'])
-        response = Rack::Cache::Response.new(status.to_i, res, body)
-        response.activate!
+      match = entries.detect{|req,res| requests_match?(res['Vary'], env, req)}
+      return nil if match.nil?
 
-        # Return the cached response
+      req, res = match
+      if body = entity_store.open(res['X-Content-Digest'])
+        response = Rack::Cache::Response.new(res['X-Status'].to_i, res, body)
+        response.activate!
         response
+      else
+        # TODO the metastore referenced an entity that doesn't exist in
+        # the entitystore. we definitely want to return nil but we should
+        # also purge the entry from the meta-store when this is detected.
       end
     end
 
@@ -75,7 +75,7 @@ module Rack::Cache
           (vary == res['Vary']) &&
             requests_match?(vary, env, stored_env)
         end
-      entries.unshift [stored_env, response.headers.dup]
+      entries.unshift [stored_env, {}.update(response.headers)]
       write key, entries
     end
 

data/lib/rack/cache/options.rb

@@ -61,6 +61,15 @@ module Rack::Cache
     # Default: 0
     option_accessor :default_ttl
 
+    # Set of request headers that trigger "private" cache-control behavior
+    # on responses that don't explicitly state whether the response is
+    # public or private via a Cache-Control directive. Applications that use
+    # cookies for authorization may need to add the 'Cookie' header to this
+    # list.
+    #
+    # Default: ['Authorization', 'Cookie']
+    option_accessor :private_headers
+
     # 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
@@ -111,7 +120,8 @@ module Rack::Cache
         'rack-cache.storage'     => Rack::Cache::Storage.instance,
         'rack-cache.metastore'   => 'heap:/',
         'rack-cache.entitystore' => 'heap:/',
-        'rack-cache.default_ttl' => 0
+        'rack-cache.default_ttl' => 0,
+        'rack-cache.private_headers' => ['Authorization', 'Cookie']
       }
       self.options = options
     end

data/lib/rack/cache/response.rb

@@ -34,7 +34,7 @@ module Rack::Cache
     # and body.
     def initialize(status, headers, body)
       @status = status
-      @headers = headers
+      @headers = Rack::Utils::HeaderHash.new(headers)
       @body = body
       @now = Time.now
       @headers['Date'] ||= now.httpdate
@@ -62,7 +62,7 @@ module Rack::Cache
 
     # Return the status, headers, and body in a three-tuple.
     def to_a
-      [status, headers, body]
+      [status, headers.to_hash, body]
     end
 
     # Freezes

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 = '0.2.0'
-  s.date = '2008-10-24'
+  s.version = '0.3.0'
+  s.date = '2008-12-28'
 
   s.description = "HTTP Caching for Rack"
   s.summary     = "HTTP Caching for Rack"
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     doc/layout.html.erb
     doc/license.markdown
     doc/rack-cache.css
+    doc/server.ru
     doc/storage.markdown
     lib/rack/cache.rb
     lib/rack/cache/config.rb

data/test/cache_test.rb

@@ -18,8 +18,8 @@ describe 'Rack::Cache::new' do
   end
   it 'sets options provided in the options Hash' do
     object = Rack::Cache.new(@app, :foo => 'bar', 'foo.bar' => 'bling')
-    object.options['foo.bar'].should.be == 'bling'
-    object.options['rack-cache.foo'].should.be == 'bar'
+    object.options['foo.bar'].should.equal 'bling'
+    object.options['rack-cache.foo'].should.equal 'bar'
   end
   it 'takes a block; executes it during initialization' do
     state, block_scope = 'not invoked', nil
@@ -29,7 +29,7 @@ describe 'Rack::Cache::new' do
         state = 'invoked'
         should.respond_to :on
       end
-    state.should.be == 'invoked'
+    state.should.equal 'invoked'
     object.should.be block_scope
   end
 end

data/test/context_test.rb

@@ -15,24 +15,58 @@ describe 'Rack::Cache::Context' do
     response.headers.should.not.include 'Age'
   end
 
-  it 'passes on requests with Authorization' do
-    respond_with 200
+  it 'does not cache with Authorization request header and non public response' do
+    respond_with 200, 'Etag' => '"FOO"'
     get '/', 'HTTP_AUTHORIZATION' => 'basic foobarbaz'
 
     app.should.be.called
     response.should.be.ok
-    cache.should.a.performed :pass
+    response.headers['Cache-Control'].should.equal 'private'
+    cache.should.a.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.not.performed :store
+    cache.should.a.performed :deliver
+    response.headers.should.not.include 'Age'
+  end
+
+  it 'does cache with Authorization request header and public response' do
+    respond_with 200, 'Cache-Control' => 'public', 'ETag' => '"FOO"'
+    get '/', 'HTTP_AUTHORIZATION' => 'basic foobarbaz'
+
+    app.should.be.called
+    response.should.be.ok
+    cache.should.a.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.performed :store
+    response.headers.should.include 'Age'
+    response.headers['Cache-Control'].should.equal 'public'
+  end
+
+  it 'does not cache with Cookie header and non public response' do
+    respond_with 200, 'Etag' => '"FOO"'
+    get '/', 'HTTP_COOKIE' => 'foo=bar'
+
+    app.should.be.called
+    response.should.be.ok
+    response.headers['Cache-Control'].should.equal 'private'
+    cache.should.a.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.not.performed :store
+    cache.should.a.performed :deliver
     response.headers.should.not.include 'Age'
   end
 
-  it 'passes on requests with a Cookie' do
+  it 'does not cache requests with a Cookie header' do
     respond_with 200
     get '/', 'HTTP_COOKIE' => 'foo=bar'
 
     response.should.be.ok
     app.should.be.called
-    cache.should.a.performed :pass
+    cache.should.a.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.performed :deliver
     response.headers.should.not.include 'Age'
+    response.headers['Cache-Control'].should.equal 'private'
   end
 
   it 'responds with 304 when If-Modified-Since matches Last-Modified' do
@@ -47,7 +81,7 @@ describe 'Rack::Cache::Context' do
     get '/',
       'HTTP_IF_MODIFIED_SINCE' => timestamp
     app.should.be.called
-    response.status.should.be == 304
+    response.status.should.equal 304
     response.headers.should.not.include 'Content-Length'
     response.headers.should.not.include 'Content-Type'
     response.body.should.empty
@@ -66,7 +100,7 @@ describe 'Rack::Cache::Context' do
     get '/',
       'HTTP_IF_NONE_MATCH' => '12345'
     app.should.be.called
-    response.status.should.be == 304
+    response.status.should.equal 304
     response.headers.should.not.include 'Content-Length'
     response.headers.should.not.include 'Content-Type'
     response.headers.should.include 'Etag'
@@ -101,7 +135,7 @@ describe 'Rack::Cache::Context' do
         get '/'
 
         cache.should.a.not.performed :store
-        response.status.should.be == response_code
+        response.status.should.equal response_code
         response.headers.should.not.include 'Age'
       end
     end
@@ -142,13 +176,13 @@ describe 'Rack::Cache::Context' do
     get '/'
 
     response.should.be.ok
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
     response.headers.should.include 'Date'
     response['Age'].should.not.be.nil
     response['X-Content-Digest'].should.not.be.nil
     cache.should.a.performed :miss
     cache.should.a.performed :store
-    cache.metastore.to_hash.keys.length.should.be == 1
+    cache.metastore.to_hash.keys.length.should.equal 1
   end
 
   it 'caches responses with a max-age directive' do
@@ -156,13 +190,27 @@ describe 'Rack::Cache::Context' do
     get '/'
 
     response.should.be.ok
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
+    response.headers.should.include 'Date'
+    response['Age'].should.not.be.nil
+    response['X-Content-Digest'].should.not.be.nil
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+    cache.metastore.to_hash.keys.length.should.equal 1
+  end
+
+  it 'caches responses with a s-maxage directive' do
+    respond_with 200, 'Cache-Control' => 's-maxage=5'
+    get '/'
+
+    response.should.be.ok
+    response.body.should.equal 'Hello World'
     response.headers.should.include 'Date'
     response['Age'].should.not.be.nil
     response['X-Content-Digest'].should.not.be.nil
     cache.should.a.performed :miss
     cache.should.a.performed :store
-    cache.metastore.to_hash.keys.length.should.be == 1
+    cache.metastore.to_hash.keys.length.should.equal 1
   end
 
   it 'caches responses with a Last-Modified validator but no freshness information' do
@@ -170,7 +218,7 @@ describe 'Rack::Cache::Context' do
     get '/'
 
     response.should.be.ok
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
     cache.should.a.performed :miss
     cache.should.a.performed :store
   end
@@ -180,7 +228,7 @@ describe 'Rack::Cache::Context' do
     get '/'
 
     response.should.be.ok
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
     cache.should.a.performed :miss
     cache.should.a.performed :store
   end
@@ -196,17 +244,17 @@ describe 'Rack::Cache::Context' do
     response.headers.should.include 'Date'
     cache.should.a.performed :miss
     cache.should.a.performed :store
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
 
     get '/'
     response.should.be.ok
     app.should.not.be.called
-    response['Date'].should.be == responses.first['Date']
-    response['Age'].to_i.should.be > 0
+    response['Date'].should.equal responses.first['Date']
+    response['Age'].to_i.should.satisfy { |age| age > 0 }
     response['X-Content-Digest'].should.not.be.nil
     cache.should.a.performed :hit
     cache.should.a.not.performed :fetch
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
   end
 
   it 'hits cached response with max-age directive' do
@@ -220,17 +268,73 @@ describe 'Rack::Cache::Context' do
     response.headers.should.include 'Date'
     cache.should.a.performed :miss
     cache.should.a.performed :store
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
 
     get '/'
     response.should.be.ok
     app.should.not.be.called
-    response['Date'].should.be == responses.first['Date']
-    response['Age'].to_i.should.be > 0
+    response['Date'].should.equal responses.first['Date']
+    response['Age'].to_i.should.satisfy { |age| age > 0 }
     response['X-Content-Digest'].should.not.be.nil
     cache.should.a.performed :hit
     cache.should.a.not.performed :fetch
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
+  end
+
+  it 'hits cached response with s-maxage directive' do
+    respond_with 200,
+      'Date' => (Time.now - 5).httpdate,
+      'Cache-Control' => 's-maxage=10, max-age=0'
+
+    get '/'
+    app.should.be.called
+    response.should.be.ok
+    response.headers.should.include 'Date'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+    response.body.should.equal 'Hello World'
+
+    get '/'
+    response.should.be.ok
+    app.should.not.be.called
+    response['Date'].should.equal responses.first['Date']
+    response['Age'].to_i.should.satisfy { |age| age > 0 }
+    response['X-Content-Digest'].should.not.be.nil
+    cache.should.a.performed :hit
+    cache.should.a.not.performed :fetch
+    response.body.should.equal 'Hello World'
+  end
+
+  it 'assigns default_ttl when response has no freshness information' do
+    respond_with 200
+
+    get '/', 'rack-cache.default_ttl' => 10
+    app.should.be.called
+    response.should.be.ok
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+    response.body.should.equal 'Hello World'
+    response['Cache-Control'].should.include 's-maxage=10'
+
+    get '/', 'rack-cache.default_ttl' => 10
+    response.should.be.ok
+    app.should.not.be.called
+    cache.should.a.performed :hit
+    cache.should.a.not.performed :fetch
+    response.body.should.equal 'Hello World'
+  end
+
+  it 'does not assign default_ttl when response has must-revalidate directive' do
+    respond_with 200,
+      'Cache-Control' => 'must-revalidate'
+
+    get '/', 'rack-cache.default_ttl' => 10
+    app.should.be.called
+    response.should.be.ok
+    cache.should.a.performed :miss
+    cache.should.a.not.performed :store
+    response['Cache-Control'].should.not.include 's-maxage'
+    response.body.should.equal 'Hello World'
   end
 
   it 'fetches full response when cache stale and no validators present' do
@@ -245,23 +349,23 @@ describe 'Rack::Cache::Context' do
     response.headers.should.include 'Age'
     cache.should.a.performed :miss
     cache.should.a.performed :store
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
 
     # go in and play around with the cached metadata directly ...
-    cache.metastore.to_hash.values.length.should.be == 1
+    cache.metastore.to_hash.values.length.should.equal 1
     cache.metastore.to_hash.values.first.first[1]['Expires'] = Time.now.httpdate
 
     # build subsequent request; should be found but miss due to freshness
     get '/'
     app.should.be.called
     response.should.be.ok
-    response['Age'].to_i.should.be == 0
+    response['Age'].to_i.should.equal 0
     response.headers.should.include 'X-Content-Digest'
     cache.should.a.not.performed :hit
     cache.should.a.not.performed :miss
     cache.should.a.performed :fetch
     cache.should.a.performed :store
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
   end
 
   it 'validates cached responses with Last-Modified and no freshness information' do
@@ -280,7 +384,7 @@ describe 'Rack::Cache::Context' do
     response.should.be.ok
     response.headers.should.include 'Last-Modified'
     response.headers.should.include 'X-Content-Digest'
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
     cache.should.a.performed :miss
     cache.should.a.performed :store
 
@@ -290,9 +394,9 @@ describe 'Rack::Cache::Context' do
     response.should.be.ok
     response.headers.should.include 'Last-Modified'
     response.headers.should.include 'X-Content-Digest'
-    response['Age'].to_i.should.be == 0
-    response['X-Origin-Status'].should.be == '304'
-    response.body.should.be == 'Hello World'
+    response['Age'].to_i.should.equal 0
+    response['X-Origin-Status'].should.equal '304'
+    response.body.should.equal 'Hello World'
     cache.should.a.not.performed :miss
     cache.should.a.performed :fetch
     cache.should.a.performed :store
@@ -314,7 +418,7 @@ describe 'Rack::Cache::Context' do
     response.should.be.ok
     response.headers.should.include 'Etag'
     response.headers.should.include 'X-Content-Digest'
-    response.body.should.be == 'Hello World'
+    response.body.should.equal 'Hello World'
     cache.should.a.performed :miss
     cache.should.a.performed :store
 
@@ -324,9 +428,9 @@ describe 'Rack::Cache::Context' do
     response.should.be.ok
     response.headers.should.include 'Etag'
     response.headers.should.include 'X-Content-Digest'
-    response['Age'].to_i.should.be == 0
-    response['X-Origin-Status'].should.be == '304'
-    response.body.should.be == 'Hello World'
+    response['Age'].to_i.should.equal 0
+    response['X-Origin-Status'].should.equal '304'
+    response.body.should.equal 'Hello World'
     cache.should.a.not.performed :miss
     cache.should.a.performed :fetch
     cache.should.a.performed :store
@@ -348,22 +452,58 @@ describe 'Rack::Cache::Context' do
 
     # first request should fetch from backend and store in cache
     get '/'
-    response.status.should.be == 200
-    response.body.should.be == 'first response'
+    response.status.should.equal 200
+    response.body.should.equal 'first response'
 
     # second request is validated, is invalid, and replaces cached entry
     get '/'
-    response.status.should.be == 200
-    response.body.should.be == 'second response'
+    response.status.should.equal 200
+    response.body.should.equal 'second response'
 
     # third respone is validated, valid, and returns cached entry
     get '/'
-    response.status.should.be == 200
-    response.body.should.be == 'second response'
+    response.status.should.equal 200
+    response.body.should.equal 'second response'
+
+    count.should.equal 3
+  end
+
+  it 'passes HEAD requests through directly on pass' do
+    respond_with do |req,res|
+      res.status = 200
+      res.body = []
+      req.request_method.should.equal 'HEAD'
+    end
+
+    cache_config do
+      on(:receive) { pass! }
+    end
+
+    head '/'
+    app.should.be.called
+    response.body.should.equal ''
+  end
+
+  it 'uses cache to respond to HEAD requests when fresh' do
+    respond_with do |req,res|
+      res['Cache-Control'] = 'max-age=10'
+      res.body = ['Hello World']
+      req.request_method.should.not.equal 'HEAD'
+    end
+
+    get '/'
+    app.should.be.called
+    response.status.should.equal 200
+    response.body.should.equal 'Hello World'
 
-    count.should.be == 3
+    head '/'
+    app.should.not.be.called
+    response.status.should.equal 200
+    response.body.should.equal ''
+    response['Content-Length'].should.equal 'Hello World'.length.to_s
   end
 
+
   describe 'with responses that include a Vary header' do
     before(:each) do
       count = 0
@@ -380,7 +520,7 @@ describe 'Rack::Cache::Context' do
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/1.0'
       response.should.be.ok
-      response.body.should.be == 'Bob/1.0'
+      response.body.should.equal 'Bob/1.0'
       cache.should.a.performed :miss
       cache.should.a.performed :store
 
@@ -388,7 +528,7 @@ describe 'Rack::Cache::Context' do
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/1.0'
       response.should.be.ok
-      response.body.should.be == 'Bob/1.0'
+      response.body.should.equal 'Bob/1.0'
       cache.should.a.performed :hit
       cache.should.a.not.performed :fetch
       response.headers.should.include 'X-Content-Digest'
@@ -399,36 +539,36 @@ describe 'Rack::Cache::Context' do
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/1.0'
       response.should.be.ok
-      response.body.should.be == 'Bob/1.0'
-      response['X-Response-Count'].should.be == '1'
+      response.body.should.equal 'Bob/1.0'
+      response['X-Response-Count'].should.equal '1'
 
       get '/',
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/2.0'
       cache.should.a.performed :miss
       cache.should.a.performed :store
-      response.body.should.be == 'Bob/2.0'
-      response['X-Response-Count'].should.be == '2'
+      response.body.should.equal 'Bob/2.0'
+      response['X-Response-Count'].should.equal '2'
 
       get '/',
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/1.0'
       cache.should.a.performed :hit
-      response.body.should.be == 'Bob/1.0'
-      response['X-Response-Count'].should.be == '1'
+      response.body.should.equal 'Bob/1.0'
+      response['X-Response-Count'].should.equal '1'
 
       get '/',
         'HTTP_ACCEPT' => 'text/html',
         'HTTP_USER_AGENT' => 'Bob/2.0'
       cache.should.a.performed :hit
-      response.body.should.be == 'Bob/2.0'
-      response['X-Response-Count'].should.be == '2'
+      response.body.should.equal 'Bob/2.0'
+      response['X-Response-Count'].should.equal '2'
 
       get '/',
         'HTTP_USER_AGENT' => 'Bob/2.0'
       cache.should.a.performed :miss
-      response.body.should.be == 'Bob/2.0'
-      response['X-Response-Count'].should.be == '3'
+      response.body.should.equal 'Bob/2.0'
+      response['X-Response-Count'].should.equal '3'
     end
   end
 
@@ -441,7 +581,7 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! }
       end
       get '/'
-      response.status.should.be == 500
+      response.status.should.equal 500
       response.body.should.be.empty
       cache.should.a.performed :error
     end
@@ -451,7 +591,7 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! 505 }
       end
       get '/'
-      response.status.should.be == 505
+      response.status.should.equal 505
     end
 
     it 'sets the status and headers with args: status, Hash' do
@@ -459,8 +599,8 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! 504, 'Content-Type' => 'application/x-foo' }
       end
       get '/'
-      response.status.should.be == 504
-      response['Content-Type'].should.be == 'application/x-foo'
+      response.status.should.equal 504
+      response['Content-Type'].should.equal 'application/x-foo'
       response.body.should.be.empty
     end
 
@@ -469,8 +609,8 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! 503, 'foo bar baz' }
       end
       get '/'
-      response.status.should.be == 503
-      response.body.should.be == 'foo bar baz'
+      response.status.should.equal 503
+      response.body.should.equal 'foo bar baz'
     end
 
     it 'sets the status and body with args: status, Array' do
@@ -478,8 +618,8 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! 503, ['foo bar baz'] }
       end
       get '/'
-      response.status.should.be == 503
-      response.body.should.be == 'foo bar baz'
+      response.status.should.equal 503
+      response.body.should.equal 'foo bar baz'
     end
 
     it 'fires the error event before finishing' do
@@ -488,16 +628,16 @@ describe 'Rack::Cache::Context' do
         on(:receive) { error! }
         on(:error) {
           fired = true
-          response.status.should.be == 500
+          response.status.should.equal 500
           response['Content-Type'] = 'application/x-foo'
           response.body = ['overridden response body']
         }
       end
       get '/'
       fired.should.be true
-      response.status.should.be == 500
-      response.body.should.be == 'overridden response body'
-      response['Content-Type'].should.be == 'application/x-foo'
+      response.status.should.equal 500
+      response.body.should.equal 'overridden response body'
+      response['Content-Type'].should.equal 'application/x-foo'
     end
 
   end