rack 1.1.0 → 1.2.0

data/README

@@ -9,16 +9,6 @@ middleware) into a single method call.
 The exact details of this are described in the Rack specification,
 which all Rack applications should conform to.
 
-== Specification changes in this release
-
-With Rack 1.1, the Rack specification (found in SPEC) changed in the
-following backward-incompatible ways.
-
-* Rack::VERSION has been pushed to [1,1].
-* rack.logger is now specified.
-* The SPEC now allows subclasses of the required types.
-* rack.input has to be opened in binary mode.
-
 == Supported web servers
 
 The included *handlers* connect all kinds of web servers to Rack:
@@ -46,9 +36,6 @@ changing anything.
 
 == Supported web frameworks
 
-The included *adapters* connect Rack with existing Ruby web frameworks:
-* Camping
-
 These frameworks include Rack adapters in their distributions:
 * Camping
 * Coset
@@ -143,9 +130,9 @@ at my site:
 
 == Running the tests
 
-Testing Rack requires the test/spec testing framework:
+Testing Rack requires the bacon testing framework:
 
-    gem install test-spec
+    gem install bacon
 
 There are two rake-based test tasks:
 
@@ -153,11 +140,10 @@ There are two rake-based test tasks:
     rake fulltest   runs all the tests
 
 The fast testsuite has no dependencies outside of the core Ruby
-installation and test-spec.
+installation and bacon.
 
 To run the test suite completely, you need:
 
-  * camping
   * fcgi
   * memcache-client
   * mongrel
@@ -278,7 +264,7 @@ run on port 11211) and memcache-client installed.
   * Make sure WEBrick respects the :Host option
   * Many Ruby 1.9 fixes.
 
-* January 3rd, 2009: Ninth public release 1.1.0.
+* January 3rd, 2010: Ninth public release 1.1.0.
   * Moved Auth::OpenID to rack-contrib.
   * SPEC change that relaxes Lint slightly to allow subclasses of the
     required types
@@ -313,17 +299,26 @@ run on port 11211) and memcache-client installed.
   * Enforce binary encoding in RewindableInput
   * Set correct external_encoding for handlers that don't use RewindableInput
 
+* June 13th, 2010: Tenth public release 1.2.0.
+  * Removed Camping adapter: Camping 2.0 supports Rack as-is
+  * Removed parsing of quoted values
+  * Add Request.trace? and Request.options?
+  * Add mime-type for .webm and .htc
+  * Fix HTTP_X_FORWARDED_FOR
+  * Various multipart fixes
+  * Switch test suite to bacon
+
 == Contact
 
 Please post bugs, suggestions and patches to
-the bug tracker at <http://rack.lighthouseapp.com/>.
+the bug tracker at <http://github.com/rack/rack/issues>.
 
 Mailing list archives are available at
 <http://groups.google.com/group/rack-devel>.
 
 Git repository (send Git patches to the mailing list):
 * http://github.com/rack/rack
-* http://git.vuxu.org/cgi-bin/gitweb.cgi?p=rack.git
+* http://git.vuxu.org/cgi-bin/gitweb.cgi?p=rack-github.git
 
 You are also welcome to join the #rack channel on irc.freenode.net.
 
@@ -345,12 +340,14 @@ would like to thank:
 * Tim Fletcher, for the HTTP authentication code.
 * Luc Heinrich for the Cookie sessions, the static file handler and bugfixes.
 * Armin Ronacher, for the logo and racktools.
-* Aredridel, Ben Alpert, Dan Kubb, Daniel Roethlisberger, Matt Todd,
-  Tom Robinson, Phil Hagelberg, S. Brent Faulkner, Bosko Milekic,
-  Daniel Rodríguez Troitiño, Genki Takiuchi, Geoffrey Grosenbach,
-  Julien Sanchez, Kamal Fariz Mahyuddin, Masayoshi Takahashi, Patrick
-  Aljordm, Mig, and Kazuhiro Nishiyama for bug fixing and other
-  improvements.
+* Alex Beregszaszi, Alexander Kahn, Anil Wadghule, Aredridel, Ben
+  Alpert, Dan Kubb, Daniel Roethlisberger, Matt Todd, Tom Robinson,
+  Phil Hagelberg, S. Brent Faulkner, Bosko Milekic, Daniel Rodríguez
+  Troitiño, Genki Takiuchi, Geoffrey Grosenbach, Julien Sanchez, Kamal
+  Fariz Mahyuddin, Masayoshi Takahashi, Patrick Aljordm, Mig, Kazuhiro
+  Nishiyama, Jon Bardin, Konstantin Haase, Larry Siden, Matias
+  Korhonen, Sam Ruby, Simon Chiang, Tim Connor, Timur Batyrshin, and
+  Zach Brock for bug fixing and other improvements.
 * Eric Wong, Hongli Lai, Jeremy Kemper for their continuous support
   and API improvements.
 * Yehuda Katz and Carl Lerche for refactoring rackup.

data/SPEC

@@ -11,9 +11,9 @@ The *status*,
 the *headers*,
 and the *body*.
 == The Environment
-The environment must be an true instance of Hash (no
-subclassing allowed) that includes CGI-like headers.
-The application is free to modify the environment.
+The environment must be an instance of Hash that includes
+CGI-like headers.  The application is free to modify the
+environment.
 The environment is required to include these variables
 (adopted from PEP333), except when they'd be empty, but see
 below.

data/lib/rack/auth/digest/params.rb

@@ -35,7 +35,7 @@ module Rack
           super k.to_s, v.to_s
         end
 
-        UNQUOTED = ['qop', 'nc', 'stale']
+        UNQUOTED = ['nc', 'stale']
 
         def to_s
           inject([]) do |parts, (k, v)|

data/lib/rack/content_length.rb

@@ -13,7 +13,7 @@ module Rack
       status, headers, body = @app.call(env)
       headers = HeaderHash.new(headers)
 
-      if !STATUS_WITH_NO_ENTITY_BODY.include?(status) &&
+      if !STATUS_WITH_NO_ENTITY_BODY.include?(status.to_i) &&
          !headers['Content-Length'] &&
          !headers['Transfer-Encoding'] &&
          (body.respond_to?(:to_ary) || body.respond_to?(:to_str))

data/lib/rack/etag.rb

@@ -11,13 +11,22 @@ module Rack
       status, headers, body = @app.call(env)
 
       if !headers.has_key?('ETag')
-        parts = []
-        body.each { |part| parts << part.to_s }
-        headers['ETag'] = %("#{Digest::MD5.hexdigest(parts.join(""))}")
-        [status, headers, parts]
-      else
-        [status, headers, body]
+        digest, body = digest_body(body)
+        headers['ETag'] = %("#{digest}")
       end
+
+      [status, headers, body]
     end
+
+    private
+      def digest_body(body)
+        digest = Digest::MD5.new
+        parts = []
+        body.each do |part|
+          digest << part
+          parts << part
+        end
+        [digest.hexdigest, parts]
+      end
   end
 end

data/lib/rack/file.rb

@@ -3,8 +3,10 @@ require 'rack/utils'
 require 'rack/mime'
 
 module Rack
-  # Rack::File serves files below the +root+ given, according to the
+  # Rack::File serves files below the +root+ directory given, according to the
   # path info of the Rack request.
+  # e.g. when Rack::File.new("/etc") is used, you can access 'passwd' file
+  # as http://localhost:9292/passwd
   #
   # Handlers can detect if bodies are a Rack::File, and use mechanisms
   # like sendfile on the +path+.

data/lib/rack/handler/cgi.rb

@@ -4,6 +4,7 @@ module Rack
   module Handler
     class CGI
       def self.run(app, options=nil)
+        $stdin.binmode
         serve app
       end
 
@@ -15,7 +16,7 @@ module Rack
 
         env["SCRIPT_NAME"] = ""  if env["SCRIPT_NAME"] == "/"
 
-        env.update({"rack.version" => [1,1],
+        env.update({"rack.version" => Rack::VERSION,
                      "rack.input" => $stdin,
                      "rack.errors" => $stderr,
 
@@ -40,20 +41,20 @@ module Rack
       end
 
       def self.send_headers(status, headers)
-        STDOUT.print "Status: #{status}\r\n"
+        $stdout.print "Status: #{status}\r\n"
         headers.each { |k, vs|
           vs.split("\n").each { |v|
-            STDOUT.print "#{k}: #{v}\r\n"
+            $stdout.print "#{k}: #{v}\r\n"
           }
         }
-        STDOUT.print "\r\n"
-        STDOUT.flush
+        $stdout.print "\r\n"
+        $stdout.flush
       end
 
       def self.send_body(body)
         body.each { |part|
-          STDOUT.print part
-          STDOUT.flush
+          $stdout.print part
+          $stdout.flush
         }
       end
     end

data/lib/rack/handler/fastcgi.rb

@@ -36,7 +36,7 @@ module Rack
 
         rack_input = RewindableInput.new(request.in)
 
-        env.update({"rack.version" => [1,1],
+        env.update({"rack.version" => Rack::VERSION,
                      "rack.input" => rack_input,
                      "rack.errors" => request.err,
 

data/lib/rack/handler/lsws.rb

@@ -20,7 +20,7 @@ module Rack
         rack_input = RewindableInput.new($stdin.read.to_s)
 
         env.update(
-          "rack.version" => [1,1],
+          "rack.version" => Rack::VERSION,
           "rack.input" => rack_input,
           "rack.errors" => $stderr,
           "rack.multithread" => false,

data/lib/rack/handler/mongrel.rb

@@ -52,7 +52,7 @@ module Rack
         rack_input = request.body || StringIO.new('')
         rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
 
-        env.update({"rack.version" => [1,1],
+        env.update({"rack.version" => Rack::VERSION,
                      "rack.input" => rack_input,
                      "rack.errors" => $stderr,
 

data/lib/rack/handler/scgi.rb

@@ -17,9 +17,6 @@ module Rack
 
       def initialize(settings = {})
         @app = Rack::Chunked.new(Rack::ContentLength.new(settings[:app]))
-        @log = Object.new
-        def @log.info(*args); end
-        def @log.error(*args); end
         super(settings)
       end
 
@@ -36,7 +33,7 @@ module Rack
         rack_input = StringIO.new(input_body)
         rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
 
-        env.update({"rack.version" => [1,1],
+        env.update({"rack.version" => Rack::VERSION,
                      "rack.input" => rack_input,
                      "rack.errors" => $stderr,
                      "rack.multithread" => true,

data/lib/rack/handler/webrick.rb

@@ -7,11 +7,15 @@ module Rack
     class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
       def self.run(app, options={})
         options[:BindAddress] = options.delete(:Host) if options[:Host]
-        server = ::WEBrick::HTTPServer.new(options)
-        server.mount "/", Rack::Handler::WEBrick, app
-        trap(:INT) { server.shutdown }
-        yield server  if block_given?
-        server.start
+        @server = ::WEBrick::HTTPServer.new(options)
+        @server.mount "/", Rack::Handler::WEBrick, app
+        yield @server  if block_given?
+        @server.start
+      end
+
+      def self.shutdown
+        @server.shutdown
+        @server = nil
       end
 
       def initialize(server, app)
@@ -26,7 +30,7 @@ module Rack
         rack_input = StringIO.new(req.body.to_s)
         rack_input.set_encoding(Encoding::BINARY) if rack_input.respond_to?(:set_encoding)
 
-        env.update({"rack.version" => [1,1],
+        env.update({"rack.version" => Rack::VERSION,
                      "rack.input" => rack_input,
                      "rack.errors" => $stderr,
 

data/lib/rack/lint.rb

@@ -7,6 +7,7 @@ module Rack
   class Lint
     def initialize(app)
       @app = app
+      @content_length = nil
     end
 
     # :stopdoc:
@@ -51,15 +52,16 @@ module Rack
       check_headers headers
       ## and the *body*.
       check_content_type status, headers
-      check_content_length status, headers, env
+      check_content_length status, headers
+      @head_request = env["REQUEST_METHOD"] == "HEAD"
       [status, headers, self]
     end
 
     ## == The Environment
     def check_env(env)
-      ## The environment must be an true instance of Hash (no
-      ## subclassing allowed) that includes CGI-like headers.
-      ## The application is free to modify the environment.
+      ## The environment must be an instance of Hash that includes
+      ## CGI-like headers.  The application is free to modify the
+      ## environment.
       assert("env #{env.inspect} is not a Hash, but #{env.class}") {
         env.kind_of? Hash
       }
@@ -288,10 +290,6 @@ module Rack
         @input = input
       end
 
-      def size
-        @input.size
-      end
-
       ## * +gets+ must be called without arguments and return a string,
       ##   or +nil+ on EOF.
       def gets(*args)
@@ -481,7 +479,7 @@ module Rack
     end
 
     ## === The Content-Length
-    def check_content_length(status, headers, env)
+    def check_content_length(status, headers)
       headers.each { |key, value|
         if key.downcase == 'content-length'
           ## There must not be a <tt>Content-Length</tt> header when the
@@ -489,49 +487,43 @@ module Rack
           assert("Content-Length header found in #{status} response, not allowed") {
             not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
           }
-
-          bytes = 0
-          string_body = true
-
-          if @body.respond_to?(:to_ary)
-            @body.each { |part|
-              unless part.kind_of?(String)
-                string_body = false
-                break
-              end
-
-              bytes += Rack::Utils.bytesize(part)
-            }
-
-            if env["REQUEST_METHOD"] == "HEAD"
-              assert("Response body was given for HEAD request, but should be empty") {
-                bytes == 0
-              }
-            else
-              if string_body
-                assert("Content-Length header was #{value}, but should be #{bytes}") {
-                  value == bytes.to_s
-                }
-              end
-            end
-          end
-
-          return
+          @content_length = value
         end
       }
     end
 
+    def verify_content_length(bytes)
+      if @head_request
+        assert("Response body was given for HEAD request, but should be empty") {
+          bytes == 0
+        }
+      elsif @content_length
+        assert("Content-Length header was #{@content_length}, but should be #{bytes}") {
+          @content_length == bytes.to_s
+        }
+      end
+    end
+
     ## === The Body
     def each
       @closed = false
+      bytes = 0
+
       ## The Body must respond to +each+
+      assert("Response body must respond to each") do
+        @body.respond_to?(:each)
+      end
+
       @body.each { |part|
         ## and must only yield String values.
         assert("Body yielded non-string value #{part.inspect}") {
           part.kind_of? String
         }
+        bytes += Rack::Utils.bytesize(part)
         yield part
       }
+      verify_content_length(bytes)
+
       ##
       ## The Body itself should not be an instance of String, as this will
       ## break in Ruby 1.9.

data/lib/rack/mime.rb

@@ -87,6 +87,7 @@ module Rack
       ".gif"     => "image/gif",
       ".gz"      => "application/x-gzip",
       ".h"       => "text/x-c",
+      ".htc"     => "text/x-component",
       ".hh"      => "text/x-c",
       ".htm"     => "text/html",
       ".html"    => "text/html",
@@ -186,6 +187,7 @@ module Rack
       ".vrml"    => "model/vrml",
       ".war"     => "application/java-archive",
       ".wav"     => "audio/x-wav",
+      ".webm"    => "video/webm",
       ".wma"     => "audio/x-ms-wma",
       ".wmv"     => "video/x-ms-wmv",
       ".wmx"     => "video/x-ms-wmx",

data/lib/rack/mock.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'stringio'
+require 'rack'
 require 'rack/lint'
 require 'rack/utils'
 require 'rack/response'
@@ -40,7 +41,7 @@ module Rack
     end
 
     DEFAULT_ENV = {
-      "rack.version" => [1,1],
+      "rack.version" => Rack::VERSION,
       "rack.input" => StringIO.new,
       "rack.errors" => StringIO.new,
       "rack.multithread" => true,

data/lib/rack/recursive.rb

@@ -35,6 +35,10 @@ module Rack
     end
 
     def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
       @script_name = env["SCRIPT_NAME"]
       @app.call(env.merge('rack.recursive.include' => method(:include)))
     rescue ForwardRequest => req

data/lib/rack/request.rb

@@ -80,11 +80,13 @@ module Rack
     def script_name=(s); @env["SCRIPT_NAME"] = s.to_s             end
     def path_info=(s);   @env["PATH_INFO"] = s.to_s               end
 
-    def get?;            request_method == "GET"                  end
-    def post?;           request_method == "POST"                 end
-    def put?;            request_method == "PUT"                  end
-    def delete?;         request_method == "DELETE"               end
-    def head?;           request_method == "HEAD"                 end
+    def delete?;  request_method == "DELETE"  end
+    def get?;     request_method == "GET"     end
+    def head?;    request_method == "HEAD"    end
+    def options?; request_method == "OPTIONS" end
+    def post?;    request_method == "POST"    end
+    def put?;     request_method == "PUT"     end
+    def trace?;   request_method == "TRACE"   end
 
     # The set of form-data media-types. Requests that do not indicate
     # one of the media types presents in this list will not be eligible
@@ -253,7 +255,7 @@ module Rack
 
     def ip
       if addr = @env['HTTP_X_FORWARDED_FOR']
-        addr.split(',').last.strip
+        (addr.split(',').grep(/\d\./).first || @env['REMOTE_ADDR']).to_s.strip
       else
         @env['REMOTE_ADDR']
       end

data/lib/rack/response.rb

@@ -1,5 +1,6 @@
 require 'rack/request'
 require 'rack/utils'
+require 'time'
 
 module Rack
   # Rack::Response provides a convenient interface to create a Rack

data/lib/rack/rewindable_input.rb

@@ -1,4 +1,6 @@
+# -*- encoding: binary -*-
 require 'tempfile'
+require 'rack/utils'
 
 module Rack
   # Class which can make any IO object rewindable, including non-rewindable ones. It does
@@ -16,27 +18,27 @@ module Rack
       @rewindable_io = nil
       @unlinked = false
     end
-    
+
     def gets
       make_rewindable unless @rewindable_io
       @rewindable_io.gets
     end
-    
+
     def read(*args)
       make_rewindable unless @rewindable_io
       @rewindable_io.read(*args)
     end
-    
+
     def each(&block)
       make_rewindable unless @rewindable_io
       @rewindable_io.each(&block)
     end
-    
+
     def rewind
       make_rewindable unless @rewindable_io
       @rewindable_io.rewind
     end
-    
+
     # Closes this RewindableInput object without closing the originally
     # wrapped IO oject. Cleans up any temporary resources that this RewindableInput
     # has created.
@@ -52,9 +54,9 @@ module Rack
         @rewindable_io = nil
       end
     end
-    
+
     private
-    
+
     # Ruby's Tempfile class has a bug. Subclass it and fix it.
     class Tempfile < ::Tempfile
       def _close
@@ -76,15 +78,16 @@ module Rack
       @rewindable_io.binmode
       if filesystem_has_posix_semantics?
         @rewindable_io.unlink
+        raise 'Unlink failed. IO closed.' if @rewindable_io.closed?
         @unlinked = true
       end
-      
+
       buffer = ""
       while @io.read(1024 * 4, buffer)
         entire_buffer_written_out = false
         while !entire_buffer_written_out
           written = @rewindable_io.write(buffer)
-          entire_buffer_written_out = written == buffer.size
+          entire_buffer_written_out = written == Rack::Utils.bytesize(buffer)
           if !entire_buffer_written_out
             buffer.slice!(0 .. written - 1)
           end
@@ -92,7 +95,7 @@ module Rack
       end
       @rewindable_io.rewind
     end
-    
+
     def filesystem_has_posix_semantics?
       RUBY_PLATFORM !~ /(mswin|mingw|cygwin|java)/
     end

data/lib/rack/sendfile.rb

@@ -2,7 +2,9 @@ require 'rack/file'
 
 module Rack
   class File #:nodoc:
-    alias :to_path :path
+    unless instance_methods(false).include?('to_path')
+      alias :to_path :path
+    end
   end
 
   # = Sendfile
@@ -11,7 +13,7 @@ module Rack
   # served from a file and replaces it with a server specific X-Sendfile
   # header. The web server is then responsible for writing the file contents
   # to the client. This can dramatically reduce the amount of work required
-  # by the Ruby backend and takes advantage of the web servers optimized file
+  # by the Ruby backend and takes advantage of the web server's optimized file
   # delivery code.
   #
   # In order to take advantage of this middleware, the response body must
@@ -31,19 +33,19 @@ module Rack
   # a private "/files/" area, enable X-Accel-Redirect, and pass the special
   # X-Sendfile-Type and X-Accel-Mapping headers to the backend:
   #
-  #   location /files/ {
+  #   location ~ /files/(.*) {
   #     internal;
-  #     alias /var/www/;
+  #     alias /var/www/$1;
   #   }
   #
   #   location / {
-  #     proxy_redirect     false;
+  #     proxy_redirect     off;
   #
   #     proxy_set_header   Host                $host;
   #     proxy_set_header   X-Real-IP           $remote_addr;
   #     proxy_set_header   X-Forwarded-For     $proxy_add_x_forwarded_for;
   #
-  #     proxy_set_header   X-Sendfile-Type     X-Accel-Redirect
+  #     proxy_set_header   X-Sendfile-Type     X-Accel-Redirect;
   #     proxy_set_header   X-Accel-Mapping     /files/=/var/www/;
   #
   #     proxy_pass         http://127.0.0.1:8080/;