net-http 0.3.2 → 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.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Rakefile +0 -7
- data/doc/net-http/examples.rdoc +2 -1
- data/doc/net-http/included_getters.rdoc +3 -0
- data/lib/net/http/backward.rb +1 -1
- data/lib/net/http/exceptions.rb +1 -1
- data/lib/net/http/generic_request.rb +91 -15
- data/lib/net/http/header.rb +164 -67
- data/lib/net/http/proxy_delta.rb +1 -1
- data/lib/net/http/request.rb +50 -5
- data/lib/net/http/requests.rb +31 -1
- data/lib/net/http/response.rb +42 -22
- data/lib/net/http/responses.rb +507 -55
- data/lib/net/http/status.rb +7 -6
- data/lib/net/http.rb +944 -464
- data/lib/net/https.rb +1 -1
- data/net-http.gemspec +9 -4
- metadata +4 -6
- data/.github/dependabot.yml +0 -6
- data/.github/workflows/test.yml +0 -22
- data/.gitignore +0 -7
data/lib/net/http.rb
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# frozen_string_literal:
|
1
|
+
# frozen_string_literal: true
|
2
2
|
#
|
3
3
|
# = net/http.rb
|
4
4
|
#
|
@@ -34,72 +34,70 @@ module Net #:nodoc:
|
|
34
34
|
|
35
35
|
# \Class \Net::HTTP provides a rich library that implements the client
|
36
36
|
# in a client-server model that uses the \HTTP request-response protocol.
|
37
|
-
# For information about \HTTP, see
|
37
|
+
# For information about \HTTP, see:
|
38
38
|
#
|
39
39
|
# - {Hypertext Transfer Protocol}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol].
|
40
40
|
# - {Technical overview}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Technical_overview].
|
41
41
|
#
|
42
|
-
# Note: If you are performing only a few GET requests, consider using
|
43
|
-
# {OpenURI}[https://docs.ruby-lang.org/en/master/OpenURI.html];
|
44
|
-
# otherwise, read on.
|
45
|
-
#
|
46
|
-
# == Synopsis
|
47
|
-
#
|
48
|
-
# If you are already familiar with \HTTP, this synopsis may be helpful.
|
49
|
-
#
|
50
|
-
# {Session}[rdoc-ref:Net::HTTP@Sessions] with multiple requests for
|
51
|
-
# {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods]:
|
52
|
-
#
|
53
|
-
# Net::HTTP.start(hostname) do |http|
|
54
|
-
# # Session started automatically before block execution.
|
55
|
-
# http.get(path_or_uri, headers = {})
|
56
|
-
# http.head(path_or_uri, headers = {})
|
57
|
-
# http.post(path_or_uri, data, headers = {}) # Can also have a block.
|
58
|
-
# http.put(path_or_uri, data, headers = {})
|
59
|
-
# http.delete(path_or_uri, headers = {Depth: 'Infinity'})
|
60
|
-
# http.options(path_or_uri, headers = {})
|
61
|
-
# http.trace(path_or_uri, headers = {})
|
62
|
-
# http.patch(path_or_uri, data, headers = {}) # Can also have a block.
|
63
|
-
# # Session finished automatically at block exit.
|
64
|
-
# end
|
65
|
-
#
|
66
|
-
# {Session}[rdoc-ref:Net::HTTP@Sessions] with multiple requests for
|
67
|
-
# {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]:
|
68
|
-
#
|
69
|
-
# Net::HTTP.start(hostname) do |http|
|
70
|
-
# # Session started automatically before block execution.
|
71
|
-
# http.copy(path_or_uri, headers = {})
|
72
|
-
# http.lock(path_or_uri, body, headers = {})
|
73
|
-
# http.mkcol(path_or_uri, body = nil, headers = {})
|
74
|
-
# http.move(path_or_uri, headers = {})
|
75
|
-
# http.propfind(path_or_uri, body = nil, headers = {'Depth' => '0'})
|
76
|
-
# http.proppatch(path_or_uri, body, headers = {})
|
77
|
-
# http.unlock(path_or_uri, body, headers = {})
|
78
|
-
# # Session finished automatically at block exit.
|
79
|
-
# end
|
80
|
-
#
|
81
|
-
# Each of the following methods automatically starts and finishes
|
82
|
-
# a {session}[rdoc-ref:Net::HTTP@Sessions] that sends a single request:
|
83
|
-
#
|
84
|
-
# # Return string response body.
|
85
|
-
# Net::HTTP.get(hostname, path, port = 80)
|
86
|
-
# Net::HTTP.get(uri, headers = {}, port = 80)
|
87
|
-
#
|
88
|
-
# # Write string response body to $stdout.
|
89
|
-
# Net::HTTP.get_print(hostname, path_or_uri, port = 80)
|
90
|
-
# Net::HTTP.get_print(uri, headers = {}, port = 80)
|
91
|
-
#
|
92
|
-
# # Return response as Net::HTTPResponse object.
|
93
|
-
# Net::HTTP.get_response(hostname, path_or_uri, port = 80)
|
94
|
-
# Net::HTTP.get_response(uri, headers = {}, port = 80)
|
95
|
-
#
|
96
|
-
# Net::HTTP.post(uri, data, headers = {})
|
97
|
-
# Net::HTTP.post_form(uri, params)
|
98
|
-
#
|
99
42
|
# == About the Examples
|
100
43
|
#
|
101
44
|
# :include: doc/net-http/examples.rdoc
|
102
45
|
#
|
46
|
+
# == Strategies
|
47
|
+
#
|
48
|
+
# - If you will make only a few GET requests,
|
49
|
+
# consider using {OpenURI}[https://docs.ruby-lang.org/en/master/OpenURI.html].
|
50
|
+
# - If you will make only a few requests of all kinds,
|
51
|
+
# consider using the various singleton convenience methods in this class.
|
52
|
+
# Each of the following methods automatically starts and finishes
|
53
|
+
# a {session}[rdoc-ref:Net::HTTP@Sessions] that sends a single request:
|
54
|
+
#
|
55
|
+
# # Return string response body.
|
56
|
+
# Net::HTTP.get(hostname, path)
|
57
|
+
# Net::HTTP.get(uri)
|
58
|
+
#
|
59
|
+
# # Write string response body to $stdout.
|
60
|
+
# Net::HTTP.get_print(hostname, path)
|
61
|
+
# Net::HTTP.get_print(uri)
|
62
|
+
#
|
63
|
+
# # Return response as Net::HTTPResponse object.
|
64
|
+
# Net::HTTP.get_response(hostname, path)
|
65
|
+
# Net::HTTP.get_response(uri)
|
66
|
+
# data = '{"title": "foo", "body": "bar", "userId": 1}'
|
67
|
+
# Net::HTTP.post(uri, data)
|
68
|
+
# params = {title: 'foo', body: 'bar', userId: 1}
|
69
|
+
# Net::HTTP.post_form(uri, params)
|
70
|
+
#
|
71
|
+
# - If performance is important, consider using sessions, which lower request overhead.
|
72
|
+
# This {session}[rdoc-ref:Net::HTTP@Sessions] has multiple requests for
|
73
|
+
# {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods]
|
74
|
+
# and {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]:
|
75
|
+
#
|
76
|
+
# Net::HTTP.start(hostname) do |http|
|
77
|
+
# # Session started automatically before block execution.
|
78
|
+
# http.get(path)
|
79
|
+
# http.head(path)
|
80
|
+
# body = 'Some text'
|
81
|
+
# http.post(path, body) # Can also have a block.
|
82
|
+
# http.put(path, body)
|
83
|
+
# http.delete(path)
|
84
|
+
# http.options(path)
|
85
|
+
# http.trace(path)
|
86
|
+
# http.patch(path, body) # Can also have a block.
|
87
|
+
# http.copy(path)
|
88
|
+
# http.lock(path, body)
|
89
|
+
# http.mkcol(path, body)
|
90
|
+
# http.move(path)
|
91
|
+
# http.propfind(path, body)
|
92
|
+
# http.proppatch(path, body)
|
93
|
+
# http.unlock(path, body)
|
94
|
+
# # Session finished automatically at block exit.
|
95
|
+
# end
|
96
|
+
#
|
97
|
+
# The methods cited above are convenience methods that, via their few arguments,
|
98
|
+
# allow minimal control over the requests.
|
99
|
+
# For greater control, consider using {request objects}[rdoc-ref:Net::HTTPRequest].
|
100
|
+
#
|
103
101
|
# == URIs
|
104
102
|
#
|
105
103
|
# On the internet, a URI
|
@@ -175,7 +173,7 @@ module Net #:nodoc:
|
|
175
173
|
# {Request Fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields].
|
176
174
|
# A host may also accept other custom fields.
|
177
175
|
#
|
178
|
-
# == Sessions
|
176
|
+
# == \HTTP Sessions
|
179
177
|
#
|
180
178
|
# A _session_ is a connection between a server (host) and a client that:
|
181
179
|
#
|
@@ -183,7 +181,7 @@ module Net #:nodoc:
|
|
183
181
|
# - May contain any number of requests.
|
184
182
|
# - Is ended by instance method Net::HTTP#finish.
|
185
183
|
#
|
186
|
-
# See example sessions at
|
184
|
+
# See example sessions at {Strategies}[rdoc-ref:Net::HTTP@Strategies].
|
187
185
|
#
|
188
186
|
# === Session Using \Net::HTTP.start
|
189
187
|
#
|
@@ -264,66 +262,55 @@ module Net #:nodoc:
|
|
264
262
|
#
|
265
263
|
# == Following Redirection
|
266
264
|
#
|
267
|
-
# Each
|
265
|
+
# Each returned response is an instance of a subclass of Net::HTTPResponse.
|
266
|
+
# See the {response class hierarchy}[rdoc-ref:Net::HTTPResponse@Response+Subclasses].
|
268
267
|
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
# details of response classes, see the section "HTTP Response Classes"
|
273
|
-
# below.
|
268
|
+
# In particular, class Net::HTTPRedirection is the parent
|
269
|
+
# of all redirection classes.
|
270
|
+
# This allows you to craft a case statement to handle redirections properly:
|
274
271
|
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
# def fetch(uri_str, limit = 10)
|
272
|
+
# def fetch(uri, limit = 10)
|
278
273
|
# # You should choose a better exception.
|
279
|
-
# raise ArgumentError, '
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
# warn "redirected to #{location}"
|
274
|
+
# raise ArgumentError, 'Too many HTTP redirects' if limit == 0
|
275
|
+
#
|
276
|
+
# res = Net::HTTP.get_response(URI(uri))
|
277
|
+
# case res
|
278
|
+
# when Net::HTTPSuccess # Any success class.
|
279
|
+
# res
|
280
|
+
# when Net::HTTPRedirection # Any redirection class.
|
281
|
+
# location = res['Location']
|
282
|
+
# warn "Redirected to #{location}"
|
289
283
|
# fetch(location, limit - 1)
|
290
|
-
# else
|
291
|
-
#
|
284
|
+
# else # Any other class.
|
285
|
+
# res.value
|
292
286
|
# end
|
293
287
|
# end
|
294
288
|
#
|
295
|
-
#
|
289
|
+
# fetch(uri)
|
296
290
|
#
|
297
291
|
# == Basic Authentication
|
298
292
|
#
|
299
293
|
# Basic authentication is performed according to
|
300
|
-
# [
|
301
|
-
#
|
302
|
-
# uri = URI('http://example.com/index.html?key=value')
|
294
|
+
# {RFC2617}[http://www.ietf.org/rfc/rfc2617.txt]:
|
303
295
|
#
|
304
296
|
# req = Net::HTTP::Get.new(uri)
|
305
|
-
# req.basic_auth
|
306
|
-
#
|
307
|
-
# res = Net::HTTP.start(uri.hostname, uri.port) {|http|
|
297
|
+
# req.basic_auth('user', 'pass')
|
298
|
+
# res = Net::HTTP.start(hostname) do |http|
|
308
299
|
# http.request(req)
|
309
|
-
#
|
310
|
-
# puts res.body
|
300
|
+
# end
|
311
301
|
#
|
312
302
|
# == Streaming Response Bodies
|
313
303
|
#
|
314
|
-
# By default Net::HTTP reads an entire response into memory. If you are
|
304
|
+
# By default \Net::HTTP reads an entire response into memory. If you are
|
315
305
|
# handling large files or wish to implement a progress bar you can instead
|
316
306
|
# stream the body directly to an IO.
|
317
307
|
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
# open 'large_file', 'w' do |io|
|
325
|
-
# response.read_body do |chunk|
|
326
|
-
# io.write chunk
|
308
|
+
# Net::HTTP.start(hostname) do |http|
|
309
|
+
# req = Net::HTTP::Get.new(uri)
|
310
|
+
# http.request(req) do |res|
|
311
|
+
# open('t.tmp', 'w') do |f|
|
312
|
+
# res.read_body do |chunk|
|
313
|
+
# f.write chunk
|
327
314
|
# end
|
328
315
|
# end
|
329
316
|
# end
|
@@ -331,56 +318,411 @@ module Net #:nodoc:
|
|
331
318
|
#
|
332
319
|
# == HTTPS
|
333
320
|
#
|
334
|
-
# HTTPS is enabled for an HTTP connection by Net::HTTP#use_ssl
|
335
|
-
#
|
336
|
-
# uri = URI('https://secure.example.com/some_path?query=string')
|
321
|
+
# HTTPS is enabled for an \HTTP connection by Net::HTTP#use_ssl=:
|
337
322
|
#
|
338
|
-
# Net::HTTP.start(
|
339
|
-
#
|
340
|
-
#
|
323
|
+
# Net::HTTP.start(hostname, :use_ssl => true) do |http|
|
324
|
+
# req = Net::HTTP::Get.new(uri)
|
325
|
+
# res = http.request(req)
|
341
326
|
# end
|
342
327
|
#
|
343
|
-
# Or if you simply want to make a GET request, you may pass in
|
344
|
-
# object that has an HTTPS URL. Net::HTTP automatically turns on TLS
|
345
|
-
# verification if the URI object has a 'https' URI scheme
|
328
|
+
# Or if you simply want to make a GET request, you may pass in a URI
|
329
|
+
# object that has an \HTTPS URL. \Net::HTTP automatically turns on TLS
|
330
|
+
# verification if the URI object has a 'https' URI scheme:
|
331
|
+
#
|
332
|
+
# uri # => #<URI::HTTPS https://jsonplaceholder.typicode.com/>
|
333
|
+
# Net::HTTP.get(uri)
|
334
|
+
#
|
335
|
+
# == Proxy Server
|
336
|
+
#
|
337
|
+
# An \HTTP object can have
|
338
|
+
# a {proxy server}[https://en.wikipedia.org/wiki/Proxy_server].
|
346
339
|
#
|
347
|
-
#
|
348
|
-
#
|
340
|
+
# You can create an \HTTP object with a proxy server
|
341
|
+
# using method Net::HTTP.new or method Net::HTTP.start.
|
349
342
|
#
|
350
|
-
#
|
351
|
-
#
|
343
|
+
# The proxy may be defined either by argument +p_addr+
|
344
|
+
# or by environment variable <tt>'http_proxy'</tt>.
|
352
345
|
#
|
353
|
-
#
|
346
|
+
# === Proxy Using Argument +p_addr+ as a \String
|
354
347
|
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# pass +nil+ for the proxy address.
|
348
|
+
# When argument +p_addr+ is a string hostname,
|
349
|
+
# the returned +http+ has the given host as its proxy:
|
358
350
|
#
|
359
|
-
#
|
351
|
+
# http = Net::HTTP.new(hostname, nil, 'proxy.example')
|
352
|
+
# http.proxy? # => true
|
353
|
+
# http.proxy_from_env? # => false
|
354
|
+
# http.proxy_address # => "proxy.example"
|
355
|
+
# # These use default values.
|
356
|
+
# http.proxy_port # => 80
|
357
|
+
# http.proxy_user # => nil
|
358
|
+
# http.proxy_pass # => nil
|
360
359
|
#
|
361
|
-
#
|
362
|
-
# proxy_port = 8080
|
360
|
+
# The port, username, and password for the proxy may also be given:
|
363
361
|
#
|
364
|
-
# Net::HTTP.new('example
|
365
|
-
#
|
366
|
-
#
|
362
|
+
# http = Net::HTTP.new(hostname, nil, 'proxy.example', 8000, 'pname', 'ppass')
|
363
|
+
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
364
|
+
# http.proxy? # => true
|
365
|
+
# http.proxy_from_env? # => false
|
366
|
+
# http.proxy_address # => "proxy.example"
|
367
|
+
# http.proxy_port # => 8000
|
368
|
+
# http.proxy_user # => "pname"
|
369
|
+
# http.proxy_pass # => "ppass"
|
367
370
|
#
|
368
|
-
#
|
369
|
-
#
|
371
|
+
# === Proxy Using '<tt>ENV['http_proxy']</tt>'
|
372
|
+
#
|
373
|
+
# When environment variable <tt>'http_proxy'</tt>
|
374
|
+
# is set to a \URI string,
|
375
|
+
# the returned +http+ will have the server at that URI as its proxy;
|
376
|
+
# note that the \URI string must have a protocol
|
377
|
+
# such as <tt>'http'</tt> or <tt>'https'</tt>:
|
378
|
+
#
|
379
|
+
# ENV['http_proxy'] = 'http://example.com'
|
380
|
+
# http = Net::HTTP.new(hostname)
|
381
|
+
# http.proxy? # => true
|
382
|
+
# http.proxy_from_env? # => true
|
383
|
+
# http.proxy_address # => "example.com"
|
384
|
+
# # These use default values.
|
385
|
+
# http.proxy_port # => 80
|
386
|
+
# http.proxy_user # => nil
|
387
|
+
# http.proxy_pass # => nil
|
388
|
+
#
|
389
|
+
# The \URI string may include proxy username, password, and port number:
|
390
|
+
#
|
391
|
+
# ENV['http_proxy'] = 'http://pname:ppass@example.com:8000'
|
392
|
+
# http = Net::HTTP.new(hostname)
|
393
|
+
# http.proxy? # => true
|
394
|
+
# http.proxy_from_env? # => true
|
395
|
+
# http.proxy_address # => "example.com"
|
396
|
+
# http.proxy_port # => 8000
|
397
|
+
# http.proxy_user # => "pname"
|
398
|
+
# http.proxy_pass # => "ppass"
|
370
399
|
#
|
371
|
-
#
|
400
|
+
# === Filtering Proxies
|
372
401
|
#
|
373
|
-
# Net::HTTP
|
374
|
-
#
|
375
|
-
# Range header was sent.
|
402
|
+
# With method Net::HTTP.new (but not Net::HTTP.start),
|
403
|
+
# you can use argument +p_no_proxy+ to filter proxies:
|
376
404
|
#
|
377
|
-
#
|
405
|
+
# - Reject a certain address:
|
406
|
+
#
|
407
|
+
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
|
408
|
+
# http.proxy_address # => nil
|
409
|
+
#
|
410
|
+
# - Reject certain domains or subdomains:
|
411
|
+
#
|
412
|
+
# http = Net::HTTP.new('example.com', nil, 'my.proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
|
413
|
+
# http.proxy_address # => nil
|
414
|
+
#
|
415
|
+
# - Reject certain addresses and port combinations:
|
416
|
+
#
|
417
|
+
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234')
|
418
|
+
# http.proxy_address # => "proxy.example"
|
419
|
+
#
|
420
|
+
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:8000')
|
421
|
+
# http.proxy_address # => nil
|
422
|
+
#
|
423
|
+
# - Reject a list of the types above delimited using a comma:
|
424
|
+
#
|
425
|
+
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
|
426
|
+
# http.proxy_address # => nil
|
427
|
+
#
|
428
|
+
# http = Net::HTTP.new('example.com', nil, 'my.proxy', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
|
429
|
+
# http.proxy_address # => nil
|
430
|
+
#
|
431
|
+
# == Compression and Decompression
|
432
|
+
#
|
433
|
+
# \Net::HTTP does not compress the body of a request before sending.
|
434
|
+
#
|
435
|
+
# By default, \Net::HTTP adds header <tt>'Accept-Encoding'</tt>
|
436
|
+
# to a new {request object}[rdoc-ref:Net::HTTPRequest]:
|
437
|
+
#
|
438
|
+
# Net::HTTP::Get.new(uri)['Accept-Encoding']
|
439
|
+
# # => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
|
440
|
+
#
|
441
|
+
# This requests the server to zip-encode the response body if there is one;
|
442
|
+
# the server is not required to do so.
|
443
|
+
#
|
444
|
+
# \Net::HTTP does not automatically decompress a response body
|
445
|
+
# if the response has header <tt>'Content-Range'</tt>.
|
446
|
+
#
|
447
|
+
# Otherwise decompression (or not) depends on the value of header
|
448
|
+
# {Content-Encoding}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-encoding-response-header]:
|
449
|
+
#
|
450
|
+
# - <tt>'deflate'</tt>, <tt>'gzip'</tt>, or <tt>'x-gzip'</tt>:
|
451
|
+
# decompresses the body and deletes the header.
|
452
|
+
# - <tt>'none'</tt> or <tt>'identity'</tt>:
|
453
|
+
# does not decompress the body, but deletes the header.
|
454
|
+
# - Any other value:
|
455
|
+
# leaves the body and header unchanged.
|
456
|
+
#
|
457
|
+
# == What's Here
|
458
|
+
#
|
459
|
+
# This is a categorized summary of methods and attributes.
|
460
|
+
#
|
461
|
+
# === \Net::HTTP Objects
|
462
|
+
#
|
463
|
+
# - {::new}[rdoc-ref:Net::HTTP.new]:
|
464
|
+
# Creates a new instance.
|
465
|
+
# - {#inspect}[rdoc-ref:Net::HTTP#inspect]:
|
466
|
+
# Returns a string representation of +self+.
|
467
|
+
#
|
468
|
+
# === Sessions
|
469
|
+
#
|
470
|
+
# - {::start}[rdoc-ref:Net::HTTP.start]:
|
471
|
+
# Begins a new session in a new \Net::HTTP object.
|
472
|
+
# - {#started?}[rdoc-ref:Net::HTTP#started?]
|
473
|
+
# (aliased as {#active?}[rdoc-ref:Net::HTTP#active?]):
|
474
|
+
# Returns whether in a session.
|
475
|
+
# - {#finish}[rdoc-ref:Net::HTTP#finish]:
|
476
|
+
# Ends an active session.
|
477
|
+
# - {#start}[rdoc-ref:Net::HTTP#start]:
|
478
|
+
# Begins a new session in an existing \Net::HTTP object (+self+).
|
479
|
+
#
|
480
|
+
# === Connections
|
481
|
+
#
|
482
|
+
# - {:continue_timeout}[rdoc-ref:Net::HTTP#continue_timeout]:
|
483
|
+
# Returns the continue timeout.
|
484
|
+
# - {#continue_timeout=}[rdoc-ref:Net::HTTP#continue_timeout=]:
|
485
|
+
# Sets the continue timeout seconds.
|
486
|
+
# - {:keep_alive_timeout}[rdoc-ref:Net::HTTP#keep_alive_timeout]:
|
487
|
+
# Returns the keep-alive timeout.
|
488
|
+
# - {:keep_alive_timeout=}[rdoc-ref:Net::HTTP#keep_alive_timeout=]:
|
489
|
+
# Sets the keep-alive timeout.
|
490
|
+
# - {:max_retries}[rdoc-ref:Net::HTTP#max_retries]:
|
491
|
+
# Returns the maximum retries.
|
492
|
+
# - {#max_retries=}[rdoc-ref:Net::HTTP#max_retries=]:
|
493
|
+
# Sets the maximum retries.
|
494
|
+
# - {:open_timeout}[rdoc-ref:Net::HTTP#open_timeout]:
|
495
|
+
# Returns the open timeout.
|
496
|
+
# - {:open_timeout=}[rdoc-ref:Net::HTTP#open_timeout=]:
|
497
|
+
# Sets the open timeout.
|
498
|
+
# - {:read_timeout}[rdoc-ref:Net::HTTP#read_timeout]:
|
499
|
+
# Returns the open timeout.
|
500
|
+
# - {:read_timeout=}[rdoc-ref:Net::HTTP#read_timeout=]:
|
501
|
+
# Sets the read timeout.
|
502
|
+
# - {:ssl_timeout}[rdoc-ref:Net::HTTP#ssl_timeout]:
|
503
|
+
# Returns the ssl timeout.
|
504
|
+
# - {:ssl_timeout=}[rdoc-ref:Net::HTTP#ssl_timeout=]:
|
505
|
+
# Sets the ssl timeout.
|
506
|
+
# - {:write_timeout}[rdoc-ref:Net::HTTP#write_timeout]:
|
507
|
+
# Returns the write timeout.
|
508
|
+
# - {write_timeout=}[rdoc-ref:Net::HTTP#write_timeout=]:
|
509
|
+
# Sets the write timeout.
|
510
|
+
#
|
511
|
+
# === Requests
|
512
|
+
#
|
513
|
+
# - {::get}[rdoc-ref:Net::HTTP.get]:
|
514
|
+
# Sends a GET request and returns the string response body.
|
515
|
+
# - {::get_print}[rdoc-ref:Net::HTTP.get_print]:
|
516
|
+
# Sends a GET request and write the string response body to $stdout.
|
517
|
+
# - {::get_response}[rdoc-ref:Net::HTTP.get_response]:
|
518
|
+
# Sends a GET request and returns a response object.
|
519
|
+
# - {::post_form}[rdoc-ref:Net::HTTP.post_form]:
|
520
|
+
# Sends a POST request with form data and returns a response object.
|
521
|
+
# - {::post}[rdoc-ref:Net::HTTP.post]:
|
522
|
+
# Sends a POST request with data and returns a response object.
|
523
|
+
# - {#copy}[rdoc-ref:Net::HTTP#copy]:
|
524
|
+
# Sends a COPY request and returns a response object.
|
525
|
+
# - {#delete}[rdoc-ref:Net::HTTP#delete]:
|
526
|
+
# Sends a DELETE request and returns a response object.
|
527
|
+
# - {#get}[rdoc-ref:Net::HTTP#get]:
|
528
|
+
# Sends a GET request and returns a response object.
|
529
|
+
# - {#head}[rdoc-ref:Net::HTTP#head]:
|
530
|
+
# Sends a HEAD request and returns a response object.
|
531
|
+
# - {#lock}[rdoc-ref:Net::HTTP#lock]:
|
532
|
+
# Sends a LOCK request and returns a response object.
|
533
|
+
# - {#mkcol}[rdoc-ref:Net::HTTP#mkcol]:
|
534
|
+
# Sends a MKCOL request and returns a response object.
|
535
|
+
# - {#move}[rdoc-ref:Net::HTTP#move]:
|
536
|
+
# Sends a MOVE request and returns a response object.
|
537
|
+
# - {#options}[rdoc-ref:Net::HTTP#options]:
|
538
|
+
# Sends a OPTIONS request and returns a response object.
|
539
|
+
# - {#patch}[rdoc-ref:Net::HTTP#patch]:
|
540
|
+
# Sends a PATCH request and returns a response object.
|
541
|
+
# - {#post}[rdoc-ref:Net::HTTP#post]:
|
542
|
+
# Sends a POST request and returns a response object.
|
543
|
+
# - {#propfind}[rdoc-ref:Net::HTTP#propfind]:
|
544
|
+
# Sends a PROPFIND request and returns a response object.
|
545
|
+
# - {#proppatch}[rdoc-ref:Net::HTTP#proppatch]:
|
546
|
+
# Sends a PROPPATCH request and returns a response object.
|
547
|
+
# - {#put}[rdoc-ref:Net::HTTP#put]:
|
548
|
+
# Sends a PUT request and returns a response object.
|
549
|
+
# - {#request}[rdoc-ref:Net::HTTP#request]:
|
550
|
+
# Sends a request and returns a response object.
|
551
|
+
# - {#request_get}[rdoc-ref:Net::HTTP#request_get]
|
552
|
+
# (aliased as {#get2}[rdoc-ref:Net::HTTP#get2]):
|
553
|
+
# Sends a GET request and forms a response object;
|
554
|
+
# if a block given, calls the block with the object,
|
555
|
+
# otherwise returns the object.
|
556
|
+
# - {#request_head}[rdoc-ref:Net::HTTP#request_head]
|
557
|
+
# (aliased as {#head2}[rdoc-ref:Net::HTTP#head2]):
|
558
|
+
# Sends a HEAD request and forms a response object;
|
559
|
+
# if a block given, calls the block with the object,
|
560
|
+
# otherwise returns the object.
|
561
|
+
# - {#request_post}[rdoc-ref:Net::HTTP#request_post]
|
562
|
+
# (aliased as {#post2}[rdoc-ref:Net::HTTP#post2]):
|
563
|
+
# Sends a POST request and forms a response object;
|
564
|
+
# if a block given, calls the block with the object,
|
565
|
+
# otherwise returns the object.
|
566
|
+
# - {#send_request}[rdoc-ref:Net::HTTP#send_request]:
|
567
|
+
# Sends a request and returns a response object.
|
568
|
+
# - {#trace}[rdoc-ref:Net::HTTP#trace]:
|
569
|
+
# Sends a TRACE request and returns a response object.
|
570
|
+
# - {#unlock}[rdoc-ref:Net::HTTP#unlock]:
|
571
|
+
# Sends an UNLOCK request and returns a response object.
|
572
|
+
#
|
573
|
+
# === Responses
|
574
|
+
#
|
575
|
+
# - {:close_on_empty_response}[rdoc-ref:Net::HTTP#close_on_empty_response]:
|
576
|
+
# Returns whether to close connection on empty response.
|
577
|
+
# - {:close_on_empty_response=}[rdoc-ref:Net::HTTP#close_on_empty_response=]:
|
578
|
+
# Sets whether to close connection on empty response.
|
579
|
+
# - {:ignore_eof}[rdoc-ref:Net::HTTP#ignore_eof]:
|
580
|
+
# Returns whether to ignore end-of-file when reading a response body
|
581
|
+
# with <tt>Content-Length</tt> headers.
|
582
|
+
# - {:ignore_eof=}[rdoc-ref:Net::HTTP#ignore_eof=]:
|
583
|
+
# Sets whether to ignore end-of-file when reading a response body
|
584
|
+
# with <tt>Content-Length</tt> headers.
|
585
|
+
# - {:response_body_encoding}[rdoc-ref:Net::HTTP#response_body_encoding]:
|
586
|
+
# Returns the encoding to use for the response body.
|
587
|
+
# - {#response_body_encoding=}[rdoc-ref:Net::HTTP#response_body_encoding=]:
|
588
|
+
# Sets the response body encoding.
|
589
|
+
#
|
590
|
+
# === Proxies
|
591
|
+
#
|
592
|
+
# - {:proxy_address}[rdoc-ref:Net::HTTP#proxy_address]:
|
593
|
+
# Returns the proxy address.
|
594
|
+
# - {:proxy_address=}[rdoc-ref:Net::HTTP#proxy_address=]:
|
595
|
+
# Sets the proxy address.
|
596
|
+
# - {::proxy_class?}[rdoc-ref:Net::HTTP.proxy_class?]:
|
597
|
+
# Returns whether +self+ is a proxy class.
|
598
|
+
# - {#proxy?}[rdoc-ref:Net::HTTP#proxy?]:
|
599
|
+
# Returns whether +self+ has a proxy.
|
600
|
+
# - {#proxy_address}[rdoc-ref:Net::HTTP#proxy_address]
|
601
|
+
# (aliased as {#proxyaddr}[rdoc-ref:Net::HTTP#proxyaddr]):
|
602
|
+
# Returns the proxy address.
|
603
|
+
# - {#proxy_from_env?}[rdoc-ref:Net::HTTP#proxy_from_env?]:
|
604
|
+
# Returns whether the proxy is taken from an environment variable.
|
605
|
+
# - {:proxy_from_env=}[rdoc-ref:Net::HTTP#proxy_from_env=]:
|
606
|
+
# Sets whether the proxy is to be taken from an environment variable.
|
607
|
+
# - {:proxy_pass}[rdoc-ref:Net::HTTP#proxy_pass]:
|
608
|
+
# Returns the proxy password.
|
609
|
+
# - {:proxy_pass=}[rdoc-ref:Net::HTTP#proxy_pass=]:
|
610
|
+
# Sets the proxy password.
|
611
|
+
# - {:proxy_port}[rdoc-ref:Net::HTTP#proxy_port]:
|
612
|
+
# Returns the proxy port.
|
613
|
+
# - {:proxy_port=}[rdoc-ref:Net::HTTP#proxy_port=]:
|
614
|
+
# Sets the proxy port.
|
615
|
+
# - {#proxy_user}[rdoc-ref:Net::HTTP#proxy_user]:
|
616
|
+
# Returns the proxy user name.
|
617
|
+
# - {:proxy_user=}[rdoc-ref:Net::HTTP#proxy_user=]:
|
618
|
+
# Sets the proxy user.
|
619
|
+
#
|
620
|
+
# === Security
|
621
|
+
#
|
622
|
+
# - {:ca_file}[rdoc-ref:Net::HTTP#ca_file]:
|
623
|
+
# Returns the path to a CA certification file.
|
624
|
+
# - {:ca_file=}[rdoc-ref:Net::HTTP#ca_file=]:
|
625
|
+
# Sets the path to a CA certification file.
|
626
|
+
# - {:ca_path}[rdoc-ref:Net::HTTP#ca_path]:
|
627
|
+
# Returns the path of to CA directory containing certification files.
|
628
|
+
# - {:ca_path=}[rdoc-ref:Net::HTTP#ca_path=]:
|
629
|
+
# Sets the path of to CA directory containing certification files.
|
630
|
+
# - {:cert}[rdoc-ref:Net::HTTP#cert]:
|
631
|
+
# Returns the OpenSSL::X509::Certificate object to be used for client certification.
|
632
|
+
# - {:cert=}[rdoc-ref:Net::HTTP#cert=]:
|
633
|
+
# Sets the OpenSSL::X509::Certificate object to be used for client certification.
|
634
|
+
# - {:cert_store}[rdoc-ref:Net::HTTP#cert_store]:
|
635
|
+
# Returns the X509::Store to be used for verifying peer certificate.
|
636
|
+
# - {:cert_store=}[rdoc-ref:Net::HTTP#cert_store=]:
|
637
|
+
# Sets the X509::Store to be used for verifying peer certificate.
|
638
|
+
# - {:ciphers}[rdoc-ref:Net::HTTP#ciphers]:
|
639
|
+
# Returns the available SSL ciphers.
|
640
|
+
# - {:ciphers=}[rdoc-ref:Net::HTTP#ciphers=]:
|
641
|
+
# Sets the available SSL ciphers.
|
642
|
+
# - {:extra_chain_cert}[rdoc-ref:Net::HTTP#extra_chain_cert]:
|
643
|
+
# Returns the extra X509 certificates to be added to the certificate chain.
|
644
|
+
# - {:extra_chain_cert=}[rdoc-ref:Net::HTTP#extra_chain_cert=]:
|
645
|
+
# Sets the extra X509 certificates to be added to the certificate chain.
|
646
|
+
# - {:key}[rdoc-ref:Net::HTTP#key]:
|
647
|
+
# Returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
|
648
|
+
# - {:key=}[rdoc-ref:Net::HTTP#key=]:
|
649
|
+
# Sets the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
|
650
|
+
# - {:max_version}[rdoc-ref:Net::HTTP#max_version]:
|
651
|
+
# Returns the maximum SSL version.
|
652
|
+
# - {:max_version=}[rdoc-ref:Net::HTTP#max_version=]:
|
653
|
+
# Sets the maximum SSL version.
|
654
|
+
# - {:min_version}[rdoc-ref:Net::HTTP#min_version]:
|
655
|
+
# Returns the minimum SSL version.
|
656
|
+
# - {:min_version=}[rdoc-ref:Net::HTTP#min_version=]:
|
657
|
+
# Sets the minimum SSL version.
|
658
|
+
# - {#peer_cert}[rdoc-ref:Net::HTTP#peer_cert]:
|
659
|
+
# Returns the X509 certificate chain for the session's socket peer.
|
660
|
+
# - {:ssl_version}[rdoc-ref:Net::HTTP#ssl_version]:
|
661
|
+
# Returns the SSL version.
|
662
|
+
# - {:ssl_version=}[rdoc-ref:Net::HTTP#ssl_version=]:
|
663
|
+
# Sets the SSL version.
|
664
|
+
# - {#use_ssl=}[rdoc-ref:Net::HTTP#use_ssl=]:
|
665
|
+
# Sets whether a new session is to use Transport Layer Security.
|
666
|
+
# - {#use_ssl?}[rdoc-ref:Net::HTTP#use_ssl?]:
|
667
|
+
# Returns whether +self+ uses SSL.
|
668
|
+
# - {:verify_callback}[rdoc-ref:Net::HTTP#verify_callback]:
|
669
|
+
# Returns the callback for the server certification verification.
|
670
|
+
# - {:verify_callback=}[rdoc-ref:Net::HTTP#verify_callback=]:
|
671
|
+
# Sets the callback for the server certification verification.
|
672
|
+
# - {:verify_depth}[rdoc-ref:Net::HTTP#verify_depth]:
|
673
|
+
# Returns the maximum depth for the certificate chain verification.
|
674
|
+
# - {:verify_depth=}[rdoc-ref:Net::HTTP#verify_depth=]:
|
675
|
+
# Sets the maximum depth for the certificate chain verification.
|
676
|
+
# - {:verify_hostname}[rdoc-ref:Net::HTTP#verify_hostname]:
|
677
|
+
# Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
|
678
|
+
# - {:verify_hostname=}[rdoc-ref:Net::HTTP#verify_hostname=]:
|
679
|
+
# Sets he flags for server the certification verification at the beginning of the SSL/TLS session.
|
680
|
+
# - {:verify_mode}[rdoc-ref:Net::HTTP#verify_mode]:
|
681
|
+
# Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
|
682
|
+
# - {:verify_mode=}[rdoc-ref:Net::HTTP#verify_mode=]:
|
683
|
+
# Sets the flags for server the certification verification at the beginning of the SSL/TLS session.
|
684
|
+
#
|
685
|
+
# === Addresses and Ports
|
686
|
+
#
|
687
|
+
# - {:address}[rdoc-ref:Net::HTTP#address]:
|
688
|
+
# Returns the string host name or host IP.
|
689
|
+
# - {::default_port}[rdoc-ref:Net::HTTP.default_port]:
|
690
|
+
# Returns integer 80, the default port to use for HTTP requests.
|
691
|
+
# - {::http_default_port}[rdoc-ref:Net::HTTP.http_default_port]:
|
692
|
+
# Returns integer 80, the default port to use for HTTP requests.
|
693
|
+
# - {::https_default_port}[rdoc-ref:Net::HTTP.https_default_port]:
|
694
|
+
# Returns integer 443, the default port to use for HTTPS requests.
|
695
|
+
# - {#ipaddr}[rdoc-ref:Net::HTTP#ipaddr]:
|
696
|
+
# Returns the IP address for the connection.
|
697
|
+
# - {#ipaddr=}[rdoc-ref:Net::HTTP#ipaddr=]:
|
698
|
+
# Sets the IP address for the connection.
|
699
|
+
# - {:local_host}[rdoc-ref:Net::HTTP#local_host]:
|
700
|
+
# Returns the string local host used to establish the connection.
|
701
|
+
# - {:local_host=}[rdoc-ref:Net::HTTP#local_host=]:
|
702
|
+
# Sets the string local host used to establish the connection.
|
703
|
+
# - {:local_port}[rdoc-ref:Net::HTTP#local_port]:
|
704
|
+
# Returns the integer local port used to establish the connection.
|
705
|
+
# - {:local_port=}[rdoc-ref:Net::HTTP#local_port=]:
|
706
|
+
# Sets the integer local port used to establish the connection.
|
707
|
+
# - {:port}[rdoc-ref:Net::HTTP#port]:
|
708
|
+
# Returns the integer port number.
|
709
|
+
#
|
710
|
+
# === \HTTP Version
|
711
|
+
#
|
712
|
+
# - {::version_1_2?}[rdoc-ref:Net::HTTP.version_1_2?]
|
713
|
+
# (aliased as {::is_version_1_2?}[rdoc-ref:Net::HTTP.is_version_1_2?]
|
714
|
+
# and {::version_1_2}[rdoc-ref:Net::HTTP.version_1_2]):
|
715
|
+
# Returns true; retained for compatibility.
|
716
|
+
#
|
717
|
+
# === Debugging
|
718
|
+
#
|
719
|
+
# - {#set_debug_output}[rdoc-ref:Net::HTTP#set_debug_output]:
|
720
|
+
# Sets the output stream for debugging.
|
378
721
|
#
|
379
722
|
class HTTP < Protocol
|
380
723
|
|
381
724
|
# :stopdoc:
|
382
|
-
VERSION = "0.
|
383
|
-
Revision = %q$Revision$.split[1]
|
725
|
+
VERSION = "0.4.0"
|
384
726
|
HTTPVersion = '1.1'
|
385
727
|
begin
|
386
728
|
require 'zlib'
|
@@ -548,10 +890,10 @@ module Net #:nodoc:
|
|
548
890
|
end
|
549
891
|
|
550
892
|
#
|
551
|
-
# HTTP session management
|
893
|
+
# \HTTP session management
|
552
894
|
#
|
553
895
|
|
554
|
-
# Returns
|
896
|
+
# Returns integer +80+, the default port to use for \HTTP requests:
|
555
897
|
#
|
556
898
|
# Net::HTTP.default_port # => 80
|
557
899
|
#
|
@@ -559,7 +901,7 @@ module Net #:nodoc:
|
|
559
901
|
http_default_port()
|
560
902
|
end
|
561
903
|
|
562
|
-
# Returns integer +80+, the default port to use for HTTP requests:
|
904
|
+
# Returns integer +80+, the default port to use for \HTTP requests:
|
563
905
|
#
|
564
906
|
# Net::HTTP.http_default_port # => 80
|
565
907
|
#
|
@@ -585,14 +927,11 @@ module Net #:nodoc:
|
|
585
927
|
#
|
586
928
|
# Creates a new \Net::HTTP object, +http+, via \Net::HTTP.new:
|
587
929
|
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
# -
|
930
|
+
# - For arguments +address+ and +port+, see Net::HTTP.new.
|
931
|
+
# - For proxy-defining arguments +p_addr+ through +p_pass+,
|
932
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
591
933
|
# - For argument +opts+, see below.
|
592
934
|
#
|
593
|
-
# Note: If +port+ is +nil+ and <tt>opts[:use_ssl]</tt> is a truthy value,
|
594
|
-
# the value passed to +new+ is Net::HTTP.https_default_port, not +port+.
|
595
|
-
#
|
596
935
|
# With no block given:
|
597
936
|
#
|
598
937
|
# - Calls <tt>http.start</tt> with no block (see #start),
|
@@ -665,6 +1004,9 @@ module Net #:nodoc:
|
|
665
1004
|
# - #verify_mode
|
666
1005
|
# - #write_timeout
|
667
1006
|
#
|
1007
|
+
# Note: If +port+ is +nil+ and <tt>opts[:use_ssl]</tt> is a truthy value,
|
1008
|
+
# the value passed to +new+ is Net::HTTP.https_default_port, not +port+.
|
1009
|
+
#
|
668
1010
|
def HTTP.start(address, *arg, &block) # :yield: +http+
|
669
1011
|
arg.pop if opt = Hash.try_convert(arg[-1])
|
670
1012
|
port, p_addr, p_port, p_user, p_pass = *arg
|
@@ -691,12 +1033,10 @@ module Net #:nodoc:
|
|
691
1033
|
alias newobj new # :nodoc:
|
692
1034
|
end
|
693
1035
|
|
694
|
-
# Returns a new Net::HTTP object +http+
|
695
|
-
# (but does not open a TCP connection or HTTP session).
|
696
|
-
#
|
697
|
-
# <b>No Proxy</b>
|
1036
|
+
# Returns a new \Net::HTTP object +http+
|
1037
|
+
# (but does not open a TCP connection or \HTTP session).
|
698
1038
|
#
|
699
|
-
# With only string argument +
|
1039
|
+
# With only string argument +address+ given
|
700
1040
|
# (and <tt>ENV['http_proxy']</tt> undefined or +nil+),
|
701
1041
|
# the returned +http+:
|
702
1042
|
#
|
@@ -719,85 +1059,8 @@ module Net #:nodoc:
|
|
719
1059
|
# # => #<Net::HTTP jsonplaceholder.typicode.com:8000 open=false>
|
720
1060
|
# http.port # => 8000
|
721
1061
|
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
# When argument +p_addr+ is a string hostname,
|
725
|
-
# the returned +http+ has a proxy:
|
726
|
-
#
|
727
|
-
# http = Net::HTTP.new(hostname, nil, 'proxy.example')
|
728
|
-
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
729
|
-
# http.proxy? # => true
|
730
|
-
# http.proxy_address # => "proxy.example"
|
731
|
-
# # These use default values.
|
732
|
-
# http.proxy_port # => 80
|
733
|
-
# http.proxy_user # => nil
|
734
|
-
# http.proxy_pass # => nil
|
735
|
-
#
|
736
|
-
# The port, username, and password for the proxy may also be given:
|
737
|
-
#
|
738
|
-
# http = Net::HTTP.new(hostname, nil, 'proxy.example', 8000, 'pname', 'ppass')
|
739
|
-
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
740
|
-
# http.proxy? # => true
|
741
|
-
# http.proxy_address # => "proxy.example"
|
742
|
-
# http.proxy_port # => 8000
|
743
|
-
# http.proxy_user # => "pname"
|
744
|
-
# http.proxy_pass # => "ppass"
|
745
|
-
#
|
746
|
-
# <b>Proxy Using <tt>ENV['http_proxy']</tt></b>
|
747
|
-
#
|
748
|
-
# When environment variable <tt>'http_proxy'</tt>
|
749
|
-
# is set to a \URI string,
|
750
|
-
# the returned +http+ will have that URI as its proxy;
|
751
|
-
# note that the \URI string must have a protocol
|
752
|
-
# such as <tt>'http'</tt> or <tt>'https'</tt>:
|
753
|
-
#
|
754
|
-
# ENV['http_proxy'] = 'http://example.com'
|
755
|
-
# # => "http://example.com"
|
756
|
-
# http = Net::HTTP.new(hostname)
|
757
|
-
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
758
|
-
# http.proxy? # => true
|
759
|
-
# http.address # => "jsonplaceholder.typicode.com"
|
760
|
-
# http.proxy_address # => "example.com"
|
761
|
-
#
|
762
|
-
# The \URI string may include proxy username, password, and port number:
|
763
|
-
#
|
764
|
-
# ENV['http_proxy'] = 'http://pname:ppass@example.com:8000'
|
765
|
-
# # => "http://pname:ppass@example.com:8000"
|
766
|
-
# http = Net::HTTP.new(hostname)
|
767
|
-
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
768
|
-
# http.proxy_port # => 8000
|
769
|
-
# http.proxy_user # => "pname"
|
770
|
-
# http.proxy_pass # => "ppass"
|
771
|
-
#
|
772
|
-
# <b>Argument +p_no_proxy+</b>
|
773
|
-
#
|
774
|
-
# You can use argument +p_no_proxy+ to reject certain proxies:
|
775
|
-
#
|
776
|
-
# - Reject a certain address:
|
777
|
-
#
|
778
|
-
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
|
779
|
-
# http.proxy_address # => nil
|
780
|
-
#
|
781
|
-
# - Reject certain domains or subdomains:
|
782
|
-
#
|
783
|
-
# http = Net::HTTP.new('example.com', nil, 'my.proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
|
784
|
-
# http.proxy_address # => nil
|
785
|
-
#
|
786
|
-
# - Reject certain addresses and port combinations:
|
787
|
-
#
|
788
|
-
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234')
|
789
|
-
# http.proxy_address # => "proxy.example"
|
790
|
-
#
|
791
|
-
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:8000')
|
792
|
-
# http.proxy_address # => nil
|
793
|
-
#
|
794
|
-
# - Reject a list of the types above delimited using a comma:
|
795
|
-
#
|
796
|
-
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
|
797
|
-
# http.proxy_address # => nil
|
798
|
-
#
|
799
|
-
# http = Net::HTTP.new('example.com', nil, 'my.proxy', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
|
800
|
-
# http.proxy_address # => nil
|
1062
|
+
# For proxy-defining arguments +p_addr+ through +p_no_proxy+,
|
1063
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
801
1064
|
#
|
802
1065
|
def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil)
|
803
1066
|
http = super address, port
|
@@ -811,7 +1074,7 @@ module Net #:nodoc:
|
|
811
1074
|
elsif p_addr == :ENV then
|
812
1075
|
http.proxy_from_env = true
|
813
1076
|
else
|
814
|
-
if p_addr && p_no_proxy && !URI::Generic.use_proxy?(
|
1077
|
+
if p_addr && p_no_proxy && !URI::Generic.use_proxy?(address, address, port, p_no_proxy)
|
815
1078
|
p_addr = nil
|
816
1079
|
p_port = nil
|
817
1080
|
end
|
@@ -824,10 +1087,10 @@ module Net #:nodoc:
|
|
824
1087
|
http
|
825
1088
|
end
|
826
1089
|
|
827
|
-
# Creates a new Net::HTTP object for the specified server address,
|
828
|
-
# without opening the TCP connection or initializing the HTTP session.
|
1090
|
+
# Creates a new \Net::HTTP object for the specified server address,
|
1091
|
+
# without opening the TCP connection or initializing the \HTTP session.
|
829
1092
|
# The +address+ should be a DNS hostname or IP address.
|
830
|
-
def initialize(address, port = nil)
|
1093
|
+
def initialize(address, port = nil) # :nodoc:
|
831
1094
|
@address = address
|
832
1095
|
@port = (port || HTTP.default_port)
|
833
1096
|
@ipaddr = nil
|
@@ -927,21 +1190,22 @@ module Net #:nodoc:
|
|
927
1190
|
@debug_output = output
|
928
1191
|
end
|
929
1192
|
|
930
|
-
#
|
1193
|
+
# Returns the string host name or host IP given as argument +address+ in ::new.
|
931
1194
|
attr_reader :address
|
932
1195
|
|
933
|
-
#
|
1196
|
+
# Returns the integer port number given as argument +port+ in ::new.
|
934
1197
|
attr_reader :port
|
935
1198
|
|
936
|
-
#
|
1199
|
+
# Sets or returns the string local host used to establish the connection;
|
1200
|
+
# initially +nil+.
|
937
1201
|
attr_accessor :local_host
|
938
1202
|
|
939
|
-
#
|
1203
|
+
# Sets or returns the integer local port used to establish the connection;
|
1204
|
+
# initially +nil+.
|
940
1205
|
attr_accessor :local_port
|
941
1206
|
|
942
|
-
#
|
943
|
-
#
|
944
|
-
# body encoding.
|
1207
|
+
# Returns the encoding to use for the response body;
|
1208
|
+
# see #response_body_encoding=.
|
945
1209
|
attr_reader :response_body_encoding
|
946
1210
|
|
947
1211
|
# Sets the encoding to be used for the response body;
|
@@ -967,10 +1231,25 @@ module Net #:nodoc:
|
|
967
1231
|
@response_body_encoding = value
|
968
1232
|
end
|
969
1233
|
|
1234
|
+
# Sets whether to determine the proxy from environment variable
|
1235
|
+
# '<tt>ENV['http_proxy']</tt>';
|
1236
|
+
# see {Proxy Using ENV['http_proxy']}[rdoc-ref:Net::HTTP@Proxy+Using+-27ENV-5B-27http_proxy-27-5D-27].
|
970
1237
|
attr_writer :proxy_from_env
|
1238
|
+
|
1239
|
+
# Sets the proxy address;
|
1240
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
971
1241
|
attr_writer :proxy_address
|
1242
|
+
|
1243
|
+
# Sets the proxy port;
|
1244
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
972
1245
|
attr_writer :proxy_port
|
1246
|
+
|
1247
|
+
# Sets the proxy user;
|
1248
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
973
1249
|
attr_writer :proxy_user
|
1250
|
+
|
1251
|
+
# Sets the proxy password;
|
1252
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
974
1253
|
attr_writer :proxy_pass
|
975
1254
|
|
976
1255
|
# Returns the IP address for the connection.
|
@@ -1009,27 +1288,25 @@ module Net #:nodoc:
|
|
1009
1288
|
@ipaddr = addr
|
1010
1289
|
end
|
1011
1290
|
|
1012
|
-
#
|
1013
|
-
#
|
1014
|
-
#
|
1015
|
-
#
|
1291
|
+
# Sets or returns the numeric (\Integer or \Float) number of seconds
|
1292
|
+
# to wait for a connection to open;
|
1293
|
+
# initially 60.
|
1294
|
+
# If the connection is not made in the given interval,
|
1295
|
+
# an exception is raised.
|
1016
1296
|
attr_accessor :open_timeout
|
1017
1297
|
|
1018
|
-
#
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
# it raises a Net::ReadTimeout exception. The default value is 60 seconds.
|
1298
|
+
# Returns the numeric (\Integer or \Float) number of seconds
|
1299
|
+
# to wait for one block to be read (via one read(2) call);
|
1300
|
+
# see #read_timeout=.
|
1022
1301
|
attr_reader :read_timeout
|
1023
1302
|
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
1027
|
-
# it raises a Net::WriteTimeout exception. The default value is 60 seconds.
|
1028
|
-
# Net::WriteTimeout is not raised on Windows.
|
1303
|
+
# Returns the numeric (\Integer or \Float) number of seconds
|
1304
|
+
# to wait for one block to be written (via one write(2) call);
|
1305
|
+
# see #write_timeout=.
|
1029
1306
|
attr_reader :write_timeout
|
1030
1307
|
|
1031
1308
|
# Sets the maximum number of times to retry an idempotent request in case of
|
1032
|
-
# Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET,
|
1309
|
+
# \Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET,
|
1033
1310
|
# Errno::ECONNABORTED, Errno::EPIPE, OpenSSL::SSL::SSLError,
|
1034
1311
|
# Timeout::Error.
|
1035
1312
|
# The initial value is 1.
|
@@ -1048,6 +1325,8 @@ module Net #:nodoc:
|
|
1048
1325
|
@max_retries = retries
|
1049
1326
|
end
|
1050
1327
|
|
1328
|
+
# Returns the maximum number of times to retry an idempotent request;
|
1329
|
+
# see #max_retries=.
|
1051
1330
|
attr_reader :max_retries
|
1052
1331
|
|
1053
1332
|
# Sets the read timeout, in seconds, for +self+ to integer +sec+;
|
@@ -1069,52 +1348,90 @@ module Net #:nodoc:
|
|
1069
1348
|
# Sets the write timeout, in seconds, for +self+ to integer +sec+;
|
1070
1349
|
# the initial value is 60.
|
1071
1350
|
#
|
1072
|
-
# Argument +sec+ must be a non-negative numeric value
|
1351
|
+
# Argument +sec+ must be a non-negative numeric value:
|
1352
|
+
#
|
1353
|
+
# _uri = uri.dup
|
1354
|
+
# _uri.path = '/posts'
|
1355
|
+
# body = 'bar' * 200000
|
1356
|
+
# data = <<EOF
|
1357
|
+
# {"title": "foo", "body": "#{body}", "userId": "1"}
|
1358
|
+
# EOF
|
1359
|
+
# headers = {'content-type': 'application/json'}
|
1360
|
+
# http = Net::HTTP.new(hostname)
|
1361
|
+
# http.write_timeout # => 60
|
1362
|
+
# http.post(_uri.path, data, headers)
|
1363
|
+
# # => #<Net::HTTPCreated 201 Created readbody=true>
|
1364
|
+
# http.write_timeout = 0
|
1365
|
+
# http.post(_uri.path, data, headers) # Raises Net::WriteTimeout.
|
1073
1366
|
#
|
1074
1367
|
def write_timeout=(sec)
|
1075
1368
|
@socket.write_timeout = sec if @socket
|
1076
1369
|
@write_timeout = sec
|
1077
1370
|
end
|
1078
1371
|
|
1079
|
-
#
|
1080
|
-
#
|
1081
|
-
# default value is +nil+.
|
1372
|
+
# Returns the continue timeout value;
|
1373
|
+
# see continue_timeout=.
|
1082
1374
|
attr_reader :continue_timeout
|
1083
1375
|
|
1084
|
-
#
|
1376
|
+
# Sets the continue timeout value,
|
1377
|
+
# which is the number of seconds to wait for an expected 100 Continue response.
|
1378
|
+
# If the \HTTP object does not receive a response in this many seconds
|
1379
|
+
# it sends the request body.
|
1085
1380
|
def continue_timeout=(sec)
|
1086
1381
|
@socket.continue_timeout = sec if @socket
|
1087
1382
|
@continue_timeout = sec
|
1088
1383
|
end
|
1089
1384
|
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
#
|
1093
|
-
#
|
1385
|
+
# Sets or returns the numeric (\Integer or \Float) number of seconds
|
1386
|
+
# to keep the connection open after a request is sent;
|
1387
|
+
# initially 2.
|
1388
|
+
# If a new request is made during the given interval,
|
1389
|
+
# the still-open connection is used;
|
1390
|
+
# otherwise the connection will have been closed
|
1391
|
+
# and a new connection is opened.
|
1094
1392
|
attr_accessor :keep_alive_timeout
|
1095
1393
|
|
1096
|
-
#
|
1097
|
-
# Content-Length headers
|
1394
|
+
# Sets or returns whether to ignore end-of-file when reading a response body
|
1395
|
+
# with <tt>Content-Length</tt> headers;
|
1396
|
+
# initially +true+.
|
1098
1397
|
attr_accessor :ignore_eof
|
1099
1398
|
|
1100
|
-
# Returns true if the HTTP session has been started
|
1399
|
+
# Returns +true+ if the \HTTP session has been started:
|
1400
|
+
#
|
1401
|
+
# http = Net::HTTP.new(hostname)
|
1402
|
+
# http.started? # => false
|
1403
|
+
# http.start
|
1404
|
+
# http.started? # => true
|
1405
|
+
# http.finish # => nil
|
1406
|
+
# http.started? # => false
|
1407
|
+
#
|
1408
|
+
# Net::HTTP.start(hostname) do |http|
|
1409
|
+
# http.started?
|
1410
|
+
# end # => true
|
1411
|
+
# http.started? # => false
|
1412
|
+
#
|
1101
1413
|
def started?
|
1102
1414
|
@started
|
1103
1415
|
end
|
1104
1416
|
|
1105
1417
|
alias active? started? #:nodoc: obsolete
|
1106
1418
|
|
1419
|
+
# Sets or returns whether to close the connection when the response is empty;
|
1420
|
+
# initially +false+.
|
1107
1421
|
attr_accessor :close_on_empty_response
|
1108
1422
|
|
1109
|
-
# Returns true if
|
1423
|
+
# Returns +true+ if +self+ uses SSL, +false+ otherwise.
|
1424
|
+
# See Net::HTTP#use_ssl=.
|
1110
1425
|
def use_ssl?
|
1111
1426
|
@use_ssl
|
1112
1427
|
end
|
1113
1428
|
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
#
|
1117
|
-
#
|
1429
|
+
# Sets whether a new session is to use
|
1430
|
+
# {Transport Layer Security}[https://en.wikipedia.org/wiki/Transport_Layer_Security]:
|
1431
|
+
#
|
1432
|
+
# Raises IOError if attempting to change during a session.
|
1433
|
+
#
|
1434
|
+
# Raises OpenSSL::SSL::SSLError if the port is not an HTTPS port.
|
1118
1435
|
def use_ssl=(flag)
|
1119
1436
|
flag = flag ? true : false
|
1120
1437
|
if started? and @use_ssl != flag
|
@@ -1139,7 +1456,7 @@ module Net #:nodoc:
|
|
1139
1456
|
:@verify_depth,
|
1140
1457
|
:@verify_mode,
|
1141
1458
|
:@verify_hostname,
|
1142
|
-
]
|
1459
|
+
] # :nodoc:
|
1143
1460
|
SSL_ATTRIBUTES = [
|
1144
1461
|
:ca_file,
|
1145
1462
|
:ca_path,
|
@@ -1156,64 +1473,67 @@ module Net #:nodoc:
|
|
1156
1473
|
:verify_depth,
|
1157
1474
|
:verify_mode,
|
1158
1475
|
:verify_hostname,
|
1159
|
-
]
|
1476
|
+
] # :nodoc:
|
1160
1477
|
|
1161
|
-
# Sets path
|
1162
|
-
#
|
1163
|
-
# The file can contain several CA certificates.
|
1478
|
+
# Sets or returns the path to a CA certification file in PEM format.
|
1164
1479
|
attr_accessor :ca_file
|
1165
1480
|
|
1166
|
-
# Sets path of
|
1167
|
-
# PEM format.
|
1481
|
+
# Sets or returns the path of to CA directory
|
1482
|
+
# containing certification files in PEM format.
|
1168
1483
|
attr_accessor :ca_path
|
1169
1484
|
|
1170
|
-
# Sets
|
1171
|
-
#
|
1485
|
+
# Sets or returns the OpenSSL::X509::Certificate object
|
1486
|
+
# to be used for client certification.
|
1172
1487
|
attr_accessor :cert
|
1173
1488
|
|
1174
|
-
# Sets the X509::Store to
|
1489
|
+
# Sets or returns the X509::Store to be used for verifying peer certificate.
|
1175
1490
|
attr_accessor :cert_store
|
1176
1491
|
|
1177
|
-
# Sets the available ciphers.
|
1492
|
+
# Sets or returns the available SSL ciphers.
|
1493
|
+
# See {OpenSSL::SSL::SSLContext#ciphers=}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#method-i-ciphers-3D].
|
1178
1494
|
attr_accessor :ciphers
|
1179
1495
|
|
1180
|
-
# Sets the extra X509 certificates to be added to the certificate chain.
|
1181
|
-
# See OpenSSL::SSL::SSLContext#
|
1496
|
+
# Sets or returns the extra X509 certificates to be added to the certificate chain.
|
1497
|
+
# See {OpenSSL::SSL::SSLContext#add_certificate}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#method-i-add_certificate].
|
1182
1498
|
attr_accessor :extra_chain_cert
|
1183
1499
|
|
1184
|
-
# Sets
|
1185
|
-
# (This method is appeared in Michal Rokos's OpenSSL extension.)
|
1500
|
+
# Sets or returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
|
1186
1501
|
attr_accessor :key
|
1187
1502
|
|
1188
|
-
# Sets the SSL timeout seconds.
|
1503
|
+
# Sets or returns the SSL timeout seconds.
|
1189
1504
|
attr_accessor :ssl_timeout
|
1190
1505
|
|
1191
|
-
# Sets the SSL version.
|
1506
|
+
# Sets or returns the SSL version.
|
1507
|
+
# See {OpenSSL::SSL::SSLContext#ssl_version=}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D].
|
1192
1508
|
attr_accessor :ssl_version
|
1193
1509
|
|
1194
|
-
# Sets the minimum SSL version.
|
1510
|
+
# Sets or returns the minimum SSL version.
|
1511
|
+
# See {OpenSSL::SSL::SSLContext#min_version=}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D].
|
1195
1512
|
attr_accessor :min_version
|
1196
1513
|
|
1197
|
-
# Sets the maximum SSL version.
|
1514
|
+
# Sets or returns the maximum SSL version.
|
1515
|
+
# See {OpenSSL::SSL::SSLContext#max_version=}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D].
|
1198
1516
|
attr_accessor :max_version
|
1199
1517
|
|
1200
|
-
# Sets the
|
1518
|
+
# Sets or returns the callback for the server certification verification.
|
1201
1519
|
attr_accessor :verify_callback
|
1202
1520
|
|
1203
|
-
# Sets the maximum depth for the certificate chain verification.
|
1521
|
+
# Sets or returns the maximum depth for the certificate chain verification.
|
1204
1522
|
attr_accessor :verify_depth
|
1205
1523
|
|
1206
|
-
# Sets the flags for server the certification verification
|
1207
|
-
# SSL/TLS session.
|
1208
|
-
#
|
1524
|
+
# Sets or returns the flags for server the certification verification
|
1525
|
+
# at the beginning of the SSL/TLS session.
|
1209
1526
|
# OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.
|
1210
1527
|
attr_accessor :verify_mode
|
1211
1528
|
|
1212
|
-
# Sets to
|
1213
|
-
#
|
1529
|
+
# Sets or returns whether to verify that the server certificate is valid
|
1530
|
+
# for the hostname.
|
1531
|
+
# See {OpenSSL::SSL::SSLContext#verify_hostname=}[https://docs.ruby-lang.org/en/master/OpenSSL/SSL/SSLContext.html#attribute-i-verify_mode].
|
1214
1532
|
attr_accessor :verify_hostname
|
1215
1533
|
|
1216
|
-
# Returns the
|
1534
|
+
# Returns the X509 certificate chain (an array of strings)
|
1535
|
+
# for the session's socket peer,
|
1536
|
+
# or +nil+ if none.
|
1217
1537
|
def peer_cert
|
1218
1538
|
if not use_ssl? or not @socket
|
1219
1539
|
return nil
|
@@ -1221,14 +1541,26 @@ module Net #:nodoc:
|
|
1221
1541
|
@socket.io.peer_cert
|
1222
1542
|
end
|
1223
1543
|
|
1224
|
-
#
|
1544
|
+
# Starts an \HTTP session.
|
1545
|
+
#
|
1546
|
+
# Without a block, returns +self+:
|
1225
1547
|
#
|
1226
|
-
#
|
1227
|
-
#
|
1228
|
-
#
|
1548
|
+
# http = Net::HTTP.new(hostname)
|
1549
|
+
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
1550
|
+
# http.start
|
1551
|
+
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=true>
|
1552
|
+
# http.started? # => true
|
1553
|
+
# http.finish
|
1554
|
+
#
|
1555
|
+
# With a block, calls the block with +self+,
|
1556
|
+
# finishes the session when the block exits,
|
1557
|
+
# and returns the block's value:
|
1229
1558
|
#
|
1230
|
-
#
|
1231
|
-
#
|
1559
|
+
# http.start do |http|
|
1560
|
+
# http
|
1561
|
+
# end
|
1562
|
+
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
|
1563
|
+
# http.started? # => false
|
1232
1564
|
#
|
1233
1565
|
def start # :yield: http
|
1234
1566
|
raise IOError, 'HTTP session already opened' if @started
|
@@ -1282,8 +1614,8 @@ module Net #:nodoc:
|
|
1282
1614
|
write_timeout: @write_timeout,
|
1283
1615
|
continue_timeout: @continue_timeout,
|
1284
1616
|
debug_output: @debug_output)
|
1285
|
-
buf = "CONNECT #{conn_address}:#{@port} HTTP/#{HTTPVersion}\r\n"
|
1286
|
-
|
1617
|
+
buf = +"CONNECT #{conn_address}:#{@port} HTTP/#{HTTPVersion}\r\n" \
|
1618
|
+
"Host: #{@address}:#{@port}\r\n"
|
1287
1619
|
if proxy_user
|
1288
1620
|
credential = ["#{proxy_user}:#{proxy_pass}"].pack('m0')
|
1289
1621
|
buf << "Proxy-Authorization: Basic #{credential}\r\n"
|
@@ -1364,8 +1696,15 @@ module Net #:nodoc:
|
|
1364
1696
|
end
|
1365
1697
|
private :on_connect
|
1366
1698
|
|
1367
|
-
# Finishes the HTTP session
|
1368
|
-
#
|
1699
|
+
# Finishes the \HTTP session:
|
1700
|
+
#
|
1701
|
+
# http = Net::HTTP.new(hostname)
|
1702
|
+
# http.start
|
1703
|
+
# http.started? # => true
|
1704
|
+
# http.finish # => nil
|
1705
|
+
# http.started? # => false
|
1706
|
+
#
|
1707
|
+
# Raises IOError if not in a session.
|
1369
1708
|
def finish
|
1370
1709
|
raise IOError, 'HTTP session not yet started' unless started?
|
1371
1710
|
do_finish
|
@@ -1392,11 +1731,11 @@ module Net #:nodoc:
|
|
1392
1731
|
@proxy_user = nil
|
1393
1732
|
@proxy_pass = nil
|
1394
1733
|
|
1395
|
-
# Creates an HTTP proxy class which behaves like Net::HTTP, but
|
1734
|
+
# Creates an \HTTP proxy class which behaves like \Net::HTTP, but
|
1396
1735
|
# performs all access via the specified proxy.
|
1397
1736
|
#
|
1398
1737
|
# This class is obsolete. You may pass these same parameters directly to
|
1399
|
-
# Net::HTTP.new. See Net::HTTP.new for details of the arguments.
|
1738
|
+
# \Net::HTTP.new. See Net::HTTP.new for details of the arguments.
|
1400
1739
|
def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) #:nodoc:
|
1401
1740
|
return self unless p_addr
|
1402
1741
|
|
@@ -1419,31 +1758,37 @@ module Net #:nodoc:
|
|
1419
1758
|
end
|
1420
1759
|
|
1421
1760
|
class << HTTP
|
1422
|
-
#
|
1761
|
+
# Returns true if self is a class which was created by HTTP::Proxy.
|
1423
1762
|
def proxy_class?
|
1424
1763
|
defined?(@is_proxy_class) ? @is_proxy_class : false
|
1425
1764
|
end
|
1426
1765
|
|
1427
|
-
#
|
1766
|
+
# Returns the address of the proxy host, or +nil+ if none;
|
1767
|
+
# see Net::HTTP@Proxy+Server.
|
1428
1768
|
attr_reader :proxy_address
|
1429
1769
|
|
1430
|
-
#
|
1770
|
+
# Returns the port number of the proxy host, or +nil+ if none;
|
1771
|
+
# see Net::HTTP@Proxy+Server.
|
1431
1772
|
attr_reader :proxy_port
|
1432
1773
|
|
1433
|
-
#
|
1774
|
+
# Returns the user name for accessing the proxy, or +nil+ if none;
|
1775
|
+
# see Net::HTTP@Proxy+Server.
|
1434
1776
|
attr_reader :proxy_user
|
1435
1777
|
|
1436
|
-
#
|
1437
|
-
#
|
1778
|
+
# Returns the password for accessing the proxy, or +nil+ if none;
|
1779
|
+
# see Net::HTTP@Proxy+Server.
|
1438
1780
|
attr_reader :proxy_pass
|
1439
1781
|
end
|
1440
1782
|
|
1441
|
-
#
|
1783
|
+
# Returns +true+ if a proxy server is defined, +false+ otherwise;
|
1784
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1442
1785
|
def proxy?
|
1443
1786
|
!!(@proxy_from_env ? proxy_uri : @proxy_address)
|
1444
1787
|
end
|
1445
1788
|
|
1446
|
-
#
|
1789
|
+
# Returns +true+ if the proxy server is defined in the environment,
|
1790
|
+
# +false+ otherwise;
|
1791
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1447
1792
|
def proxy_from_env?
|
1448
1793
|
@proxy_from_env
|
1449
1794
|
end
|
@@ -1452,12 +1797,13 @@ module Net #:nodoc:
|
|
1452
1797
|
def proxy_uri # :nodoc:
|
1453
1798
|
return if @proxy_uri == false
|
1454
1799
|
@proxy_uri ||= URI::HTTP.new(
|
1455
|
-
"http"
|
1800
|
+
"http", nil, address, port, nil, nil, nil, nil, nil
|
1456
1801
|
).find_proxy || false
|
1457
1802
|
@proxy_uri || nil
|
1458
1803
|
end
|
1459
1804
|
|
1460
|
-
#
|
1805
|
+
# Returns the address of the proxy server, if defined, +nil+ otherwise;
|
1806
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1461
1807
|
def proxy_address
|
1462
1808
|
if @proxy_from_env then
|
1463
1809
|
proxy_uri&.hostname
|
@@ -1466,7 +1812,8 @@ module Net #:nodoc:
|
|
1466
1812
|
end
|
1467
1813
|
end
|
1468
1814
|
|
1469
|
-
#
|
1815
|
+
# Returns the port number of the proxy server, if defined, +nil+ otherwise;
|
1816
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1470
1817
|
def proxy_port
|
1471
1818
|
if @proxy_from_env then
|
1472
1819
|
proxy_uri&.port
|
@@ -1475,7 +1822,8 @@ module Net #:nodoc:
|
|
1475
1822
|
end
|
1476
1823
|
end
|
1477
1824
|
|
1478
|
-
#
|
1825
|
+
# Returns the user name of the proxy server, if defined, +nil+ otherwise;
|
1826
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1479
1827
|
def proxy_user
|
1480
1828
|
if @proxy_from_env
|
1481
1829
|
user = proxy_uri&.user
|
@@ -1485,7 +1833,8 @@ module Net #:nodoc:
|
|
1485
1833
|
end
|
1486
1834
|
end
|
1487
1835
|
|
1488
|
-
#
|
1836
|
+
# Returns the password of the proxy server, if defined, +nil+ otherwise;
|
1837
|
+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
|
1489
1838
|
def proxy_pass
|
1490
1839
|
if @proxy_from_env
|
1491
1840
|
pass = proxy_uri&.password
|
@@ -1533,45 +1882,38 @@ module Net #:nodoc:
|
|
1533
1882
|
|
1534
1883
|
public
|
1535
1884
|
|
1536
|
-
#
|
1537
|
-
#
|
1885
|
+
# :call-seq:
|
1886
|
+
# get(path, initheader = nil) {|res| ... }
|
1538
1887
|
#
|
1539
|
-
#
|
1540
|
-
#
|
1541
|
-
# If +initheader+ doesn't have the key 'accept-encoding', then
|
1542
|
-
# a value of "gzip;q=1.0,deflate;q=0.6,identity;q=0.3" is used,
|
1543
|
-
# so that gzip compression is used in preference to deflate
|
1544
|
-
# compression, which is used in preference to no compression.
|
1545
|
-
# Ruby doesn't have libraries to support the compress (Lempel-Ziv)
|
1546
|
-
# compression, so that is not supported. The intent of this is
|
1547
|
-
# to reduce bandwidth by default. If this routine sets up
|
1548
|
-
# compression, then it does the decompression also, removing
|
1549
|
-
# the header as well to prevent confusion. Otherwise
|
1550
|
-
# it leaves the body as it found it.
|
1888
|
+
# Sends a GET request to the server;
|
1889
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1551
1890
|
#
|
1552
|
-
#
|
1891
|
+
# The request is based on the Net::HTTP::Get object
|
1892
|
+
# created from string +path+ and initial headers hash +initheader+.
|
1553
1893
|
#
|
1554
|
-
#
|
1555
|
-
# entity body in turn as a string as it is read from
|
1556
|
-
# the socket. Note that in this case, the returned response
|
1557
|
-
# object will *not* contain a (meaningful) body.
|
1894
|
+
# With a block given, calls the block with the response body:
|
1558
1895
|
#
|
1559
|
-
#
|
1560
|
-
#
|
1896
|
+
# http = Net::HTTP.new(hostname)
|
1897
|
+
# http.get('/todos/1') do |res|
|
1898
|
+
# p res
|
1899
|
+
# end # => #<Net::HTTPOK 200 OK readbody=true>
|
1561
1900
|
#
|
1562
|
-
#
|
1901
|
+
# Output:
|
1902
|
+
#
|
1903
|
+
# "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false\n}"
|
1904
|
+
#
|
1905
|
+
# With no block given, simply returns the response object:
|
1563
1906
|
#
|
1564
|
-
#
|
1907
|
+
# http.get('/') # => #<Net::HTTPOK 200 OK readbody=true>
|
1565
1908
|
#
|
1566
|
-
#
|
1567
|
-
#
|
1568
|
-
#
|
1569
|
-
#
|
1570
|
-
# end
|
1571
|
-
# }
|
1909
|
+
# Related:
|
1910
|
+
#
|
1911
|
+
# - Net::HTTP::Get: request class for \HTTP method GET.
|
1912
|
+
# - Net::HTTP.get: sends GET request, returns response body.
|
1572
1913
|
#
|
1573
1914
|
def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+
|
1574
1915
|
res = nil
|
1916
|
+
|
1575
1917
|
request(Get.new(path, initheader)) {|r|
|
1576
1918
|
r.read_body dest, &block
|
1577
1919
|
res = r
|
@@ -1579,198 +1921,312 @@ module Net #:nodoc:
|
|
1579
1921
|
res
|
1580
1922
|
end
|
1581
1923
|
|
1582
|
-
#
|
1583
|
-
#
|
1924
|
+
# Sends a HEAD request to the server;
|
1925
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1584
1926
|
#
|
1585
|
-
#
|
1927
|
+
# The request is based on the Net::HTTP::Head object
|
1928
|
+
# created from string +path+ and initial headers hash +initheader+:
|
1586
1929
|
#
|
1587
|
-
#
|
1588
|
-
#
|
1589
|
-
#
|
1590
|
-
#
|
1591
|
-
#
|
1592
|
-
#
|
1593
|
-
#
|
1930
|
+
# res = http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
|
1931
|
+
# res.body # => nil
|
1932
|
+
# res.to_hash.take(3)
|
1933
|
+
# # =>
|
1934
|
+
# [["date", ["Wed, 15 Feb 2023 15:25:42 GMT"]],
|
1935
|
+
# ["content-type", ["application/json; charset=utf-8"]],
|
1936
|
+
# ["connection", ["close"]]]
|
1594
1937
|
#
|
1595
1938
|
def head(path, initheader = nil)
|
1596
1939
|
request(Head.new(path, initheader))
|
1597
1940
|
end
|
1598
1941
|
|
1599
|
-
#
|
1600
|
-
#
|
1942
|
+
# :call-seq:
|
1943
|
+
# post(path, data, initheader = nil) {|res| ... }
|
1944
|
+
#
|
1945
|
+
# Sends a POST request to the server;
|
1946
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1601
1947
|
#
|
1602
|
-
#
|
1948
|
+
# The request is based on the Net::HTTP::Post object
|
1949
|
+
# created from string +path+, string +data+, and initial headers hash +initheader+.
|
1950
|
+
#
|
1951
|
+
# With a block given, calls the block with the response body:
|
1952
|
+
#
|
1953
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
1954
|
+
# http = Net::HTTP.new(hostname)
|
1955
|
+
# http.post('/todos', data) do |res|
|
1956
|
+
# p res
|
1957
|
+
# end # => #<Net::HTTPCreated 201 Created readbody=true>
|
1603
1958
|
#
|
1604
|
-
#
|
1605
|
-
# entity body in turn as a string as it is read from
|
1606
|
-
# the socket. Note that in this case, the returned response
|
1607
|
-
# object will *not* contain a (meaningful) body.
|
1959
|
+
# Output:
|
1608
1960
|
#
|
1609
|
-
#
|
1610
|
-
# It still works but you must not use it.
|
1961
|
+
# "{\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n \"id\": 201\n}"
|
1611
1962
|
#
|
1612
|
-
#
|
1963
|
+
# With no block given, simply returns the response object:
|
1613
1964
|
#
|
1614
|
-
#
|
1965
|
+
# http.post('/todos', data) # => #<Net::HTTPCreated 201 Created readbody=true>
|
1615
1966
|
#
|
1616
|
-
#
|
1617
|
-
# File.open('result.txt', 'w') {|f|
|
1618
|
-
# http.post('/cgi-bin/search.rb', 'query=foo') do |str|
|
1619
|
-
# f.write str
|
1620
|
-
# end
|
1621
|
-
# }
|
1967
|
+
# Related:
|
1622
1968
|
#
|
1623
|
-
#
|
1624
|
-
#
|
1625
|
-
# "application/x-www-form-urlencoded" by default.
|
1969
|
+
# - Net::HTTP::Post: request class for \HTTP method POST.
|
1970
|
+
# - Net::HTTP.post: sends POST request, returns response body.
|
1626
1971
|
#
|
1627
1972
|
def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
|
1628
1973
|
send_entity(path, data, initheader, dest, Post, &block)
|
1629
1974
|
end
|
1630
1975
|
|
1631
|
-
#
|
1632
|
-
#
|
1976
|
+
# :call-seq:
|
1977
|
+
# patch(path, data, initheader = nil) {|res| ... }
|
1978
|
+
#
|
1979
|
+
# Sends a PATCH request to the server;
|
1980
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1981
|
+
#
|
1982
|
+
# The request is based on the Net::HTTP::Patch object
|
1983
|
+
# created from string +path+, string +data+, and initial headers hash +initheader+.
|
1984
|
+
#
|
1985
|
+
# With a block given, calls the block with the response body:
|
1986
|
+
#
|
1987
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
1988
|
+
# http = Net::HTTP.new(hostname)
|
1989
|
+
# http.patch('/todos/1', data) do |res|
|
1990
|
+
# p res
|
1991
|
+
# end # => #<Net::HTTPOK 200 OK readbody=true>
|
1992
|
+
#
|
1993
|
+
# Output:
|
1994
|
+
#
|
1995
|
+
# "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false,\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\"\n}"
|
1996
|
+
#
|
1997
|
+
# With no block given, simply returns the response object:
|
1998
|
+
#
|
1999
|
+
# http.patch('/todos/1', data) # => #<Net::HTTPCreated 201 Created readbody=true>
|
2000
|
+
#
|
1633
2001
|
def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
|
1634
2002
|
send_entity(path, data, initheader, dest, Patch, &block)
|
1635
2003
|
end
|
1636
2004
|
|
1637
|
-
|
2005
|
+
# Sends a PUT request to the server;
|
2006
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2007
|
+
#
|
2008
|
+
# The request is based on the Net::HTTP::Put object
|
2009
|
+
# created from string +path+, string +data+, and initial headers hash +initheader+.
|
2010
|
+
#
|
2011
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2012
|
+
# http = Net::HTTP.new(hostname)
|
2013
|
+
# http.put('/todos/1', data) # => #<Net::HTTPOK 200 OK readbody=true>
|
2014
|
+
#
|
2015
|
+
def put(path, data, initheader = nil)
|
1638
2016
|
request(Put.new(path, initheader), data)
|
1639
2017
|
end
|
1640
2018
|
|
1641
|
-
# Sends a PROPPATCH request to the
|
1642
|
-
#
|
2019
|
+
# Sends a PROPPATCH request to the server;
|
2020
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2021
|
+
#
|
2022
|
+
# The request is based on the Net::HTTP::Proppatch object
|
2023
|
+
# created from string +path+, string +body+, and initial headers hash +initheader+.
|
2024
|
+
#
|
2025
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2026
|
+
# http = Net::HTTP.new(hostname)
|
2027
|
+
# http.proppatch('/todos/1', data)
|
2028
|
+
#
|
1643
2029
|
def proppatch(path, body, initheader = nil)
|
1644
2030
|
request(Proppatch.new(path, initheader), body)
|
1645
2031
|
end
|
1646
2032
|
|
1647
|
-
# Sends a LOCK request to the
|
1648
|
-
#
|
2033
|
+
# Sends a LOCK request to the server;
|
2034
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2035
|
+
#
|
2036
|
+
# The request is based on the Net::HTTP::Lock object
|
2037
|
+
# created from string +path+, string +body+, and initial headers hash +initheader+.
|
2038
|
+
#
|
2039
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2040
|
+
# http = Net::HTTP.new(hostname)
|
2041
|
+
# http.lock('/todos/1', data)
|
2042
|
+
#
|
1649
2043
|
def lock(path, body, initheader = nil)
|
1650
2044
|
request(Lock.new(path, initheader), body)
|
1651
2045
|
end
|
1652
2046
|
|
1653
|
-
# Sends
|
1654
|
-
#
|
2047
|
+
# Sends an UNLOCK request to the server;
|
2048
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2049
|
+
#
|
2050
|
+
# The request is based on the Net::HTTP::Unlock object
|
2051
|
+
# created from string +path+, string +body+, and initial headers hash +initheader+.
|
2052
|
+
#
|
2053
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2054
|
+
# http = Net::HTTP.new(hostname)
|
2055
|
+
# http.unlock('/todos/1', data)
|
2056
|
+
#
|
1655
2057
|
def unlock(path, body, initheader = nil)
|
1656
2058
|
request(Unlock.new(path, initheader), body)
|
1657
2059
|
end
|
1658
2060
|
|
1659
|
-
# Sends
|
1660
|
-
#
|
2061
|
+
# Sends an Options request to the server;
|
2062
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2063
|
+
#
|
2064
|
+
# The request is based on the Net::HTTP::Options object
|
2065
|
+
# created from string +path+ and initial headers hash +initheader+.
|
2066
|
+
#
|
2067
|
+
# http = Net::HTTP.new(hostname)
|
2068
|
+
# http.options('/')
|
2069
|
+
#
|
1661
2070
|
def options(path, initheader = nil)
|
1662
2071
|
request(Options.new(path, initheader))
|
1663
2072
|
end
|
1664
2073
|
|
1665
|
-
# Sends a PROPFIND request to the
|
1666
|
-
#
|
2074
|
+
# Sends a PROPFIND request to the server;
|
2075
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2076
|
+
#
|
2077
|
+
# The request is based on the Net::HTTP::Propfind object
|
2078
|
+
# created from string +path+, string +body+, and initial headers hash +initheader+.
|
2079
|
+
#
|
2080
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2081
|
+
# http = Net::HTTP.new(hostname)
|
2082
|
+
# http.propfind('/todos/1', data)
|
2083
|
+
#
|
1667
2084
|
def propfind(path, body = nil, initheader = {'Depth' => '0'})
|
1668
2085
|
request(Propfind.new(path, initheader), body)
|
1669
2086
|
end
|
1670
2087
|
|
1671
|
-
# Sends a DELETE request to the
|
1672
|
-
#
|
2088
|
+
# Sends a DELETE request to the server;
|
2089
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2090
|
+
#
|
2091
|
+
# The request is based on the Net::HTTP::Delete object
|
2092
|
+
# created from string +path+ and initial headers hash +initheader+.
|
2093
|
+
#
|
2094
|
+
# http = Net::HTTP.new(hostname)
|
2095
|
+
# http.delete('/todos/1')
|
2096
|
+
#
|
1673
2097
|
def delete(path, initheader = {'Depth' => 'Infinity'})
|
1674
2098
|
request(Delete.new(path, initheader))
|
1675
2099
|
end
|
1676
2100
|
|
1677
|
-
# Sends a MOVE request to the
|
1678
|
-
#
|
2101
|
+
# Sends a MOVE request to the server;
|
2102
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2103
|
+
#
|
2104
|
+
# The request is based on the Net::HTTP::Move object
|
2105
|
+
# created from string +path+ and initial headers hash +initheader+.
|
2106
|
+
#
|
2107
|
+
# http = Net::HTTP.new(hostname)
|
2108
|
+
# http.move('/todos/1')
|
2109
|
+
#
|
1679
2110
|
def move(path, initheader = nil)
|
1680
2111
|
request(Move.new(path, initheader))
|
1681
2112
|
end
|
1682
2113
|
|
1683
|
-
# Sends a COPY request to the
|
1684
|
-
#
|
2114
|
+
# Sends a COPY request to the server;
|
2115
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2116
|
+
#
|
2117
|
+
# The request is based on the Net::HTTP::Copy object
|
2118
|
+
# created from string +path+ and initial headers hash +initheader+.
|
2119
|
+
#
|
2120
|
+
# http = Net::HTTP.new(hostname)
|
2121
|
+
# http.copy('/todos/1')
|
2122
|
+
#
|
1685
2123
|
def copy(path, initheader = nil)
|
1686
2124
|
request(Copy.new(path, initheader))
|
1687
2125
|
end
|
1688
2126
|
|
1689
|
-
# Sends a MKCOL request to the
|
1690
|
-
#
|
2127
|
+
# Sends a MKCOL request to the server;
|
2128
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2129
|
+
#
|
2130
|
+
# The request is based on the Net::HTTP::Mkcol object
|
2131
|
+
# created from string +path+, string +body+, and initial headers hash +initheader+.
|
2132
|
+
#
|
2133
|
+
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
|
2134
|
+
# http.mkcol('/todos/1', data)
|
2135
|
+
# http = Net::HTTP.new(hostname)
|
2136
|
+
#
|
1691
2137
|
def mkcol(path, body = nil, initheader = nil)
|
1692
2138
|
request(Mkcol.new(path, initheader), body)
|
1693
2139
|
end
|
1694
2140
|
|
1695
|
-
# Sends a TRACE request to the
|
1696
|
-
#
|
2141
|
+
# Sends a TRACE request to the server;
|
2142
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2143
|
+
#
|
2144
|
+
# The request is based on the Net::HTTP::Trace object
|
2145
|
+
# created from string +path+ and initial headers hash +initheader+.
|
2146
|
+
#
|
2147
|
+
# http = Net::HTTP.new(hostname)
|
2148
|
+
# http.trace('/todos/1')
|
2149
|
+
#
|
1697
2150
|
def trace(path, initheader = nil)
|
1698
2151
|
request(Trace.new(path, initheader))
|
1699
2152
|
end
|
1700
2153
|
|
1701
|
-
# Sends a GET request to the
|
1702
|
-
#
|
2154
|
+
# Sends a GET request to the server;
|
2155
|
+
# forms the response into a Net::HTTPResponse object.
|
1703
2156
|
#
|
1704
|
-
#
|
1705
|
-
#
|
1706
|
-
# the block can process it using HTTPResponse#read_body,
|
1707
|
-
# if desired.
|
2157
|
+
# The request is based on the Net::HTTP::Get object
|
2158
|
+
# created from string +path+ and initial headers hash +initheader+.
|
1708
2159
|
#
|
1709
|
-
#
|
2160
|
+
# With no block given, returns the response object:
|
1710
2161
|
#
|
1711
|
-
#
|
2162
|
+
# http = Net::HTTP.new(hostname)
|
2163
|
+
# http.request_get('/todos') # => #<Net::HTTPOK 200 OK readbody=true>
|
1712
2164
|
#
|
1713
|
-
#
|
1714
|
-
#
|
1715
|
-
# p response['content-type']
|
1716
|
-
# puts response.body
|
2165
|
+
# With a block given, calls the block with the response object
|
2166
|
+
# and returns the response object:
|
1717
2167
|
#
|
1718
|
-
#
|
1719
|
-
#
|
1720
|
-
#
|
1721
|
-
#
|
1722
|
-
#
|
1723
|
-
#
|
1724
|
-
#
|
2168
|
+
# http.request_get('/todos') do |res|
|
2169
|
+
# p res
|
2170
|
+
# end # => #<Net::HTTPOK 200 OK readbody=true>
|
2171
|
+
#
|
2172
|
+
# Output:
|
2173
|
+
#
|
2174
|
+
# #<Net::HTTPOK 200 OK readbody=false>
|
1725
2175
|
#
|
1726
2176
|
def request_get(path, initheader = nil, &block) # :yield: +response+
|
1727
2177
|
request(Get.new(path, initheader), &block)
|
1728
2178
|
end
|
1729
2179
|
|
1730
|
-
# Sends a HEAD request to the
|
1731
|
-
#
|
1732
|
-
#
|
1733
|
-
# Returns the response.
|
2180
|
+
# Sends a HEAD request to the server;
|
2181
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1734
2182
|
#
|
1735
|
-
#
|
2183
|
+
# The request is based on the Net::HTTP::Head object
|
2184
|
+
# created from string +path+ and initial headers hash +initheader+.
|
1736
2185
|
#
|
1737
|
-
#
|
1738
|
-
#
|
2186
|
+
# http = Net::HTTP.new(hostname)
|
2187
|
+
# http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
|
1739
2188
|
#
|
1740
2189
|
def request_head(path, initheader = nil, &block)
|
1741
2190
|
request(Head.new(path, initheader), &block)
|
1742
2191
|
end
|
1743
2192
|
|
1744
|
-
# Sends a POST request to the
|
2193
|
+
# Sends a POST request to the server;
|
2194
|
+
# forms the response into a Net::HTTPResponse object.
|
2195
|
+
#
|
2196
|
+
# The request is based on the Net::HTTP::Post object
|
2197
|
+
# created from string +path+, string +data+, and initial headers hash +initheader+.
|
1745
2198
|
#
|
1746
|
-
#
|
2199
|
+
# With no block given, returns the response object:
|
1747
2200
|
#
|
1748
|
-
#
|
1749
|
-
#
|
1750
|
-
#
|
2201
|
+
# http = Net::HTTP.new(hostname)
|
2202
|
+
# http.post('/todos', 'xyzzy')
|
2203
|
+
# # => #<Net::HTTPCreated 201 Created readbody=true>
|
1751
2204
|
#
|
1752
|
-
#
|
2205
|
+
# With a block given, calls the block with the response body
|
2206
|
+
# and returns the response object:
|
1753
2207
|
#
|
1754
|
-
#
|
2208
|
+
# http.post('/todos', 'xyzzy') do |res|
|
2209
|
+
# p res
|
2210
|
+
# end # => #<Net::HTTPCreated 201 Created readbody=true>
|
1755
2211
|
#
|
1756
|
-
#
|
1757
|
-
# response = http.request_post('/cgi-bin/nice.rb', 'datadatadata...')
|
1758
|
-
# p response.status
|
1759
|
-
# puts response.body # body is already read in this case
|
2212
|
+
# Output:
|
1760
2213
|
#
|
1761
|
-
#
|
1762
|
-
# http.request_post('/cgi-bin/nice.rb', 'datadatadata...') {|response|
|
1763
|
-
# p response.status
|
1764
|
-
# p response['content-type']
|
1765
|
-
# response.read_body do |str| # read body now
|
1766
|
-
# print str
|
1767
|
-
# end
|
1768
|
-
# }
|
2214
|
+
# "{\n \"xyzzy\": \"\",\n \"id\": 201\n}"
|
1769
2215
|
#
|
1770
2216
|
def request_post(path, data, initheader = nil, &block) # :yield: +response+
|
1771
2217
|
request Post.new(path, initheader), data, &block
|
1772
2218
|
end
|
1773
2219
|
|
2220
|
+
# Sends a PUT request to the server;
|
2221
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
2222
|
+
#
|
2223
|
+
# The request is based on the Net::HTTP::Put object
|
2224
|
+
# created from string +path+, string +data+, and initial headers hash +initheader+.
|
2225
|
+
#
|
2226
|
+
# http = Net::HTTP.new(hostname)
|
2227
|
+
# http.put('/todos/1', 'xyzzy')
|
2228
|
+
# # => #<Net::HTTPOK 200 OK readbody=true>
|
2229
|
+
#
|
1774
2230
|
def request_put(path, data, initheader = nil, &block) #:nodoc:
|
1775
2231
|
request Put.new(path, initheader), data, &block
|
1776
2232
|
end
|
@@ -1780,16 +2236,25 @@ module Net #:nodoc:
|
|
1780
2236
|
alias post2 request_post #:nodoc: obsolete
|
1781
2237
|
alias put2 request_put #:nodoc: obsolete
|
1782
2238
|
|
1783
|
-
|
1784
|
-
#
|
1785
|
-
# Also sends a DATA string if +data+ is given.
|
2239
|
+
# Sends an \HTTP request to the server;
|
2240
|
+
# returns an instance of a subclass of Net::HTTPResponse.
|
1786
2241
|
#
|
1787
|
-
#
|
2242
|
+
# The request is based on the Net::HTTPRequest object
|
2243
|
+
# created from string +path+, string +data+, and initial headers hash +header+.
|
2244
|
+
# That object is an instance of the
|
2245
|
+
# {subclass of Net::HTTPRequest}[rdoc-ref:Net::HTTPRequest@Request+Subclasses],
|
2246
|
+
# that corresponds to the given uppercase string +name+,
|
2247
|
+
# which must be
|
2248
|
+
# an {HTTP request method}[https://en.wikipedia.org/wiki/HTTP#Request_methods]
|
2249
|
+
# or a {WebDAV request method}[https://en.wikipedia.org/wiki/WebDAV#Implementation].
|
1788
2250
|
#
|
1789
|
-
#
|
2251
|
+
# Examples:
|
1790
2252
|
#
|
1791
|
-
#
|
1792
|
-
#
|
2253
|
+
# http = Net::HTTP.new(hostname)
|
2254
|
+
# http.send_request('GET', '/todos/1')
|
2255
|
+
# # => #<Net::HTTPOK 200 OK readbody=true>
|
2256
|
+
# http.send_request('POST', '/todos', 'xyzzy')
|
2257
|
+
# # => #<Net::HTTPCreated 201 Created readbody=true>
|
1793
2258
|
#
|
1794
2259
|
def send_request(name, path, data = nil, header = nil)
|
1795
2260
|
has_response_body = name != 'HEAD'
|
@@ -1797,20 +2262,35 @@ module Net #:nodoc:
|
|
1797
2262
|
request r, data
|
1798
2263
|
end
|
1799
2264
|
|
1800
|
-
# Sends
|
2265
|
+
# Sends the given request +req+ to the server;
|
2266
|
+
# forms the response into a Net::HTTPResponse object.
|
2267
|
+
#
|
2268
|
+
# The given +req+ must be an instance of a
|
2269
|
+
# {subclass of Net::HTTPRequest}[rdoc-ref:Net::HTTPRequest@Request+Subclasses].
|
2270
|
+
# Argument +body+ should be given only if needed for the request.
|
1801
2271
|
#
|
1802
|
-
#
|
1803
|
-
# data, the data is also sent. Providing data for a Net::HTTP::Head or
|
1804
|
-
# Net::HTTP::Get request results in an ArgumentError.
|
2272
|
+
# With no block given, returns the response object:
|
1805
2273
|
#
|
1806
|
-
#
|
2274
|
+
# http = Net::HTTP.new(hostname)
|
2275
|
+
#
|
2276
|
+
# req = Net::HTTP::Get.new('/todos/1')
|
2277
|
+
# http.request(req)
|
2278
|
+
# # => #<Net::HTTPOK 200 OK readbody=true>
|
2279
|
+
#
|
2280
|
+
# req = Net::HTTP::Post.new('/todos')
|
2281
|
+
# http.request(req, 'xyzzy')
|
2282
|
+
# # => #<Net::HTTPCreated 201 Created readbody=true>
|
1807
2283
|
#
|
1808
|
-
#
|
1809
|
-
#
|
1810
|
-
#
|
1811
|
-
#
|
2284
|
+
# With a block given, calls the block with the response and returns the response:
|
2285
|
+
#
|
2286
|
+
# req = Net::HTTP::Get.new('/todos/1')
|
2287
|
+
# http.request(req) do |res|
|
2288
|
+
# p res
|
2289
|
+
# end # => #<Net::HTTPOK 200 OK readbody=true>
|
2290
|
+
#
|
2291
|
+
# Output:
|
1812
2292
|
#
|
1813
|
-
#
|
2293
|
+
# #<Net::HTTPOK 200 OK readbody=false>
|
1814
2294
|
#
|
1815
2295
|
def request(req, body = nil, &block) # :yield: +response+
|
1816
2296
|
unless started?
|