rack-cache 0.5.2 → 0.5.3

data/Rakefile

@@ -5,12 +5,6 @@ task :default => :test
 CLEAN.include %w[coverage/ doc/api tags]
 CLOBBER.include %w[dist]
 
-# load gemspec like github's gem builder to surface any SAFE issues.
-Thread.new do
-  require 'rubygems/specification'
-  $spec = eval("$SAFE=3\n#{File.read('rack-cache.gemspec')}")
-end.join
-
 # SPECS =====================================================================
 
 desc 'Run specs with story style output'
@@ -36,7 +30,7 @@ task :doc => %w[doc:api doc:markdown]
 # requires the hanna gem:
 #   gem install mislav-hanna --source=http://gems.github.com
 desc 'Build API documentation (doc/api)'
-task 'doc:api' => 'doc/api/index.html' 
+task 'doc:api' => 'doc/api/index.html'
 file 'doc/api/index.html' => FileList['lib/**/*.rb'] do |f|
   rm_rf 'doc/api'
   sh((<<-SH).gsub(/[\s\n]+/, ' ').strip)
@@ -86,45 +80,39 @@ end
 
 # PACKAGING =================================================================
 
-def package(ext='')
-  "dist/rack-cache-#{$spec.version}" + ext
-end
+if defined?(Gem)
+  # load gemspec
+  $spec = eval(File.read('rack-cache.gemspec'))
 
-desc 'Build packages'
-task :package => %w[.gem .tar.gz].map {|e| package(e)}
+  def package(ext='')
+    "dist/rack-cache-#{$spec.version}" + ext
+  end
 
-desc 'Build and install as local gem'
-task :install => package('.gem') do
-  sh "gem install #{package('.gem')}"
-end
+  desc 'Build packages'
+  task :package => %w[.gem .tar.gz].map {|e| package(e)}
 
-directory 'dist/'
+  desc 'Build and install as local gem'
+  task :install => package('.gem') do
+    sh "gem install #{package('.gem')}"
+  end
 
-file package('.gem') => %w[dist/ rack-cache.gemspec] + $spec.files do |f|
-  sh "gem build rack-cache.gemspec"
-  mv File.basename(f.name), f.name
-end
+  directory 'dist/'
 
-file package('.tar.gz') => %w[dist/] + $spec.files do |f|
-  sh "git archive --format=tar HEAD | gzip > #{f.name}"
-end
+  file package('.gem') => %w[dist/ rack-cache.gemspec] + $spec.files do |f|
+    sh "gem build rack-cache.gemspec"
+    mv File.basename(f.name), f.name
+  end
 
-desc 'Upload gem and tar.gz distributables to rubyforge'
-task 'release:rubyforge' => [package('.gem'), package('.tar.gz')] do |t|
-  sh <<-SH
-    rubyforge add_release wink rack-cache #{$spec.version} #{package('.gem')} &&
-    rubyforge add_file    wink rack-cache #{$spec.version} #{package('.tar.gz')}
-  SH
-end
+  file package('.tar.gz') => %w[dist/] + $spec.files do |f|
+    sh "git archive --format=tar HEAD | gzip > #{f.name}"
+  end
 
-desc 'Upload gem to gemcutter.org'
-task 'release:gemcutter' => [package('.gem')] do |t|
-  sh "gem push #{package('.gem')}"
+  desc 'Upload gem to gemcutter.org'
+  task 'release' => [package('.gem')] do |t|
+    sh "gem push #{package('.gem')}"
+  end
 end
 
-desc 'Upload gem to gemcutter and rubyforge'
-task 'release' => ['release:gemcutter', 'release:rubyforge']
-
 # GEMSPEC ===================================================================
 
 file 'rack-cache.gemspec' => FileList['{lib,test}/**','Rakefile'] do |f|

data/doc/index.markdown

@@ -42,7 +42,7 @@ simply `require` and `use` as follows:
 
     use Rack::Cache,
       :verbose     => true,
-      :metastore   => 'file:/var/cache/rack/meta'
+      :metastore   => 'file:/var/cache/rack/meta',
       :entitystore => 'file:/var/cache/rack/body'
 
     run app
@@ -74,7 +74,7 @@ More
   * [RDoc API Documentation](./api/) - Mostly worthless if you just want to use
     __Rack::Cache__ in your application but mildly insightful if you'd like to
     get a feel for how the system has been put together; I recommend
-    [reading the source](http://github.com/rtomayko/rack-cache/master/lib/rack/cache).
+    [reading the source](http://github.com/rtomayko/rack-cache/tree/master/lib/rack/cache).
 
 
 See Also

data/example/sinatra/app.rb

@@ -5,10 +5,6 @@ use Rack::Cache do
   set :verbose, true
   set :metastore,   'heap:/'
   set :entitystore, 'heap:/'
-
-  on :receive do
-    pass! if request.url =~ /favicon/
-  end
 end
 
 before do

data/lib/rack/cache/context.rb

@@ -55,7 +55,8 @@ module Rack::Cache
     # the context of the receiver.
     def call!(env)
       @trace = []
-      @env = @default_options.merge(env)
+      @default_options.each { |k,v| env[k] ||= v }
+      @env = env
       @request = Request.new(@env.dup.freeze)
 
       response =
@@ -103,8 +104,13 @@ module Rack::Cache
     # Determine if the #response validators (ETag, Last-Modified) matches
     # a conditional value specified in #request.
     def not_modified?(response)
-      response.etag_matches?(@request.env['HTTP_IF_NONE_MATCH']) ||
-        response.last_modified_at?(@request.env['HTTP_IF_MODIFIED_SINCE'])
+      last_modified = @request.env['HTTP_IF_MODIFIED_SINCE']
+      if etags = @request.env['HTTP_IF_NONE_MATCH']
+        etags = etags.split(/\s*,\s*/)
+        (etags.include?(response.etag) || etags.include?('*')) && (!last_modified || response.last_modified == last_modified)
+      elsif last_modified
+        response.last_modified == last_modified
+      end
     end
 
     # Whether the cache entry is "fresh enough" to satisfy the request.
@@ -180,26 +186,36 @@ module Rack::Cache
       # send no head requests because we want content
       @env['REQUEST_METHOD'] = 'GET'
 
-      # add our cached validators to the environment
+      # add our cached last-modified validator to the environment
       @env['HTTP_IF_MODIFIED_SINCE'] = entry.last_modified
-      @env['HTTP_IF_NONE_MATCH'] = entry.etag
 
-      backend_response = forward
+      # Add our cached etag validator to the environment.
+      # We keep the etags from the client to handle the case when the client
+      # has a different private valid entry which is not cached here.
+      cached_etags = entry.etag.to_s.split(/\s*,\s*/)
+      request_etags = @request.env['HTTP_IF_NONE_MATCH'].to_s.split(/\s*,\s*/)
+      etags = (cached_etags + request_etags).uniq
+      @env['HTTP_IF_NONE_MATCH'] = etags.empty? ? nil : etags.join(', ')
 
-      response =
-        if backend_response.status == 304
-          record :valid
-          entry = entry.dup
-          entry.headers.delete('Date')
-          %w[Date Expires Cache-Control ETag Last-Modified].each do |name|
-            next unless value = backend_response.headers[name]
-            entry.headers[name] = value
-          end
-          entry
-        else
-          record :invalid
-          backend_response
+      response = forward
+
+      if response.status == 304
+        record :valid
+
+        # Check if the response validated which is not cached here
+        etag = response.headers['ETag']
+        return response if etag && request_etags.include?(etag) && !cached_etags.include?(etag)
+
+        entry = entry.dup
+        entry.headers.delete('Date')
+        %w[Date Expires Cache-Control ETag Last-Modified].each do |name|
+          next unless value = response.headers[name]
+          entry.headers[name] = value
         end
+        response = entry
+      else
+        record :invalid
+      end
 
       store(response) if response.cacheable?
 

data/lib/rack/cache/metastore.rb

@@ -214,23 +214,26 @@ module Rack::Cache
       def read(key)
         path = key_path(key)
         File.open(path, 'rb') { |io| Marshal.load(io) }
-      rescue Errno::ENOENT
+      rescue Errno::ENOENT, IOError
         []
       end
 
       def write(key, entries)
-        path = key_path(key)
-        File.open(path, 'wb') { |io| Marshal.dump(entries, io, -1) }
-      rescue Errno::ENOENT
-        Dir.mkdir(File.dirname(path), 0755)
-        retry
+        tries = 0
+        begin
+          path = key_path(key)
+          File.open(path, 'wb') { |io| Marshal.dump(entries, io, -1) }
+        rescue Errno::ENOENT, IOError
+          Dir.mkdir(File.dirname(path), 0755)
+          retry if (tries += 1) == 1
+        end
       end
 
       def purge(key)
         path = key_path(key)
         File.unlink(path)
         nil
-      rescue Errno::ENOENT
+      rescue Errno::ENOENT, IOError
         nil
       end
 

data/lib/rack/cache/response.rb

@@ -30,7 +30,7 @@ module Rack::Cache
     # Create a Response instance given the response status code, header hash,
     # and body.
     def initialize(status, headers, body)
-      @status = status
+      @status = status.to_i
       @headers = Rack::Utils::HeaderHash.new(headers)
       @body = body
       @now = Time.now
@@ -208,19 +208,6 @@ module Rack::Cache
       headers['ETag']
     end
 
-    # Determine if the response was last modified at the time provided.
-    # time_value is the exact string provided in an origin response's
-    # Last-Modified header.
-    def last_modified_at?(time_value)
-      time_value && last_modified == time_value
-    end
-
-    # Determine if response's ETag matches the etag value provided. Return
-    # false when either value is nil.
-    def etag_matches?(etag)
-      etag && self.etag == etag
-    end
-
     # Headers that MUST NOT be included with 304 Not Modified responses.
     #
     # http://tools.ietf.org/html/rfc2616#section-10.3.5

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.5.2'
-  s.date = '2009-09-25'
+  s.version = '0.5.3'
+  s.date = '2010-09-10'
 
   s.description = "HTTP Caching for Rack"
   s.summary     = "HTTP Caching for Rack"
@@ -61,6 +61,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = %w[README COPYING TODO CHANGES]
   s.add_dependency 'rack', '>= 0.4'
 
+  s.add_development_dependency 'test-spec'
+
   s.has_rdoc = true
   s.homepage = "http://tomayko.com/src/rack-cache/"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rack::Cache", "--main", "Rack::Cache"]

data/test/context_test.rb

@@ -115,6 +115,97 @@ describe 'Rack::Cache::Context' do
     cache.trace.should.include :store
   end
 
+  it 'responds with 304 only if If-None-Match and If-Modified-Since both match' do
+    timestamp = Time.now
+
+    respond_with do |req,res|
+      res.status = 200
+      res['ETag'] = '12345'
+      res['Last-Modified'] = timestamp.httpdate
+      res['Content-Type'] = 'text/plain'
+      res.body = ['Hello World']
+    end
+
+    # Only etag matches
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '12345', 'HTTP_IF_MODIFIED_SINCE' => (timestamp - 1).httpdate
+    app.should.be.called
+    response.status.should.equal 200
+
+    # Only last-modified matches
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '1234', 'HTTP_IF_MODIFIED_SINCE' => timestamp.httpdate
+    app.should.be.called
+    response.status.should.equal 200
+
+    # Both matches
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '12345', 'HTTP_IF_MODIFIED_SINCE' => timestamp.httpdate
+    app.should.be.called
+    response.status.should.equal 304
+  end
+
+  it 'validates private responses cached on the client' do
+    respond_with do |req,res|
+      etags = req.env['HTTP_IF_NONE_MATCH'].to_s.split(/\s*,\s*/)
+      if req.env['HTTP_COOKIE'] == 'authenticated'
+        res['Cache-Control'] = 'private, no-store'
+        res['ETag'] = '"private tag"'
+        if etags.include?('"private tag"')
+          res.status = 304
+        else
+          res.status = 200
+          res['Content-Type'] = 'text/plain'
+          res.body = ['private data']
+        end
+      else
+        res['ETag'] = '"public tag"'
+        if etags.include?('"public tag"')
+          res.status = 304
+        else
+          res.status = 200
+          res['Content-Type'] = 'text/plain'
+          res.body = ['public data']
+        end
+      end
+    end
+
+    get '/'
+    app.should.be.called
+    response.status.should.equal 200
+    response.headers['ETag'].should == '"public tag"'
+    response.body.should == 'public data'
+    cache.trace.should.include :miss
+    cache.trace.should.include :store
+
+    get '/', 'HTTP_COOKIE' => 'authenticated'
+    app.should.be.called
+    response.status.should.equal 200
+    response.headers['ETag'].should == '"private tag"'
+    response.body.should == 'private data'
+    cache.trace.should.include :stale
+    cache.trace.should.include :invalid
+    cache.trace.should.not.include :store
+
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '"public tag"'
+    app.should.be.called
+    response.status.should.equal 304
+    response.headers['ETag'].should == '"public tag"'
+    cache.trace.should.include :stale
+    cache.trace.should.include :valid
+    cache.trace.should.include :store
+
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '"private tag"',
+      'HTTP_COOKIE' => 'authenticated'
+    app.should.be.called
+    response.status.should.equal 304
+    response.headers['ETag'].should == '"private tag"'
+    cache.trace.should.include :valid
+    cache.trace.should.not.include :store
+  end
+
   it 'stores responses when no-cache request directive present' do
     respond_with 200, 'Expires' => (Time.now + 5).httpdate
 

data/test/response_test.rb

@@ -12,6 +12,12 @@ describe 'Rack::Cache::Response' do
     @now, @res, @one_hour_ago = nil
   end
 
+  it 'marks Rack tuples with string typed statuses as cacheable' do
+    @res = Rack::Cache::Response.new('200',{'Date' => @now.httpdate},[])
+    @res.headers['Expires'] = @one_hour_later.httpdate
+    @res.cacheable?.should.equal true
+  end
+
   it 'responds to #to_a with a Rack response tuple' do
     @res.should.respond_to :to_a
     @res.to_a.should.equal [200, {'Date' => @now.httpdate}, []]

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-cache
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 3
+  version: 0.5.3
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -9,19 +15,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-25 00:00:00 -07:00
+date: 2010-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
         version: "0.4"
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: HTTP Caching for Rack
 email: r@tomayko.com
 executables: []
@@ -88,21 +113,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: wink
-rubygems_version: 1.3.4
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: HTTP Caching for Rack