roda 1.0.0 → 1.1.0

data/spec/plugin/caching_spec.rb

@@ -0,0 +1,335 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+describe 'response.cache_control' do
+  it 'sets the Cache-Control header' do
+    app(:caching) do |r|
+      response.cache_control :public=>true, :no_cache=>true, :max_age => 60
+    end
+    header('Cache-Control').split(', ').sort.should == ['max-age=60', 'no-cache', 'public']
+  end
+
+  it 'does not add a Cache-Control header if it would be empty' do
+    app(:caching) do |r|
+      response.cache_control({})
+    end
+    header('Cache-Control').should == nil
+  end
+end
+
+describe 'response.expires' do
+  it 'sets the Cache-Control and Expires header' do
+    app(:caching) do |r|
+      response.expires 60, :public=>true, :no_cache=>true
+    end
+    header('Cache-Control').split(', ').sort.should == ['max-age=60', 'no-cache', 'public']
+    ((Time.httpdate(header('Expires')) - Time.now).round - 60).abs.should <= 1
+  end
+
+  it 'can be called with only one argument' do
+    app(:caching) do |r|
+      response.expires 60
+    end
+    header('Cache-Control').split(', ').sort.should == ['max-age=60']
+    ((Time.httpdate(header('Expires')) - Time.now).round - 60).abs.should <= 1
+  end
+end
+
+describe 'response.finish' do
+  it 'removes Content-Type and Content-Length for 304 responses' do
+    app(:caching) do |r|
+      response.status = 304
+    end
+    header('Content-Type').should == nil
+    header('Content-Length').should == nil
+  end
+
+  it 'does not change non-304 responses' do
+    app(:caching) do |r|
+      response.status = 200
+    end
+    header('Content-Type').should == 'text/html'
+    header('Content-Length').should == '0'
+  end
+end
+
+describe 'request.last_modified' do
+  it 'ignores nil' do
+    app(:caching) do |r|
+      r.last_modified nil
+    end
+    header('Last-Modified').should == nil
+  end
+
+  it 'does not change a status other than 200' do
+    app(:caching) do |r|
+      response.status = 201
+      r.last_modified Time.now
+    end
+    status.should == 201
+    status('HTTP_IF_MODIFIED_SINCE' => 'Sun, 26 Sep 2030 23:43:52 GMT').should == 201
+    status('HTTP_IF_MODIFIED_SINCE' => 'Sun, 26 Sep 2000 23:43:52 GMT').should == 201
+  end
+end
+
+describe 'request.last_modified' do
+  def res(a={})
+    s, h, b = req(a)
+    h['Last-Modified'].should == @last_modified.httpdate
+    [s, b.join]
+  end
+
+  before(:all) do
+    lm = @last_modified = Time.now
+    app(:caching) do |r|
+      r.last_modified lm
+      'ok'
+    end
+  end
+
+  it 'just sets Last-Modified if no If-Modified-Since header' do
+    res.should == [200, 'ok']
+  end
+
+  it 'just sets Last-Modified if bogus If-Modified-Since header' do
+    res('HTTP_IF_MODIFIED_SINCE' => 'a really weird date').should == [200, 'ok']
+  end
+
+  it 'just sets Last-Modified if modified since If-Modified-Since header' do
+    res('HTTP_IF_MODIFIED_SINCE' => (@last_modified - 1).httpdate).should == [200, 'ok']
+  end
+
+  it 'sets Last-Modified and returns 304 if modified on If-Modified-Since header' do
+    res('HTTP_IF_MODIFIED_SINCE' => @last_modified.httpdate).should == [304, '']
+  end
+
+  it 'sets Last-Modified and returns 304 if modified before If-Modified-Since header' do
+    res('HTTP_IF_MODIFIED_SINCE' => (@last_modified + 1).httpdate).should == [304, '']
+  end
+
+  it 'sets Last-Modified if If-None-Match header present' do
+    res('HTTP_IF_NONE_MATCH' => '*', 'HTTP_IF_MODIFIED_SINCE' => (@last_modified + 1).httpdate).should == [200, 'ok']
+  end
+
+  it 'sets Last-Modified if modified before If-Unmodified-Since header' do
+    res('HTTP_IF_UNMODIFIED_SINCE' => (@last_modified + 1).httpdate).should == [200, 'ok']
+  end
+
+  it 'sets Last-Modified if modified on If-Unmodified-Since header' do
+    res('HTTP_IF_UNMODIFIED_SINCE' => @last_modified.httpdate).should == [200, 'ok']
+  end
+
+  it 'sets Last-Modified and returns 412 if modified after If-Unmodified-Since header' do
+    res('HTTP_IF_UNMODIFIED_SINCE' => (@last_modified - 1).httpdate).should == [412, '']
+  end
+end
+
+describe 'request.etag' do
+  before(:all) do
+    app(:caching) do |r|
+      r.is "" do
+        response.status = r.env['status'] if r.env['status']
+        etag_opts = {}
+        etag_opts[:new_resource] = r.env['new_resource'] if r.env.has_key?('new_resource')
+        etag_opts[:weak] = r.env['weak'] if r.env.has_key?('weak')
+        r.etag 'foo', etag_opts
+        'ok'
+      end
+    end
+  end
+
+  it 'uses a weak etag with the :weak option' do
+    header('ETag', 'weak'=>true).should == 'W/"foo"'
+  end
+
+  describe 'for GET requests' do
+    def res(a={})
+      s, h, b = req(a)
+      h['ETag'].should == '"foo"'
+      [s, b.join]
+    end
+
+    it "sets etag if no If-None-Match" do
+      res.should == [200, 'ok']
+    end
+
+    it "sets etag and returns 304 if If-None-Match is *" do
+      res('HTTP_IF_NONE_MATCH' => '*').should == [304, '']
+    end
+
+    it "sets etag and if If-None-Match is * and it is a new resource" do
+      res('HTTP_IF_NONE_MATCH' => '*', 'new_resource'=>true).should == [200, 'ok']
+    end
+
+    it "sets etag and returns 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"').should == [304, '']
+    end
+
+    it "sets etag and returns 304 if If-None-Match includes etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "foo"').should == [304, '']
+    end
+
+    it "sets etag if If-None-Match does not include etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "baz"').should == [200, 'ok']
+    end
+
+    it "sets etag and does not change status code if status code set and not 2xx or 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>499).should == [499, 'ok']
+    end
+
+    it "sets etag and returns 304 if status code set to 2xx if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>201).should == [304, '']
+    end
+
+    it "sets etag and returns 304 if status code is already 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>304).should == [304, '']
+    end
+
+    it "sets etag if If-Match is *" do
+      res('HTTP_IF_MATCH' => '*').should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match is etag" do
+      res('HTTP_IF_MATCH' => '"foo"').should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match includes etag" do
+      res('HTTP_IF_MATCH' => '"bar", "foo"').should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-Match is * for new resources" do
+      res('HTTP_IF_MATCH' => '*', 'new_resource'=>true).should == [412, '']
+    end
+
+    it "sets etag if If-Match does not include etag" do
+      res('HTTP_IF_MATCH' => '"bar", "baz"', 'new_resource'=>true).should == [412, '']
+    end
+  end
+
+  describe 'for PUT requests' do
+    def res(a={})
+      s, h, b = req(a.merge('REQUEST_METHOD'=>'PUT'))
+      h['ETag'].should == '"foo"'
+      [s, b.join]
+    end
+
+    it "sets etag if no If-None-Match" do
+      res.should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-None-Match is *" do
+      res('HTTP_IF_NONE_MATCH' => '*').should == [412, '']
+    end
+
+    it "sets etag and if If-None-Match is * and it is a new resource" do
+      res('HTTP_IF_NONE_MATCH' => '*', 'new_resource'=>true).should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"').should == [412, '']
+    end
+
+    it "sets etag and returns 412 if If-None-Match includes etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "foo"').should == [412, '']
+    end
+
+    it "sets etag if If-None-Match does not include etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "baz"').should == [200, 'ok']
+    end
+
+    it "sets etag and does not change status code if status code set and not 2xx or 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>499).should == [499, 'ok']
+    end
+
+    it "sets etag and returns 304 if status code set to 2xx if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>201).should == [412, '']
+    end
+
+    it "sets etag and returns 304 if status code is already 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>304).should == [412, '']
+    end
+
+    it "sets etag if If-Match is *" do
+      res('HTTP_IF_MATCH' => '*').should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match is etag" do
+      res('HTTP_IF_MATCH' => '"foo"').should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match includes etag" do
+      res('HTTP_IF_MATCH' => '"bar", "foo"').should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-Match is * for new resources" do
+      res('HTTP_IF_MATCH' => '*', 'new_resource'=>true).should == [412, '']
+    end
+
+    it "sets etag if If-Match does not include etag" do
+      res('HTTP_IF_MATCH' => '"bar", "baz"', 'new_resource'=>true).should == [412, '']
+    end
+  end
+
+  describe 'for POST requests' do
+    def res(a={})
+      s, h, b = req(a.merge('REQUEST_METHOD'=>'POST'))
+      h['ETag'].should == '"foo"'
+      [s, b.join]
+    end
+
+    it "sets etag if no If-None-Match" do
+      res.should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-None-Match is * and it is not a new resource" do
+      res('HTTP_IF_NONE_MATCH' => '*', 'new_resource'=>false).should == [412, '']
+    end
+
+    it "sets etag and if If-None-Match is *" do
+      res('HTTP_IF_NONE_MATCH' => '*').should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"').should == [412, '']
+    end
+
+    it "sets etag and returns 412 if If-None-Match includes etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "foo"').should == [412, '']
+    end
+
+    it "sets etag if If-None-Match does not include etag" do
+      res('HTTP_IF_NONE_MATCH' => '"bar", "baz"').should == [200, 'ok']
+    end
+
+    it "sets etag and does not change status code if status code set and not 2xx or 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>499).should == [499, 'ok']
+    end
+
+    it "sets etag and returns 304 if status code set to 2xx if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>201).should == [412, '']
+    end
+
+    it "sets etag and returns 304 if status code is already 304 if If-None-Match is etag" do
+      res('HTTP_IF_NONE_MATCH' => '"foo"', 'status'=>304).should == [412, '']
+    end
+
+    it "sets etag if If-Match is * and this is not a new resource" do
+      res('HTTP_IF_MATCH' => '*', 'new_resource'=>false).should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match is etag" do
+      res('HTTP_IF_MATCH' => '"foo"').should == [200, 'ok']
+    end
+
+    it "sets etag if If-Match includes etag" do
+      res('HTTP_IF_MATCH' => '"bar", "foo"').should == [200, 'ok']
+    end
+
+    it "sets etag and returns 412 if If-Match is * for new resources" do
+      res('HTTP_IF_MATCH' => '*').should == [412, '']
+    end
+
+    it "sets etag if If-Match does not include etag" do
+      res('HTTP_IF_MATCH' => '"bar", "baz"', 'new_resource'=>true).should == [412, '']
+    end
+  end
+end

data/spec/plugin/chunked_spec.rb

@@ -0,0 +1,182 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+begin
+  require 'tilt/erb'
+rescue LoadError
+  warn "tilt not installed, skipping chunked plugin test"  
+else
+describe "chunked plugin" do 
+  def cbody(env={})
+    b = ''
+    req({'HTTP_VERSION'=>'HTTP/1.1'}.merge(env))[2].each{|s| b << s}
+    b
+  end
+
+  it "streams templates in chunked encoding only if HTTP 1.1 is used" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmt"
+  end
+
+  it "hex encodes chunk sizes" do
+    m = 'm' * 31
+    app(:chunked) do |r|
+      chunked(:inline=>m, :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\nh\r\n1f\r\n#{m}\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "h#{m}t"
+  end
+
+  it "accepts a block that is called after layout yielding but before content when streaming" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m<%= @h %>', :layout=>{:inline=>'<%= @h %><%= yield %>t'}) do
+        @h = 'h'
+      end
+    end
+
+    cbody.should == "2\r\nmh\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmht"
+  end
+
+  it "works when a layout is not used" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>nil)
+    end
+
+    cbody.should == "1\r\nm\r\n0\r\n\r\n"
+    body.should == "m"
+  end
+
+  it "streams partial template responses if flush is used in content template" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m<%= flush %>n', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\nn\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmnt"
+  end
+
+  it "streams partial template responses if flush is used in layout template" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>{:inline=>'h<%= flush %>i<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\ni\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "himt"
+  end
+
+  it "does not stream if no_chunk! is used" do
+    app(:chunked) do |r|
+      no_chunk!
+      chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "hmt"
+    body.should == "hmt"
+  end
+
+  it "streams existing response body before call" do
+    app(:chunked) do |r|
+      response.write('a')
+      response.write chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\na\r\n1\r\nh\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "ahmt"
+  end
+
+  it "should not include Content-Length header even if body is already written to" do
+    app(:chunked) do |r|
+      response.write('a')
+      response.write chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    header('Content-Length', 'HTTP_VERSION'=>'HTTP/1.1').should == nil
+    header('Content-Length', 'HTTP_VERSION'=>'HTTP/1.0').should == '4'
+  end
+
+  it "stream template responses for view if :chunk_by_default is used" do
+    app(:bare) do
+      plugin :chunked, :chunk_by_default=>true
+      route do |r|
+        view(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+      end
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmt"
+  end
+
+  it "uses Transfer-Encoding header when chunking" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    header('Transfer-Encoding', 'HTTP_VERSION'=>'HTTP/1.1').should == 'chunked'
+    header('Transfer-Encoding', 'HTTP_VERSION'=>'HTTP/1.0').should == nil
+  end
+
+  it "uses given :headers when chunking" do
+    app(:bare) do
+      plugin :chunked, :headers=>{'Foo'=>'bar'}
+      route do |r|
+        chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
+      end
+    end
+
+    header('Foo', 'HTTP_VERSION'=>'HTTP/1.1').should == 'bar'
+    header('Foo', 'HTTP_VERSION'=>'HTTP/1.0').should == nil
+  end
+
+  it "handles multiple arguments to chunked" do
+    app(:bare) do
+      plugin :chunked, :chunk_by_default=>true
+      plugin :render, :views => "./spec/views"
+      route do |r|
+        chunked('about', :locals=>{:title=>'m'}, :layout=>{:inline=>'h<%= yield %>t'})
+      end
+    end
+
+    cbody.should == "1\r\nh\r\nb\r\n<h1>m</h1>\n\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "h<h1>m</h1>\nt"
+  end
+
+  it "handles multiple hash arguments to chunked" do
+    app(:chunked) do |r|
+      chunked({:inline=>'m'}, :layout=>{:inline=>'h<%= yield %>t'})
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmt"
+  end
+
+  it "handles :layout_opts option" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>{:inline=>'<%= h %><%= yield %>t'}, :layout_opts=>{:locals=>{:h=>'h'}})
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\nt\r\n0\r\n\r\n"
+    body.should == "hmt"
+  end
+
+  it "uses handle_chunk_error for handling errors when chunking" do
+    app(:chunked) do |r|
+      chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %><% raise %>'})
+    end
+    proc{cbody}.should raise_error
+    proc{body}.should raise_error
+
+    app.send(:define_method, :handle_chunk_error) do |v|
+      @_out_buf = 'e'
+      flush
+    end
+
+    cbody.should == "1\r\nh\r\n1\r\nm\r\n1\r\ne\r\n0\r\n\r\n"
+    proc{body}.should raise_error
+  end
+end
+end