corntrace-rack-contrib 1.0.2

data/test/spec_rack_relative_redirect.rb

@@ -0,0 +1,78 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/relative_redirect'
+require 'fileutils'
+
+context Rack::RelativeRedirect do
+  def request(opts={}, &block)
+    @def_status = opts[:status] if opts[:status]
+    @def_location = opts[:location] if opts[:location]
+    yield Rack::MockRequest.new(Rack::RelativeRedirect.new(@def_app, &opts[:block])).get(opts[:path]||@def_path, opts[:headers]||{})
+  end
+
+  setup do
+    @def_path = '/path/to/blah'
+    @def_status = 301
+    @def_location = '/redirect/to/blah'
+    @def_app = lambda { |env| [@def_status, {'Location' => @def_location}, [""]]}
+  end
+
+  specify "should make the location url an absolute url if currently a relative url" do
+    request do |r|
+      r.status.should.equal(301)
+      r.headers['Location'].should.equal('http://example.org/redirect/to/blah')
+    end
+    request(:status=>302, :location=>'/redirect') do |r|
+      r.status.should.equal(302)
+      r.headers['Location'].should.equal('http://example.org/redirect')
+    end
+  end
+
+  specify "should use the request path if the relative url is given and doesn't start with a slash" do
+    request(:status=>303, :location=>'redirect/to/blah') do |r|
+      r.status.should.equal(303)
+      r.headers['Location'].should.equal('http://example.org/path/to/redirect/to/blah')
+    end
+    request(:status=>303, :location=>'redirect') do |r|
+      r.status.should.equal(303)
+      r.headers['Location'].should.equal('http://example.org/path/to/redirect')
+    end
+  end
+
+  specify "should use a given block to make the url absolute" do
+    request(:block=>proc{|env, res| "https://example.org"}) do |r|
+      r.status.should.equal(301)
+      r.headers['Location'].should.equal('https://example.org/redirect/to/blah')
+    end
+    request(:status=>303, :location=>'/redirect', :block=>proc{|env, res| "https://e.org:9999/blah"}) do |r|
+      r.status.should.equal(303)
+      r.headers['Location'].should.equal('https://e.org:9999/blah/redirect')
+    end
+  end
+
+  specify "should not modify the location url unless the response is a redirect" do
+    status = 200
+    @def_app = lambda { |env| [status, {'Content-Type' => "text/html"}, [""]]}
+    request do |r|
+      r.status.should.equal(200)
+      r.headers.should.not.include?('Location')
+    end
+    status = 404
+    @def_app = lambda { |env| [status, {'Content-Type' => "text/html", 'Location' => 'redirect'}, [""]]}
+    request do |r|
+      r.status.should.equal(404)
+      r.headers['Location'].should.equal('redirect')
+    end
+  end
+
+  specify "should not modify the location url if it is already an absolute url" do
+    request(:location=>'https://example.org/') do |r|
+      r.status.should.equal(301)
+      r.headers['Location'].should.equal('https://example.org/')
+    end
+    request(:status=>302, :location=>'https://e.org:9999/redirect') do |r|
+      r.status.should.equal(302)
+      r.headers['Location'].should.equal('https://e.org:9999/redirect')
+    end
+  end
+end

data/test/spec_rack_response_cache.rb

@@ -0,0 +1,137 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/response_cache'
+require 'fileutils'
+
+context Rack::ResponseCache do
+  F = ::File
+
+  def request(opts={}, &block)
+    Rack::MockRequest.new(Rack::ResponseCache.new(block||@def_app, opts[:cache]||@cache, &opts[:rc_block])).send(opts[:meth]||:get, opts[:path]||@def_path, opts[:headers]||{})
+  end
+
+  setup do
+    @cache = {}
+    @def_disk_cache = F.join(F.dirname(__FILE__), 'response_cache_test_disk_cache')
+    @def_value = ["rack-response-cache"]
+    @def_path = '/path/to/blah'
+    @def_app = lambda { |env| [200, {'Content-Type' => env['CT'] || 'text/html'}, @def_value]}
+  end
+  teardown do
+    FileUtils.rm_rf(@def_disk_cache)
+  end
+
+  specify "should cache results to disk if cache is a string" do
+    request(:cache=>@def_disk_cache)
+    F.read(F.join(@def_disk_cache, 'path', 'to', 'blah.html')).should.equal @def_value.first
+    request(:path=>'/path/3', :cache=>@def_disk_cache)
+    F.read(F.join(@def_disk_cache, 'path', '3.html')).should.equal @def_value.first
+  end
+
+  specify "should cache results to given cache if cache is not a string" do
+    request
+    @cache.should.equal('/path/to/blah.html'=>@def_value)
+    request(:path=>'/path/3')
+    @cache.should.equal('/path/to/blah.html'=>@def_value, '/path/3.html'=>@def_value)
+  end
+
+  specify "should not CACHE RESults if request method is not GET" do
+    request(:meth=>:post)
+    @cache.should.equal({})
+    request(:meth=>:put)
+    @cache.should.equal({})
+    request(:meth=>:delete)
+    @cache.should.equal({})
+  end
+
+  specify "should not cache results if there is a query string" do
+    request(:path=>'/path/to/blah?id=1')
+    @cache.should.equal({})
+    request(:path=>'/path/to/?id=1')
+    @cache.should.equal({})
+    request(:path=>'/?id=1')
+    @cache.should.equal({})
+  end
+
+  specify "should cache results if there is an empty query string" do
+    request(:path=>'/?')
+    @cache.should.equal('/index.html'=>@def_value)
+  end
+
+  specify "should not cache results if the request is not sucessful (status 200)" do
+    request{|env| [404, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+    request{|env| [500, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+    request{|env| [302, {'Content-Type' => 'text/html'}, ['']]}
+    @cache.should.equal({})
+  end
+
+  specify "should not cache results if the block returns nil or false" do
+    request(:rc_block=>proc{false})
+    @cache.should.equal({})
+    request(:rc_block=>proc{nil})
+    @cache.should.equal({})
+  end
+
+  specify "should cache results to path returned by block" do
+    request(:rc_block=>proc{"1"})
+    @cache.should.equal("1"=>@def_value)
+    request(:rc_block=>proc{"2"})
+    @cache.should.equal("1"=>@def_value, "2"=>@def_value)
+  end
+
+  specify "should pass the environment and response to the block" do
+    e, r = nil, nil
+    request(:rc_block=>proc{|env,res| e, r = env, res; nil})
+    e['PATH_INFO'].should.equal @def_path
+    e['REQUEST_METHOD'].should.equal 'GET'
+    e['QUERY_STRING'].should.equal ''
+    r.should.equal([200, {"Content-Type"=>"text/html"}, ["rack-response-cache"]])
+  end
+
+  specify "should unescape the path by default" do
+    request(:path=>'/path%20with%20spaces')
+    @cache.should.equal('/path with spaces.html'=>@def_value)
+    request(:path=>'/path%3chref%3e')
+    @cache.should.equal('/path with spaces.html'=>@def_value, '/path<href>.html'=>@def_value)
+  end
+
+  specify "should cache html, css, and xml responses by default" do
+    request(:path=>'/a')
+    @cache.should.equal('/a.html'=>@def_value)
+    request(:path=>'/b', :headers=>{'CT'=>'text/xml'})
+    @cache.should.equal('/a.html'=>@def_value, '/b.xml'=>@def_value)
+    request(:path=>'/c', :headers=>{'CT'=>'text/css'})
+    @cache.should.equal('/a.html'=>@def_value, '/b.xml'=>@def_value, '/c.css'=>@def_value)
+  end
+
+  specify "should cache responses by default with the extension added if not already present" do
+    request(:path=>'/a.html')
+    @cache.should.equal('/a.html'=>@def_value)
+    request(:path=>'/b.xml', :headers=>{'CT'=>'text/xml'})
+    @cache.should.equal('/a.html'=>@def_value, '/b.xml'=>@def_value)
+    request(:path=>'/c.css', :headers=>{'CT'=>'text/css'})
+    @cache.should.equal('/a.html'=>@def_value, '/b.xml'=>@def_value, '/c.css'=>@def_value)
+  end
+
+  specify "should not delete existing extensions" do
+    request(:path=>'/d.css', :headers=>{'CT'=>'text/html'})
+    @cache.should.equal('/d.css.html'=>@def_value)
+  end
+
+  specify "should cache html responses with empty basename to index.html by default" do
+    request(:path=>'/')
+    @cache.should.equal('/index.html'=>@def_value)
+    request(:path=>'/blah/')
+    @cache.should.equal('/index.html'=>@def_value, '/blah/index.html'=>@def_value)
+    request(:path=>'/blah/2/')
+    @cache.should.equal('/index.html'=>@def_value, '/blah/index.html'=>@def_value, '/blah/2/index.html'=>@def_value)
+  end
+
+  specify "should raise an error if a cache argument is not provided" do
+    app = Rack::Builder.new{use Rack::ResponseCache; run lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST]}}
+    proc{Rack::MockRequest.new(app).get('/')}.should.raise(ArgumentError)
+  end
+
+end

data/test/spec_rack_response_headers.rb

@@ -0,0 +1,35 @@
+require 'test/spec'
+require 'rack'
+require 'rack/contrib/response_headers'
+
+context "Rack::ResponseHeaders" do
+
+  specify "yields a HeaderHash of response headers" do
+    orig_headers = {'X-Foo' => 'foo', 'X-Bar' => 'bar'}
+    app = Proc.new {[200, orig_headers, []]}
+    middleware = Rack::ResponseHeaders.new(app) do |headers|
+      assert_instance_of Rack::Utils::HeaderHash, headers
+      orig_headers.should == headers
+    end
+    middleware.call({})
+  end
+
+  specify "allows adding headers" do
+    app = Proc.new {[200, {'X-Foo' => 'foo'}, []]}
+    middleware = Rack::ResponseHeaders.new(app) do |headers|
+      headers['X-Bar'] = 'bar'
+    end
+    r = middleware.call({})
+    r[1].should == {'X-Foo' => 'foo', 'X-Bar' => 'bar'}
+  end
+
+  specify "allows deleting headers" do
+    app = Proc.new {[200, {'X-Foo' => 'foo', 'X-Bar' => 'bar'}, []]}
+    middleware = Rack::ResponseHeaders.new(app) do |headers|
+      headers.delete('X-Bar')
+    end
+    r = middleware.call({})
+    r[1].should == {'X-Foo' => 'foo'}
+  end
+
+end

data/test/spec_rack_runtime.rb

@@ -0,0 +1,35 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/runtime'
+
+context "Rack::Runtime" do
+  specify "sets X-Runtime is none is set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    response = Rack::Runtime.new(app).call({})
+    response[1]['X-Runtime'].should =~ /[\d\.]+/
+  end
+
+  specify "does not set the X-Runtime if it is already set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain', "X-Runtime" => "foobar"}, "Hello, World!"] }
+    response = Rack::Runtime.new(app).call({})
+    response[1]['X-Runtime'].should == "foobar"
+  end
+
+  specify "should allow a suffix to be set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    response = Rack::Runtime.new(app, "Test").call({})
+    response[1]['X-Runtime-Test'].should =~ /[\d\.]+/
+  end
+
+  specify "should allow multiple timers to be set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    runtime1 = Rack::Runtime.new(app, "App")
+    runtime2 = Rack::Runtime.new(runtime1, "All")
+    response = runtime2.call({})
+
+    response[1]['X-Runtime-App'].should =~ /[\d\.]+/
+    response[1]['X-Runtime-All'].should =~ /[\d\.]+/
+
+    Float(response[1]['X-Runtime-All']).should > Float(response[1]['X-Runtime-App'])
+  end
+end

data/test/spec_rack_sendfile.rb

@@ -0,0 +1,86 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/sendfile'
+
+context "Rack::File" do
+  specify "should respond to #to_path" do
+    Rack::File.new(Dir.pwd).should.respond_to :to_path
+  end
+end
+
+context "Rack::Sendfile" do
+  def sendfile_body
+    res = ['Hello World']
+    def res.to_path ; "/tmp/hello.txt" ; end
+    res
+  end
+
+  def simple_app(body=sendfile_body)
+    lambda { |env| [200, {'Content-Type' => 'text/plain'}, body] }
+  end
+
+  def sendfile_app(body=sendfile_body)
+    Rack::Sendfile.new(simple_app(body))
+  end
+
+  setup do
+    @request = Rack::MockRequest.new(sendfile_app)
+  end
+
+  def request(headers={})
+    yield @request.get('/', headers)
+  end
+
+  specify "does nothing when no X-Sendfile-Type header present" do
+    request do |response|
+      response.should.be.ok
+      response.body.should.equal 'Hello World'
+      response.headers.should.not.include 'X-Sendfile'
+    end
+  end
+
+  specify "sets X-Sendfile response header and discards body" do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Sendfile' do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Sendfile'].should.equal '/tmp/hello.txt'
+    end
+  end
+
+  specify "sets X-Lighttpd-Send-File response header and discards body" do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Lighttpd-Send-File' do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Lighttpd-Send-File'].should.equal '/tmp/hello.txt'
+    end
+  end
+
+  specify "sets X-Accel-Redirect response header and discards body" do
+    headers = {
+      'HTTP_X_SENDFILE_TYPE' => 'X-Accel-Redirect',
+      'HTTP_X_ACCEL_MAPPING' => '/tmp/=/foo/bar/'
+    }
+    request headers do |response|
+      response.should.be.ok
+      response.body.should.be.empty
+      response.headers['X-Accel-Redirect'].should.equal '/foo/bar/hello.txt'
+    end
+  end
+
+  specify 'writes to rack.error when no X-Accel-Mapping is specified' do
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Accel-Redirect' do |response|
+      response.should.be.ok
+      response.body.should.equal 'Hello World'
+      response.headers.should.not.include 'X-Accel-Redirect'
+      response.errors.should.include 'X-Accel-Mapping'
+    end
+  end
+
+  specify 'does nothing when body does not respond to #to_path' do
+    @request = Rack::MockRequest.new(sendfile_app(['Not a file...']))
+    request 'HTTP_X_SENDFILE_TYPE' => 'X-Sendfile' do |response|
+      response.body.should.equal 'Not a file...'
+      response.headers.should.not.include 'X-Sendfile'
+    end
+  end
+end

data/test/spec_rack_simple_endpoint.rb

@@ -0,0 +1,95 @@
+require 'test/spec'
+require 'rack'
+require 'rack/contrib/simple_endpoint'
+
+context "Rack::SimpleEndpoint" do
+  setup do
+    @app = Proc.new { Rack::Response.new {|r| r.write "Downstream app"}.finish }
+  end
+
+  specify "calls downstream app when no match" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/baz'))
+    status.should == 200
+    body.body.should == ['Downstream app']
+  end
+
+  specify "calls downstream app when path matches but method does not" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo' => :get) { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo', :method => 'post'))
+    status.should == 200
+    body.body.should == ['Downstream app']
+  end
+
+  specify "calls downstream app when path matches but block returns :pass" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') { :pass }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo'))
+    status.should == 200
+    body.body.should == ['Downstream app']
+  end
+
+  specify "returns endpoint response when path matches" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo'))
+    status.should == 200
+    body.body.should == ['bar']
+  end
+
+  specify "returns endpoint response when path and single method requirement match" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo' => :get) { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo'))
+    status.should == 200
+    body.body.should == ['bar']
+  end
+
+  specify "returns endpoint response when path and one of multiple method requirements match" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo' => [:get, :post]) { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo', :method => 'post'))
+    status.should == 200
+    body.body.should == ['bar']
+  end
+
+  specify "returns endpoint response when path matches regex" do
+    endpoint = Rack::SimpleEndpoint.new(@app, /foo/) { 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/bar/foo'))
+    status.should == 200
+    body.body.should == ['bar']
+  end
+
+  specify "block yields Rack::Request and Rack::Response objects" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') do |req, res|
+      assert_instance_of ::Rack::Request, req
+      assert_instance_of ::Rack::Response, res
+    end
+    endpoint.call(Rack::MockRequest.env_for('/foo'))
+  end
+
+  specify "block yields MatchData object when Regex path matcher specified" do
+    endpoint = Rack::SimpleEndpoint.new(@app, /foo(.+)/) do |req, res, match|
+      assert_instance_of MatchData, match
+      assert_equal 'bar', match[1]
+    end
+    endpoint.call(Rack::MockRequest.env_for('/foobar'))
+  end
+
+  specify "block does NOT yield MatchData object when String path matcher specified" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') do |req, res, match|
+      assert_nil match
+    end
+    endpoint.call(Rack::MockRequest.env_for('/foo'))
+  end
+
+  specify "response honors headers set in block" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') {|req, res| res['X-Foo'] = 'bar'; 'baz' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo'))
+    status.should == 200
+    headers['X-Foo'].should == 'bar'
+    body.body.should == ['baz']
+  end
+  
+  specify "sets Content-Length header" do
+    endpoint = Rack::SimpleEndpoint.new(@app, '/foo') {|req, res| 'bar' }
+    status, headers, body = endpoint.call(Rack::MockRequest.env_for('/foo'))
+    headers['Content-Length'].should == '3'
+  end
+end

data/test/spec_rack_static_cache.rb

@@ -0,0 +1,91 @@
+require 'test/spec'
+
+require 'rack'
+require 'rack/contrib/static_cache'
+require 'rack/mock'
+
+class DummyApp
+  def call(env)
+    [200, {}, ["Hello World"]]
+  end
+end
+
+describe "Rack::StaticCache" do
+
+  setup do
+    @root = ::File.expand_path(::File.dirname(__FILE__))
+  end
+
+  it "should serve files with required headers" do
+    default_app_request
+    res = @request.get("/statics/test")
+    res.should.be.ok
+    res.body.should =~ /rubyrack/
+    res.headers['Cache-Control'].should == 'max-age=31536000, public'
+     next_year = Time.now().year + 1
+    res.headers['Expires'].should =~ Regexp.new(
+        "[A-Z][a-z]{2}[,][\s][0-9]{2}[\s][A-Z][a-z]{2}[\s]" << "#{next_year}" <<
+        "[\s][0-9]{2}[:][0-9]{2}[:][0-9]{2} GMT$")
+    res.headers.has_key?('Etag').should == false
+    res.headers.has_key?('Pragma').should == false
+    res.headers.has_key?('Last-Modified').should == false
+  end
+
+  it "should return 404s if url root is known but it can't find the file" do
+    default_app_request
+    res = @request.get("/statics/foo")
+    res.should.be.not_found
+  end
+
+  it "should call down the chain if url root is not known" do
+    default_app_request
+    res = @request.get("/something/else")
+    res.should.be.ok
+    res.body.should == "Hello World"
+  end
+
+  it "should serve files if requested with version number and versioning is enabled" do
+    default_app_request
+    res = @request.get("/statics/test-0.0.1")
+    res.should.be.ok
+  end
+
+  it "should change cache duration if specified thorugh option" do
+    configured_app_request
+    res = @request.get("/statics/test")
+    res.should.be.ok
+    res.body.should =~ /rubyrack/
+    next_next_year = Time.now().year + 2
+    res.headers['Expires'].should =~ Regexp.new("#{next_next_year}")
+  end
+
+  it "should return 404s if requested with version number but versioning is disabled" do
+    configured_app_request
+    res = @request.get("/statics/test-0.0.1")
+    res.should.be.not_found
+  end
+
+  it "should serve files with plain headers when * is added to the directory name" do
+    configured_app_request
+    res = @request.get("/documents/test")
+    res.should.be.ok
+    res.body.should =~ /nocache/
+    next_next_year = Time.now().year + 2
+    res.headers['Expires'].should.not =~ Regexp.new("#{next_next_year}")
+  end
+
+  def default_app_request
+    @options = {:urls => ["/statics"], :root => @root}
+    request
+  end
+
+  def configured_app_request
+    @options = {:urls => ["/statics", "/documents*"], :root => @root, :versioning => false, :duration => 2}
+    request
+  end
+
+  def request
+    @request = Rack::MockRequest.new(Rack::StaticCache.new(DummyApp.new, @options))
+  end
+
+end

data/test/statics/test

@@ -0,0 +1 @@
+rubyrack