rack-contrib 0.9.0

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_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,32 @@
+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"}
+    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
+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

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: rack-contrib
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- rack-devel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+description: Contributed Rack Middleware and Utilities
+email: rack-devel@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- COPYING
+files: 
+- COPYING
+- README.rdoc
+- Rakefile
+- lib/rack/contrib.rb
+- lib/rack/contrib/bounce_favicon.rb
+- lib/rack/contrib/callbacks.rb
+- lib/rack/contrib/etag.rb
+- lib/rack/contrib/evil.rb
+- lib/rack/contrib/garbagecollector.rb
+- lib/rack/contrib/jsonp.rb
+- lib/rack/contrib/lighttpd_script_name_fix.rb
+- lib/rack/contrib/locale.rb
+- lib/rack/contrib/mailexceptions.rb
+- lib/rack/contrib/nested_params.rb
+- lib/rack/contrib/post_body_content_type_parser.rb
+- lib/rack/contrib/proctitle.rb
+- lib/rack/contrib/profiler.rb
+- lib/rack/contrib/route_exceptions.rb
+- lib/rack/contrib/sendfile.rb
+- lib/rack/contrib/time_zone.rb
+- rack-contrib.gemspec
+- test/mail_settings.rb
+- test/spec_rack_callbacks.rb
+- test/spec_rack_contrib.rb
+- test/spec_rack_etag.rb
+- test/spec_rack_evil.rb
+- test/spec_rack_garbagecollector.rb
+- test/spec_rack_jsonp.rb
+- test/spec_rack_lighttpd_script_name_fix.rb
+- test/spec_rack_mailexceptions.rb
+- test/spec_rack_nested_params.rb
+- test/spec_rack_post_body_content_type_parser.rb
+- test/spec_rack_proctitle.rb
+- test/spec_rack_profiler.rb
+- test/spec_rack_sendfile.rb
+has_rdoc: true
+homepage: http://github.com/rack/rack-contrib/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- rack-contrib
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Contributed Rack Middleware and Utilities
+test_files: 
+- test/spec_rack_callbacks.rb
+- test/spec_rack_contrib.rb
+- test/spec_rack_etag.rb
+- test/spec_rack_evil.rb
+- test/spec_rack_garbagecollector.rb
+- test/spec_rack_jsonp.rb
+- test/spec_rack_lighttpd_script_name_fix.rb
+- test/spec_rack_mailexceptions.rb
+- test/spec_rack_nested_params.rb
+- test/spec_rack_post_body_content_type_parser.rb
+- test/spec_rack_proctitle.rb
+- test/spec_rack_profiler.rb
+- test/spec_rack_sendfile.rb