rtomayko-rack-cache 0.2.0

data/test/context_test.rb

@@ -0,0 +1,505 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+require 'rack/cache/context'
+
+describe 'Rack::Cache::Context' do
+  before(:each) { setup_cache_context }
+  after(:each)  { teardown_cache_context }
+
+  it 'passes on non-GET/HEAD requests' do
+    respond_with 200
+    post '/'
+
+    app.should.be.called
+    response.should.be.ok
+    cache.should.a.performed :pass
+    response.headers.should.not.include 'Age'
+  end
+
+  it 'passes on requests with Authorization' do
+    respond_with 200
+    get '/', 'HTTP_AUTHORIZATION' => 'basic foobarbaz'
+
+    app.should.be.called
+    response.should.be.ok
+    cache.should.a.performed :pass
+    response.headers.should.not.include 'Age'
+  end
+
+  it 'passes on requests with a Cookie' do
+    respond_with 200
+    get '/', 'HTTP_COOKIE' => 'foo=bar'
+
+    response.should.be.ok
+    app.should.be.called
+    cache.should.a.performed :pass
+    response.headers.should.not.include 'Age'
+  end
+
+  it 'responds with 304 when If-Modified-Since matches Last-Modified' do
+    timestamp = Time.now.httpdate
+    respond_with do |req,res|
+      res.status = 200
+      res['Last-Modified'] = timestamp
+      res['Content-Type'] = 'text/plain'
+      res.body = ['Hello World']
+    end
+
+    get '/',
+      'HTTP_IF_MODIFIED_SINCE' => timestamp
+    app.should.be.called
+    response.status.should.be == 304
+    response.headers.should.not.include 'Content-Length'
+    response.headers.should.not.include 'Content-Type'
+    response.body.should.empty
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+  end
+
+  it 'responds with 304 when If-None-Match matches ETag' do
+    respond_with do |req,res|
+      res.status = 200
+      res['Etag'] = '12345'
+      res['Content-Type'] = 'text/plain'
+      res.body = ['Hello World']
+    end
+
+    get '/',
+      'HTTP_IF_NONE_MATCH' => '12345'
+    app.should.be.called
+    response.status.should.be == 304
+    response.headers.should.not.include 'Content-Length'
+    response.headers.should.not.include 'Content-Type'
+    response.headers.should.include 'Etag'
+    response.body.should.empty
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+  end
+
+  it 'caches requests when Cache-Control request header set to no-cache' do
+    respond_with 200, 'Expires' => (Time.now + 5).httpdate
+    get '/', 'HTTP_CACHE_CONTROL' => 'no-cache'
+
+    response.should.be.ok
+    cache.should.a.performed :store
+    response.headers.should.include 'Age'
+  end
+
+  it 'fetches response from backend when cache misses' do
+    respond_with 200, 'Expires' => (Time.now + 5).httpdate
+    get '/'
+
+    response.should.be.ok
+    cache.should.a.performed :miss
+    cache.should.a.performed :fetch
+    response.headers.should.include 'Age'
+  end
+
+  [(201..202),(204..206),(303..305),(400..403),(405..409),(411..417),(500..505)].each do |range|
+    range.each do |response_code|
+      it "does not cache #{response_code} responses" do
+        respond_with response_code, 'Expires' => (Time.now + 5).httpdate
+        get '/'
+
+        cache.should.a.not.performed :store
+        response.status.should.be == response_code
+        response.headers.should.not.include 'Age'
+      end
+    end
+  end
+
+  it "does not cache responses with explicit no-store directive" do
+    respond_with 200,
+      'Expires' => (Time.now + 5).httpdate,
+      'Cache-Control' => 'no-store'
+    get '/'
+
+    response.should.be.ok
+    cache.should.a.not.performed :store
+    response.headers.should.not.include 'Age'
+  end
+
+  it 'does not cache responses without freshness information or a validator' do
+    respond_with 200
+    get '/'
+
+    response.should.be.ok
+    cache.should.a.not.performed :store
+  end
+
+  it "caches responses with explicit no-cache directive" do
+    respond_with 200,
+      'Expires' => (Time.now + 5).httpdate,
+      'Cache-Control' => 'no-cache'
+    get '/'
+
+    response.should.be.ok
+    cache.should.a.performed :store
+    response.headers.should.include 'Age'
+  end
+
+  it 'caches responses with an Expiration header' do
+    respond_with 200, 'Expires' => (Time.now + 5).httpdate
+    get '/'
+
+    response.should.be.ok
+    response.body.should.be == '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
+  end
+
+  it 'caches responses with a max-age directive' do
+    respond_with 200, 'Cache-Control' => 'max-age=5'
+    get '/'
+
+    response.should.be.ok
+    response.body.should.be == '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
+  end
+
+  it 'caches responses with a Last-Modified validator but no freshness information' do
+    respond_with 200, 'Last-Modified' => Time.now.httpdate
+    get '/'
+
+    response.should.be.ok
+    response.body.should.be == 'Hello World'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+  end
+
+  it 'caches responses with an ETag validator but no freshness information' do
+    respond_with 200, 'Etag' => '"123456"'
+    get '/'
+
+    response.should.be.ok
+    response.body.should.be == 'Hello World'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+  end
+
+  it 'hits cached response with Expires header' do
+    respond_with 200,
+      'Date' => (Time.now - 5).httpdate,
+      'Expires' => (Time.now + 5).httpdate
+
+    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.be == '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['X-Content-Digest'].should.not.be.nil
+    cache.should.a.performed :hit
+    cache.should.a.not.performed :fetch
+    response.body.should.be == 'Hello World'
+  end
+
+  it 'hits cached response with max-age directive' do
+    respond_with 200,
+      'Date' => (Time.now - 5).httpdate,
+      'Cache-Control' => 'max-age=10'
+
+    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.be == '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['X-Content-Digest'].should.not.be.nil
+    cache.should.a.performed :hit
+    cache.should.a.not.performed :fetch
+    response.body.should.be == 'Hello World'
+  end
+
+  it 'fetches full response when cache stale and no validators present' do
+    respond_with 200, 'Expires' => (Time.now + 5).httpdate
+
+    # build initial request
+    get '/'
+    app.should.be.called
+    response.should.be.ok
+    response.headers.should.include 'Date'
+    response.headers.should.include 'X-Content-Digest'
+    response.headers.should.include 'Age'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+    response.body.should.be == '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.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.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'
+  end
+
+  it 'validates cached responses with Last-Modified and no freshness information' do
+    timestamp = Time.now.httpdate
+    respond_with do |req,res|
+      res['Last-Modified'] = timestamp
+      if req.env['HTTP_IF_MODIFIED_SINCE'] == timestamp
+        res.status = 304
+        res.body = []
+      end
+    end
+
+    # build initial request
+    get '/'
+    app.should.be.called
+    response.should.be.ok
+    response.headers.should.include 'Last-Modified'
+    response.headers.should.include 'X-Content-Digest'
+    response.body.should.be == 'Hello World'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+
+    # build subsequent request; should be found but miss due to freshness
+    get '/'
+    app.should.be.called
+    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'
+    cache.should.a.not.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.performed :store
+  end
+
+  it 'validates cached responses with ETag and no freshness information' do
+    timestamp = Time.now.httpdate
+    respond_with do |req,res|
+      res['ETAG'] = '"12345"'
+      if req.env['HTTP_IF_NONE_MATCH'] == res['Etag']
+        res.status = 304
+        res.body = []
+      end
+    end
+
+    # build initial request
+    get '/'
+    app.should.be.called
+    response.should.be.ok
+    response.headers.should.include 'Etag'
+    response.headers.should.include 'X-Content-Digest'
+    response.body.should.be == 'Hello World'
+    cache.should.a.performed :miss
+    cache.should.a.performed :store
+
+    # build subsequent request; should be found but miss due to freshness
+    get '/'
+    app.should.be.called
+    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'
+    cache.should.a.not.performed :miss
+    cache.should.a.performed :fetch
+    cache.should.a.performed :store
+  end
+
+  it 'replaces cached responses when validation results in non-304 response' do
+    timestamp = Time.now.httpdate
+    count = 0
+    respond_with do |req,res|
+      res['Last-Modified'] = timestamp
+      case (count+=1)
+      when 1 ; res.body = 'first response'
+      when 2 ; res.body = 'second response'
+      when 3
+        res.body = []
+        res.status = 304
+      end
+    end
+
+    # first request should fetch from backend and store in cache
+    get '/'
+    response.status.should.be == 200
+    response.body.should.be == 'first response'
+
+    # second request is validated, is invalid, and replaces cached entry
+    get '/'
+    response.status.should.be == 200
+    response.body.should.be == 'second response'
+
+    # third respone is validated, valid, and returns cached entry
+    get '/'
+    response.status.should.be == 200
+    response.body.should.be == 'second response'
+
+    count.should.be == 3
+  end
+
+  describe 'with responses that include a Vary header' do
+    before(:each) do
+      count = 0
+      respond_with 200 do |req,res|
+        res['Vary'] = 'Accept User-Agent Foo'
+        res['Cache-Control'] = 'max-age=10'
+        res['X-Response-Count'] = (count+=1).to_s
+        res.body = req.env['HTTP_USER_AGENT']
+      end
+    end
+
+    it 'serves from cache when headers match' do
+      get '/',
+        'HTTP_ACCEPT' => 'text/html',
+        'HTTP_USER_AGENT' => 'Bob/1.0'
+      response.should.be.ok
+      response.body.should.be == 'Bob/1.0'
+      cache.should.a.performed :miss
+      cache.should.a.performed :store
+
+      get '/',
+        'HTTP_ACCEPT' => 'text/html',
+        'HTTP_USER_AGENT' => 'Bob/1.0'
+      response.should.be.ok
+      response.body.should.be == 'Bob/1.0'
+      cache.should.a.performed :hit
+      cache.should.a.not.performed :fetch
+      response.headers.should.include 'X-Content-Digest'
+    end
+
+    it 'stores multiple responses when headers differ' do
+      get '/',
+        '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'
+
+      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'
+
+      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'
+
+      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'
+
+      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'
+    end
+  end
+
+  describe 'when transitioning to the error state' do
+
+    setup { respond_with(200) }
+
+    it 'creates a blank slate response object with 500 status with no args' do
+      cache_config do
+        on(:receive) { error! }
+      end
+      get '/'
+      response.status.should.be == 500
+      response.body.should.be.empty
+      cache.should.a.performed :error
+    end
+
+    it 'sets the status code with one arg' do
+      cache_config do
+        on(:receive) { error! 505 }
+      end
+      get '/'
+      response.status.should.be == 505
+    end
+
+    it 'sets the status and headers with args: status, Hash' do
+      cache_config 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.body.should.be.empty
+    end
+
+    it 'sets the status and body with args: status, String' do
+      cache_config do
+        on(:receive) { error! 503, 'foo bar baz' }
+      end
+      get '/'
+      response.status.should.be == 503
+      response.body.should.be == 'foo bar baz'
+    end
+
+    it 'sets the status and body with args: status, Array' do
+      cache_config do
+        on(:receive) { error! 503, ['foo bar baz'] }
+      end
+      get '/'
+      response.status.should.be == 503
+      response.body.should.be == 'foo bar baz'
+    end
+
+    it 'fires the error event before finishing' do
+      fired = false
+      cache_config do
+        on(:receive) { error! }
+        on(:error) {
+          fired = true
+          response.status.should.be == 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'
+    end
+
+  end
+
+end

data/test/core_test.rb

@@ -0,0 +1,84 @@
+require "#{File.dirname(__FILE__)}/spec_setup"
+require 'rack/cache/core'
+
+class MockCore
+  include Rack::Cache::Core
+  alias_method :initialize, :initialize_core
+  public :transition, :trigger, :events
+end
+
+describe 'Rack::Cache::Core' do
+  before :each do
+    @core = MockCore.new
+  end
+
+  it 'has events after instantiation' do
+    @core.events.should.respond_to :[]
+  end
+  it 'defines and triggers event handlers' do
+    executed = false
+    @core.on(:foo) { executed = true }
+    @core.trigger :foo
+    executed.should.be true
+  end
+  it 'executes multiple handlers in LIFO order' do
+    x = 'nothing executed'
+    @core.on :foo do
+      x.should.be == 'bottom executed'
+      x = 'top executed'
+    end
+    @core.on :foo do
+      x.should.be == 'nothing executed'
+      x = 'bottom executed'
+    end
+    @core.trigger :foo
+    x.should.be == 'top executed'
+  end
+  it 'records event execution history' do
+    @core.on(:foo) {}
+    @core.trigger :foo
+    @core.should.a.performed :foo
+  end
+  it 'raises an exception when asked to perform an unknown event' do
+    assert_raises NameError do
+      @core.trigger :foo
+    end
+  end
+  it 'raises an exception when asked to transition to an unknown event' do
+    @core.on(:bling) {}
+    @core.on(:foo) { throw(:transition, [:bling]) }
+    lambda { @core.transition(from=:foo, to=[:bar, :baz]) }.
+      should.raise Rack::Cache::IllegalTransition
+  end
+  it 'passes transition arguments to handlers' do
+    passed = nil
+    @core.meta_def(:perform_bar) do |*args|
+      passed = args
+      'hi'
+    end
+    @core.on(:bar) {}
+    @core.on(:foo) { throw(:transition, [:bar, 1, 2, 3]) }
+    result = @core.transition(from=:foo, to=[:bar])
+    passed.should.be == [1,2,3]
+    result.should.be == 'hi'
+  end
+  it 'fully transitions out of handlers when the next event is invoked' do
+    x = []
+    @core.on(:foo) {
+      x << 'in foo, before transitioning to bar'
+      throw(:transition, [:bar])
+      x << 'in foo, after transitioning to bar'
+    }
+    @core.on(:bar) { x << 'in bar' }
+    @core.trigger(:foo).should.be == [:bar]
+    @core.trigger(:bar).should.be.nil
+    x.should.be == [
+      'in foo, before transitioning to bar',
+      'in bar'
+    ]
+  end
+  it 'returns the transition event name' do
+    @core.on(:foo) { throw(:transition, [:bar]) }
+    @core.trigger(:foo).should.be == [:bar]
+  end
+end