rack-contrib 1.2.0 → 1.2.0.39.g17d21b4

data/README.rdoc

@@ -1,98 +0,0 @@
-= Contributed Rack Middleware and Utilities
-
-This package includes a variety of add-on components for Rack, a Ruby web server
-interface:
-
-* Rack::JSONP - Adds JSON-P support by stripping out the callback param
-  and padding the response with the appropriate callback format.
-* Rack::LighttpdScriptNameFix - Fixes how lighttpd sets the SCRIPT_NAME
-  and PATH_INFO variables in certain configurations.
-* Rack::Locale - Detects the client locale using the Accept-Language request
-  header and sets a rack.locale variable in the environment.
-* Rack::MailExceptions - Rescues exceptions raised from the app and
-  sends a useful email with the exception, stacktrace, and contents of the
-  environment.
-* Rack::NestedParams - parses form params with subscripts (e.g., * "post[title]=Hello")
-  into a nested/recursive Hash structure (based on Rails' implementation).
-* Rack::PostBodyContentTypeParser - Adds support for JSON request bodies. The
-  Rack parameter hash is populated by deserializing the JSON data provided in
-  the request body when the Content-Type is application/json.
-* Rack::ProcTitle - Displays request information in process title ($0) for
-  monitoring/inspection with ps(1).
-* Rack::Profiler - Uses ruby-prof to measure request time.
-* Rack::Sendfile - Enables X-Sendfile support for bodies that can be served
-  from file.
-* Rack::Signals - Installs signal handlers that are safely processed after
-  a request
-* Rack::StaticCache - Modifies the response headers to facilitiate client and proxy caching for
-  static files that minimizes http requests and improves overall load times for second time visitors.
-* Rack::TimeZone - Detects the client's timezone using JavaScript and sets
-  a variable in Rack's environment with the offset from UTC.
-* Rack::Evil - Lets the rack application return a response to the client from any place.
-* Rack::Callbacks - Implements DSL for pure before/after filter like Middlewares.
-* Rack::Config - Shared configuration for cooperative middleware.
-* Rack::NotFound - A default 404 application.
-* Rack::CSSHTTPRequest - Adds CSSHTTPRequest support by encoding responses as
-  CSS for cross-site AJAX-style data loading
-* Rack::Deflect - Helps protect against DoS attacks.
-* Rack::ResponseCache - Caches responses to requests without query strings
-  to Disk or a user provider Ruby object. Similar to Rails' page caching.
-* Rack::RelativeRedirect - Transforms relative paths in redirects to
-  absolute URLs.
-* Rack::Backstage - Returns content of specified file if it exists, which makes
-  it convenient for putting up maintenance pages.
-* Rack::AcceptFormat - Adds a format extension at the end of the URI when there is none, corresponding to the mime-type given in the Accept HTTP header.
-* Rack::HostMeta - Configures /host-meta using a block
-* Rack::Cookies - Adds simple cookie jar hash to env
-* Rack::Access - Limits access based on IP address
-* Rack::ResponseHeaders - Manipulates response headers object at runtime
-* Rack::SimpleEndpoint - Creates simple endpoints with routing rules, similar to Sinatra actions
-* Rack::TryStatic - Tries to match request to a static file
-* Rack::Printout - Prints the environment and the response per request
-
-=== Use
-
-Git is the quickest way to the rack-contrib sources:
-
-  git clone git://github.com/rack/rack-contrib.git
-
-Gems are available too:
-
-  gem install rack-contrib
-
-Requiring 'rack/contrib' will add autoloads to the Rack modules for all of the
-components included. The following example shows what a simple rackup
-(+config.ru+) file might look like:
-
-  require 'rack'
-  require 'rack/contrib'
-
-  use Rack::Profiler if ENV['RACK_ENV'] == 'development'
-
-  use Rack::ETag
-  use Rack::MailExceptions
-
-  run theapp
-
-=== Testing
-
-To contribute to the project, begin by cloning the repo and installing the necessary gems:
-
-    gem install json rack ruby-prof test-spec test-unit
-
-To run the entire test suite, run 
-    rake test
-
-To run a specific component's tests run
-    specrb -Ilib:test -w test/spec_rack_thecomponent.rb
-
-This works on ruby 1.8.7 but has problems under ruby 1.9.x. 
-
-TODO: instructions for 1.9.x and include bundler
-
-=== Links
-
-rack-contrib on GitHub:: <http://github.com/rack/rack-contrib>
-Rack:: <http://rack.rubyforge.org/>
-Rack On GitHub:: <http://github.com/rack/rack>
-rack-devel mailing list:: <http://groups.google.com/group/rack-devel>

data/Rakefile

@@ -1,89 +0,0 @@
-# Rakefile for Rack::Contrib.  -*-ruby-*-
-require 'rake/rdoctask'
-require 'rake/testtask'
-
-desc "Run all the tests"
-task :default => [:test]
-
-desc "Generate RDox"
-task "RDOX" do
-  sh "specrb -Ilib:test -a --rdox >RDOX"
-end
-
-desc "Run specs with test/unit style output"
-task :test do
-  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
-end
-
-desc "Run specs with specdoc style output"
-task :spec do
-  sh "specrb -Ilib:test -s -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
-end
-
-desc "Run all the tests"
-task :fulltest do
-  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
-end
-
-desc "Generate RDoc documentation"
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.options << '--line-numbers' << '--inline-source' <<
-    '--main' << 'README' <<
-    '--title' << 'Rack Contrib Documentation' <<
-    '--charset' << 'utf-8'
-  rdoc.rdoc_dir = "doc"
-  rdoc.rdoc_files.include 'README.rdoc'
-  rdoc.rdoc_files.include 'RDOX'
-  rdoc.rdoc_files.include('lib/rack/*.rb')
-  rdoc.rdoc_files.include('lib/rack/*/*.rb')
-end
-task :rdoc => ["RDOX"]
-
-
-# PACKAGING =================================================================
-
-require 'rubygems'
-# load gemspec
-$spec = eval(File.read('rack-contrib.gemspec'))
-
-def package(ext='')
-  "pkg/rack-contrib-#{$spec.version}" + ext
-end
-
-desc 'Build packages'
-task :package => %w[.gem .tar.gz].map {|e| package(e)}
-
-desc 'Build and install as local gem'
-task :install => package('.gem') do
-  sh "gem install #{package('.gem')}"
-end
-
-directory 'pkg/'
-
-file package('.gem') => %w[pkg/ rack-contrib.gemspec] + $spec.files do |f|
-  sh "gem build rack-contrib.gemspec"
-  mv File.basename(f.name), f.name
-end
-
-file package('.tar.gz') => %w[pkg/] + $spec.files do |f|
-  sh "git archive --format=tar HEAD | gzip > #{f.name}"
-end
-
-# GEMSPEC ===================================================================
-
-file 'rack-contrib.gemspec' => FileList['{lib,test}/**','Rakefile', 'README.rdoc'] do |f|
-  # read spec file and split out manifest section
-  spec = File.read(f.name)
-  parts = spec.split("  # = MANIFEST =\n")
-  fail 'bad spec' if parts.length != 3
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").sort.reject{ |file| file =~ /^\./ }.
-    map{ |file| "    #{file}" }.join("\n")
-  # piece file back together and write...
-  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = parts.join("  # = MANIFEST =\n")
-  spec.sub!(/s.date = '.*'/, "s.date = '#{Time.now.strftime("%Y-%m-%d")}'")
-  File.open(f.name, 'w') { |io| io.write(spec) }
-  puts "updated #{f.name}"
-end

data/rack-contrib.gemspec

@@ -1,112 +0,0 @@
-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 = '1.2.0'
-  s.licenses = ['MIT']
-
-  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[
-    AUTHORS
-    COPYING
-    README.rdoc
-    Rakefile
-    lib/rack/contrib.rb
-    lib/rack/contrib/accept_format.rb
-    lib/rack/contrib/access.rb
-    lib/rack/contrib/backstage.rb
-    lib/rack/contrib/bounce_favicon.rb
-    lib/rack/contrib/callbacks.rb
-    lib/rack/contrib/common_cookies.rb
-    lib/rack/contrib/config.rb
-    lib/rack/contrib/cookies.rb
-    lib/rack/contrib/csshttprequest.rb
-    lib/rack/contrib/deflect.rb
-    lib/rack/contrib/evil.rb
-    lib/rack/contrib/expectation_cascade.rb
-    lib/rack/contrib/garbagecollector.rb
-    lib/rack/contrib/host_meta.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/printout.rb
-    lib/rack/contrib/profiler.rb
-    lib/rack/contrib/relative_redirect.rb
-    lib/rack/contrib/response_cache.rb
-    lib/rack/contrib/response_headers.rb
-    lib/rack/contrib/route_exceptions.rb
-    lib/rack/contrib/runtime.rb
-    lib/rack/contrib/sendfile.rb
-    lib/rack/contrib/signals.rb
-    lib/rack/contrib/simple_endpoint.rb
-    lib/rack/contrib/static_cache.rb
-    lib/rack/contrib/time_zone.rb
-    lib/rack/contrib/try_static.rb
-    rack-contrib.gemspec
-    test/404.html
-    test/Maintenance.html
-    test/documents/existing.html
-    test/documents/index.htm
-    test/documents/index.html
-    test/documents/test
-    test/mail_settings.rb
-    test/spec_rack_accept_format.rb
-    test/spec_rack_access.rb
-    test/spec_rack_backstage.rb
-    test/spec_rack_callbacks.rb
-    test/spec_rack_common_cookies.rb
-    test/spec_rack_config.rb
-    test/spec_rack_contrib.rb
-    test/spec_rack_cookies.rb
-    test/spec_rack_csshttprequest.rb
-    test/spec_rack_deflect.rb
-    test/spec_rack_evil.rb
-    test/spec_rack_expectation_cascade.rb
-    test/spec_rack_garbagecollector.rb
-    test/spec_rack_host_meta.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_response_headers.rb
-    test/spec_rack_runtime.rb
-    test/spec_rack_sendfile.rb
-    test/spec_rack_simple_endpoint.rb
-    test/spec_rack_static_cache.rb
-    test/spec_rack_try_static.rb
-    test/statics/test
-  ]
-  # = 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_development_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

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

data/test/Maintenance.html

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

data/test/documents/existing.html

@@ -1 +0,0 @@
-existing.html

data/test/documents/index.htm

@@ -1 +0,0 @@
-index.htm

data/test/documents/index.html

@@ -1 +0,0 @@
-index.html

data/test/documents/test

@@ -1 +0,0 @@
-nocache

data/test/mail_settings.rb

@@ -1,20 +0,0 @@
-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
-# }
-#TEST_SMTP_TLS = {
-#    :server         => 'smtp.gmail.com',
-#    :domain         => 'gmail.com',
-#    :port           => 587,
-#    :authentication => 'plain',
-#    :user_name      => nil,
-#    :password       => nil,
-#}

data/test/spec_rack_accept_format.rb

@@ -1,72 +0,0 @@
-require 'test/spec'
-require 'rack/mock'
-require 'rack/contrib/accept_format'
-require 'rack/mime'
-
-context "Rack::AcceptFormat" do
-  app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
-
-  specify "should do nothing when a format extension is already provided" do
-    request = Rack::MockRequest.env_for("/resource.json")
-    body = Rack::AcceptFormat.new(app).call(request).last
-    body.should == "/resource.json"
-  end
-
-  context "default extention" do
-    specify "should allow custom default" do
-      request = Rack::MockRequest.env_for("/resource")
-      body = Rack::AcceptFormat.new(app, '.xml').call(request).last
-      body.should == "/resource.xml"
-    end
-
-    specify "should default to html" do
-      request = Rack::MockRequest.env_for("/resource")
-      body = Rack::AcceptFormat.new(app).call(request).last
-      body.should == "/resource.html"
-    end
-
-    specify "should notmalize custom extention" do
-      request = Rack::MockRequest.env_for("/resource")
-
-      body = Rack::AcceptFormat.new(app,'xml').call(request).last #no dot prefix
-      body.should == "/resource.xml"
-
-      body = Rack::AcceptFormat.new(app, :xml).call(request).last
-      body.should == "/resource.xml"
-    end
-  end
-
-  context "there is no format extension" do
-    Rack::Mime::MIME_TYPES.clear
-
-    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.html"
-    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.html"
-    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
-
-  specify "shouldn't confuse extention when there are dots in path" do
-    request = Rack::MockRequest.env_for("/parent.resource/resource")
-    body = Rack::AcceptFormat.new(app, '.html').call(request).last
-    body.should == "/parent.resource/resource.html"
-  end
-end

data/test/spec_rack_access.rb

@@ -1,154 +0,0 @@
-require 'test/spec'
-require 'rack/mock'
-require 'rack/contrib/access'
-
-context "Rack::Access" do
-
-  setup do
-    @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['hello']] }
-    @mock_addr_1 = '111.111.111.111'
-    @mock_addr_2 = '192.168.1.222'
-    @mock_addr_localhost = '127.0.0.1'
-    @mock_addr_range = '192.168.1.0/24'
-  end
-
-  def mock_env(remote_addr, path = '/')
-    Rack::MockRequest.env_for(path, { 'REMOTE_ADDR' => remote_addr })
-  end
-
-  def middleware(options = {})
-    Rack::Access.new(@app, options)
-  end
-
-  specify "default configuration should deny non-local requests" do
-    app = middleware
-    status, headers, body = app.call(mock_env(@mock_addr_1))
-    status.should.equal 403
-    body.should.equal []
-  end
-
-  specify "default configuration should allow requests from 127.0.0.1" do
-    app = middleware
-    status, headers, body = app.call(mock_env(@mock_addr_localhost))
-    status.should.equal 200
-    body.should.equal ['hello']
-  end
-
-  specify "should allow remote addresses in allow_ipmasking" do
-    app = middleware('/' => [@mock_addr_1])
-    status, headers, body = app.call(mock_env(@mock_addr_1))
-    status.should.equal 200
-    body.should.equal ['hello']
-  end
-
-  specify "should deny remote addresses not in allow_ipmasks" do
-    app = middleware('/' => [@mock_addr_1])
-    status, headers, body = app.call(mock_env(@mock_addr_2))
-    status.should.equal 403
-    body.should.equal []
-  end
-
-  specify "should allow remote addresses in allow_ipmasks range" do
-    app = middleware('/' => [@mock_addr_range])
-    status, headers, body = app.call(mock_env(@mock_addr_2))
-    status.should.equal 200
-    body.should.equal ['hello']
-  end
-
-  specify "should deny remote addresses not in allow_ipmasks range" do
-    app = middleware('/' => [@mock_addr_range])
-    status, headers, body = app.call(mock_env(@mock_addr_1))
-    status.should.equal 403
-    body.should.equal []
-  end
-
-  specify "should allow remote addresses in one of allow_ipmasking" do
-    app = middleware('/' => [@mock_addr_range, @mock_addr_localhost])
-
-    status, headers, body = app.call(mock_env(@mock_addr_2))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_localhost))
-    status.should.equal 200
-    body.should.equal ['hello']
-  end
-
-  specify "should deny remote addresses not in one of allow_ipmasks" do
-    app = middleware('/' => [@mock_addr_range, @mock_addr_localhost])
-    status, headers, body = app.call(mock_env(@mock_addr_1))
-    status.should.equal 403
-    body.should.equal []
-  end
-
-  specify "handles paths correctly" do
-    app = middleware({
-      'http://foo.org/bar' => [@mock_addr_localhost],
-      '/foo' => [@mock_addr_localhost],
-      '/foo/bar' => [@mock_addr_range, @mock_addr_localhost]
-    })
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/qux"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar"))
-    status.should.equal 200
-    body.should.equal ['hello']
-    status, headers, body = app.call(mock_env(@mock_addr_2, "/foo/bar"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/bar/"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/bar/"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo///bar//quux"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo///bar//quux"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/foo/quux"))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/foo/quux"))
-    status.should.equal 200
-    body.should.equal ['hello']
-
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/bar"))
-    status.should.equal 200
-    body.should.equal ['hello']
-    status, headers, body = app.call(mock_env(@mock_addr_1, "/bar").merge('HTTP_HOST' => 'foo.org'))
-    status.should.equal 403
-    body.should.equal []
-    status, headers, body = app.call(mock_env(@mock_addr_localhost, "/bar").merge('HTTP_HOST' => 'foo.org'))
-    status.should.equal 200
-    body.should.equal ['hello']
-  end
-end