Class: Rack::Lint
Overview
Rack::Lint validates your application and the requests and responses according to the Rack spec.
Defined Under Namespace
Modules: Assertion
Classes: ErrorWrapper, InputWrapper, LintError
Instance Method Summary
collapse
Methods included from Assertion
#assert
Constructor Details
#initialize(app) ⇒ Lint
Returns a new instance of Lint.
8
9
10
11
|
# File 'lib/rack/lint.rb', line 8
def initialize(app)
@app = app
@content_length = nil
end
|
Instance Method Details
#_call(env) ⇒ Object
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
# File 'lib/rack/lint.rb', line 39
def _call(env)
assert("No env given") { env }
check_env env
env['rack.input'] = InputWrapper.new(env['rack.input'])
env['rack.errors'] = ErrorWrapper.new(env['rack.errors'])
status, , @body = @app.call(env)
check_status status
check_content_type status,
check_content_length status,
@head_request = env["REQUEST_METHOD"] == "HEAD"
[status, , self]
end
|
#call(env = nil) ⇒ Object
A Rack application is an Ruby object (not a class) that responds to call
.
35
36
37
|
# File 'lib/rack/lint.rb', line 35
def call(env=nil)
dup._call(env)
end
|
#check_content_length(status, headers) ⇒ Object
482
483
484
485
486
487
488
489
490
491
492
493
|
# File 'lib/rack/lint.rb', line 482
def check_content_length(status, )
.each { |key, value|
if key.downcase == 'content-length'
assert("Content-Length header found in #{status} response, not allowed") {
not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
}
@content_length = value
end
}
end
|
#check_content_type(status, headers) ⇒ Object
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
# File 'lib/rack/lint.rb', line 464
def check_content_type(status, )
.each { |key, value|
if key.downcase == "content-type"
assert("Content-Type header found in #{status} response, not allowed") {
not Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
}
return
end
}
assert("No Content-Type header found") {
Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include? status.to_i
}
end
|
#check_env(env) ⇒ Object
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
# File 'lib/rack/lint.rb', line 61
def check_env(env)
assert("env #{env.inspect} is not a Hash, but #{env.class}") {
env.kind_of? Hash
}
if session = env['rack.session']
assert("session #{session.inspect} must respond to store and []=") {
session.respond_to?(:store) && session.respond_to?(:[]=)
}
assert("session #{session.inspect} must respond to fetch and []") {
session.respond_to?(:fetch) && session.respond_to?(:[])
}
assert("session #{session.inspect} must respond to delete") {
session.respond_to?(:delete)
}
assert("session #{session.inspect} must respond to clear") {
session.respond_to?(:clear)
}
end
if logger = env['rack.logger']
assert("logger #{logger.inspect} must respond to info") {
logger.respond_to?(:info)
}
assert("logger #{logger.inspect} must respond to debug") {
logger.respond_to?(:debug)
}
assert("logger #{logger.inspect} must respond to warn") {
logger.respond_to?(:warn)
}
assert("logger #{logger.inspect} must respond to error") {
logger.respond_to?(:error)
}
assert("logger #{logger.inspect} must respond to fatal") {
logger.respond_to?(:fatal)
}
end
%w[REQUEST_METHOD SERVER_NAME SERVER_PORT
QUERY_STRING
rack.version rack.input rack.errors
rack.multithread rack.multiprocess rack.run_once].each { ||
assert("env missing required key #{}") { env.include? }
}
%w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { ||
assert("env contains #{}, must use #{[5,-1]}") {
not env.include?
}
}
env.each { |key, value|
next if key.include? "." assert("env variable #{key} has non-string value #{value.inspect}") {
value.kind_of? String
}
}
assert("rack.version must be an Array, was #{env["rack.version"].class}") {
env["rack.version"].kind_of? Array
}
assert("rack.url_scheme unknown: #{env["rack.url_scheme"].inspect}") {
%w[http https].include? env["rack.url_scheme"]
}
check_input env["rack.input"]
check_error env["rack.errors"]
assert("REQUEST_METHOD unknown: #{env["REQUEST_METHOD"]}") {
env["REQUEST_METHOD"] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
}
assert("SCRIPT_NAME must start with /") {
!env.include?("SCRIPT_NAME") ||
env["SCRIPT_NAME"] == "" ||
env["SCRIPT_NAME"] =~ /\A\//
}
assert("PATH_INFO must start with /") {
!env.include?("PATH_INFO") ||
env["PATH_INFO"] == "" ||
env["PATH_INFO"] =~ /\A\//
}
assert("Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}") {
!env.include?("CONTENT_LENGTH") || env["CONTENT_LENGTH"] =~ /\A\d+\z/
}
assert("One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)") {
env["SCRIPT_NAME"] || env["PATH_INFO"]
}
assert("SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'") {
env["SCRIPT_NAME"] != "/"
}
end
|
#check_error(error) ⇒ Object
380
381
382
383
384
385
386
387
|
# File 'lib/rack/lint.rb', line 380
def check_error(error)
[:puts, :write, :flush].each { |method|
assert("rack.error #{error} does not respond to ##{method}") {
error.respond_to? method
}
}
end
|
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
# File 'lib/rack/lint.rb', line 429
def ()
assert("headers object should respond to #each, but doesn't (got #{.class} as headers)") {
.respond_to? :each
}
.each { |key, value|
assert("header key must be a string, was #{key.class}") {
key.kind_of? String
}
assert("header must not contain Status") { key.downcase != "status" }
assert("header names must not contain : or \\n") { key !~ /[:\n]/ }
assert("header names must not end in - or _") { key !~ /[-_]\z/ }
assert("invalid header name: #{key}") { key =~ /\A[a-zA-Z][a-zA-Z0-9_-]*\z/ }
assert("a header value must be a String, but the value of " +
"'#{key}' is a #{value.class}") { value.kind_of? String }
value.split("\n").each { |item|
assert("invalid header value #{key}: #{item.inspect}") {
item !~ /[\000-\037]/
}
}
}
end
|
The input stream is an IO-like object which contains the raw HTTP POST data.
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
# File 'lib/rack/lint.rb', line 268
def check_input(input)
assert("rack.input #{input} does not have ASCII-8BIT as its external encoding") {
input.external_encoding.name == "ASCII-8BIT"
} if input.respond_to?(:external_encoding)
assert("rack.input #{input} is not opened in binary mode") {
input.binmode?
} if input.respond_to?(:binmode?)
[:gets, :each, :read, :rewind].each { |method|
assert("rack.input #{input} does not respond to ##{method}") {
input.respond_to? method
}
}
end
|
#check_status(status) ⇒ Object
422
423
424
425
426
|
# File 'lib/rack/lint.rb', line 422
def check_status(status)
assert("Status must be >=100 seen as integer") { status.to_i >= 100 }
end
|
#close ⇒ Object
553
554
555
556
|
# File 'lib/rack/lint.rb', line 553
def close
@closed = true
@body.close if @body.respond_to?(:close)
end
|
#each ⇒ Object
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
|
# File 'lib/rack/lint.rb', line 508
def each
@closed = false
bytes = 0
assert("Response body must respond to each") do
@body.respond_to?(:each)
end
@body.each { |part|
assert("Body yielded non-string value #{part.inspect}") {
part.kind_of? String
}
bytes += Rack::Utils.bytesize(part)
yield part
}
verify_content_length(bytes)
if @body.respond_to?(:to_path)
assert("The file identified by body.to_path does not exist") {
::File.exist? @body.to_path
}
end
end
|
#verify_content_length(bytes) ⇒ Object
495
496
497
498
499
500
501
502
503
504
505
|
# File 'lib/rack/lint.rb', line 495
def verify_content_length(bytes)
if @head_request
assert("Response body was given for HEAD request, but should be empty") {
bytes == 0
}
elsif @content_length
assert("Content-Length header was #{@content_length}, but should be #{bytes}") {
@content_length == bytes.to_s
}
end
end
|