rack 2.1.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

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