rack-rack-contrib 0.9.1

data/test/spec_rack_etag.rb

@@ -0,0 +1,23 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/etag'
+
+context "Rack::ETag" do
+  specify "sets ETag if none is set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, World!"] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal "\"65a8e27d8879283831b664bd8b7f0ad4\""
+  end
+
+  specify "does not change ETag if it is already set" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain', 'ETag' => '"abc"'}, "Hello, World!"] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal "\"abc\""
+  end
+
+  specify "does not set ETag if steaming body" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello", "World"]] }
+    response = Rack::ETag.new(app).call({})
+    response[1]['ETag'].should.equal nil
+  end
+end

data/test/spec_rack_evil.rb

@@ -0,0 +1,19 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/evil'
+require 'erb'
+
+context "Rack::Evil" do
+  app = lambda do |env|
+    template = ERB.new("<%= throw :response, [404, {'Content-Type' => 'text/html'}, 'Never know where it comes from'] %>")
+    [200, {'Content-Type' => 'text/plain'}, template.result(binding)]
+  end
+
+  specify "should enable the app to return the response from anywhere" do
+    status, headers, body = Rack::Evil.new(app).call({})
+
+    status.should.equal 404
+    headers['Content-Type'].should.equal 'text/html'
+    body.should.equal 'Never know where it comes from'
+  end
+end

data/test/spec_rack_garbagecollector.rb

@@ -0,0 +1,13 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/garbagecollector'
+
+context 'Rack::GarbageCollector' do
+
+  specify 'starts the garbage collector after each request' do
+    app = lambda { |env|
+      [200, {'Content-Type'=>'text/plain'}, ['Hello World']] }
+    Rack::GarbageCollector.new(app).call({})
+  end
+
+end

data/test/spec_rack_jsonp.rb

@@ -0,0 +1,34 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/jsonp'
+
+context "Rack::JSONP" do
+
+  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
+    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.join.should.equal '{"bar":"foo"}'
+  end
+
+end

data/test/spec_rack_lighttpd_script_name_fix.rb

@@ -0,0 +1,16 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/lighttpd_script_name_fix'
+
+context "Rack::LighttpdScriptNameFix" do
+  specify "corrects SCRIPT_NAME and PATH_INFO set by lighttpd " do
+    env = {
+      "PATH_INFO" => "/foo/bar/baz",
+      "SCRIPT_NAME" => "/hello"
+    }
+    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'
+  end
+end

data/test/spec_rack_mailexceptions.rb

@@ -0,0 +1,97 @@
+require 'test/spec'
+require 'rack/mock'
+
+begin
+  require 'tmail'
+  require 'rack/contrib/mailexceptions'
+
+  require File.dirname(__FILE__) + '/mail_settings.rb'
+
+  class TestError < RuntimeError
+  end
+
+  def test_exception
+    raise TestError, 'Suffering Succotash!'
+  rescue => boom
+    return boom
+  end
+
+  context 'Rack::MailExceptions' do
+
+    setup do
+      @app = lambda { |env| raise TestError, 'Why, I say' }
+      @env = Rack::MockRequest.env_for("/foo",
+        'FOO' => 'BAR',
+        :method => 'GET',
+        :input => 'THE BODY'
+      )
+      @smtp_settings = {
+        :server         => 'example.com',
+        :domain         => 'example.com',
+        :port           => 500,
+        :authentication => :login,
+        :user_name      => 'joe',
+        :password       => 'secret'
+      }
+    end
+
+    specify 'yields a configuration object to the block when created' do
+      called = false
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          called = true
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+      called.should.be == true
+    end
+
+    specify 'generates a TMail object with configured settings' do
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+
+      tmail = mailer.send(:generate_mail, test_exception, @env)
+      tmail.to.should.equal ['foo@example.org']
+      tmail.from.should.equal ['bar@example.org']
+      tmail.subject.should.equal '[ERROR] Suffering Succotash!'
+      tmail.body.should.not.be.nil
+      tmail.body.should.be =~ /FOO:\s+"BAR"/
+      tmail.body.should.be =~ /^\s*THE BODY\s*$/
+    end
+
+    specify 'catches exceptions raised from app, sends mail, and re-raises' do
+      mailer =
+        Rack::MailExceptions.new(@app) do |mail|
+          mail.to 'foo@example.org'
+          mail.from 'bar@example.org'
+          mail.subject '[ERROR] %s'
+          mail.smtp @smtp_settings
+        end
+      lambda { mailer.call(@env) }.should.raise(TestError)
+      @env['mail.sent'].should.be == true
+    end
+
+    if TEST_SMTP && ! TEST_SMTP.empty?
+      specify 'sends mail' do
+        mailer =
+          Rack::MailExceptions.new(@app) do |mail|
+            mail.config.merge! TEST_SMTP
+          end
+        lambda { mailer.call(@env) }.should.raise(TestError)
+        @env['mail.sent'].should.be == true
+      end
+    else
+      STDERR.puts 'WARN: Skipping SMTP tests (edit test/mail_settings.rb to enable)'
+    end
+
+  end
+rescue LoadError => boom
+  STDERR.puts "WARN: Skipping Rack::MailExceptions tests (tmail not installed)"
+end

data/test/spec_rack_nested_params.rb

@@ -0,0 +1,46 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/nested_params'
+require 'rack/methodoverride'
+
+context Rack::NestedParams do
+
+  App = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env)] }
+
+  def env_for_post_with_headers(path, headers, body)
+    Rack::MockRequest.env_for(path, {:method => "POST", :input => body}.merge(headers))
+  end
+
+  def form_post(params, content_type = 'application/x-www-form-urlencoded')
+    params = Rack::Utils.build_query(params) if Hash === params
+    env_for_post_with_headers('/', {'CONTENT_TYPE' => content_type}, params)
+  end
+
+  def middleware
+    Rack::NestedParams.new(App)
+  end
+
+  specify "should handle requests with POST body Content-Type of application/x-www-form-urlencoded" do
+    req = middleware.call(form_post({'foo[bar][baz]' => 'nested'})).last
+    req.POST.should.equal({"foo" => { "bar" => { "baz" => "nested" }}})
+  end
+
+  specify "should not parse requests with other Content-Type" do
+    req = middleware.call(form_post({'foo[bar][baz]' => 'nested'}, 'text/plain')).last
+    req.POST.should.equal({})
+  end
+
+  specify "should work even after another middleware already parsed the request" do
+    app = Rack::MethodOverride.new(middleware)
+    req = app.call(form_post({'_method' => 'put', 'foo[bar]' => 'nested'})).last
+    req.POST.should.equal({'_method' => 'put', "foo" => { "bar" => "nested" }})
+    req.put?.should.equal true
+  end
+
+  specify "should make first boolean have precedence even after request already parsed" do
+    app = Rack::MethodOverride.new(middleware)
+    req = app.call(form_post("foo=1&foo=0")).last
+    req.POST.should.equal({"foo" => '1'})
+  end
+
+end

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

@@ -0,0 +1,32 @@
+require 'test/spec'
+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)
+      body = Rack::PostBodyContentTypeParser.new(app).call(env).last
+      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
+rescue LoadError => e
+  # Missing dependency JSON, skipping tests.
+  STDERR.puts "WARN: Skipping Rack::PostBodyContentTypeParser tests (json not installed)"
+end

data/test/spec_rack_proctitle.rb

@@ -0,0 +1,26 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/proctitle'
+
+context "Rack::ProcTitle" do
+  F = ::File
+
+  progname = File.basename($0)
+  appname = F.expand_path(__FILE__).split('/')[-3]
+
+  def simple_app(body=['Hello World!'])
+    lambda { |env| [200, {'Content-Type' => 'text/plain'}, body] }
+  end
+
+  specify "should set the process title when created" do
+    Rack::ProcTitle.new(simple_app)
+    $0.should.equal "#{progname} [#{appname}] init ..."
+  end
+
+  specify "should set the process title on each request" do
+    app = Rack::ProcTitle.new(simple_app)
+    req = Rack::MockRequest.new(app)
+    10.times { req.get('/hello') }
+    $0.should.equal "#{progname} [#{appname}/80] (10) GET /hello"
+  end
+end

data/test/spec_rack_profiler.rb

@@ -0,0 +1,37 @@
+require 'test/spec'
+require 'rack/mock'
+
+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
+
+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