rack 2.1.3 → 2.2.1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of rack might be problematic. Click here for more details.

Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +613 -1
  3. data/CONTRIBUTING.md +136 -0
  4. data/README.rdoc +83 -39
  5. data/Rakefile +14 -7
  6. data/{SPEC → SPEC.rdoc} +26 -1
  7. data/lib/rack.rb +7 -16
  8. data/lib/rack/auth/abstract/request.rb +0 -2
  9. data/lib/rack/auth/basic.rb +3 -3
  10. data/lib/rack/auth/digest/md5.rb +4 -4
  11. data/lib/rack/auth/digest/request.rb +3 -3
  12. data/lib/rack/body_proxy.rb +13 -9
  13. data/lib/rack/builder.rb +77 -8
  14. data/lib/rack/cascade.rb +23 -8
  15. data/lib/rack/chunked.rb +48 -23
  16. data/lib/rack/common_logger.rb +25 -18
  17. data/lib/rack/conditional_get.rb +18 -16
  18. data/lib/rack/content_length.rb +6 -7
  19. data/lib/rack/content_type.rb +3 -4
  20. data/lib/rack/deflater.rb +45 -35
  21. data/lib/rack/directory.rb +77 -59
  22. data/lib/rack/etag.rb +2 -3
  23. data/lib/rack/events.rb +15 -18
  24. data/lib/rack/file.rb +1 -1
  25. data/lib/rack/files.rb +96 -56
  26. data/lib/rack/handler/cgi.rb +1 -4
  27. data/lib/rack/handler/fastcgi.rb +1 -3
  28. data/lib/rack/handler/lsws.rb +1 -3
  29. data/lib/rack/handler/scgi.rb +1 -3
  30. data/lib/rack/handler/thin.rb +15 -11
  31. data/lib/rack/handler/webrick.rb +12 -5
  32. data/lib/rack/head.rb +0 -2
  33. data/lib/rack/lint.rb +57 -14
  34. data/lib/rack/lobster.rb +3 -5
  35. data/lib/rack/lock.rb +0 -1
  36. data/lib/rack/mock.rb +22 -4
  37. data/lib/rack/multipart.rb +1 -1
  38. data/lib/rack/multipart/generator.rb +11 -6
  39. data/lib/rack/multipart/parser.rb +7 -15
  40. data/lib/rack/multipart/uploaded_file.rb +13 -7
  41. data/lib/rack/query_parser.rb +7 -8
  42. data/lib/rack/recursive.rb +1 -1
  43. data/lib/rack/reloader.rb +1 -3
  44. data/lib/rack/request.rb +182 -76
  45. data/lib/rack/response.rb +62 -19
  46. data/lib/rack/rewindable_input.rb +0 -1
  47. data/lib/rack/runtime.rb +3 -3
  48. data/lib/rack/sendfile.rb +0 -3
  49. data/lib/rack/server.rb +9 -8
  50. data/lib/rack/session/abstract/id.rb +20 -18
  51. data/lib/rack/session/cookie.rb +2 -3
  52. data/lib/rack/session/pool.rb +1 -1
  53. data/lib/rack/show_exceptions.rb +2 -4
  54. data/lib/rack/show_status.rb +1 -3
  55. data/lib/rack/static.rb +13 -6
  56. data/lib/rack/tempfile_reaper.rb +0 -2
  57. data/lib/rack/urlmap.rb +1 -4
  58. data/lib/rack/utils.rb +58 -54
  59. data/lib/rack/version.rb +29 -0
  60. data/rack.gemspec +31 -29
  61. metadata +11 -12
@@ -11,23 +11,11 @@
11
11
  # All modules meant for use in your application are <tt>autoload</tt>ed here,
12
12
  # so it should be enough just to <tt>require 'rack'</tt> in your code.
13
13
 
14
- module Rack
15
- # The Rack protocol version number implemented.
16
- VERSION = [1, 3]
17
-
18
- # Return the Rack protocol version as a dotted string.
19
- def self.version
20
- VERSION.join(".")
21
- end
22
-
23
- RELEASE = "2.1.3"
24
-
25
- # Return the Rack release as a dotted string.
26
- def self.release
27
- RELEASE
28
- end
14
+ require_relative 'rack/version'
29
15
 
16
+ module Rack
30
17
  HTTP_HOST = 'HTTP_HOST'
18
+ HTTP_PORT = 'HTTP_PORT'
31
19
  HTTP_VERSION = 'HTTP_VERSION'
32
20
  HTTPS = 'HTTPS'
33
21
  PATH_INFO = 'PATH_INFO'
@@ -37,9 +25,9 @@ module Rack
37
25
  QUERY_STRING = 'QUERY_STRING'
38
26
  SERVER_PROTOCOL = 'SERVER_PROTOCOL'
39
27
  SERVER_NAME = 'SERVER_NAME'
40
- SERVER_ADDR = 'SERVER_ADDR'
41
28
  SERVER_PORT = 'SERVER_PORT'
42
29
  CACHE_CONTROL = 'Cache-Control'
30
+ EXPIRES = 'Expires'
43
31
  CONTENT_LENGTH = 'Content-Length'
44
32
  CONTENT_TYPE = 'Content-Type'
45
33
  SET_COOKIE = 'Set-Cookie'
@@ -98,6 +86,7 @@ module Rack
98
86
  autoload :ContentLength, "rack/content_length"
99
87
  autoload :ContentType, "rack/content_type"
100
88
  autoload :ETag, "rack/etag"
89
+ autoload :Events, "rack/events"
101
90
  autoload :File, "rack/file"
102
91
  autoload :Files, "rack/files"
103
92
  autoload :Deflater, "rack/deflater"
@@ -108,11 +97,13 @@ module Rack
108
97
  autoload :Lint, "rack/lint"
109
98
  autoload :Lock, "rack/lock"
110
99
  autoload :Logger, "rack/logger"
100
+ autoload :MediaType, "rack/media_type"
111
101
  autoload :MethodOverride, "rack/method_override"
112
102
  autoload :Mime, "rack/mime"
113
103
  autoload :NullLogger, "rack/null_logger"
114
104
  autoload :Recursive, "rack/recursive"
115
105
  autoload :Reloader, "rack/reloader"
106
+ autoload :RewindableInput, "rack/rewindable_input"
116
107
  autoload :Runtime, "rack/runtime"
117
108
  autoload :Sendfile, "rack/sendfile"
118
109
  autoload :Server, "rack/server"
@@ -1,7 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'rack/request'
4
-
5
3
  module Rack
6
4
  module Auth
7
5
  class AbstractRequest
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'rack/auth/abstract/handler'
4
- require 'rack/auth/abstract/request'
3
+ require_relative 'abstract/handler'
4
+ require_relative 'abstract/request'
5
5
  require 'base64'
6
6
 
7
7
  module Rack
@@ -44,7 +44,7 @@ module Rack
44
44
 
45
45
  class Request < Auth::AbstractRequest
46
46
  def basic?
47
- "basic" == scheme
47
+ "basic" == scheme && credentials.length == 2
48
48
  end
49
49
 
50
50
  def credentials
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'rack/auth/abstract/handler'
4
- require 'rack/auth/digest/request'
5
- require 'rack/auth/digest/params'
6
- require 'rack/auth/digest/nonce'
3
+ require_relative '../abstract/handler'
4
+ require_relative 'request'
5
+ require_relative 'params'
6
+ require_relative 'nonce'
7
7
  require 'digest/md5'
8
8
 
9
9
  module Rack
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'rack/auth/abstract/request'
4
- require 'rack/auth/digest/params'
5
- require 'rack/auth/digest/nonce'
3
+ require_relative '../abstract/request'
4
+ require_relative 'params'
5
+ require_relative 'nonce'
6
6
 
7
7
  module Rack
8
8
  module Auth
@@ -1,17 +1,25 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Rack
4
+ # Proxy for response bodies allowing calling a block when
5
+ # the response body is closed (after the response has been fully
6
+ # sent to the client).
4
7
  class BodyProxy
8
+ # Set the response body to wrap, and the block to call when the
9
+ # response has been fully sent.
5
10
  def initialize(body, &block)
6
11
  @body = body
7
12
  @block = block
8
13
  @closed = false
9
14
  end
10
15
 
11
- def respond_to?(method_name, include_all = false)
16
+ # Return whether the wrapped body responds to the method.
17
+ def respond_to_missing?(method_name, include_all = false)
12
18
  super or @body.respond_to?(method_name, include_all)
13
19
  end
14
20
 
21
+ # If not already closed, close the wrapped body and
22
+ # then call the block the proxy was initialized with.
15
23
  def close
16
24
  return if @closed
17
25
  @closed = true
@@ -22,20 +30,16 @@ module Rack
22
30
  end
23
31
  end
24
32
 
33
+ # Whether the proxy is closed. The proxy starts as not closed,
34
+ # and becomes closed on the first call to close.
25
35
  def closed?
26
36
  @closed
27
37
  end
28
38
 
29
- # N.B. This method is a special case to address the bug described by #434.
30
- # We are applying this special case for #each only. Future bugs of this
31
- # class will be handled by requesting users to patch their ruby
32
- # implementation, to save adding too many methods in this class.
33
- def each
34
- @body.each { |body| yield body }
35
- end
36
-
39
+ # Delegate missing methods to the wrapped body.
37
40
  def method_missing(method_name, *args, &block)
38
41
  @body.__send__(method_name, *args, &block)
39
42
  end
43
+ ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
40
44
  end
41
45
  end
@@ -35,6 +35,32 @@ module Rack
35
35
  # https://stackoverflow.com/questions/2223882/whats-the-difference-between-utf-8-and-utf-8-without-bom
36
36
  UTF_8_BOM = '\xef\xbb\xbf'
37
37
 
38
+ # Parse the given config file to get a Rack application.
39
+ #
40
+ # If the config file ends in +.ru+, it is treated as a
41
+ # rackup file and the contents will be treated as if
42
+ # specified inside a Rack::Builder block, using the given
43
+ # options.
44
+ #
45
+ # If the config file does not end in +.ru+, it is
46
+ # required and Rack will use the basename of the file
47
+ # to guess which constant will be the Rack application to run.
48
+ # The options given will be ignored in this case.
49
+ #
50
+ # Examples:
51
+ #
52
+ # Rack::Builder.parse_file('config.ru')
53
+ # # Rack application built using Rack::Builder.new
54
+ #
55
+ # Rack::Builder.parse_file('app.rb')
56
+ # # requires app.rb, which can be anywhere in Ruby's
57
+ # # load path. After requiring, assumes App constant
58
+ # # contains Rack application
59
+ #
60
+ # Rack::Builder.parse_file('./my_app.rb')
61
+ # # requires ./my_app.rb, which should be in the
62
+ # # process's current directory. After requiring,
63
+ # # assumes MyApp constant contains Rack application
38
64
  def self.parse_file(config, opts = Server::Options.new)
39
65
  if config.end_with?('.ru')
40
66
  return self.load_file(config, opts)
@@ -45,6 +71,25 @@ module Rack
45
71
  end
46
72
  end
47
73
 
74
+ # Load the given file as a rackup file, treating the
75
+ # contents as if specified inside a Rack::Builder block.
76
+ #
77
+ # Treats the first comment at the beginning of a line
78
+ # that starts with a backslash as options similar to
79
+ # options passed on a rackup command line.
80
+ #
81
+ # Ignores content in the file after +__END__+, so that
82
+ # use of +__END__+ will not result in a syntax error.
83
+ #
84
+ # Example config.ru file:
85
+ #
86
+ # $ cat config.ru
87
+ #
88
+ # #\ -p 9393
89
+ #
90
+ # use Rack::ContentLength
91
+ # require './app.rb'
92
+ # run App
48
93
  def self.load_file(path, opts = Server::Options.new)
49
94
  options = {}
50
95
 
@@ -52,6 +97,7 @@ module Rack
52
97
  cfgfile.slice!(/\A#{UTF_8_BOM}/) if cfgfile.encoding == Encoding::UTF_8
53
98
 
54
99
  if cfgfile[/^#\\(.*)/] && opts
100
+ warn "Parsing options from the first comment line is deprecated!"
55
101
  options = opts.parse! $1.split(/\s+/)
56
102
  end
57
103
 
@@ -61,16 +107,26 @@ module Rack
61
107
  return app, options
62
108
  end
63
109
 
110
+ # Evaluate the given +builder_script+ string in the context of
111
+ # a Rack::Builder block, returning a Rack application.
64
112
  def self.new_from_string(builder_script, file = "(rackup)")
65
- eval "Rack::Builder.new {\n" + builder_script + "\n}.to_app",
66
- TOPLEVEL_BINDING, file, 0
113
+ # We want to build a variant of TOPLEVEL_BINDING with self as a Rack::Builder instance.
114
+ # We cannot use instance_eval(String) as that would resolve constants differently.
115
+ binding, builder = TOPLEVEL_BINDING.eval('Rack::Builder.new.instance_eval { [binding, self] }')
116
+ eval builder_script, binding, file
117
+ builder.to_app
67
118
  end
68
119
 
120
+ # Initialize a new Rack::Builder instance. +default_app+ specifies the
121
+ # default application if +run+ is not called later. If a block
122
+ # is given, it is evaluted in the context of the instance.
69
123
  def initialize(default_app = nil, &block)
70
124
  @use, @map, @run, @warmup, @freeze_app = [], nil, default_app, nil, false
71
125
  instance_eval(&block) if block_given?
72
126
  end
73
127
 
128
+ # Create a new Rack::Builder instance and return the Rack application
129
+ # generated from it.
74
130
  def self.app(default_app = nil, &block)
75
131
  self.new(default_app, &block).to_app
76
132
  end
@@ -121,7 +177,8 @@ module Rack
121
177
  @run = app
122
178
  end
123
179
 
124
- # Takes a lambda or block that is used to warm-up the application.
180
+ # Takes a lambda or block that is used to warm-up the application. This block is called
181
+ # before the Rack application is returned by to_app.
125
182
  #
126
183
  # warmup do |app|
127
184
  # client = Rack::MockRequest.new(app)
@@ -134,25 +191,31 @@ module Rack
134
191
  @warmup = prc || block
135
192
  end
136
193
 
137
- # Creates a route within the application.
194
+ # Creates a route within the application. Routes under the mapped path will be sent to
195
+ # the Rack application specified by run inside the block. Other requests will be sent to the
196
+ # default application specified by run outside the block.
138
197
  #
139
198
  # Rack::Builder.app do
140
- # map '/' do
199
+ # map '/heartbeat' do
141
200
  # run Heartbeat
142
201
  # end
202
+ # run App
143
203
  # end
144
204
  #
145
- # The +use+ method can also be used here to specify middleware to run under a specific path:
205
+ # The +use+ method can also be used inside the block to specify middleware to run under a specific path:
146
206
  #
147
207
  # Rack::Builder.app do
148
- # map '/' do
208
+ # map '/heartbeat' do
149
209
  # use Middleware
150
210
  # run Heartbeat
151
211
  # end
212
+ # run App
152
213
  # end
153
214
  #
154
- # This example includes a piece of middleware which will run before requests hit +Heartbeat+.
215
+ # This example includes a piece of middleware which will run before +/heartbeat+ requests hit +Heartbeat+.
155
216
  #
217
+ # Note that providing a +path+ of +/+ will ignore any default application given in a +run+ statement
218
+ # outside the block.
156
219
  def map(path, &block)
157
220
  @map ||= {}
158
221
  @map[path] = block
@@ -164,6 +227,7 @@ module Rack
164
227
  @freeze_app = true
165
228
  end
166
229
 
230
+ # Return the Rack application generated by this instance.
167
231
  def to_app
168
232
  app = @map ? generate_map(@run, @map) : @run
169
233
  fail "missing run or map statement" unless app
@@ -173,12 +237,17 @@ module Rack
173
237
  app
174
238
  end
175
239
 
240
+ # Call the Rack application generated by this builder instance. Note that
241
+ # this rebuilds the Rack application and runs the warmup code (if any)
242
+ # every time it is called, so it should not be used if performance is important.
176
243
  def call(env)
177
244
  to_app.call(env)
178
245
  end
179
246
 
180
247
  private
181
248
 
249
+ # Generate a URLMap instance by generating new Rack applications for each
250
+ # map block in this instance.
182
251
  def generate_map(default_app, mapping)
183
252
  mapped = default_app ? { '/' => default_app } : {}
184
253
  mapping.each { |r, b| mapped[r] = self.class.new(default_app, &b).to_app }
@@ -2,25 +2,37 @@
2
2
 
3
3
  module Rack
4
4
  # Rack::Cascade tries a request on several apps, and returns the
5
- # first response that is not 404 or 405 (or in a list of configurable
6
- # status codes).
5
+ # first response that is not 404 or 405 (or in a list of configured
6
+ # status codes). If all applications tried return one of the configured
7
+ # status codes, return the last response.
7
8
 
8
9
  class Cascade
10
+ # deprecated, no longer used
9
11
  NotFound = [404, { CONTENT_TYPE => "text/plain" }, []]
10
12
 
13
+ # An array of applications to try in order.
11
14
  attr_reader :apps
12
15
 
13
- def initialize(apps, catch = [404, 405])
16
+ # Set the apps to send requests to, and what statuses result in
17
+ # cascading. Arguments:
18
+ #
19
+ # apps: An enumerable of rack applications.
20
+ # cascade_for: The statuses to use cascading for. If a response is received
21
+ # from an app, the next app is tried.
22
+ def initialize(apps, cascade_for = [404, 405])
14
23
  @apps = []
15
24
  apps.each { |app| add app }
16
25
 
17
- @catch = {}
18
- [*catch].each { |status| @catch[status] = true }
26
+ @cascade_for = {}
27
+ [*cascade_for].each { |status| @cascade_for[status] = true }
19
28
  end
20
29
 
30
+ # Call each app in order. If the responses uses a status that requires
31
+ # cascading, try the next app. If all responses require cascading,
32
+ # return the response from the last app.
21
33
  def call(env)
22
- result = NotFound
23
-
34
+ return [404, { CONTENT_TYPE => "text/plain" }, []] if @apps.empty?
35
+ result = nil
24
36
  last_body = nil
25
37
 
26
38
  @apps.each do |app|
@@ -33,17 +45,20 @@ module Rack
33
45
  last_body.close if last_body.respond_to? :close
34
46
 
35
47
  result = app.call(env)
48
+ return result unless @cascade_for.include?(result[0].to_i)
36
49
  last_body = result[2]
37
- break unless @catch.include?(result[0].to_i)
38
50
  end
39
51
 
40
52
  result
41
53
  end
42
54
 
55
+ # Append an app to the list of apps to cascade. This app will
56
+ # be tried last.
43
57
  def add(app)
44
58
  @apps << app
45
59
  end
46
60
 
61
+ # Whether the given app is one of the apps to cascade to.
47
62
  def include?(app)
48
63
  @apps.include?(app)
49
64
  end
@@ -1,53 +1,74 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'rack/utils'
4
-
5
3
  module Rack
6
4
 
7
5
  # Middleware that applies chunked transfer encoding to response bodies
8
6
  # when the response does not include a Content-Length header.
7
+ #
8
+ # This supports the Trailer response header to allow the use of trailing
9
+ # headers in the chunked encoding. However, using this requires you manually
10
+ # specify a response body that supports a +trailers+ method. Example:
11
+ #
12
+ # [200, { 'Trailer' => 'Expires'}, ["Hello", "World"]]
13
+ # # error raised
14
+ #
15
+ # body = ["Hello", "World"]
16
+ # def body.trailers
17
+ # { 'Expires' => Time.now.to_s }
18
+ # end
19
+ # [200, { 'Trailer' => 'Expires'}, body]
20
+ # # No exception raised
9
21
  class Chunked
10
22
  include Rack::Utils
11
23
 
12
- # A body wrapper that emits chunked responses
24
+ # A body wrapper that emits chunked responses.
13
25
  class Body
14
26
  TERM = "\r\n"
15
27
  TAIL = "0#{TERM}"
16
28
 
17
- include Rack::Utils
18
-
29
+ # Store the response body to be chunked.
19
30
  def initialize(body)
20
31
  @body = body
21
32
  end
22
33
 
34
+ # For each element yielded by the response body, yield
35
+ # the element in chunked encoding.
23
36
  def each(&block)
24
37
  term = TERM
25
38
  @body.each do |chunk|
26
39
  size = chunk.bytesize
27
40
  next if size == 0
28
41
 
29
- chunk = chunk.b
30
- yield [size.to_s(16), term, chunk, term].join
42
+ yield [size.to_s(16), term, chunk.b, term].join
31
43
  end
32
44
  yield TAIL
33
- insert_trailers(&block)
34
- yield TERM
45
+ yield_trailers(&block)
46
+ yield term
35
47
  end
36
48
 
49
+ # Close the response body if the response body supports it.
37
50
  def close
38
51
  @body.close if @body.respond_to?(:close)
39
52
  end
40
53
 
41
54
  private
42
55
 
43
- def insert_trailers(&block)
56
+ # Do nothing as this class does not support trailer headers.
57
+ def yield_trailers
44
58
  end
45
59
  end
46
60
 
61
+ # A body wrapper that emits chunked responses and also supports
62
+ # sending Trailer headers. Note that the response body provided to
63
+ # initialize must have a +trailers+ method that returns a hash
64
+ # of trailer headers, and the rack response itself should have a
65
+ # Trailer header listing the headers that the +trailers+ method
66
+ # will return.
47
67
  class TrailerBody < Body
48
68
  private
49
69
 
50
- def insert_trailers(&block)
70
+ # Yield strings for each trailer header.
71
+ def yield_trailers
51
72
  @body.trailers.each_pair do |k, v|
52
73
  yield "#{k}: #{v}\r\n"
53
74
  end
@@ -58,10 +79,11 @@ module Rack
58
79
  @app = app
59
80
  end
60
81
 
61
- # pre-HTTP/1.0 (informally "HTTP/0.9") HTTP requests did not have
62
- # a version (nor response headers)
82
+ # Whether the HTTP version supports chunked encoding (HTTP 1.1 does).
63
83
  def chunkable_version?(ver)
64
84
  case ver
85
+ # pre-HTTP/1.0 (informally "HTTP/0.9") HTTP requests did not have
86
+ # a version (nor response headers)
65
87
  when 'HTTP/1.0', nil, 'HTTP/0.9'
66
88
  false
67
89
  else
@@ -69,24 +91,27 @@ module Rack
69
91
  end
70
92
  end
71
93
 
94
+ # If the rack app returns a response that should have a body,
95
+ # but does not have Content-Length or Transfer-Encoding headers,
96
+ # modify the response to use chunked Transfer-Encoding.
72
97
  def call(env)
73
98
  status, headers, body = @app.call(env)
74
- headers = HeaderHash.new(headers)
99
+ headers = HeaderHash[headers]
100
+
101
+ if chunkable_version?(env[SERVER_PROTOCOL]) &&
102
+ !STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) &&
103
+ !headers[CONTENT_LENGTH] &&
104
+ !headers[TRANSFER_ENCODING]
75
105
 
76
- if ! chunkable_version?(env[SERVER_PROTOCOL]) ||
77
- STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) ||
78
- headers[CONTENT_LENGTH] ||
79
- headers[TRANSFER_ENCODING]
80
- [status, headers, body]
81
- else
82
- headers.delete(CONTENT_LENGTH)
83
106
  headers[TRANSFER_ENCODING] = 'chunked'
84
107
  if headers['Trailer']
85
- [status, headers, TrailerBody.new(body)]
108
+ body = TrailerBody.new(body)
86
109
  else
87
- [status, headers, Body.new(body)]
110
+ body = Body.new(body)
88
111
  end
89
112
  end
113
+
114
+ [status, headers, body]
90
115
  end
91
116
  end
92
117
  end