rack 2.2.8 → 3.0.9.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +213 -83
  3. data/CONTRIBUTING.md +53 -47
  4. data/MIT-LICENSE +1 -1
  5. data/README.md +309 -0
  6. data/SPEC.rdoc +174 -126
  7. data/lib/rack/auth/abstract/handler.rb +3 -1
  8. data/lib/rack/auth/abstract/request.rb +3 -1
  9. data/lib/rack/auth/basic.rb +0 -2
  10. data/lib/rack/auth/digest/md5.rb +1 -131
  11. data/lib/rack/auth/digest/nonce.rb +1 -54
  12. data/lib/rack/auth/digest/params.rb +1 -54
  13. data/lib/rack/auth/digest/request.rb +1 -43
  14. data/lib/rack/auth/digest.rb +256 -0
  15. data/lib/rack/body_proxy.rb +3 -1
  16. data/lib/rack/builder.rb +83 -63
  17. data/lib/rack/cascade.rb +2 -0
  18. data/lib/rack/chunked.rb +16 -13
  19. data/lib/rack/common_logger.rb +23 -18
  20. data/lib/rack/conditional_get.rb +18 -15
  21. data/lib/rack/constants.rb +64 -0
  22. data/lib/rack/content_length.rb +12 -16
  23. data/lib/rack/content_type.rb +8 -5
  24. data/lib/rack/deflater.rb +40 -26
  25. data/lib/rack/directory.rb +9 -3
  26. data/lib/rack/etag.rb +14 -23
  27. data/lib/rack/events.rb +4 -0
  28. data/lib/rack/file.rb +2 -0
  29. data/lib/rack/files.rb +15 -17
  30. data/lib/rack/head.rb +9 -8
  31. data/lib/rack/headers.rb +154 -0
  32. data/lib/rack/lint.rb +758 -646
  33. data/lib/rack/lock.rb +2 -5
  34. data/lib/rack/logger.rb +2 -0
  35. data/lib/rack/media_type.rb +9 -4
  36. data/lib/rack/method_override.rb +5 -1
  37. data/lib/rack/mime.rb +8 -0
  38. data/lib/rack/mock.rb +1 -271
  39. data/lib/rack/mock_request.rb +166 -0
  40. data/lib/rack/mock_response.rb +126 -0
  41. data/lib/rack/multipart/generator.rb +7 -5
  42. data/lib/rack/multipart/parser.rb +120 -64
  43. data/lib/rack/multipart/uploaded_file.rb +4 -0
  44. data/lib/rack/multipart.rb +20 -40
  45. data/lib/rack/null_logger.rb +9 -0
  46. data/lib/rack/query_parser.rb +78 -46
  47. data/lib/rack/recursive.rb +2 -0
  48. data/lib/rack/reloader.rb +0 -2
  49. data/lib/rack/request.rb +224 -106
  50. data/lib/rack/response.rb +138 -61
  51. data/lib/rack/rewindable_input.rb +24 -5
  52. data/lib/rack/runtime.rb +7 -6
  53. data/lib/rack/sendfile.rb +30 -25
  54. data/lib/rack/show_exceptions.rb +15 -2
  55. data/lib/rack/show_status.rb +17 -7
  56. data/lib/rack/static.rb +8 -8
  57. data/lib/rack/tempfile_reaper.rb +15 -4
  58. data/lib/rack/urlmap.rb +3 -1
  59. data/lib/rack/utils.rb +208 -178
  60. data/lib/rack/version.rb +9 -4
  61. data/lib/rack.rb +6 -76
  62. metadata +14 -34
  63. data/README.rdoc +0 -320
  64. data/Rakefile +0 -130
  65. data/bin/rackup +0 -5
  66. data/contrib/rack.png +0 -0
  67. data/contrib/rack.svg +0 -150
  68. data/contrib/rack_logo.svg +0 -164
  69. data/contrib/rdoc.css +0 -412
  70. data/example/lobster.ru +0 -6
  71. data/example/protectedlobster.rb +0 -16
  72. data/example/protectedlobster.ru +0 -10
  73. data/lib/rack/core_ext/regexp.rb +0 -14
  74. data/lib/rack/handler/cgi.rb +0 -59
  75. data/lib/rack/handler/fastcgi.rb +0 -100
  76. data/lib/rack/handler/lsws.rb +0 -61
  77. data/lib/rack/handler/scgi.rb +0 -71
  78. data/lib/rack/handler/thin.rb +0 -36
  79. data/lib/rack/handler/webrick.rb +0 -129
  80. data/lib/rack/handler.rb +0 -104
  81. data/lib/rack/lobster.rb +0 -70
  82. data/lib/rack/server.rb +0 -466
  83. data/lib/rack/session/abstract/id.rb +0 -523
  84. data/lib/rack/session/cookie.rb +0 -204
  85. data/lib/rack/session/memcache.rb +0 -10
  86. data/lib/rack/session/pool.rb +0 -85
  87. data/rack.gemspec +0 -46
data/lib/rack/lint.rb CHANGED
@@ -2,6 +2,9 @@
2
2
 
3
3
  require 'forwardable'
4
4
 
5
+ require_relative 'constants'
6
+ require_relative 'utils'
7
+
5
8
  module Rack
6
9
  # Rack::Lint validates your application and the requests and
7
10
  # responses according to the Rack spec.
@@ -9,787 +12,896 @@ module Rack
9
12
  class Lint
10
13
  def initialize(app)
11
14
  @app = app
12
- @content_length = nil
13
15
  end
14
16
 
15
17
  # :stopdoc:
16
18
 
17
19
  class LintError < RuntimeError; end
18
- module Assertion
19
- def assert(message)
20
- unless yield
21
- raise LintError, message
22
- end
23
- end
24
- end
25
- include Assertion
26
-
27
- ## This specification aims to formalize the Rack protocol. You
20
+ # AUTHORS: n.b. The trailing whitespace between paragraphs is important and
21
+ # should not be removed. The whitespace creates paragraphs in the RDoc
22
+ # output.
23
+ #
24
+ ## This specification aims to formalize the Rack protocol. You
28
25
  ## can (and should) use Rack::Lint to enforce it.
29
26
  ##
30
27
  ## When you develop middleware, be sure to add a Lint before and
31
28
  ## after to catch all mistakes.
32
-
29
+ ##
33
30
  ## = Rack applications
34
-
31
+ ##
35
32
  ## A Rack application is a Ruby object (not a class) that
36
33
  ## responds to +call+.
37
34
  def call(env = nil)
38
- dup._call(env)
35
+ Wrapper.new(@app, env).response
39
36
  end
40
37
 
41
- def _call(env)
42
- ## It takes exactly one argument, the *environment*
43
- raise LintError, "No env given" unless env
44
- check_env env
38
+ class Wrapper
39
+ def initialize(app, env)
40
+ @app = app
41
+ @env = env
42
+ @response = nil
43
+ @head_request = false
45
44
 
46
- env[RACK_INPUT] = InputWrapper.new(env[RACK_INPUT])
47
- env[RACK_ERRORS] = ErrorWrapper.new(env[RACK_ERRORS])
45
+ @status = nil
46
+ @headers = nil
47
+ @body = nil
48
+ @invoked = nil
49
+ @content_length = nil
50
+ @closed = false
51
+ @size = 0
52
+ end
48
53
 
49
- ## and returns an Array of exactly three values:
50
- ary = @app.call(env)
51
- raise LintError, "response is not an Array, but #{ary.class}" unless ary.kind_of? Array
52
- raise LintError, "response array has #{ary.size} elements instead of 3" unless ary.size == 3
54
+ def response
55
+ ## It takes exactly one argument, the *environment*
56
+ raise LintError, "No env given" unless @env
57
+ check_environment(@env)
53
58
 
54
- status, headers, @body = ary
55
- ## The *status*,
56
- check_status status
57
- ## the *headers*,
58
- check_headers headers
59
+ @env[RACK_INPUT] = InputWrapper.new(@env[RACK_INPUT])
60
+ @env[RACK_ERRORS] = ErrorWrapper.new(@env[RACK_ERRORS])
59
61
 
60
- hijack_proc = check_hijack_response headers, env
61
- if hijack_proc && headers.is_a?(Hash)
62
- headers[RACK_HIJACK] = hijack_proc
63
- end
62
+ ## and returns a non-frozen Array of exactly three values:
63
+ @response = @app.call(@env)
64
+ raise LintError, "response is not an Array, but #{@response.class}" unless @response.kind_of? Array
65
+ raise LintError, "response is frozen" if @response.frozen?
66
+ raise LintError, "response array has #{@response.size} elements instead of 3" unless @response.size == 3
64
67
 
65
- ## and the *body*.
66
- check_content_type status, headers
67
- check_content_length status, headers
68
- @head_request = env[REQUEST_METHOD] == HEAD
69
- [status, headers, self]
70
- end
68
+ @status, @headers, @body = @response
69
+ ## The *status*,
70
+ check_status(@status)
71
+
72
+ ## the *headers*,
73
+ check_headers(@headers)
71
74
 
72
- ## == The Environment
73
- def check_env(env)
74
- ## The environment must be an unfrozen instance of Hash that includes
75
- ## CGI-like headers. The application is free to modify the
76
- ## environment.
77
- raise LintError, "env #{env.inspect} is not a Hash, but #{env.class}" unless env.kind_of? Hash
78
- raise LintError, "env should not be frozen, but is" if env.frozen?
79
-
80
- ##
81
- ## The environment is required to include these variables
82
- ## (adopted from PEP333), except when they'd be empty, but see
83
- ## below.
84
-
85
- ## <tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
86
- ## "GET" or "POST". This cannot ever
87
- ## be an empty string, and so is
88
- ## always required.
89
-
90
- ## <tt>SCRIPT_NAME</tt>:: The initial portion of the request
91
- ## URL's "path" that corresponds to the
92
- ## application object, so that the
93
- ## application knows its virtual
94
- ## "location". This may be an empty
95
- ## string, if the application corresponds
96
- ## to the "root" of the server.
97
-
98
- ## <tt>PATH_INFO</tt>:: The remainder of the request URL's
99
- ## "path", designating the virtual
100
- ## "location" of the request's target
101
- ## within the application. This may be an
102
- ## empty string, if the request URL targets
103
- ## the application root and does not have a
104
- ## trailing slash. This value may be
105
- ## percent-encoded when originating from
106
- ## a URL.
107
-
108
- ## <tt>QUERY_STRING</tt>:: The portion of the request URL that
109
- ## follows the <tt>?</tt>, if any. May be
110
- ## empty, but is always required!
111
-
112
- ## <tt>SERVER_NAME</tt>:: When combined with <tt>SCRIPT_NAME</tt> and
113
- ## <tt>PATH_INFO</tt>, these variables can be
114
- ## used to complete the URL. Note, however,
115
- ## that <tt>HTTP_HOST</tt>, if present,
116
- ## should be used in preference to
117
- ## <tt>SERVER_NAME</tt> for reconstructing
118
- ## the request URL.
119
- ## <tt>SERVER_NAME</tt> can never be an empty
120
- ## string, and so is always required.
121
-
122
- ## <tt>SERVER_PORT</tt>:: An optional +Integer+ which is the port the
123
- ## server is running on. Should be specified if
124
- ## the server is running on a non-standard port.
125
-
126
- ## <tt>HTTP_</tt> Variables:: Variables corresponding to the
127
- ## client-supplied HTTP request
128
- ## headers (i.e., variables whose
129
- ## names begin with <tt>HTTP_</tt>). The
130
- ## presence or absence of these
131
- ## variables should correspond with
132
- ## the presence or absence of the
133
- ## appropriate HTTP header in the
134
- ## request. See
135
- ## {RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18]
136
- ## for specific behavior.
137
-
138
- ## In addition to this, the Rack environment must include these
139
- ## Rack-specific variables:
140
-
141
- ## <tt>rack.version</tt>:: The Array representing this version of Rack
142
- ## See Rack::VERSION, that corresponds to
143
- ## the version of this SPEC.
144
-
145
- ## <tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the
146
- ## request URL.
147
-
148
- ## <tt>rack.input</tt>:: See below, the input stream.
149
-
150
- ## <tt>rack.errors</tt>:: See below, the error stream.
151
-
152
- ## <tt>rack.multithread</tt>:: true if the application object may be
153
- ## simultaneously invoked by another thread
154
- ## in the same process, false otherwise.
155
-
156
- ## <tt>rack.multiprocess</tt>:: true if an equivalent application object
157
- ## may be simultaneously invoked by another
158
- ## process, false otherwise.
159
-
160
- ## <tt>rack.run_once</tt>:: true if the server expects
161
- ## (but does not guarantee!) that the
162
- ## application will only be invoked this one
163
- ## time during the life of its containing
164
- ## process. Normally, this will only be true
165
- ## for a server based on CGI
166
- ## (or something similar).
167
-
168
- ## <tt>rack.hijack?</tt>:: present and true if the server supports
169
- ## connection hijacking. See below, hijacking.
170
-
171
- ## <tt>rack.hijack</tt>:: an object responding to #call that must be
172
- ## called at least once before using
173
- ## rack.hijack_io.
174
- ## It is recommended #call return rack.hijack_io
175
- ## as well as setting it in env if necessary.
176
-
177
- ## <tt>rack.hijack_io</tt>:: if rack.hijack? is true, and rack.hijack
178
- ## has received #call, this will contain
179
- ## an object resembling an IO. See hijacking.
180
-
181
- ## Additional environment specifications have approved to
182
- ## standardized middleware APIs. None of these are required to
183
- ## be implemented by the server.
184
-
185
- ## <tt>rack.session</tt>:: A hash like interface for storing
186
- ## request session data.
187
- ## The store must implement:
188
- if session = env[RACK_SESSION]
189
- ## store(key, value) (aliased as []=);
190
- unless session.respond_to?(:store) && session.respond_to?(:[]=)
191
- raise LintError, "session #{session.inspect} must respond to store and []="
192
- end
193
-
194
- ## fetch(key, default = nil) (aliased as []);
195
- unless session.respond_to?(:fetch) && session.respond_to?(:[])
196
- raise LintError, "session #{session.inspect} must respond to fetch and []"
197
- end
198
-
199
- ## delete(key);
200
- unless session.respond_to?(:delete)
201
- raise LintError, "session #{session.inspect} must respond to delete"
202
- end
203
-
204
- ## clear;
205
- unless session.respond_to?(:clear)
206
- raise LintError, "session #{session.inspect} must respond to clear"
75
+ hijack_proc = check_hijack_response(@headers, @env)
76
+ if hijack_proc
77
+ @headers[RACK_HIJACK] = hijack_proc
207
78
  end
208
-
209
- ## to_hash (returning unfrozen Hash instance);
210
- unless session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
211
- raise LintError, "session #{session.inspect} must respond to to_hash and return unfrozen Hash instance"
79
+
80
+ ## and the *body*.
81
+ check_content_type(@status, @headers)
82
+ check_content_length(@status, @headers)
83
+ @head_request = @env[REQUEST_METHOD] == HEAD
84
+
85
+ @lint = (@env['rack.lint'] ||= []) << self
86
+
87
+ if (@env['rack.lint.body_iteration'] ||= 0) > 0
88
+ raise LintError, "Middleware must not call #each directly"
212
89
  end
90
+
91
+ return [@status, @headers, self]
213
92
  end
214
93
 
215
- ## <tt>rack.logger</tt>:: A common object interface for logging messages.
216
- ## The object must implement:
217
- if logger = env[RACK_LOGGER]
218
- ## info(message, &block)
219
- unless logger.respond_to?(:info)
220
- raise LintError, "logger #{logger.inspect} must respond to info"
94
+ ##
95
+ ## == The Environment
96
+ ##
97
+ def check_environment(env)
98
+ ## The environment must be an unfrozen instance of Hash that includes
99
+ ## CGI-like headers. The Rack application is free to modify the
100
+ ## environment.
101
+ raise LintError, "env #{env.inspect} is not a Hash, but #{env.class}" unless env.kind_of? Hash
102
+ raise LintError, "env should not be frozen, but is" if env.frozen?
103
+
104
+ ##
105
+ ## The environment is required to include these variables
106
+ ## (adopted from {PEP 333}[https://peps.python.org/pep-0333/]), except when they'd be empty, but see
107
+ ## below.
108
+
109
+ ## <tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
110
+ ## "GET" or "POST". This cannot ever
111
+ ## be an empty string, and so is
112
+ ## always required.
113
+
114
+ ## <tt>SCRIPT_NAME</tt>:: The initial portion of the request
115
+ ## URL's "path" that corresponds to the
116
+ ## application object, so that the
117
+ ## application knows its virtual
118
+ ## "location". This may be an empty
119
+ ## string, if the application corresponds
120
+ ## to the "root" of the server.
121
+
122
+ ## <tt>PATH_INFO</tt>:: The remainder of the request URL's
123
+ ## "path", designating the virtual
124
+ ## "location" of the request's target
125
+ ## within the application. This may be an
126
+ ## empty string, if the request URL targets
127
+ ## the application root and does not have a
128
+ ## trailing slash. This value may be
129
+ ## percent-encoded when originating from
130
+ ## a URL.
131
+
132
+ ## <tt>QUERY_STRING</tt>:: The portion of the request URL that
133
+ ## follows the <tt>?</tt>, if any. May be
134
+ ## empty, but is always required!
135
+
136
+ ## <tt>SERVER_NAME</tt>:: When combined with <tt>SCRIPT_NAME</tt> and
137
+ ## <tt>PATH_INFO</tt>, these variables can be
138
+ ## used to complete the URL. Note, however,
139
+ ## that <tt>HTTP_HOST</tt>, if present,
140
+ ## should be used in preference to
141
+ ## <tt>SERVER_NAME</tt> for reconstructing
142
+ ## the request URL.
143
+ ## <tt>SERVER_NAME</tt> can never be an empty
144
+ ## string, and so is always required.
145
+
146
+ ## <tt>SERVER_PORT</tt>:: An optional +Integer+ which is the port the
147
+ ## server is running on. Should be specified if
148
+ ## the server is running on a non-standard port.
149
+
150
+ ## <tt>SERVER_PROTOCOL</tt>:: A string representing the HTTP version used
151
+ ## for the request.
152
+
153
+ ## <tt>HTTP_</tt> Variables:: Variables corresponding to the
154
+ ## client-supplied HTTP request
155
+ ## headers (i.e., variables whose
156
+ ## names begin with <tt>HTTP_</tt>). The
157
+ ## presence or absence of these
158
+ ## variables should correspond with
159
+ ## the presence or absence of the
160
+ ## appropriate HTTP header in the
161
+ ## request. See
162
+ ## {RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18]
163
+ ## for specific behavior.
164
+
165
+ ## In addition to this, the Rack environment must include these
166
+ ## Rack-specific variables:
167
+
168
+ ## <tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the
169
+ ## request URL.
170
+
171
+ ## <tt>rack.input</tt>:: See below, the input stream.
172
+
173
+ ## <tt>rack.errors</tt>:: See below, the error stream.
174
+
175
+ ## <tt>rack.hijack?</tt>:: See below, if present and true, indicates
176
+ ## that the server supports partial hijacking.
177
+
178
+ ## <tt>rack.hijack</tt>:: See below, if present, an object responding
179
+ ## to +call+ that is used to perform a full
180
+ ## hijack.
181
+
182
+ ## Additional environment specifications have approved to
183
+ ## standardized middleware APIs. None of these are required to
184
+ ## be implemented by the server.
185
+
186
+ ## <tt>rack.session</tt>:: A hash-like interface for storing
187
+ ## request session data.
188
+ ## The store must implement:
189
+ if session = env[RACK_SESSION]
190
+ ## store(key, value) (aliased as []=);
191
+ unless session.respond_to?(:store) && session.respond_to?(:[]=)
192
+ raise LintError, "session #{session.inspect} must respond to store and []="
193
+ end
194
+
195
+ ## fetch(key, default = nil) (aliased as []);
196
+ unless session.respond_to?(:fetch) && session.respond_to?(:[])
197
+ raise LintError, "session #{session.inspect} must respond to fetch and []"
198
+ end
199
+
200
+ ## delete(key);
201
+ unless session.respond_to?(:delete)
202
+ raise LintError, "session #{session.inspect} must respond to delete"
203
+ end
204
+
205
+ ## clear;
206
+ unless session.respond_to?(:clear)
207
+ raise LintError, "session #{session.inspect} must respond to clear"
208
+ end
209
+
210
+ ## to_hash (returning unfrozen Hash instance);
211
+ unless session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
212
+ raise LintError, "session #{session.inspect} must respond to to_hash and return unfrozen Hash instance"
213
+ end
221
214
  end
222
215
 
223
- ## debug(message, &block)
224
- unless logger.respond_to?(:debug)
225
- raise LintError, "logger #{logger.inspect} must respond to debug"
216
+ ## <tt>rack.logger</tt>:: A common object interface for logging messages.
217
+ ## The object must implement:
218
+ if logger = env[RACK_LOGGER]
219
+ ## info(message, &block)
220
+ unless logger.respond_to?(:info)
221
+ raise LintError, "logger #{logger.inspect} must respond to info"
222
+ end
223
+
224
+ ## debug(message, &block)
225
+ unless logger.respond_to?(:debug)
226
+ raise LintError, "logger #{logger.inspect} must respond to debug"
227
+ end
228
+
229
+ ## warn(message, &block)
230
+ unless logger.respond_to?(:warn)
231
+ raise LintError, "logger #{logger.inspect} must respond to warn"
232
+ end
233
+
234
+ ## error(message, &block)
235
+ unless logger.respond_to?(:error)
236
+ raise LintError, "logger #{logger.inspect} must respond to error"
237
+ end
238
+
239
+ ## fatal(message, &block)
240
+ unless logger.respond_to?(:fatal)
241
+ raise LintError, "logger #{logger.inspect} must respond to fatal"
242
+ end
226
243
  end
227
244
 
228
- ## warn(message, &block)
229
- unless logger.respond_to?(:warn)
230
- raise LintError, "logger #{logger.inspect} must respond to warn"
245
+ ## <tt>rack.multipart.buffer_size</tt>:: An Integer hint to the multipart parser as to what chunk size to use for reads and writes.
246
+ if bufsize = env[RACK_MULTIPART_BUFFER_SIZE]
247
+ unless bufsize.is_a?(Integer) && bufsize > 0
248
+ raise LintError, "rack.multipart.buffer_size must be an Integer > 0 if specified"
249
+ end
231
250
  end
232
251
 
233
- ## error(message, &block)
234
- unless logger.respond_to?(:error)
235
- raise LintError, "logger #{logger.inspect} must respond to error"
252
+ ## <tt>rack.multipart.tempfile_factory</tt>:: An object responding to #call with two arguments, the filename and content_type given for the multipart form field, and returning an IO-like object that responds to #<< and optionally #rewind. This factory will be used to instantiate the tempfile for each multipart form file upload field, rather than the default class of Tempfile.
253
+ if tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
254
+ raise LintError, "rack.multipart.tempfile_factory must respond to #call" unless tempfile_factory.respond_to?(:call)
255
+ env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
256
+ io = tempfile_factory.call(filename, content_type)
257
+ raise LintError, "rack.multipart.tempfile_factory return value must respond to #<<" unless io.respond_to?(:<<)
258
+ io
259
+ end
236
260
  end
237
261
 
238
- ## fatal(message, &block)
239
- unless logger.respond_to?(:fatal)
240
- raise LintError, "logger #{logger.inspect} must respond to fatal"
262
+ ## The server or the application can store their own data in the
263
+ ## environment, too. The keys must contain at least one dot,
264
+ ## and should be prefixed uniquely. The prefix <tt>rack.</tt>
265
+ ## is reserved for use with the Rack core distribution and other
266
+ ## accepted specifications and must not be used otherwise.
267
+ ##
268
+
269
+ %w[REQUEST_METHOD SERVER_NAME QUERY_STRING SERVER_PROTOCOL
270
+ rack.input rack.errors].each { |header|
271
+ raise LintError, "env missing required key #{header}" unless env.include? header
272
+ }
273
+
274
+ ## The <tt>SERVER_PORT</tt> must be an Integer if set.
275
+ server_port = env["SERVER_PORT"]
276
+ unless server_port.nil? || (Integer(server_port) rescue false)
277
+ raise LintError, "env[SERVER_PORT] is not an Integer"
241
278
  end
242
- end
243
279
 
244
- ## <tt>rack.multipart.buffer_size</tt>:: An Integer hint to the multipart parser as to what chunk size to use for reads and writes.
245
- if bufsize = env[RACK_MULTIPART_BUFFER_SIZE]
246
- unless bufsize.is_a?(Integer) && bufsize > 0
247
- raise LintError, "rack.multipart.buffer_size must be an Integer > 0 if specified"
280
+ ## The <tt>SERVER_NAME</tt> must be a valid authority as defined by RFC7540.
281
+ unless (URI.parse("http://#{env[SERVER_NAME]}/") rescue false)
282
+ raise LintError, "#{env[SERVER_NAME]} must be a valid authority"
248
283
  end
249
- end
250
284
 
251
- ## <tt>rack.multipart.tempfile_factory</tt>:: An object responding to #call with two arguments, the filename and content_type given for the multipart form field, and returning an IO-like object that responds to #<< and optionally #rewind. This factory will be used to instantiate the tempfile for each multipart form file upload field, rather than the default class of Tempfile.
252
- if tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
253
- raise LintError, "rack.multipart.tempfile_factory must respond to #call" unless tempfile_factory.respond_to?(:call)
254
- env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
255
- io = tempfile_factory.call(filename, content_type)
256
- raise LintError, "rack.multipart.tempfile_factory return value must respond to #<<" unless io.respond_to?(:<<)
257
- io
285
+ ## The <tt>HTTP_HOST</tt> must be a valid authority as defined by RFC7540.
286
+ unless (URI.parse("http://#{env[HTTP_HOST]}/") rescue false)
287
+ raise LintError, "#{env[HTTP_HOST]} must be a valid authority"
258
288
  end
259
- end
260
289
 
261
- ## The server or the application can store their own data in the
262
- ## environment, too. The keys must contain at least one dot,
263
- ## and should be prefixed uniquely. The prefix <tt>rack.</tt>
264
- ## is reserved for use with the Rack core distribution and other
265
- ## accepted specifications and must not be used otherwise.
266
- ##
290
+ ## The <tt>SERVER_PROTOCOL</tt> must match the regexp <tt>HTTP/\d(\.\d)?</tt>.
291
+ server_protocol = env['SERVER_PROTOCOL']
292
+ unless %r{HTTP/\d(\.\d)?}.match?(server_protocol)
293
+ raise LintError, "env[SERVER_PROTOCOL] does not match HTTP/\\d(\\.\\d)?"
294
+ end
267
295
 
268
- %w[REQUEST_METHOD SERVER_NAME QUERY_STRING
269
- rack.version rack.input rack.errors
270
- rack.multithread rack.multiprocess rack.run_once].each { |header|
271
- raise LintError, "env missing required key #{header}" unless env.include? header
272
- }
296
+ ## If the <tt>HTTP_VERSION</tt> is present, it must equal the <tt>SERVER_PROTOCOL</tt>.
297
+ if env['HTTP_VERSION'] && env['HTTP_VERSION'] != server_protocol
298
+ raise LintError, "env[HTTP_VERSION] does not equal env[SERVER_PROTOCOL]"
299
+ end
273
300
 
274
- ## The <tt>SERVER_PORT</tt> must be an Integer if set.
275
- server_port = env["SERVER_PORT"]
276
- unless server_port.nil? || (Integer(server_port) rescue false)
277
- raise LintError, "env[SERVER_PORT] is not an Integer"
278
- end
301
+ ## The environment must not contain the keys
302
+ ## <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
303
+ ## (use the versions without <tt>HTTP_</tt>).
304
+ %w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { |header|
305
+ if env.include? header
306
+ raise LintError, "env contains #{header}, must use #{header[5..-1]}"
307
+ end
308
+ }
279
309
 
280
- ## The <tt>SERVER_NAME</tt> must be a valid authority as defined by RFC7540.
281
- unless (URI.parse("http://#{env[SERVER_NAME]}/") rescue false)
282
- raise LintError, "#{env[SERVER_NAME]} must be a valid authority"
283
- end
310
+ ## The CGI keys (named without a period) must have String values.
311
+ ## If the string values for CGI keys contain non-ASCII characters,
312
+ ## they should use ASCII-8BIT encoding.
313
+ env.each { |key, value|
314
+ next if key.include? "." # Skip extensions
315
+ unless value.kind_of? String
316
+ raise LintError, "env variable #{key} has non-string value #{value.inspect}"
317
+ end
318
+ next if value.encoding == Encoding::ASCII_8BIT
319
+ unless value.b !~ /[\x80-\xff]/n
320
+ raise LintError, "env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}"
321
+ end
322
+ }
284
323
 
285
- ## The <tt>HTTP_HOST</tt> must be a valid authority as defined by RFC7540.
286
- unless (URI.parse("http://#{env[HTTP_HOST]}/") rescue false)
287
- raise LintError, "#{env[HTTP_HOST]} must be a valid authority"
288
- end
324
+ ## There are the following restrictions:
289
325
 
290
- ## The environment must not contain the keys
291
- ## <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
292
- ## (use the versions without <tt>HTTP_</tt>).
293
- %w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { |header|
294
- if env.include? header
295
- raise LintError, "env contains #{header}, must use #{header[5, -1]}"
326
+ ## * <tt>rack.url_scheme</tt> must either be +http+ or +https+.
327
+ unless %w[http https].include?(env[RACK_URL_SCHEME])
328
+ raise LintError, "rack.url_scheme unknown: #{env[RACK_URL_SCHEME].inspect}"
296
329
  end
297
- }
298
330
 
299
- ## The CGI keys (named without a period) must have String values.
300
- ## If the string values for CGI keys contain non-ASCII characters,
301
- ## they should use ASCII-8BIT encoding.
302
- env.each { |key, value|
303
- next if key.include? "." # Skip extensions
304
- unless value.kind_of? String
305
- raise LintError, "env variable #{key} has non-string value #{value.inspect}"
331
+ ## * There must be a valid input stream in <tt>rack.input</tt>.
332
+ check_input env[RACK_INPUT]
333
+ ## * There must be a valid error stream in <tt>rack.errors</tt>.
334
+ check_error env[RACK_ERRORS]
335
+ ## * There may be a valid hijack callback in <tt>rack.hijack</tt>
336
+ check_hijack env
337
+
338
+ ## * The <tt>REQUEST_METHOD</tt> must be a valid token.
339
+ unless env[REQUEST_METHOD] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
340
+ raise LintError, "REQUEST_METHOD unknown: #{env[REQUEST_METHOD].dump}"
306
341
  end
307
- next if value.encoding == Encoding::ASCII_8BIT
308
- unless value.b !~ /[\x80-\xff]/n
309
- raise LintError, "env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}"
342
+
343
+ ## * The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
344
+ if env.include?(SCRIPT_NAME) && env[SCRIPT_NAME] != "" && env[SCRIPT_NAME] !~ /\A\//
345
+ raise LintError, "SCRIPT_NAME must start with /"
346
+ end
347
+ ## * The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
348
+ if env.include?(PATH_INFO) && env[PATH_INFO] != "" && env[PATH_INFO] !~ /\A\//
349
+ raise LintError, "PATH_INFO must start with /"
350
+ end
351
+ ## * The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
352
+ if env.include?("CONTENT_LENGTH") && env["CONTENT_LENGTH"] !~ /\A\d+\z/
353
+ raise LintError, "Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}"
310
354
  end
311
- }
312
355
 
313
- ## There are the following restrictions:
356
+ ## * One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
357
+ ## set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
358
+ ## <tt>SCRIPT_NAME</tt> is empty.
359
+ unless env[SCRIPT_NAME] || env[PATH_INFO]
360
+ raise LintError, "One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)"
361
+ end
362
+ ## <tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
363
+ unless env[SCRIPT_NAME] != "/"
364
+ raise LintError, "SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'"
365
+ end
314
366
 
315
- ## * <tt>rack.version</tt> must be an array of Integers.
316
- unless env[RACK_VERSION].kind_of? Array
317
- raise LintError, "rack.version must be an Array, was #{env[RACK_VERSION].class}"
367
+ ## <tt>rack.response_finished</tt>:: An array of callables run by the server after the response has been
368
+ ## processed. This would typically be invoked after sending the response to the client, but it could also be
369
+ ## invoked if an error occurs while generating the response or sending the response; in that case, the error
370
+ ## argument will be a subclass of +Exception+.
371
+ ## The callables are invoked with +env, status, headers, error+ arguments and should not raise any
372
+ ## exceptions. They should be invoked in reverse order of registration.
373
+ if callables = env[RACK_RESPONSE_FINISHED]
374
+ raise LintError, "rack.response_finished must be an array of callable objects" unless callables.is_a?(Array)
375
+
376
+ callables.each do |callable|
377
+ raise LintError, "rack.response_finished values must respond to call(env, status, headers, error)" unless callable.respond_to?(:call)
378
+ end
379
+ end
318
380
  end
319
- ## * <tt>rack.url_scheme</tt> must either be +http+ or +https+.
320
- unless %w[http https].include?(env[RACK_URL_SCHEME])
321
- raise LintError, "rack.url_scheme unknown: #{env[RACK_URL_SCHEME].inspect}"
381
+
382
+ ##
383
+ ## === The Input Stream
384
+ ##
385
+ ## The input stream is an IO-like object which contains the raw HTTP
386
+ ## POST data.
387
+ def check_input(input)
388
+ ## When applicable, its external encoding must be "ASCII-8BIT" and it
389
+ ## must be opened in binary mode, for Ruby 1.9 compatibility.
390
+ if input.respond_to?(:external_encoding) && input.external_encoding != Encoding::ASCII_8BIT
391
+ raise LintError, "rack.input #{input} does not have ASCII-8BIT as its external encoding"
392
+ end
393
+ if input.respond_to?(:binmode?) && !input.binmode?
394
+ raise LintError, "rack.input #{input} is not opened in binary mode"
395
+ end
396
+
397
+ ## The input stream must respond to +gets+, +each+, and +read+.
398
+ [:gets, :each, :read].each { |method|
399
+ unless input.respond_to? method
400
+ raise LintError, "rack.input #{input} does not respond to ##{method}"
401
+ end
402
+ }
322
403
  end
323
404
 
324
- ## * There must be a valid input stream in <tt>rack.input</tt>.
325
- check_input env[RACK_INPUT]
326
- ## * There must be a valid error stream in <tt>rack.errors</tt>.
327
- check_error env[RACK_ERRORS]
328
- ## * There may be a valid hijack stream in <tt>rack.hijack_io</tt>
329
- check_hijack env
405
+ class InputWrapper
406
+ def initialize(input)
407
+ @input = input
408
+ end
330
409
 
331
- ## * The <tt>REQUEST_METHOD</tt> must be a valid token.
332
- unless env[REQUEST_METHOD] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
333
- raise LintError, "REQUEST_METHOD unknown: #{env[REQUEST_METHOD].dump}"
334
- end
410
+ ## * +gets+ must be called without arguments and return a string,
411
+ ## or +nil+ on EOF.
412
+ def gets(*args)
413
+ raise LintError, "rack.input#gets called with arguments" unless args.size == 0
414
+ v = @input.gets
415
+ unless v.nil? or v.kind_of? String
416
+ raise LintError, "rack.input#gets didn't return a String"
417
+ end
418
+ v
419
+ end
335
420
 
336
- ## * The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
337
- if env.include?(SCRIPT_NAME) && env[SCRIPT_NAME] != "" && env[SCRIPT_NAME] !~ /\A\//
338
- raise LintError, "SCRIPT_NAME must start with /"
339
- end
340
- ## * The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
341
- if env.include?(PATH_INFO) && env[PATH_INFO] != "" && env[PATH_INFO] !~ /\A\//
342
- raise LintError, "PATH_INFO must start with /"
343
- end
344
- ## * The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
345
- if env.include?("CONTENT_LENGTH") && env["CONTENT_LENGTH"] !~ /\A\d+\z/
346
- raise LintError, "Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}"
347
- end
421
+ ## * +read+ behaves like IO#read.
422
+ ## Its signature is <tt>read([length, [buffer]])</tt>.
423
+ ##
424
+ ## If given, +length+ must be a non-negative Integer (>= 0) or +nil+,
425
+ ## and +buffer+ must be a String and may not be nil.
426
+ ##
427
+ ## If +length+ is given and not nil, then this method reads at most
428
+ ## +length+ bytes from the input stream.
429
+ ##
430
+ ## If +length+ is not given or nil, then this method reads
431
+ ## all data until EOF.
432
+ ##
433
+ ## When EOF is reached, this method returns nil if +length+ is given
434
+ ## and not nil, or "" if +length+ is not given or is nil.
435
+ ##
436
+ ## If +buffer+ is given, then the read data will be placed
437
+ ## into +buffer+ instead of a newly created String object.
438
+ def read(*args)
439
+ unless args.size <= 2
440
+ raise LintError, "rack.input#read called with too many arguments"
441
+ end
442
+ if args.size >= 1
443
+ unless args.first.kind_of?(Integer) || args.first.nil?
444
+ raise LintError, "rack.input#read called with non-integer and non-nil length"
445
+ end
446
+ unless args.first.nil? || args.first >= 0
447
+ raise LintError, "rack.input#read called with a negative length"
448
+ end
449
+ end
450
+ if args.size >= 2
451
+ unless args[1].kind_of?(String)
452
+ raise LintError, "rack.input#read called with non-String buffer"
453
+ end
454
+ end
348
455
 
349
- ## * One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
350
- ## set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
351
- ## <tt>SCRIPT_NAME</tt> is empty.
352
- unless env[SCRIPT_NAME] || env[PATH_INFO]
353
- raise LintError, "One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)"
354
- end
355
- ## <tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
356
- unless env[SCRIPT_NAME] != "/"
357
- raise LintError, "SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'"
358
- end
359
- end
456
+ v = @input.read(*args)
360
457
 
361
- ## === The Input Stream
362
- ##
363
- ## The input stream is an IO-like object which contains the raw HTTP
364
- ## POST data.
365
- def check_input(input)
366
- ## When applicable, its external encoding must be "ASCII-8BIT" and it
367
- ## must be opened in binary mode, for Ruby 1.9 compatibility.
368
- if input.respond_to?(:external_encoding) && input.external_encoding != Encoding::ASCII_8BIT
369
- raise LintError, "rack.input #{input} does not have ASCII-8BIT as its external encoding"
458
+ unless v.nil? or v.kind_of? String
459
+ raise LintError, "rack.input#read didn't return nil or a String"
460
+ end
461
+ if args[0].nil?
462
+ unless !v.nil?
463
+ raise LintError, "rack.input#read(nil) returned nil on EOF"
464
+ end
465
+ end
466
+
467
+ v
468
+ end
469
+
470
+ ## * +each+ must be called without arguments and only yield Strings.
471
+ def each(*args)
472
+ raise LintError, "rack.input#each called with arguments" unless args.size == 0
473
+ @input.each { |line|
474
+ unless line.kind_of? String
475
+ raise LintError, "rack.input#each didn't yield a String"
476
+ end
477
+ yield line
478
+ }
479
+ end
480
+
481
+ ## * +close+ can be called on the input stream to indicate that the
482
+ ## any remaining input is not needed.
483
+ def close(*args)
484
+ @input.close(*args)
485
+ end
370
486
  end
371
- if input.respond_to?(:binmode?) && !input.binmode?
372
- raise LintError, "rack.input #{input} is not opened in binary mode"
487
+
488
+ ##
489
+ ## === The Error Stream
490
+ ##
491
+ def check_error(error)
492
+ ## The error stream must respond to +puts+, +write+ and +flush+.
493
+ [:puts, :write, :flush].each { |method|
494
+ unless error.respond_to? method
495
+ raise LintError, "rack.error #{error} does not respond to ##{method}"
496
+ end
497
+ }
373
498
  end
374
499
 
375
- ## The input stream must respond to +gets+, +each+, +read+ and +rewind+.
376
- [:gets, :each, :read, :rewind].each { |method|
377
- unless input.respond_to? method
378
- raise LintError, "rack.input #{input} does not respond to ##{method}"
500
+ class ErrorWrapper
501
+ def initialize(error)
502
+ @error = error
379
503
  end
380
- }
381
- end
382
504
 
383
- class InputWrapper
384
- include Assertion
505
+ ## * +puts+ must be called with a single argument that responds to +to_s+.
506
+ def puts(str)
507
+ @error.puts str
508
+ end
385
509
 
386
- def initialize(input)
387
- @input = input
388
- end
510
+ ## * +write+ must be called with a single argument that is a String.
511
+ def write(str)
512
+ raise LintError, "rack.errors#write not called with a String" unless str.kind_of? String
513
+ @error.write str
514
+ end
389
515
 
390
- ## * +gets+ must be called without arguments and return a string,
391
- ## or +nil+ on EOF.
392
- def gets(*args)
393
- raise LintError, "rack.input#gets called with arguments" unless args.size == 0
394
- v = @input.gets
395
- unless v.nil? or v.kind_of? String
396
- raise LintError, "rack.input#gets didn't return a String"
516
+ ## * +flush+ must be called without arguments and must be called
517
+ ## in order to make the error appear for sure.
518
+ def flush
519
+ @error.flush
520
+ end
521
+
522
+ ## * +close+ must never be called on the error stream.
523
+ def close(*args)
524
+ raise LintError, "rack.errors#close must not be called"
397
525
  end
398
- v
399
526
  end
400
527
 
401
- ## * +read+ behaves like IO#read.
402
- ## Its signature is <tt>read([length, [buffer]])</tt>.
403
528
  ##
404
- ## If given, +length+ must be a non-negative Integer (>= 0) or +nil+,
405
- ## and +buffer+ must be a String and may not be nil.
529
+ ## === Hijacking
406
530
  ##
407
- ## If +length+ is given and not nil, then this method reads at most
408
- ## +length+ bytes from the input stream.
531
+ ## The hijacking interfaces provides a means for an application to take
532
+ ## control of the HTTP connection. There are two distinct hijack
533
+ ## interfaces: full hijacking where the application takes over the raw
534
+ ## connection, and partial hijacking where the application takes over
535
+ ## just the response body stream. In both cases, the application is
536
+ ## responsible for closing the hijacked stream.
409
537
  ##
410
- ## If +length+ is not given or nil, then this method reads
411
- ## all data until EOF.
538
+ ## Full hijacking only works with HTTP/1. Partial hijacking is functionally
539
+ ## equivalent to streaming bodies, and is still optionally supported for
540
+ ## backwards compatibility with older Rack versions.
412
541
  ##
413
- ## When EOF is reached, this method returns nil if +length+ is given
414
- ## and not nil, or "" if +length+ is not given or is nil.
542
+ ## ==== Full Hijack
415
543
  ##
416
- ## If +buffer+ is given, then the read data will be placed
417
- ## into +buffer+ instead of a newly created String object.
418
- def read(*args)
419
- unless args.size <= 2
420
- raise LintError, "rack.input#read called with too many arguments"
421
- end
422
- if args.size >= 1
423
- unless args.first.kind_of?(Integer) || args.first.nil?
424
- raise LintError, "rack.input#read called with non-integer and non-nil length"
425
- end
426
- unless args.first.nil? || args.first >= 0
427
- raise LintError, "rack.input#read called with a negative length"
428
- end
429
- end
430
- if args.size >= 2
431
- unless args[1].kind_of?(String)
432
- raise LintError, "rack.input#read called with non-String buffer"
433
- end
434
- end
544
+ ## Full hijack is used to completely take over an HTTP/1 connection. It
545
+ ## occurs before any headers are written and causes the request to
546
+ ## ignores any response generated by the application.
547
+ ##
548
+ ## It is intended to be used when applications need access to raw HTTP/1
549
+ ## connection.
550
+ ##
551
+ def check_hijack(env)
552
+ ## If +rack.hijack+ is present in +env+, it must respond to +call+
553
+ if original_hijack = env[RACK_HIJACK]
554
+ raise LintError, "rack.hijack must respond to call" unless original_hijack.respond_to?(:call)
435
555
 
436
- v = @input.read(*args)
556
+ env[RACK_HIJACK] = proc do
557
+ io = original_hijack.call
437
558
 
438
- unless v.nil? or v.kind_of? String
439
- raise LintError, "rack.input#read didn't return nil or a String"
440
- end
441
- if args[0].nil?
442
- unless !v.nil?
443
- raise LintError, "rack.input#read(nil) returned nil on EOF"
559
+ ## and return an +IO+ instance which can be used to read and write
560
+ ## to the underlying connection using HTTP/1 semantics and
561
+ ## formatting.
562
+ raise LintError, "rack.hijack must return an IO instance" unless io.is_a?(IO)
563
+
564
+ io
444
565
  end
445
566
  end
446
-
447
- v
448
567
  end
449
568
 
450
- ## * +each+ must be called without arguments and only yield Strings.
451
- def each(*args)
452
- raise LintError, "rack.input#each called with arguments" unless args.size == 0
453
- @input.each { |line|
454
- unless line.kind_of? String
455
- raise LintError, "rack.input#each didn't yield a String"
569
+ ##
570
+ ## ==== Partial Hijack
571
+ ##
572
+ ## Partial hijack is used for bi-directional streaming of the request and
573
+ ## response body. It occurs after the status and headers are written by
574
+ ## the server and causes the server to ignore the Body of the response.
575
+ ##
576
+ ## It is intended to be used when applications need bi-directional
577
+ ## streaming.
578
+ ##
579
+ def check_hijack_response(headers, env)
580
+ ## If +rack.hijack?+ is present in +env+ and truthy,
581
+ if env[RACK_IS_HIJACK]
582
+ ## an application may set the special response header +rack.hijack+
583
+ if original_hijack = headers[RACK_HIJACK]
584
+ ## to an object that responds to +call+,
585
+ unless original_hijack.respond_to?(:call)
586
+ raise LintError, 'rack.hijack header must respond to #call'
587
+ end
588
+ ## accepting a +stream+ argument.
589
+ return proc do |io|
590
+ original_hijack.call StreamWrapper.new(io)
591
+ end
456
592
  end
457
- yield line
458
- }
593
+ ##
594
+ ## After the response status and headers have been sent, this hijack
595
+ ## callback will be invoked with a +stream+ argument which follows the
596
+ ## same interface as outlined in "Streaming Body". Servers must
597
+ ## ignore the +body+ part of the response tuple when the
598
+ ## +rack.hijack+ response header is present. Using an empty +Array+
599
+ ## instance is recommended.
600
+ else
601
+ ##
602
+ ## The special response header +rack.hijack+ must only be set
603
+ ## if the request +env+ has a truthy +rack.hijack?+.
604
+ if headers.key?(RACK_HIJACK)
605
+ raise LintError, 'rack.hijack header must not be present if server does not support hijacking'
606
+ end
607
+ end
608
+
609
+ nil
459
610
  end
460
611
 
461
- ## * +rewind+ must be called without arguments. It rewinds the input
462
- ## stream back to the beginning. It must not raise Errno::ESPIPE:
463
- ## that is, it may not be a pipe or a socket. Therefore, handler
464
- ## developers must buffer the input data into some rewindable object
465
- ## if the underlying input stream is not rewindable.
466
- def rewind(*args)
467
- raise LintError, "rack.input#rewind called with arguments" unless args.size == 0
468
- begin
469
- @input.rewind
470
- true
471
- rescue Errno::ESPIPE
472
- raise LintError, "rack.input#rewind raised Errno::ESPIPE"
612
+ ## == The Response
613
+ ##
614
+ ## === The Status
615
+ ##
616
+ def check_status(status)
617
+ ## This is an HTTP status. It must be an Integer greater than or equal to
618
+ ## 100.
619
+ unless status.is_a?(Integer) && status >= 100
620
+ raise LintError, "Status must be an Integer >=100"
473
621
  end
474
622
  end
475
623
 
476
- ## * +close+ must never be called on the input stream.
477
- def close(*args)
478
- raise LintError, "rack.input#close must not be called"
479
- end
480
- end
624
+ ##
625
+ ## === The Headers
626
+ ##
627
+ def check_headers(headers)
628
+ ## The headers must be a unfrozen Hash.
629
+ unless headers.kind_of?(Hash)
630
+ raise LintError, "headers object should be a hash, but isn't (got #{headers.class} as headers)"
631
+ end
481
632
 
482
- ## === The Error Stream
483
- def check_error(error)
484
- ## The error stream must respond to +puts+, +write+ and +flush+.
485
- [:puts, :write, :flush].each { |method|
486
- unless error.respond_to? method
487
- raise LintError, "rack.error #{error} does not respond to ##{method}"
633
+ if headers.frozen?
634
+ raise LintError, "headers object should not be frozen, but is"
488
635
  end
489
- }
490
- end
491
636
 
492
- class ErrorWrapper
493
- include Assertion
637
+ headers.each do |key, value|
638
+ ## The header keys must be Strings.
639
+ unless key.kind_of? String
640
+ raise LintError, "header key must be a string, was #{key.class}"
641
+ end
494
642
 
495
- def initialize(error)
496
- @error = error
643
+ ## Special headers starting "rack." are for communicating with the
644
+ ## server, and must not be sent back to the client.
645
+ next if key.start_with?("rack.")
646
+
647
+ ## The header must not contain a +Status+ key.
648
+ raise LintError, "header must not contain status" if key == "status"
649
+ ## Header keys must conform to RFC7230 token specification, i.e. cannot
650
+ ## contain non-printable ASCII, DQUOTE or "(),/:;<=>?@[\]{}".
651
+ raise LintError, "invalid header name: #{key}" if key =~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/
652
+ ## Header keys must not contain uppercase ASCII characters (A-Z).
653
+ raise LintError, "uppercase character in header name: #{key}" if key =~ /[A-Z]/
654
+
655
+ ## Header values must be either a String instance,
656
+ if value.kind_of?(String)
657
+ check_header_value(key, value)
658
+ elsif value.kind_of?(Array)
659
+ ## or an Array of String instances,
660
+ value.each{|value| check_header_value(key, value)}
661
+ else
662
+ raise LintError, "a header value must be a String or Array of Strings, but the value of '#{key}' is a #{value.class}"
663
+ end
664
+ end
497
665
  end
498
666
 
499
- ## * +puts+ must be called with a single argument that responds to +to_s+.
500
- def puts(str)
501
- @error.puts str
667
+ def check_header_value(key, value)
668
+ ## such that each String instance must not contain characters below 037.
669
+ if value =~ /[\000-\037]/
670
+ raise LintError, "invalid header value #{key}: #{value.inspect}"
671
+ end
502
672
  end
503
673
 
504
- ## * +write+ must be called with a single argument that is a String.
505
- def write(str)
506
- raise LintError, "rack.errors#write not called with a String" unless str.kind_of? String
507
- @error.write str
674
+ ##
675
+ ## === The content-type
676
+ ##
677
+ def check_content_type(status, headers)
678
+ headers.each { |key, value|
679
+ ## There must not be a <tt>content-type</tt> header key when the +Status+ is 1xx,
680
+ ## 204, or 304.
681
+ if key == "content-type"
682
+ if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
683
+ raise LintError, "content-type header found in #{status} response, not allowed"
684
+ end
685
+ return
686
+ end
687
+ }
508
688
  end
509
689
 
510
- ## * +flush+ must be called without arguments and must be called
511
- ## in order to make the error appear for sure.
512
- def flush
513
- @error.flush
690
+ ##
691
+ ## === The content-length
692
+ ##
693
+ def check_content_length(status, headers)
694
+ headers.each { |key, value|
695
+ if key == 'content-length'
696
+ ## There must not be a <tt>content-length</tt> header key when the
697
+ ## +Status+ is 1xx, 204, or 304.
698
+ if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
699
+ raise LintError, "content-length header found in #{status} response, not allowed"
700
+ end
701
+ @content_length = value
702
+ end
703
+ }
514
704
  end
515
705
 
516
- ## * +close+ must never be called on the error stream.
517
- def close(*args)
518
- raise LintError, "rack.errors#close must not be called"
706
+ def verify_content_length(size)
707
+ if @head_request
708
+ unless size == 0
709
+ raise LintError, "Response body was given for HEAD request, but should be empty"
710
+ end
711
+ elsif @content_length
712
+ unless @content_length == size.to_s
713
+ raise LintError, "content-length header was #{@content_length}, but should be #{size}"
714
+ end
715
+ end
519
716
  end
520
- end
521
717
 
522
- class HijackWrapper
523
- include Assertion
524
- extend Forwardable
525
-
526
- REQUIRED_METHODS = [
527
- :read, :write, :read_nonblock, :write_nonblock, :flush, :close,
528
- :close_read, :close_write, :closed?
529
- ]
718
+ ##
719
+ ## === The Body
720
+ ##
721
+ ## The Body is typically an +Array+ of +String+ instances, an enumerable
722
+ ## that yields +String+ instances, a +Proc+ instance, or a File-like
723
+ ## object.
724
+ ##
725
+ ## The Body must respond to +each+ or +call+. It may optionally respond
726
+ ## to +to_path+ or +to_ary+. A Body that responds to +each+ is considered
727
+ ## to be an Enumerable Body. A Body that responds to +call+ is considered
728
+ ## to be a Streaming Body.
729
+ ##
730
+ ## A Body that responds to both +each+ and +call+ must be treated as an
731
+ ## Enumerable Body, not a Streaming Body. If it responds to +each+, you
732
+ ## must call +each+ and not +call+. If the Body doesn't respond to
733
+ ## +each+, then you can assume it responds to +call+.
734
+ ##
735
+ ## The Body must either be consumed or returned. The Body is consumed by
736
+ ## optionally calling either +each+ or +call+.
737
+ ## Then, if the Body responds to +close+, it must be called to release
738
+ ## any resources associated with the generation of the body.
739
+ ## In other words, +close+ must always be called at least once; typically
740
+ ## after the web server has sent the response to the client, but also in
741
+ ## cases where the Rack application makes internal/virtual requests and
742
+ ## discards the response.
743
+ ##
744
+ def close
745
+ ##
746
+ ## After calling +close+, the Body is considered closed and should not
747
+ ## be consumed again.
748
+ @closed = true
530
749
 
531
- def_delegators :@io, *REQUIRED_METHODS
750
+ ## If the original Body is replaced by a new Body, the new Body must
751
+ ## also consume the original Body by calling +close+ if possible.
752
+ @body.close if @body.respond_to?(:close)
532
753
 
533
- def initialize(io)
534
- @io = io
535
- REQUIRED_METHODS.each do |meth|
536
- raise LintError, "rack.hijack_io must respond to #{meth}" unless io.respond_to? meth
754
+ index = @lint.index(self)
755
+ unless @env['rack.lint'][0..index].all? {|lint| lint.instance_variable_get(:@closed)}
756
+ raise LintError, "Body has not been closed"
537
757
  end
538
758
  end
539
- end
540
759
 
541
- ## === Hijacking
542
- #
543
- # AUTHORS: n.b. The trailing whitespace between paragraphs is important and
544
- # should not be removed. The whitespace creates paragraphs in the RDoc
545
- # output.
546
- #
547
- ## ==== Request (before status)
548
- def check_hijack(env)
549
- if env[RACK_IS_HIJACK]
550
- ## If rack.hijack? is true then rack.hijack must respond to #call.
551
- original_hijack = env[RACK_HIJACK]
552
- raise LintError, "rack.hijack must respond to call" unless original_hijack.respond_to?(:call)
553
- env[RACK_HIJACK] = proc do
554
- ## rack.hijack must return the io that will also be assigned (or is
555
- ## already present, in rack.hijack_io.
556
- io = original_hijack.call
557
- HijackWrapper.new(io)
558
- ##
559
- ## rack.hijack_io must respond to:
560
- ## <tt>read, write, read_nonblock, write_nonblock, flush, close,
561
- ## close_read, close_write, closed?</tt>
562
- ##
563
- ## The semantics of these IO methods must be a best effort match to
564
- ## those of a normal ruby IO or Socket object, using standard
565
- ## arguments and raising standard exceptions. Servers are encouraged
566
- ## to simply pass on real IO objects, although it is recognized that
567
- ## this approach is not directly compatible with SPDY and HTTP 2.0.
568
- ##
569
- ## IO provided in rack.hijack_io should preference the
570
- ## IO::WaitReadable and IO::WaitWritable APIs wherever supported.
571
- ##
572
- ## There is a deliberate lack of full specification around
573
- ## rack.hijack_io, as semantics will change from server to server.
574
- ## Users are encouraged to utilize this API with a knowledge of their
575
- ## server choice, and servers may extend the functionality of
576
- ## hijack_io to provide additional features to users. The purpose of
577
- ## rack.hijack is for Rack to "get out of the way", as such, Rack only
578
- ## provides the minimum of specification and support.
579
- env[RACK_HIJACK_IO] = HijackWrapper.new(env[RACK_HIJACK_IO])
580
- io
581
- end
582
- else
583
- ##
584
- ## If rack.hijack? is false, then rack.hijack should not be set.
585
- raise LintError, "rack.hijack? is false, but rack.hijack is present" unless env[RACK_HIJACK].nil?
760
+ def verify_to_path
586
761
  ##
587
- ## If rack.hijack? is false, then rack.hijack_io should not be set.
588
- raise LintError, "rack.hijack? is false, but rack.hijack_io is present" unless env[RACK_HIJACK_IO].nil?
589
- end
590
- end
591
-
592
- ## ==== Response (after headers)
593
- ## It is also possible to hijack a response after the status and headers
594
- ## have been sent.
595
- def check_hijack_response(headers, env)
596
-
597
- # this check uses headers like a hash, but the spec only requires
598
- # headers respond to #each
599
- headers = Rack::Utils::HeaderHash[headers]
600
-
601
- ## In order to do this, an application may set the special header
602
- ## <tt>rack.hijack</tt> to an object that responds to <tt>call</tt>
603
- ## accepting an argument that conforms to the <tt>rack.hijack_io</tt>
604
- ## protocol.
605
- ##
606
- ## After the headers have been sent, and this hijack callback has been
607
- ## called, the application is now responsible for the remaining lifecycle
608
- ## of the IO. The application is also responsible for maintaining HTTP
609
- ## semantics. Of specific note, in almost all cases in the current SPEC,
610
- ## applications will have wanted to specify the header Connection:close in
611
- ## HTTP/1.1, and not Connection:keep-alive, as there is no protocol for
612
- ## returning hijacked sockets to the web server. For that purpose, use the
613
- ## body streaming API instead (progressively yielding strings via each).
614
- ##
615
- ## Servers must ignore the <tt>body</tt> part of the response tuple when
616
- ## the <tt>rack.hijack</tt> response API is in use.
617
-
618
- if env[RACK_IS_HIJACK] && headers[RACK_HIJACK]
619
- unless headers[RACK_HIJACK].respond_to? :call
620
- raise LintError, 'rack.hijack header must respond to #call'
621
- end
622
- original_hijack = headers[RACK_HIJACK]
623
- proc do |io|
624
- original_hijack.call HijackWrapper.new(io)
625
- end
626
- else
627
- ##
628
- ## The special response header <tt>rack.hijack</tt> must only be set
629
- ## if the request env has <tt>rack.hijack?</tt> <tt>true</tt>.
630
- unless headers[RACK_HIJACK].nil?
631
- raise LintError, 'rack.hijack header must not be present if server does not support hijacking'
762
+ ## If the Body responds to +to_path+, it must return a +String+
763
+ ## path for the local file system whose contents are identical
764
+ ## to that produced by calling +each+; this may be used by the
765
+ ## server as an alternative, possibly more efficient way to
766
+ ## transport the response. The +to_path+ method does not consume
767
+ ## the body.
768
+ if @body.respond_to?(:to_path)
769
+ unless ::File.exist? @body.to_path
770
+ raise LintError, "The file identified by body.to_path does not exist"
771
+ end
632
772
  end
633
-
634
- nil
635
- end
636
- end
637
- ## ==== Conventions
638
- ## * Middleware should not use hijack unless it is handling the whole
639
- ## response.
640
- ## * Middleware may wrap the IO object for the response pattern.
641
- ## * Middleware should not wrap the IO object for the request pattern. The
642
- ## request pattern is intended to provide the hijacker with "raw tcp".
643
-
644
- ## == The Response
645
-
646
- ## === The Status
647
- def check_status(status)
648
- ## This is an HTTP status. When parsed as integer (+to_i+), it must be
649
- ## greater than or equal to 100.
650
- unless status.to_i >= 100
651
- raise LintError, "Status must be >=100 seen as integer"
652
773
  end
653
- end
654
774
 
655
- ## === The Headers
656
- def check_headers(header)
657
- ## The header must respond to +each+, and yield values of key and value.
658
- unless header.respond_to? :each
659
- raise LintError, "headers object should respond to #each, but doesn't (got #{header.class} as headers)"
660
- end
775
+ ##
776
+ ## ==== Enumerable Body
777
+ ##
778
+ def each
779
+ ## The Enumerable Body must respond to +each+.
780
+ raise LintError, "Enumerable Body must respond to each" unless @body.respond_to?(:each)
661
781
 
662
- header.each { |key, value|
663
- ## The header keys must be Strings.
664
- unless key.kind_of? String
665
- raise LintError, "header key must be a string, was #{key.class}"
666
- end
782
+ ## It must only be called once.
783
+ raise LintError, "Response body must only be invoked once (#{@invoked})" unless @invoked.nil?
667
784
 
668
- ## Special headers starting "rack." are for communicating with the
669
- ## server, and must not be sent back to the client.
670
- next if key =~ /^rack\..+$/
785
+ ## It must not be called after being closed.
786
+ raise LintError, "Response body is already closed" if @closed
671
787
 
672
- ## The header must not contain a +Status+ key.
673
- raise LintError, "header must not contain Status" if key.downcase == "status"
674
- ## The header must conform to RFC7230 token specification, i.e. cannot
675
- ## contain non-printable ASCII, DQUOTE or "(),/:;<=>?@[\]{}".
676
- raise LintError, "invalid header name: #{key}" if key =~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/
788
+ @invoked = :each
677
789
 
678
- ## The values of the header must be Strings,
679
- unless value.kind_of? String
680
- raise LintError, "a header value must be a String, but the value of '#{key}' is a #{value.class}"
681
- end
682
- ## consisting of lines (for multiple header values, e.g. multiple
683
- ## <tt>Set-Cookie</tt> values) separated by "\\n".
684
- value.split("\n").each { |item|
685
- ## The lines must not contain characters below 037.
686
- if item =~ /[\000-\037]/
687
- raise LintError, "invalid header value #{key}: #{item.inspect}"
790
+ @body.each do |chunk|
791
+ ## and must only yield String values.
792
+ unless chunk.kind_of? String
793
+ raise LintError, "Body yielded non-string value #{chunk.inspect}"
688
794
  end
689
- }
690
- }
691
- end
692
795
 
693
- ## === The Content-Type
694
- def check_content_type(status, headers)
695
- headers.each { |key, value|
696
- ## There must not be a <tt>Content-Type</tt>, when the +Status+ is 1xx,
697
- ## 204 or 304.
698
- if key.downcase == "content-type"
699
- if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
700
- raise LintError, "Content-Type header found in #{status} response, not allowed"
796
+ ##
797
+ ## The Body itself should not be an instance of String, as this will
798
+ ## break in Ruby 1.9.
799
+ ##
800
+ ## Middleware must not call +each+ directly on the Body.
801
+ ## Instead, middleware can return a new Body that calls +each+ on the
802
+ ## original Body, yielding at least once per iteration.
803
+ if @lint[0] == self
804
+ @env['rack.lint.body_iteration'] += 1
805
+ else
806
+ if (@env['rack.lint.body_iteration'] -= 1) > 0
807
+ raise LintError, "New body must yield at least once per iteration of old body"
808
+ end
701
809
  end
702
- return
703
- end
704
- }
705
- end
706
810
 
707
- ## === The Content-Length
708
- def check_content_length(status, headers)
709
- headers.each { |key, value|
710
- if key.downcase == 'content-length'
711
- ## There must not be a <tt>Content-Length</tt> header when the
712
- ## +Status+ is 1xx, 204 or 304.
713
- if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
714
- raise LintError, "Content-Length header found in #{status} response, not allowed"
715
- end
716
- @content_length = value
811
+ @size += chunk.bytesize
812
+ yield chunk
717
813
  end
718
- }
719
- end
720
814
 
721
- def verify_content_length(bytes)
722
- if @head_request
723
- unless bytes == 0
724
- raise LintError, "Response body was given for HEAD request, but should be empty"
725
- end
726
- elsif @content_length
727
- unless @content_length == bytes.to_s
728
- raise LintError, "Content-Length header was #{@content_length}, but should be #{bytes}"
729
- end
815
+ verify_content_length(@size)
816
+
817
+ verify_to_path
730
818
  end
731
- end
732
819
 
733
- ## === The Body
734
- def each
735
- @closed = false
736
- bytes = 0
820
+ BODY_METHODS = {to_ary: true, each: true, call: true, to_path: true}
737
821
 
738
- ## The Body must respond to +each+
739
- unless @body.respond_to?(:each)
740
- raise LintError, "Response body must respond to each"
822
+ def to_path
823
+ @body.to_path
741
824
  end
742
825
 
743
- @body.each { |part|
744
- ## and must only yield String values.
745
- unless part.kind_of? String
746
- raise LintError, "Body yielded non-string value #{part.inspect}"
826
+ def respond_to?(name, *)
827
+ if BODY_METHODS.key?(name)
828
+ @body.respond_to?(name)
829
+ else
830
+ super
747
831
  end
748
- bytes += part.bytesize
749
- yield part
750
- }
751
- verify_content_length(bytes)
832
+ end
833
+
834
+ ##
835
+ ## If the Body responds to +to_ary+, it must return an +Array+ whose
836
+ ## contents are identical to that produced by calling +each+.
837
+ ## Middleware may call +to_ary+ directly on the Body and return a new
838
+ ## Body in its place. In other words, middleware can only process the
839
+ ## Body directly if it responds to +to_ary+. If the Body responds to both
840
+ ## +to_ary+ and +close+, its implementation of +to_ary+ must call
841
+ ## +close+.
842
+ def to_ary
843
+ @body.to_ary.tap do |content|
844
+ unless content == @body.enum_for.to_a
845
+ raise LintError, "#to_ary not identical to contents produced by calling #each"
846
+ end
847
+ end
848
+ ensure
849
+ close
850
+ end
752
851
 
753
852
  ##
754
- ## The Body itself should not be an instance of String, as this will
755
- ## break in Ruby 1.9.
853
+ ## ==== Streaming Body
756
854
  ##
757
- ## If the Body responds to +close+, it will be called after iteration. If
758
- ## the body is replaced by a middleware after action, the original body
759
- ## must be closed first, if it responds to close.
760
- # XXX howto: raise LintError, "Body has not been closed" unless @closed
855
+ def call(stream)
856
+ ## The Streaming Body must respond to +call+.
857
+ raise LintError, "Streaming Body must respond to call" unless @body.respond_to?(:call)
761
858
 
859
+ ## It must only be called once.
860
+ raise LintError, "Response body must only be invoked once (#{@invoked})" unless @invoked.nil?
762
861
 
763
- ##
764
- ## If the Body responds to +to_path+, it must return a String
765
- ## identifying the location of a file whose contents are identical
766
- ## to that produced by calling +each+; this may be used by the
767
- ## server as an alternative, possibly more efficient way to
768
- ## transport the response.
862
+ ## It must not be called after being closed.
863
+ raise LintError, "Response body is already closed" if @closed
769
864
 
770
- if @body.respond_to?(:to_path)
771
- unless ::File.exist? @body.to_path
772
- raise LintError, "The file identified by body.to_path does not exist"
773
- end
865
+ @invoked = :call
866
+
867
+ ## It takes a +stream+ argument.
868
+ ##
869
+ ## The +stream+ argument must implement:
870
+ ## <tt>read, write, <<, flush, close, close_read, close_write, closed?</tt>
871
+ ##
872
+ @body.call(StreamWrapper.new(stream))
774
873
  end
775
874
 
776
- ##
777
- ## The Body commonly is an Array of Strings, the application
778
- ## instance itself, or a File-like object.
779
- end
875
+ class StreamWrapper
876
+ extend Forwardable
780
877
 
781
- def close
782
- @closed = true
783
- @body.close if @body.respond_to?(:close)
784
- end
878
+ ## The semantics of these IO methods must be a best effort match to
879
+ ## those of a normal Ruby IO or Socket object, using standard arguments
880
+ ## and raising standard exceptions. Servers are encouraged to simply
881
+ ## pass on real IO objects, although it is recognized that this approach
882
+ ## is not directly compatible with HTTP/2.
883
+ REQUIRED_METHODS = [
884
+ :read, :write, :<<, :flush, :close,
885
+ :close_read, :close_write, :closed?
886
+ ]
887
+
888
+ def_delegators :@stream, *REQUIRED_METHODS
785
889
 
786
- # :startdoc:
890
+ def initialize(stream)
891
+ @stream = stream
787
892
 
893
+ REQUIRED_METHODS.each do |method_name|
894
+ raise LintError, "Stream must respond to #{method_name}" unless stream.respond_to?(method_name)
895
+ end
896
+ end
897
+ end
898
+
899
+ # :startdoc:
900
+ end
788
901
  end
789
902
  end
790
903
 
904
+ ##
791
905
  ## == Thanks
792
- ## Some parts of this specification are adopted from PEP333: Python
793
- ## Web Server Gateway Interface
794
- ## v1.0 (http://www.python.org/dev/peps/pep-0333/). I'd like to thank
795
- ## everyone involved in that effort.
906
+ ## Some parts of this specification are adopted from {PEP 333 – Python Web Server Gateway Interface v1.0}[https://peps.python.org/pep-0333/]
907
+ ## I'd like to thank everyone involved in that effort.