Class: Rack::Lint
- Inherits:
-
Object
show all
- Includes:
- Assertion
- Defined in:
- lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb
Overview
Rack::Lint validates your application and the requests and responses according to the Rack spec.
Defined Under Namespace
Modules: Assertion
Classes: ErrorWrapper, HijackWrapper, InputWrapper, LintError
Instance Method Summary
collapse
Methods included from Assertion
#assert
Constructor Details
#initialize(app) ⇒ Lint
Returns a new instance of Lint.
10
11
12
13
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 10
def initialize(app)
@app = app
@content_length = nil
end
|
Instance Method Details
#_call(env) ⇒ Object
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 41
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])
ary = @app.call(env)
assert("response is not an Array, but #{ary.class}") {
ary.kind_of? Array
}
assert("response array has #{ary.size} elements instead of 3") {
ary.size == 3
}
status, , @body = ary
check_status status
hijack_proc = check_hijack_response , env
if hijack_proc && .is_a?(Hash)
[RACK_HIJACK] = hijack_proc
end
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 a Ruby object (not a class) that responds to call
.
37
38
39
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 37
def call(env = nil)
dup._call(env)
end
|
#check_content_length(status, headers) ⇒ Object
719
720
721
722
723
724
725
726
727
728
729
730
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 719
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.key? status.to_i
}
@content_length = value
end
}
end
|
#check_content_type(status, headers) ⇒ Object
705
706
707
708
709
710
711
712
713
714
715
716
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 705
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.key? status.to_i
}
return
end
}
end
|
#check_env(env) ⇒ Object
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 77
def check_env(env)
assert("env #{env.inspect} is not a Hash, but #{env.class}") {
env.kind_of? Hash
}
assert("env should not be frozen, but is") {
!env.frozen?
}
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)
}
assert("session #{session.inspect} must respond to to_hash and return unfrozen Hash instance") {
session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
}
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
if bufsize = env[RACK_MULTIPART_BUFFER_SIZE]
assert("rack.multipart.buffer_size must be an Integer > 0 if specified") {
bufsize.is_a?(Integer) && bufsize > 0
}
end
if tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
assert("rack.multipart.tempfile_factory must respond to #call") { tempfile_factory.respond_to?(:call) }
env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
io = tempfile_factory.call(filename, content_type)
assert("rack.multipart.tempfile_factory return value must respond to #<<") { io.respond_to?(:<<) }
io
end
end
%w[REQUEST_METHOD SERVER_NAME QUERY_STRING
rack.version rack.input rack.errors
rack.multithread rack.multiprocess rack.run_once].each { ||
assert("env missing required key #{}") { env.include? }
}
assert("env[SERVER_PORT] is not an Integer") do
server_port = env["SERVER_PORT"]
server_port.nil? || (Integer(server_port) rescue false)
end
assert("#{env[SERVER_NAME]} must be a valid authority") do
URI.parse("http://#{env[SERVER_NAME]}/") rescue false
end
assert("#{env[HTTP_HOST]} must be a valid authority") do
URI.parse("http://#{env[HTTP_HOST]}/") rescue false
end
%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
}
next if value.encoding == Encoding::ASCII_8BIT
assert("env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}") {
value.b !~ /[\x80-\xff]/n
}
}
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]
check_hijack env
assert("REQUEST_METHOD unknown: #{env[REQUEST_METHOD].dump}") {
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
497
498
499
500
501
502
503
504
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 497
def check_error(error)
[:puts, :write, :flush].each { |method|
assert("rack.error #{error} does not respond to ##{method}") {
error.respond_to? method
}
}
end
|
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 668
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
}
next if key =~ /^rack\..+$/
assert("header must not contain Status") { key.downcase != "status" }
assert("invalid header name: #{key}") { key !~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/ }
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
|
#check_hijack(env) ⇒ Object
Hijacking
AUTHORS: n.b. The trailing whitespace between paragraphs is important and should not be removed. The whitespace creates paragraphs in the RDoc output.
Request (before status)
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 562
def check_hijack(env)
if env[RACK_IS_HIJACK]
original_hijack = env[RACK_HIJACK]
assert("rack.hijack must respond to call") { original_hijack.respond_to?(:call) }
env[RACK_HIJACK] = proc do
io = original_hijack.call
HijackWrapper.new(io)
env[RACK_HIJACK_IO] = HijackWrapper.new(env[RACK_HIJACK_IO])
io
end
else
assert("rack.hijack? is false, but rack.hijack is present") { env[RACK_HIJACK].nil? }
assert("rack.hijack? is false, but rack.hijack_io is present") { env[RACK_HIJACK_IO].nil? }
end
end
|
#check_hijack_response(headers, env) ⇒ Object
It is also possible to hijack a response after the status and headers have been sent.
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 609
def check_hijack_response(, env)
= Rack::Utils::HeaderHash[]
if env[RACK_IS_HIJACK] && [RACK_HIJACK]
assert('rack.hijack header must respond to #call') {
[RACK_HIJACK].respond_to? :call
}
original_hijack = [RACK_HIJACK]
proc do |io|
original_hijack.call HijackWrapper.new(io)
end
else
assert('rack.hijack header must not be present if server does not support hijacking') {
[RACK_HIJACK].nil?
}
nil
end
end
|
The input stream is an IO-like object which contains the raw HTTP POST data.
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 377
def check_input(input)
assert("rack.input #{input} does not have ASCII-8BIT as its external encoding") {
input.external_encoding == Encoding::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
661
662
663
664
665
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 661
def check_status(status)
assert("Status must be >=100 seen as integer") { status.to_i >= 100 }
end
|
792
793
794
795
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 792
def close
@closed = true
@body.close if @body.respond_to?(:close)
end
|
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 745
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 += part.bytesize
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
732
733
734
735
736
737
738
739
740
741
742
|
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/rack-2.2.5/lib/rack/lint.rb', line 732
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
|