rack-rack-contrib 0.9.1

data/lib/rack/contrib/time_zone.rb

@@ -0,0 +1,25 @@
+module Rack
+  class TimeZone
+    Javascript = <<-EOJ
+    function setTimezoneCookie() {
+      var offset = (new Date()).getTimezoneOffset()
+      var date = new Date();
+      date.setTime(date.getTime()+3600000);
+      document.cookie = "utc_offset="+offset+"; expires="+date.toGMTString();+"; path=/";
+    }
+EOJ
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if utc_offset = request.cookies["utc_offset"]
+        env["rack.timezone.utc_offset"] = -(utc_offset.to_i * 60)
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/rack-contrib.gemspec

@@ -0,0 +1,87 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'rack-contrib'
+  s.version = '0.9.1'
+  s.date = '2009-03-07'
+
+  s.description = "Contributed Rack Middleware and Utilities"
+  s.summary     = "Contributed Rack Middleware and Utilities"
+
+  s.authors = ["rack-devel"]
+  s.email = "rack-devel@googlegroups.com"
+
+  # = MANIFEST =
+  s.files = %w[
+    COPYING
+    README.rdoc
+    Rakefile
+    lib/rack/contrib.rb
+    lib/rack/contrib/accept_format.rb
+    lib/rack/contrib/backstage.rb
+    lib/rack/contrib/bounce_favicon.rb
+    lib/rack/contrib/callbacks.rb
+    lib/rack/contrib/config.rb
+    lib/rack/contrib/csshttprequest.rb
+    lib/rack/contrib/deflect.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/not_found.rb
+    lib/rack/contrib/post_body_content_type_parser.rb
+    lib/rack/contrib/proctitle.rb
+    lib/rack/contrib/profiler.rb
+    lib/rack/contrib/relative_redirect.rb
+    lib/rack/contrib/response_cache.rb
+    lib/rack/contrib/route_exceptions.rb
+    lib/rack/contrib/sendfile.rb
+    lib/rack/contrib/signals.rb
+    lib/rack/contrib/time_zone.rb
+    rack-contrib.gemspec
+    test/404.html
+    test/Maintenance.html
+    test/mail_settings.rb
+    test/spec_rack_accept_format.rb
+    test/spec_rack_backstage.rb
+    test/spec_rack_callbacks.rb
+    test/spec_rack_config.rb
+    test/spec_rack_contrib.rb
+    test/spec_rack_csshttprequest.rb
+    test/spec_rack_deflect.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_not_found.rb
+    test/spec_rack_post_body_content_type_parser.rb
+    test/spec_rack_proctitle.rb
+    test/spec_rack_profiler.rb
+    test/spec_rack_relative_redirect.rb
+    test/spec_rack_response_cache.rb
+    test/spec_rack_sendfile.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select {|path| path =~ /^test\/spec_.*\.rb/}
+
+  s.extra_rdoc_files = %w[README.rdoc COPYING]
+  s.add_dependency 'rack', '~> 0.9.1'
+  s.add_dependency 'test-spec', '~> 0.9.0'
+  s.add_development_dependency 'tmail', '>= 1.2'
+  s.add_development_dependency 'json', '>= 1.1'
+
+  s.has_rdoc = true
+  s.homepage = "http://github.com/rack/rack-contrib/"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "rack-contrib", "--main", "README"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.1.1'
+end

data/test/404.html

@@ -0,0 +1 @@
+Not Found

data/test/Maintenance.html

@@ -0,0 +1 @@
+Under maintenance.

data/test/mail_settings.rb

@@ -0,0 +1,12 @@
+TEST_SMTP = nil
+
+# Enable SMTP tests by providing the following for your SMTP server.
+#
+# TEST_SMTP = {
+#   :server         => 'localhost',
+#   :domain         => 'localhost',
+#   :port           => 25,
+#   :authentication => :login,
+#   :user_name      => nil,
+#   :password       => nil
+# }

data/test/spec_rack_accept_format.rb

@@ -0,0 +1,41 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/accept_format'
+require 'rack/mime'
+
+context "Rack::AcceptFormat" do
+  specify "should do nothing when a format extension is already provided" do
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
+    request = Rack::MockRequest.env_for("/resource.json")
+    body = Rack::AcceptFormat.new(app).call(request).last
+    body.should == "/resource.json"
+  end
+
+  context "there is no format extension" do
+    Rack::Mime::MIME_TYPES.clear
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
+    def mime(ext, type)
+      ext = ".#{ext}" unless ext.to_s[0] == ?.
+      Rack::Mime::MIME_TYPES[ext.to_s] = type
+    end
+
+    specify "should add the default extension if no Accept header" do
+      request = Rack::MockRequest.env_for("/resource")
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource#{Rack::AcceptFormat::DEFAULT_EXTENSION}"
+    end
+
+    specify "should add the default extension if the Accept header is not registered in the Mime::Types" do
+      request = Rack::MockRequest.env_for("/resource", 'HTTP_ACCEPT' => 'application/json;q=1.0, text/html;q=0.8, */*;q=0.1')
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource#{Rack::AcceptFormat::DEFAULT_EXTENSION}"
+    end
+
+    specify "should add the correct extension if the Accept header is registered in the Mime::Types" do
+      mime :json, 'application/json'
+      request = Rack::MockRequest.env_for("/resource", 'HTTP_ACCEPT' => 'application/json;q=1.0, text/html;q=0.8, */*;q=0.1')
+      body = Rack::AcceptFormat.new(app).call(request).last
+      body.should == "/resource.json"
+    end
+  end
+end

data/test/spec_rack_backstage.rb

@@ -0,0 +1,26 @@
+require 'test/spec'
+require 'rack/builder'
+require 'rack/mock'
+require 'rack/contrib/backstage'
+
+context "Rack::Backstage" do
+  specify "shows maintenances page if present" do
+    app = Rack::Builder.new do
+      use Rack::Backstage, 'test/Maintenance.html'
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should.equal('Under maintenance.')
+    response.status.should.equal(503)
+  end
+
+  specify "passes on request if page is not present" do
+    app = Rack::Builder.new do
+      use Rack::Backstage, 'test/Nonsense.html'
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]] }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should.equal('Hello, World!')
+    response.status.should.equal(200)
+  end
+end

data/test/spec_rack_callbacks.rb

@@ -0,0 +1,65 @@
+require 'test/spec'
+require 'rack/mock'
+
+class Flame
+  def call(env)
+    env['flame'] = 'F Lifo..'
+  end
+end
+
+class Pacify
+  def initialize(with)
+    @with = with
+  end
+
+  def call(env)
+    env['peace'] = @with
+  end
+end
+
+class Finale
+  def call(response)
+    status, headers, body = response
+
+    headers['last'] = 'Finale'
+    $old_status = status
+
+    [201, headers, body]
+  end
+end
+
+class TheEnd
+  def call(response)
+    status, headers, body = response
+
+    headers['last'] = 'TheEnd'
+    [201, headers, body]
+  end
+end
+
+context "Rack::Callbacks" do
+  specify "works for love and small stack trace" do
+    callback_app = Rack::Callbacks.new do
+      before Flame
+      before Pacify, "with love"
+
+      run lambda {|env| [200, {}, [env['flame'], env['peace']]] }
+
+      after Finale
+      after TheEnd
+    end
+
+    app = Rack::Builder.new do
+      run callback_app
+    end.to_app
+
+    response = Rack::MockRequest.new(app).get("/")
+
+    response.body.should.equal 'F Lifo..with love'
+
+    $old_status.should.equal 200
+    response.status.should.equal 201
+
+    response.headers['last'].should.equal 'TheEnd'
+  end
+end

data/test/spec_rack_config.rb

@@ -0,0 +1,22 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack/contrib/config'
+
+context "Rack::Config" do
+
+  specify "should accept a block that modifies the environment" do
+    app = Rack::Builder.new do
+      use Rack::Lint
+      use Rack::ContentLength
+      use Rack::Config do |env|
+        env['greeting'] = 'hello'
+      end
+      run lambda { |env|
+        [200, {'Content-Type' => 'text/plain'}, [env['greeting'] || '']]
+      }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+    response.body.should.equal('hello')
+  end
+
+end

data/test/spec_rack_contrib.rb

@@ -0,0 +1,8 @@
+require 'test/spec'
+require 'rack/contrib'
+
+context "Rack::Contrib" do
+  specify "should expose release" do
+    Rack::Contrib.should.respond_to :release
+  end
+end

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