rack-contrib 0.9.0 → 0.9.2

data/test/spec_rack_csshttprequest.rb

@@ -0,0 +1,66 @@
+require 'test/spec'
+require 'rack/mock'
+
+begin
+  require 'csshttprequest'
+  require 'rack/contrib/csshttprequest'
+
+  context "Rack::CSSHTTPRequest" do
+
+    before(:each) do
+      @test_body = '{"bar":"foo"}'
+      @test_headers = {'Content-Type' => 'text/plain'}
+      @encoded_body = CSSHTTPRequest.encode(@test_body)
+      @app = lambda { |env| [200, @test_headers, [@test_body]] }
+    end
+
+    specify "env['csshttprequest.chr'] should be set to true when \
+        PATH_INFO ends with '.chr'" do
+      request = Rack::MockRequest.env_for("/blah.chr", :lint => true, :fatal => true)
+      Rack::CSSHTTPRequest.new(@app).call(request)
+      request['csshttprequest.chr'].should.equal true
+    end
+
+    specify "env['csshttprequest.chr'] should be set to true when \
+        request parameter _format == 'chr'" do
+      request = Rack::MockRequest.env_for("/?_format=chr", :lint => true, :fatal => true)
+      Rack::CSSHTTPRequest.new(@app).call(request)
+      request['csshttprequest.chr'].should.equal true
+    end
+
+    specify "should not change the headers or response when !env['csshttprequest.chr']" do
+      request = Rack::MockRequest.env_for("/", :lint => true, :fatal => true)
+      status, headers, response = Rack::CSSHTTPRequest.new(@app).call(request)
+      headers.should.equal @test_headers
+      response.join.should.equal @test_body
+    end
+
+    context "when env['csshttprequest.chr']" do
+      before(:each) do
+        @request = Rack::MockRequest.env_for("/",
+          'csshttprequest.chr' => true, :lint => true, :fatal => true)
+      end
+
+      specify "should modify the content length to the correct value" do
+        headers = Rack::CSSHTTPRequest.new(@app).call(@request)[1]
+        headers['Content-Length'].should.equal @encoded_body.length.to_s
+      end
+
+      specify "should modify the content type to the correct value" do
+        headers = Rack::CSSHTTPRequest.new(@app).call(@request)[1]
+        headers['Content-Type'].should.equal 'text/css'
+      end
+
+      specify "should not modify any other headers" do
+        headers = Rack::CSSHTTPRequest.new(@app).call(@request)[1]
+        headers.should.equal @test_headers.merge({
+          'Content-Type' => 'text/css',
+          'Content-Length' => @encoded_body.length.to_s
+        })
+      end
+    end
+
+  end
+rescue LoadError => boom
+  STDERR.puts "WARN: Skipping Rack::CSSHTTPRequest tests (nbio-csshttprequest not installed)"
+end

data/test/spec_rack_deflect.rb

@@ -0,0 +1,107 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/deflect'
+
+context "Rack::Deflect" do
+
+  setup do
+    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, 'cookies'] }
+    @mock_addr_1 = '111.111.111.111'
+    @mock_addr_2 = '222.222.222.222'
+    @mock_addr_3 = '333.333.333.333'
+  end
+
+  def mock_env remote_addr, path = '/'
+    Rack::MockRequest.env_for path, { 'REMOTE_ADDR' => remote_addr }
+  end
+
+  def mock_deflect options = {}
+    Rack::Deflect.new @app, options
+  end
+
+  specify "should allow regular requests to follow through" do
+    app = mock_deflect
+    status, headers, body = app.call mock_env(@mock_addr_1)
+    status.should.equal 200
+    body.should.equal 'cookies'
+  end
+
+  specify "should deflect requests exceeding the request threshold" do
+    log = StringIO.new
+    app = mock_deflect :request_threshold => 5, :interval => 10, :block_duration => 10, :log => log
+    env = mock_env @mock_addr_1
+
+    # First 5 should be fine
+    5.times do
+      status, headers, body = app.call env
+      status.should.equal 200
+      body.should.equal 'cookies'
+    end
+
+    # Remaining requests should fail for 10 seconds
+    10.times do
+      status, headers, body = app.call env
+      status.should.equal 403
+      body.should.equal ''
+    end
+
+    # Log should reflect that we have blocked an address
+    log.string.should.match(/^deflect\(\d+\/\d+\/\d+\): blocked 111.111.111.111\n/)
+  end
+
+  specify "should expire blocking" do
+    log = StringIO.new
+    app = mock_deflect :request_threshold => 5, :interval => 2, :block_duration => 2, :log => log
+    env = mock_env @mock_addr_1
+
+    # First 5 should be fine
+    5.times do
+      status, headers, body = app.call env
+      status.should.equal 200
+      body.should.equal 'cookies'
+    end
+
+    # Exceeds request threshold
+    status, headers, body = app.call env
+    status.should.equal 403
+    body.should.equal ''
+
+    # Allow block to expire
+    sleep 3
+
+    # Another 5 is fine now
+    5.times do
+      status, headers, body = app.call env
+      status.should.equal 200
+      body.should.equal 'cookies'
+    end
+
+    # Log should reflect block and release
+    log.string.should.match(/deflect.*: blocked 111\.111\.111\.111\ndeflect.*: released 111\.111\.111\.111\n/)
+  end
+
+  specify "should allow whitelisting of remote addresses" do
+    app = mock_deflect :whitelist => [@mock_addr_1], :request_threshold => 5, :interval => 2
+    env = mock_env @mock_addr_1
+
+    # Whitelisted addresses are always fine
+    10.times do
+      status, headers, body = app.call env
+      status.should.equal 200
+      body.should.equal 'cookies'
+    end
+  end
+
+  specify "should allow blacklisting of remote addresses" do
+    app = mock_deflect :blacklist => [@mock_addr_2]
+
+    status, headers, body = app.call mock_env(@mock_addr_1)
+    status.should.equal 200
+    body.should.equal 'cookies'
+
+    status, headers, body = app.call mock_env(@mock_addr_2)
+    status.should.equal 403
+    body.should.equal ''
+  end
+
+end

data/test/spec_rack_jsonp.rb

@@ -3,19 +3,32 @@ require 'rack/mock'
 require 'rack/contrib/jsonp'
 
 context "Rack::JSONP" do
-  
-  specify "should wrap the response body in the Javascript callback when provided" do
-    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, '{"bar":"foo"}'] }
-    request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=foo")
-    body = Rack::JSONP.new(app).call(request).last
-    body.should == 'foo({"bar":"foo"})'
+
+  context "when a callback parameter is provided" do
+    specify "should wrap the response body in the Javascript callback" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=#{callback}")
+      body = Rack::JSONP.new(app).call(request).last
+      body.join.should.equal "#{callback}(#{test_body})"
+    end
+
+    specify "should modify the content length to the correct value" do
+      test_body = '{"bar":"foo"}'
+      callback = 'foo'
+      app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/", :input => "foo=bar&callback=#{callback}")
+      headers = Rack::JSONP.new(app).call(request)[1]
+      headers['Content-Length'].should.equal((test_body.length + callback.length + 2).to_s) # 2 parentheses
+    end
   end
-  
-  specify "should not change anything if no :callback param is provided" do
+
+  specify "should not change anything if no callback param is provided" do
     app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, '{"bar":"foo"}'] }
     request = Rack::MockRequest.env_for("/", :input => "foo=bar")
     body = Rack::JSONP.new(app).call(request).last
-    body.should == '{"bar":"foo"}'
+    body.join.should.equal '{"bar":"foo"}'
   end
-  
+
 end

data/test/spec_rack_lighttpd_script_name_fix.rb

@@ -8,7 +8,7 @@ context "Rack::LighttpdScriptNameFix" do
       "PATH_INFO" => "/foo/bar/baz",
       "SCRIPT_NAME" => "/hello"
     }
-    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    app = lambda { |_| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
     response = Rack::LighttpdScriptNameFix.new(app).call(env)
     env['SCRIPT_NAME'].should.be.empty
     env['PATH_INFO'].should.equal '/hello/foo/bar/baz'

data/test/spec_rack_not_found.rb

@@ -0,0 +1,17 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/not_found'
+
+context "Rack::NotFound" do
+
+  specify "should render the file at the given path for all requests" do
+    app = Rack::Builder.new do
+      use Rack::Lint
+      run Rack::NotFound.new('test/404.html')
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should.equal('Not Found')
+    response.status.should.equal(404)
+  end
+
+end

data/test/spec_rack_post_body_content_type_parser.rb

@@ -3,9 +3,9 @@ require 'rack/mock'
 
 begin
   require 'rack/contrib/post_body_content_type_parser'
-  
+
   context "Rack::PostBodyContentTypeParser" do
-    
+
     specify "should handle requests with POST body Content-Type of application/json" do
       app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST] }
       env = env_for_post_with_headers('/', {'Content_Type'.upcase => 'application/json'}, {:body => "asdf", :status => "12"}.to_json)
@@ -13,16 +13,16 @@ begin
       body['body'].should.equal "asdf"
       body['status'].should.equal "12"
     end
-    
+
     specify "should change nothing when the POST body content type isn't application/json" do
       app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env).POST] }
       body = app.call(Rack::MockRequest.env_for("/", :input => "body=asdf&status=12")).last
       body['body'].should.equal "asdf"
       body['status'].should.equal "12"
     end
-    
+
   end
-  
+
   def env_for_post_with_headers(path, headers, body)
     Rack::MockRequest.env_for(path, {:method => "POST", :input => body}.merge(headers))
   end

data/test/spec_rack_profiler.rb

@@ -1,32 +1,37 @@
 require 'test/spec'
 require 'rack/mock'
-require 'rack/contrib/profiler'
 
-context 'Rack::Profiler' do
-  
-  app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'Oh hai der'] }
-  request = Rack::MockRequest.env_for("/", :input => "profile=process_time")
-  
-  specify 'printer defaults to RubyProf::CallTreePrinter' do
-    profiler = Rack::Profiler.new(nil)
-    profiler.instance_variable_get('@printer').should == RubyProf::CallTreePrinter
-    profiler.instance_variable_get('@times').should == 1
-  end
-  
-  specify 'CallTreePrinter has correct headers' do  
-    headers = Rack::Profiler.new(app).call(request)[1]
-    headers.should == {"Content-Disposition"=>"attachment; filename=\"/.process_time.tree\"", "Content-Type"=>"application/octet-stream"}
-  end
-  
-  specify 'FlatPrinter and GraphPrinter has Content-Type text/plain' do
-    %w(flat graph).each do |printer|
-      headers = Rack::Profiler.new(app, :printer => printer.to_sym).call(request)[1]
-      headers.should == {"Content-Type"=>"text/plain"}
+begin
+  require 'rack/contrib/profiler'
+
+  context 'Rack::Profiler' do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, 'Oh hai der'] }
+    request = Rack::MockRequest.env_for("/", :input => "profile=process_time")
+
+    specify 'printer defaults to RubyProf::CallTreePrinter' do
+      profiler = Rack::Profiler.new(nil)
+      profiler.instance_variable_get('@printer').should.equal RubyProf::CallTreePrinter
+      profiler.instance_variable_get('@times').should.equal 1
+    end
+
+    specify 'CallTreePrinter has correct headers' do
+      headers = Rack::Profiler.new(app).call(request)[1]
+      headers.should.equal "Content-Disposition"=>"attachment; filename=\"/.process_time.tree\"", "Content-Type"=>"application/octet-stream"
+    end
+
+    specify 'FlatPrinter and GraphPrinter has Content-Type text/plain' do
+      %w(flat graph).each do |printer|
+        headers = Rack::Profiler.new(app, :printer => printer.to_sym).call(request)[1]
+        headers.should.equal "Content-Type"=>"text/plain"
+      end
+    end
+
+    specify 'GraphHtmlPrinter has Content-Type text/html' do
+      headers = Rack::Profiler.new(app, :printer => :graph_html).call(request)[1]
+      headers.should.equal "Content-Type"=>"text/html"
     end
   end
-  
-  specify 'GraphHtmlPrinter has Content-Type text/html' do
-    headers = Rack::Profiler.new(app, :printer => :graph_html).call(request)[1]
-    headers.should == {"Content-Type"=>"text/html"}
-  end
+
+rescue LoadError => boom
+  $stderr.puts "WARN: Skipping Rack::Profiler tests (ruby-prof not installed)"
 end

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