net-http 0.3.1 → 0.4.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.
@@ -3,192 +3,909 @@
3
3
  # https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
4
4
 
5
5
  module Net
6
- # :stopdoc:
7
6
 
8
7
  class HTTPUnknownResponse < HTTPResponse
9
8
  HAS_BODY = true
10
9
  EXCEPTION_TYPE = HTTPError #
11
10
  end
12
- class HTTPInformation < HTTPResponse # 1xx
11
+
12
+ # Parent class for informational (1xx) HTTP response classes.
13
+ #
14
+ # An informational response indicates that the request was received and understood.
15
+ #
16
+ # References:
17
+ #
18
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.1xx].
19
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#1xx_informational_response].
20
+ #
21
+ class HTTPInformation < HTTPResponse
13
22
  HAS_BODY = false
14
23
  EXCEPTION_TYPE = HTTPError #
15
24
  end
16
- class HTTPSuccess < HTTPResponse # 2xx
25
+
26
+ # Parent class for success (2xx) HTTP response classes.
27
+ #
28
+ # A success response indicates the action requested by the client
29
+ # was received, understood, and accepted.
30
+ #
31
+ # References:
32
+ #
33
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.2xx].
34
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_success].
35
+ #
36
+ class HTTPSuccess < HTTPResponse
17
37
  HAS_BODY = true
18
38
  EXCEPTION_TYPE = HTTPError #
19
39
  end
20
- class HTTPRedirection < HTTPResponse # 3xx
40
+
41
+ # Parent class for redirection (3xx) HTTP response classes.
42
+ #
43
+ # A redirection response indicates the client must take additional action
44
+ # to complete the request.
45
+ #
46
+ # References:
47
+ #
48
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.3xx].
49
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection].
50
+ #
51
+ class HTTPRedirection < HTTPResponse
21
52
  HAS_BODY = true
22
53
  EXCEPTION_TYPE = HTTPRetriableError #
23
54
  end
24
- class HTTPClientError < HTTPResponse # 4xx
55
+
56
+ # Parent class for client error (4xx) HTTP response classes.
57
+ #
58
+ # A client error response indicates that the client may have caused an error.
59
+ #
60
+ # References:
61
+ #
62
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.4xx].
63
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_client_errors].
64
+ #
65
+ class HTTPClientError < HTTPResponse
25
66
  HAS_BODY = true
26
67
  EXCEPTION_TYPE = HTTPClientException #
27
68
  end
28
- class HTTPServerError < HTTPResponse # 5xx
69
+
70
+ # Parent class for server error (5xx) HTTP response classes.
71
+ #
72
+ # A server error response indicates that the server failed to fulfill a request.
73
+ #
74
+ # References:
75
+ #
76
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.5xx].
77
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_server_errors].
78
+ #
79
+ class HTTPServerError < HTTPResponse
29
80
  HAS_BODY = true
30
81
  EXCEPTION_TYPE = HTTPFatalError #
31
82
  end
32
83
 
33
- class HTTPContinue < HTTPInformation # 100
84
+ # Response class for +Continue+ responses (status code 100).
85
+ #
86
+ # A +Continue+ response indicates that the server has received the request headers.
87
+ #
88
+ # :include: doc/net-http/included_getters.rdoc
89
+ #
90
+ # References:
91
+ #
92
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100].
93
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue].
94
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#100].
95
+ #
96
+ class HTTPContinue < HTTPInformation
34
97
  HAS_BODY = false
35
98
  end
36
- class HTTPSwitchProtocol < HTTPInformation # 101
99
+
100
+ # Response class for <tt>Switching Protocol</tt> responses (status code 101).
101
+ #
102
+ # The <tt>Switching Protocol<tt> response indicates that the server has received
103
+ # a request to switch protocols, and has agreed to do so.
104
+ #
105
+ # :include: doc/net-http/included_getters.rdoc
106
+ #
107
+ # References:
108
+ #
109
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101].
110
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols].
111
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#101].
112
+ #
113
+ class HTTPSwitchProtocol < HTTPInformation
37
114
  HAS_BODY = false
38
115
  end
39
- class HTTPProcessing < HTTPInformation # 102
116
+
117
+ # Response class for +Processing+ responses (status code 102).
118
+ #
119
+ # The +Processing+ response indicates that the server has received
120
+ # and is processing the request, but no response is available yet.
121
+ #
122
+ # :include: doc/net-http/included_getters.rdoc
123
+ #
124
+ # References:
125
+ #
126
+ # - {RFC 2518}[https://www.rfc-editor.org/rfc/rfc2518#section-10.1].
127
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#102].
128
+ #
129
+ class HTTPProcessing < HTTPInformation
40
130
  HAS_BODY = false
41
131
  end
42
- class HTTPEarlyHints < HTTPInformation # 103 - RFC 8297
132
+
133
+ # Response class for <tt>Early Hints</tt> responses (status code 103).
134
+ #
135
+ # The <tt>Early Hints</tt> indicates that the server has received
136
+ # and is processing the request, and contains certain headers;
137
+ # the final response is not available yet.
138
+ #
139
+ # :include: doc/net-http/included_getters.rdoc
140
+ #
141
+ # References:
142
+ #
143
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103].
144
+ # - {RFC 8297}[https://www.rfc-editor.org/rfc/rfc8297.html#section-2].
145
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#103].
146
+ #
147
+ class HTTPEarlyHints < HTTPInformation
43
148
  HAS_BODY = false
44
149
  end
45
150
 
46
- class HTTPOK < HTTPSuccess # 200
151
+ # Response class for +OK+ responses (status code 200).
152
+ #
153
+ # The +OK+ response indicates that the server has received
154
+ # a request and has responded successfully.
155
+ #
156
+ # :include: doc/net-http/included_getters.rdoc
157
+ #
158
+ # References:
159
+ #
160
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200].
161
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok].
162
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#200].
163
+ #
164
+ class HTTPOK < HTTPSuccess
47
165
  HAS_BODY = true
48
166
  end
49
- class HTTPCreated < HTTPSuccess # 201
167
+
168
+ # Response class for +Created+ responses (status code 201).
169
+ #
170
+ # The +Created+ response indicates that the server has received
171
+ # and has fulfilled a request to create a new resource.
172
+ #
173
+ # :include: doc/net-http/included_getters.rdoc
174
+ #
175
+ # References:
176
+ #
177
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201].
178
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created].
179
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#201].
180
+ #
181
+ class HTTPCreated < HTTPSuccess
50
182
  HAS_BODY = true
51
183
  end
52
- class HTTPAccepted < HTTPSuccess # 202
184
+
185
+ # Response class for +Accepted+ responses (status code 202).
186
+ #
187
+ # The +Accepted+ response indicates that the server has received
188
+ # and is processing a request, but the processing has not yet been completed.
189
+ #
190
+ # :include: doc/net-http/included_getters.rdoc
191
+ #
192
+ # References:
193
+ #
194
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202].
195
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted].
196
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#202].
197
+ #
198
+ class HTTPAccepted < HTTPSuccess
53
199
  HAS_BODY = true
54
200
  end
55
- class HTTPNonAuthoritativeInformation < HTTPSuccess # 203
201
+
202
+ # Response class for <tt>Non-Authoritative Information</tt> responses (status code 203).
203
+ #
204
+ # The <tt>Non-Authoritative Information</tt> response indicates that the server
205
+ # is a transforming proxy (such as a Web accelerator)
206
+ # that received a 200 OK response from its origin,
207
+ # and is returning a modified version of the origin's response.
208
+ #
209
+ # :include: doc/net-http/included_getters.rdoc
210
+ #
211
+ # References:
212
+ #
213
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203].
214
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-infor].
215
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#203].
216
+ #
217
+ class HTTPNonAuthoritativeInformation < HTTPSuccess
56
218
  HAS_BODY = true
57
219
  end
58
- class HTTPNoContent < HTTPSuccess # 204
220
+
221
+ # Response class for <tt>No Content</tt> responses (status code 204).
222
+ #
223
+ # The <tt>No Content</tt> response indicates that the server
224
+ # successfully processed the request, and is not returning any content.
225
+ #
226
+ # :include: doc/net-http/included_getters.rdoc
227
+ #
228
+ # References:
229
+ #
230
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204].
231
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content].
232
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#204].
233
+ #
234
+ class HTTPNoContent < HTTPSuccess
59
235
  HAS_BODY = false
60
236
  end
61
- class HTTPResetContent < HTTPSuccess # 205
237
+
238
+ # Response class for <tt>Reset Content</tt> responses (status code 205).
239
+ #
240
+ # The <tt>Reset Content</tt> response indicates that the server
241
+ # successfully processed the request,
242
+ # asks that the client reset its document view, and is not returning any content.
243
+ #
244
+ # :include: doc/net-http/included_getters.rdoc
245
+ #
246
+ # References:
247
+ #
248
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205].
249
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content].
250
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#205].
251
+ #
252
+ class HTTPResetContent < HTTPSuccess
62
253
  HAS_BODY = false
63
254
  end
64
- class HTTPPartialContent < HTTPSuccess # 206
255
+
256
+ # Response class for <tt>Partial Content</tt> responses (status code 206).
257
+ #
258
+ # The <tt>Partial Content</tt> response indicates that the server is delivering
259
+ # only part of the resource (byte serving)
260
+ # due to a Range header in the request.
261
+ #
262
+ # :include: doc/net-http/included_getters.rdoc
263
+ #
264
+ # References:
265
+ #
266
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206].
267
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content].
268
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#206].
269
+ #
270
+ class HTTPPartialContent < HTTPSuccess
65
271
  HAS_BODY = true
66
272
  end
67
- class HTTPMultiStatus < HTTPSuccess # 207 - RFC 4918
273
+
274
+ # Response class for <tt>Multi-Status (WebDAV)</tt> responses (status code 207).
275
+ #
276
+ # The <tt>Multi-Status (WebDAV)</tt> response indicates that the server
277
+ # has received the request,
278
+ # and that the message body can contain a number of separate response codes.
279
+ #
280
+ # :include: doc/net-http/included_getters.rdoc
281
+ #
282
+ # References:
283
+ #
284
+ # - {RFC 4818}[https://www.rfc-editor.org/rfc/rfc4918#section-11.1].
285
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#207].
286
+ #
287
+ class HTTPMultiStatus < HTTPSuccess
68
288
  HAS_BODY = true
69
289
  end
70
- class HTTPAlreadyReported < HTTPSuccess # 208 - RFC 5842
290
+
291
+ # Response class for <tt>Already Reported (WebDAV)</tt> responses (status code 208).
292
+ #
293
+ # The <tt>Already Reported (WebDAV)</tt> response indicates that the server
294
+ # has received the request,
295
+ # and that the members of a DAV binding have already been enumerated
296
+ # in a preceding part of the (multi-status) response,
297
+ # and are not being included again.
298
+ #
299
+ # :include: doc/net-http/included_getters.rdoc
300
+ #
301
+ # References:
302
+ #
303
+ # - {RFC 5842}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.1].
304
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#208].
305
+ #
306
+ class HTTPAlreadyReported < HTTPSuccess
71
307
  HAS_BODY = true
72
308
  end
73
- class HTTPIMUsed < HTTPSuccess # 226 - RFC 3229
309
+
310
+ # Response class for <tt>IM Used</tt> responses (status code 226).
311
+ #
312
+ # The <tt>IM Used</tt> response indicates that the server has fulfilled a request
313
+ # for the resource, and the response is a representation of the result
314
+ # of one or more instance-manipulations applied to the current instance.
315
+ #
316
+ # :include: doc/net-http/included_getters.rdoc
317
+ #
318
+ # References:
319
+ #
320
+ # - {RFC 3229}[https://www.rfc-editor.org/rfc/rfc3229.html#section-10.4.1].
321
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#226].
322
+ #
323
+ class HTTPIMUsed < HTTPSuccess
74
324
  HAS_BODY = true
75
325
  end
76
326
 
77
- class HTTPMultipleChoices < HTTPRedirection # 300
327
+ # Response class for <tt>Multiple Choices</tt> responses (status code 300).
328
+ #
329
+ # The <tt>Multiple Choices</tt> response indicates that the server
330
+ # offers multiple options for the resource from which the client may choose.
331
+ #
332
+ # :include: doc/net-http/included_getters.rdoc
333
+ #
334
+ # References:
335
+ #
336
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300].
337
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices].
338
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#300].
339
+ #
340
+ class HTTPMultipleChoices < HTTPRedirection
78
341
  HAS_BODY = true
79
342
  end
80
343
  HTTPMultipleChoice = HTTPMultipleChoices
81
- class HTTPMovedPermanently < HTTPRedirection # 301
344
+
345
+ # Response class for <tt>Moved Permanently</tt> responses (status code 301).
346
+ #
347
+ # The <tt>Moved Permanently</tt> response indicates that links or records
348
+ # returning this response should be updated to use the given URL.
349
+ #
350
+ # :include: doc/net-http/included_getters.rdoc
351
+ #
352
+ # References:
353
+ #
354
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301].
355
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently].
356
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#301].
357
+ #
358
+ class HTTPMovedPermanently < HTTPRedirection
82
359
  HAS_BODY = true
83
360
  end
84
- class HTTPFound < HTTPRedirection # 302
361
+
362
+ # Response class for <tt>Found</tt> responses (status code 302).
363
+ #
364
+ # The <tt>Found</tt> response indicates that the client
365
+ # should look at (browse to) another URL.
366
+ #
367
+ # :include: doc/net-http/included_getters.rdoc
368
+ #
369
+ # References:
370
+ #
371
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302].
372
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found].
373
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#302].
374
+ #
375
+ class HTTPFound < HTTPRedirection
85
376
  HAS_BODY = true
86
377
  end
87
378
  HTTPMovedTemporarily = HTTPFound
88
- class HTTPSeeOther < HTTPRedirection # 303
379
+
380
+ # Response class for <tt>See Other</tt> responses (status code 303).
381
+ #
382
+ # The response to the request can be found under another URI using the GET method.
383
+ #
384
+ # :include: doc/net-http/included_getters.rdoc
385
+ #
386
+ # References:
387
+ #
388
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303].
389
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other].
390
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#303].
391
+ #
392
+ class HTTPSeeOther < HTTPRedirection
89
393
  HAS_BODY = true
90
394
  end
91
- class HTTPNotModified < HTTPRedirection # 304
395
+
396
+ # Response class for <tt>Not Modified</tt> responses (status code 304).
397
+ #
398
+ # Indicates that the resource has not been modified since the version
399
+ # specified by the request headers.
400
+ #
401
+ # :include: doc/net-http/included_getters.rdoc
402
+ #
403
+ # References:
404
+ #
405
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304].
406
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified].
407
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#304].
408
+ #
409
+ class HTTPNotModified < HTTPRedirection
92
410
  HAS_BODY = false
93
411
  end
94
- class HTTPUseProxy < HTTPRedirection # 305
412
+
413
+ # Response class for <tt>Use Proxy</tt> responses (status code 305).
414
+ #
415
+ # The requested resource is available only through a proxy,
416
+ # whose address is provided in the response.
417
+ #
418
+ # :include: doc/net-http/included_getters.rdoc
419
+ #
420
+ # References:
421
+ #
422
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy].
423
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#305].
424
+ #
425
+ class HTTPUseProxy < HTTPRedirection
95
426
  HAS_BODY = false
96
427
  end
97
- # 306 Switch Proxy - no longer unused
98
- class HTTPTemporaryRedirect < HTTPRedirection # 307
428
+
429
+ # Response class for <tt>Temporary Redirect</tt> responses (status code 307).
430
+ #
431
+ # The request should be repeated with another URI;
432
+ # however, future requests should still use the original URI.
433
+ #
434
+ # :include: doc/net-http/included_getters.rdoc
435
+ #
436
+ # References:
437
+ #
438
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307].
439
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect].
440
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#307].
441
+ #
442
+ class HTTPTemporaryRedirect < HTTPRedirection
99
443
  HAS_BODY = true
100
444
  end
101
- class HTTPPermanentRedirect < HTTPRedirection # 308
445
+
446
+ # Response class for <tt>Permanent Redirect</tt> responses (status code 308).
447
+ #
448
+ # This and all future requests should be directed to the given URI.
449
+ #
450
+ # :include: doc/net-http/included_getters.rdoc
451
+ #
452
+ # References:
453
+ #
454
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308].
455
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect].
456
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#308].
457
+ #
458
+ class HTTPPermanentRedirect < HTTPRedirection
102
459
  HAS_BODY = true
103
460
  end
104
461
 
105
- class HTTPBadRequest < HTTPClientError # 400
462
+ # Response class for <tt>Bad Request</tt> responses (status code 400).
463
+ #
464
+ # The server cannot or will not process the request due to an apparent client error.
465
+ #
466
+ # :include: doc/net-http/included_getters.rdoc
467
+ #
468
+ # References:
469
+ #
470
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400].
471
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request].
472
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#400].
473
+ #
474
+ class HTTPBadRequest < HTTPClientError
106
475
  HAS_BODY = true
107
476
  end
108
- class HTTPUnauthorized < HTTPClientError # 401
477
+
478
+ # Response class for <tt>Unauthorized</tt> responses (status code 401).
479
+ #
480
+ # Authentication is required, but either was not provided or failed.
481
+ #
482
+ # :include: doc/net-http/included_getters.rdoc
483
+ #
484
+ # References:
485
+ #
486
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401].
487
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized].
488
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#401].
489
+ #
490
+ class HTTPUnauthorized < HTTPClientError
109
491
  HAS_BODY = true
110
492
  end
111
- class HTTPPaymentRequired < HTTPClientError # 402
493
+
494
+ # Response class for <tt>Payment Required</tt> responses (status code 402).
495
+ #
496
+ # Reserved for future use.
497
+ #
498
+ # :include: doc/net-http/included_getters.rdoc
499
+ #
500
+ # References:
501
+ #
502
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402].
503
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required].
504
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#402].
505
+ #
506
+ class HTTPPaymentRequired < HTTPClientError
112
507
  HAS_BODY = true
113
508
  end
114
- class HTTPForbidden < HTTPClientError # 403
509
+
510
+ # Response class for <tt>Forbidden</tt> responses (status code 403).
511
+ #
512
+ # The request contained valid data and was understood by the server,
513
+ # but the server is refusing action.
514
+ #
515
+ # :include: doc/net-http/included_getters.rdoc
516
+ #
517
+ # References:
518
+ #
519
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403].
520
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden].
521
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#403].
522
+ #
523
+ class HTTPForbidden < HTTPClientError
115
524
  HAS_BODY = true
116
525
  end
117
- class HTTPNotFound < HTTPClientError # 404
526
+
527
+ # Response class for <tt>Not Found</tt> responses (status code 404).
528
+ #
529
+ # The requested resource could not be found but may be available in the future.
530
+ #
531
+ # :include: doc/net-http/included_getters.rdoc
532
+ #
533
+ # References:
534
+ #
535
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404].
536
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found].
537
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#404].
538
+ #
539
+ class HTTPNotFound < HTTPClientError
118
540
  HAS_BODY = true
119
541
  end
120
- class HTTPMethodNotAllowed < HTTPClientError # 405
542
+
543
+ # Response class for <tt>Method Not Allowed</tt> responses (status code 405).
544
+ #
545
+ # The request method is not supported for the requested resource.
546
+ #
547
+ # :include: doc/net-http/included_getters.rdoc
548
+ #
549
+ # References:
550
+ #
551
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405].
552
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed].
553
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#405].
554
+ #
555
+ class HTTPMethodNotAllowed < HTTPClientError
121
556
  HAS_BODY = true
122
557
  end
123
- class HTTPNotAcceptable < HTTPClientError # 406
558
+
559
+ # Response class for <tt>Not Acceptable</tt> responses (status code 406).
560
+ #
561
+ # The requested resource is capable of generating only content
562
+ # that not acceptable according to the Accept headers sent in the request.
563
+ #
564
+ # :include: doc/net-http/included_getters.rdoc
565
+ #
566
+ # References:
567
+ #
568
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406].
569
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable].
570
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#406].
571
+ #
572
+ class HTTPNotAcceptable < HTTPClientError
124
573
  HAS_BODY = true
125
574
  end
126
- class HTTPProxyAuthenticationRequired < HTTPClientError # 407
575
+
576
+ # Response class for <tt>Proxy Authentication Required</tt> responses (status code 407).
577
+ #
578
+ # The client must first authenticate itself with the proxy.
579
+ #
580
+ # :include: doc/net-http/included_getters.rdoc
581
+ #
582
+ # References:
583
+ #
584
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407].
585
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-re].
586
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#407].
587
+ #
588
+ class HTTPProxyAuthenticationRequired < HTTPClientError
127
589
  HAS_BODY = true
128
590
  end
129
- class HTTPRequestTimeout < HTTPClientError # 408
591
+
592
+ # Response class for <tt>Request Timeout</tt> responses (status code 408).
593
+ #
594
+ # The server timed out waiting for the request.
595
+ #
596
+ # :include: doc/net-http/included_getters.rdoc
597
+ #
598
+ # References:
599
+ #
600
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408].
601
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout].
602
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#408].
603
+ #
604
+ class HTTPRequestTimeout < HTTPClientError
130
605
  HAS_BODY = true
131
606
  end
132
607
  HTTPRequestTimeOut = HTTPRequestTimeout
133
- class HTTPConflict < HTTPClientError # 409
608
+
609
+ # Response class for <tt>Conflict</tt> responses (status code 409).
610
+ #
611
+ # The request could not be processed because of conflict in the current state of the resource.
612
+ #
613
+ # :include: doc/net-http/included_getters.rdoc
614
+ #
615
+ # References:
616
+ #
617
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409].
618
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict].
619
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#409].
620
+ #
621
+ class HTTPConflict < HTTPClientError
134
622
  HAS_BODY = true
135
623
  end
136
- class HTTPGone < HTTPClientError # 410
624
+
625
+ # Response class for <tt>Gone</tt> responses (status code 410).
626
+ #
627
+ # The resource requested was previously in use but is no longer available
628
+ # and will not be available again.
629
+ #
630
+ # :include: doc/net-http/included_getters.rdoc
631
+ #
632
+ # References:
633
+ #
634
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410].
635
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone].
636
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#410].
637
+ #
638
+ class HTTPGone < HTTPClientError
137
639
  HAS_BODY = true
138
640
  end
139
- class HTTPLengthRequired < HTTPClientError # 411
641
+
642
+ # Response class for <tt>Length Required</tt> responses (status code 411).
643
+ #
644
+ # The request did not specify the length of its content,
645
+ # which is required by the requested resource.
646
+ #
647
+ # :include: doc/net-http/included_getters.rdoc
648
+ #
649
+ # References:
650
+ #
651
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411].
652
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required].
653
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#411].
654
+ #
655
+ class HTTPLengthRequired < HTTPClientError
140
656
  HAS_BODY = true
141
657
  end
142
- class HTTPPreconditionFailed < HTTPClientError # 412
658
+
659
+ # Response class for <tt>Precondition Failed</tt> responses (status code 412).
660
+ #
661
+ # The server does not meet one of the preconditions
662
+ # specified in the request headers.
663
+ #
664
+ # :include: doc/net-http/included_getters.rdoc
665
+ #
666
+ # References:
667
+ #
668
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412].
669
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed].
670
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#412].
671
+ #
672
+ class HTTPPreconditionFailed < HTTPClientError
143
673
  HAS_BODY = true
144
674
  end
145
- class HTTPPayloadTooLarge < HTTPClientError # 413
675
+
676
+ # Response class for <tt>Payload Too Large</tt> responses (status code 413).
677
+ #
678
+ # The request is larger than the server is willing or able to process.
679
+ #
680
+ # :include: doc/net-http/included_getters.rdoc
681
+ #
682
+ # References:
683
+ #
684
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413].
685
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large].
686
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#413].
687
+ #
688
+ class HTTPPayloadTooLarge < HTTPClientError
146
689
  HAS_BODY = true
147
690
  end
148
691
  HTTPRequestEntityTooLarge = HTTPPayloadTooLarge
149
- class HTTPURITooLong < HTTPClientError # 414
692
+
693
+ # Response class for <tt>URI Too Long</tt> responses (status code 414).
694
+ #
695
+ # The URI provided was too long for the server to process.
696
+ #
697
+ # :include: doc/net-http/included_getters.rdoc
698
+ #
699
+ # References:
700
+ #
701
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414].
702
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long].
703
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#414].
704
+ #
705
+ class HTTPURITooLong < HTTPClientError
150
706
  HAS_BODY = true
151
707
  end
152
708
  HTTPRequestURITooLong = HTTPURITooLong
153
709
  HTTPRequestURITooLarge = HTTPRequestURITooLong
154
- class HTTPUnsupportedMediaType < HTTPClientError # 415
710
+
711
+ # Response class for <tt>Unsupported Media Type</tt> responses (status code 415).
712
+ #
713
+ # The request entity has a media type which the server or resource does not support.
714
+ #
715
+ # :include: doc/net-http/included_getters.rdoc
716
+ #
717
+ # References:
718
+ #
719
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415].
720
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type].
721
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#415].
722
+ #
723
+ class HTTPUnsupportedMediaType < HTTPClientError
155
724
  HAS_BODY = true
156
725
  end
157
- class HTTPRangeNotSatisfiable < HTTPClientError # 416
726
+
727
+ # Response class for <tt>Range Not Satisfiable</tt> responses (status code 416).
728
+ #
729
+ # The request entity has a media type which the server or resource does not support.
730
+ #
731
+ # :include: doc/net-http/included_getters.rdoc
732
+ #
733
+ # References:
734
+ #
735
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416].
736
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable].
737
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#416].
738
+ #
739
+ class HTTPRangeNotSatisfiable < HTTPClientError
158
740
  HAS_BODY = true
159
741
  end
160
742
  HTTPRequestedRangeNotSatisfiable = HTTPRangeNotSatisfiable
161
- class HTTPExpectationFailed < HTTPClientError # 417
743
+
744
+ # Response class for <tt>Expectation Failed</tt> responses (status code 417).
745
+ #
746
+ # The server cannot meet the requirements of the Expect request-header field.
747
+ #
748
+ # :include: doc/net-http/included_getters.rdoc
749
+ #
750
+ # References:
751
+ #
752
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417].
753
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed].
754
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#417].
755
+ #
756
+ class HTTPExpectationFailed < HTTPClientError
162
757
  HAS_BODY = true
163
758
  end
759
+
164
760
  # 418 I'm a teapot - RFC 2324; a joke RFC
761
+ # See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#418.
762
+
165
763
  # 420 Enhance Your Calm - Twitter
166
- class HTTPMisdirectedRequest < HTTPClientError # 421 - RFC 7540
764
+
765
+ # Response class for <tt>Misdirected Request</tt> responses (status code 421).
766
+ #
767
+ # The request was directed at a server that is not able to produce a response.
768
+ #
769
+ # :include: doc/net-http/included_getters.rdoc
770
+ #
771
+ # References:
772
+ #
773
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request].
774
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#421].
775
+ #
776
+ class HTTPMisdirectedRequest < HTTPClientError
167
777
  HAS_BODY = true
168
778
  end
169
- class HTTPUnprocessableEntity < HTTPClientError # 422 - RFC 4918
779
+
780
+ # Response class for <tt>Unprocessable Entity</tt> responses (status code 422).
781
+ #
782
+ # The request was well-formed but had semantic errors.
783
+ #
784
+ # :include: doc/net-http/included_getters.rdoc
785
+ #
786
+ # References:
787
+ #
788
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422].
789
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content].
790
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#422].
791
+ #
792
+ class HTTPUnprocessableEntity < HTTPClientError
170
793
  HAS_BODY = true
171
794
  end
172
- class HTTPLocked < HTTPClientError # 423 - RFC 4918
795
+
796
+ # Response class for <tt>Locked (WebDAV)</tt> responses (status code 423).
797
+ #
798
+ # The requested resource is locked.
799
+ #
800
+ # :include: doc/net-http/included_getters.rdoc
801
+ #
802
+ # References:
803
+ #
804
+ # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.3].
805
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#423].
806
+ #
807
+ class HTTPLocked < HTTPClientError
173
808
  HAS_BODY = true
174
809
  end
175
- class HTTPFailedDependency < HTTPClientError # 424 - RFC 4918
810
+
811
+ # Response class for <tt>Failed Dependency (WebDAV)</tt> responses (status code 424).
812
+ #
813
+ # The request failed because it depended on another request and that request failed.
814
+ # See {424 Failed Dependency (WebDAV)}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424].
815
+ #
816
+ # :include: doc/net-http/included_getters.rdoc
817
+ #
818
+ # References:
819
+ #
820
+ # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.4].
821
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424].
822
+ #
823
+ class HTTPFailedDependency < HTTPClientError
176
824
  HAS_BODY = true
177
825
  end
178
- # 425 Unordered Collection - existed only in draft
179
- class HTTPUpgradeRequired < HTTPClientError # 426 - RFC 2817
826
+
827
+ # 425 Too Early
828
+ # https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#425.
829
+
830
+ # Response class for <tt>Upgrade Required</tt> responses (status code 426).
831
+ #
832
+ # The client should switch to the protocol given in the Upgrade header field.
833
+ #
834
+ # :include: doc/net-http/included_getters.rdoc
835
+ #
836
+ # References:
837
+ #
838
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426].
839
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required].
840
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#426].
841
+ #
842
+ class HTTPUpgradeRequired < HTTPClientError
180
843
  HAS_BODY = true
181
844
  end
182
- class HTTPPreconditionRequired < HTTPClientError # 428 - RFC 6585
845
+
846
+ # Response class for <tt>Precondition Required</tt> responses (status code 428).
847
+ #
848
+ # The origin server requires the request to be conditional.
849
+ #
850
+ # :include: doc/net-http/included_getters.rdoc
851
+ #
852
+ # References:
853
+ #
854
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428].
855
+ # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-3].
856
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#428].
857
+ #
858
+ class HTTPPreconditionRequired < HTTPClientError
183
859
  HAS_BODY = true
184
860
  end
185
- class HTTPTooManyRequests < HTTPClientError # 429 - RFC 6585
861
+
862
+ # Response class for <tt>Too Many Requests</tt> responses (status code 429).
863
+ #
864
+ # The user has sent too many requests in a given amount of time.
865
+ #
866
+ # :include: doc/net-http/included_getters.rdoc
867
+ #
868
+ # References:
869
+ #
870
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429].
871
+ # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-4].
872
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429].
873
+ #
874
+ class HTTPTooManyRequests < HTTPClientError
186
875
  HAS_BODY = true
187
876
  end
188
- class HTTPRequestHeaderFieldsTooLarge < HTTPClientError # 431 - RFC 6585
877
+
878
+ # Response class for <tt>Request Header Fields Too Large</tt> responses (status code 431).
879
+ #
880
+ # An individual header field is too large,
881
+ # or all the header fields collectively, are too large.
882
+ #
883
+ # :include: doc/net-http/included_getters.rdoc
884
+ #
885
+ # References:
886
+ #
887
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431].
888
+ # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-5].
889
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#431].
890
+ #
891
+ class HTTPRequestHeaderFieldsTooLarge < HTTPClientError
189
892
  HAS_BODY = true
190
893
  end
191
- class HTTPUnavailableForLegalReasons < HTTPClientError # 451 - RFC 7725
894
+
895
+ # Response class for <tt>Unavailable For Legal Reasons</tt> responses (status code 451).
896
+ #
897
+ # A server operator has received a legal demand to deny access to a resource or to a set of resources
898
+ # that includes the requested resource.
899
+ #
900
+ # :include: doc/net-http/included_getters.rdoc
901
+ #
902
+ # References:
903
+ #
904
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451].
905
+ # - {RFC 7725}[https://www.rfc-editor.org/rfc/rfc7725.html#section-3].
906
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#451].
907
+ #
908
+ class HTTPUnavailableForLegalReasons < HTTPClientError
192
909
  HAS_BODY = true
193
910
  end
194
911
  # 444 No Response - Nginx
@@ -196,43 +913,188 @@ module Net
196
913
  # 450 Blocked by Windows Parental Controls - Microsoft
197
914
  # 499 Client Closed Request - Nginx
198
915
 
199
- class HTTPInternalServerError < HTTPServerError # 500
916
+ # Response class for <tt>Internal Server Error</tt> responses (status code 500).
917
+ #
918
+ # An unexpected condition was encountered and no more specific message is suitable.
919
+ #
920
+ # :include: doc/net-http/included_getters.rdoc
921
+ #
922
+ # References:
923
+ #
924
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500].
925
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error].
926
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#500].
927
+ #
928
+ class HTTPInternalServerError < HTTPServerError
200
929
  HAS_BODY = true
201
930
  end
202
- class HTTPNotImplemented < HTTPServerError # 501
931
+
932
+ # Response class for <tt>Not Implemented</tt> responses (status code 501).
933
+ #
934
+ # The server either does not recognize the request method,
935
+ # or it lacks the ability to fulfil the request.
936
+ #
937
+ # :include: doc/net-http/included_getters.rdoc
938
+ #
939
+ # References:
940
+ #
941
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501].
942
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented].
943
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#501].
944
+ #
945
+ class HTTPNotImplemented < HTTPServerError
203
946
  HAS_BODY = true
204
947
  end
205
- class HTTPBadGateway < HTTPServerError # 502
948
+
949
+ # Response class for <tt>Bad Gateway</tt> responses (status code 502).
950
+ #
951
+ # The server was acting as a gateway or proxy
952
+ # and received an invalid response from the upstream server.
953
+ #
954
+ # :include: doc/net-http/included_getters.rdoc
955
+ #
956
+ # References:
957
+ #
958
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502].
959
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway].
960
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#502].
961
+ #
962
+ class HTTPBadGateway < HTTPServerError
206
963
  HAS_BODY = true
207
964
  end
208
- class HTTPServiceUnavailable < HTTPServerError # 503
965
+
966
+ # Response class for <tt>Service Unavailable</tt> responses (status code 503).
967
+ #
968
+ # The server cannot handle the request
969
+ # (because it is overloaded or down for maintenance).
970
+ #
971
+ # :include: doc/net-http/included_getters.rdoc
972
+ #
973
+ # References:
974
+ #
975
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503].
976
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable].
977
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#503].
978
+ #
979
+ class HTTPServiceUnavailable < HTTPServerError
209
980
  HAS_BODY = true
210
981
  end
211
- class HTTPGatewayTimeout < HTTPServerError # 504
982
+
983
+ # Response class for <tt>Gateway Timeout</tt> responses (status code 504).
984
+ #
985
+ # The server was acting as a gateway or proxy
986
+ # and did not receive a timely response from the upstream server.
987
+ #
988
+ # :include: doc/net-http/included_getters.rdoc
989
+ #
990
+ # References:
991
+ #
992
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504].
993
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout].
994
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#504].
995
+ #
996
+ class HTTPGatewayTimeout < HTTPServerError
212
997
  HAS_BODY = true
213
998
  end
214
999
  HTTPGatewayTimeOut = HTTPGatewayTimeout
215
- class HTTPVersionNotSupported < HTTPServerError # 505
1000
+
1001
+ # Response class for <tt>HTTP Version Not Supported</tt> responses (status code 505).
1002
+ #
1003
+ # The server does not support the HTTP version used in the request.
1004
+ #
1005
+ # :include: doc/net-http/included_getters.rdoc
1006
+ #
1007
+ # References:
1008
+ #
1009
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505].
1010
+ # - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-suppor].
1011
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#505].
1012
+ #
1013
+ class HTTPVersionNotSupported < HTTPServerError
216
1014
  HAS_BODY = true
217
1015
  end
218
- class HTTPVariantAlsoNegotiates < HTTPServerError # 506
1016
+
1017
+ # Response class for <tt>Variant Also Negotiates</tt> responses (status code 506).
1018
+ #
1019
+ # Transparent content negotiation for the request results in a circular reference.
1020
+ #
1021
+ # :include: doc/net-http/included_getters.rdoc
1022
+ #
1023
+ # References:
1024
+ #
1025
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506].
1026
+ # - {RFC 2295}[https://www.rfc-editor.org/rfc/rfc2295#section-8.1].
1027
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#506].
1028
+ #
1029
+ class HTTPVariantAlsoNegotiates < HTTPServerError
219
1030
  HAS_BODY = true
220
1031
  end
221
- class HTTPInsufficientStorage < HTTPServerError # 507 - RFC 4918
1032
+
1033
+ # Response class for <tt>Insufficient Storage (WebDAV)</tt> responses (status code 507).
1034
+ #
1035
+ # The server is unable to store the representation needed to complete the request.
1036
+ #
1037
+ # :include: doc/net-http/included_getters.rdoc
1038
+ #
1039
+ # References:
1040
+ #
1041
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507].
1042
+ # - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.5].
1043
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#507].
1044
+ #
1045
+ class HTTPInsufficientStorage < HTTPServerError
222
1046
  HAS_BODY = true
223
1047
  end
224
- class HTTPLoopDetected < HTTPServerError # 508 - RFC 5842
1048
+
1049
+ # Response class for <tt>Loop Detected (WebDAV)</tt> responses (status code 508).
1050
+ #
1051
+ # The server detected an infinite loop while processing the request.
1052
+ #
1053
+ # :include: doc/net-http/included_getters.rdoc
1054
+ #
1055
+ # References:
1056
+ #
1057
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508].
1058
+ # - {RFC 5942}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.2].
1059
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#508].
1060
+ #
1061
+ class HTTPLoopDetected < HTTPServerError
225
1062
  HAS_BODY = true
226
1063
  end
227
1064
  # 509 Bandwidth Limit Exceeded - Apache bw/limited extension
228
- class HTTPNotExtended < HTTPServerError # 510 - RFC 2774
1065
+
1066
+ # Response class for <tt>Not Extended</tt> responses (status code 510).
1067
+ #
1068
+ # Further extensions to the request are required for the server to fulfill it.
1069
+ #
1070
+ # :include: doc/net-http/included_getters.rdoc
1071
+ #
1072
+ # References:
1073
+ #
1074
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510].
1075
+ # - {RFC 2774}[https://www.rfc-editor.org/rfc/rfc2774.html#section-7].
1076
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#510].
1077
+ #
1078
+ class HTTPNotExtended < HTTPServerError
229
1079
  HAS_BODY = true
230
1080
  end
231
- class HTTPNetworkAuthenticationRequired < HTTPServerError # 511 - RFC 6585
1081
+
1082
+ # Response class for <tt>Network Authentication Required</tt> responses (status code 511).
1083
+ #
1084
+ # The client needs to authenticate to gain network access.
1085
+ #
1086
+ # :include: doc/net-http/included_getters.rdoc
1087
+ #
1088
+ # References:
1089
+ #
1090
+ # - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511].
1091
+ # - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-6].
1092
+ # - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#511].
1093
+ #
1094
+ class HTTPNetworkAuthenticationRequired < HTTPServerError
232
1095
  HAS_BODY = true
233
1096
  end
234
1097
 
235
- # :startdoc:
236
1098
  end
237
1099
 
238
1100
  class Net::HTTPResponse