Class: Net::HTTP::Persistent
- Inherits:
-
Object
- Object
- Net::HTTP::Persistent
- Defined in:
- lib/net/http/persistent.rb
Overview
Persistent connections for Net::HTTP
Net::HTTP::Persistent maintains persistent connections across all the servers you wish to talk to. For each host:port you communicate with a single persistent connection is created.
Connections will be shared across threads through a connection pool to increase reuse of connections.
You can shut down any remaining HTTP connections when done by calling #shutdown.
Example:
require 'net/http/persistent'
uri = URI 'http://example.com/awesome/web/service'
http = Net::HTTP::Persistent.new
# perform a GET
response = http.request uri
# or
get = Net::HTTP::Get.new uri.request_uri
response = http.request get
# create a POST
post_uri = uri + 'create'
post = Net::HTTP::Post.new post_uri.path
post.set_form_data 'some' => 'cool data'
# perform the POST, the URI is always required
response http.request post_uri, post
Note that for GET, HEAD and other requests that do not have a body you want to use URI#request_uri not URI#path. The request_uri contains the query params which are sent in the body for other requests.
TLS/SSL
TLS connections are automatically created depending upon the scheme of the URI. TLS connections are automatically verified against the default certificate store for your computer. You can override this by changing verify_mode or by specifying an alternate cert_store.
Here are the TLS settings, see the individual methods for documentation:
- #certificate
-
This client’s certificate
- #ca_file
-
The certificate-authorities
- #ca_path
-
Directory with certificate-authorities
- #cert_store
-
An SSL certificate store
- #ciphers
-
List of SSl ciphers allowed
- #extra_chain_cert
-
Extra certificates to be added to the certificate chain
- #private_key
-
The client’s SSL private key
- #reuse_ssl_sessions
-
Reuse a previously opened SSL session for a new connection
- #ssl_timeout
-
Session lifetime
- #ssl_version
-
Which specific SSL version to use
- #verify_callback
-
For server certificate verification
- #verify_depth
-
Depth of certificate verification
- #verify_mode
-
How connections should be verified
- #verify_hostname
-
Use hostname verification for server certificate during the handshake
Proxies
A proxy can be set through #proxy= or at initialization time by providing a second argument to ::new. The proxy may be the URI of the proxy server or :ENV
which will consult environment variables.
See #proxy= and #proxy_from_env for details.
Headers
Headers may be specified for use in every request. #headers are appended to any headers on the request. #override_headers replace existing headers on the request.
The difference between the two can be seen in setting the User-Agent. Using http.headers['User-Agent'] = 'MyUserAgent'
will send “Ruby, MyUserAgent” while http.override_headers['User-Agent'] = 'MyUserAgent'
will send “MyUserAgent”.
Tuning
Segregation
Each Net::HTTP::Persistent instance has its own pool of connections. There is no sharing with other instances (as was true in earlier versions).
Idle Timeout
If a connection hasn’t been used for this number of seconds it will automatically be reset upon the next use to avoid attempting to send to a closed connection. The default value is 5 seconds. nil means no timeout. Set through #idle_timeout.
Reducing this value may help avoid the “too many connection resets” error when sending non-idempotent requests while increasing this value will cause fewer round-trips.
Read Timeout
The amount of time allowed between reading two chunks from the socket. Set through #read_timeout
Max Requests
The number of requests that should be made before opening a new connection. Typically many keep-alive capable servers tune this to 100 or less, so the 101st request will fail with ECONNRESET. If unset (default), this value has no effect, if set, connections will be reset on the request after max_requests.
Open Timeout
The amount of time to wait for a connection to be opened. Set through #open_timeout.
Socket Options
Socket options may be set on newly-created connections. See #socket_options for details.
Connection Termination
If you are done using the Net::HTTP::Persistent instance you may shut down all the connections in the current thread with #shutdown. This is not recommended for normal use, it should only be used when it will be several minutes before you make another HTTP request.
If you are using multiple threads, call #shutdown in each thread when the thread is done making requests. If you don’t call shutdown, that’s OK. Ruby will automatically garbage collect and shutdown your HTTP connections when the thread terminates.
Defined Under Namespace
Classes: Error
Constant Summary collapse
- EPOCH =
The beginning of Time
Time.at 0
- HAVE_OPENSSL =
Is OpenSSL available? This test works with autoload
defined? OpenSSL::SSL # :nodoc:
- DEFAULT_POOL_SIZE =
256
- VERSION =
The version of Net::HTTP::Persistent you are using
'4.0.5'
Instance Attribute Summary collapse
-
#ca_file ⇒ Object
An SSL certificate authority.
-
#ca_path ⇒ Object
A directory of SSL certificates to be used as certificate authorities.
-
#cert_store ⇒ Object
An SSL certificate store.
-
#certificate ⇒ Object
(also: #cert)
This client’s OpenSSL::X509::Certificate.
-
#ciphers ⇒ Object
The ciphers allowed for SSL connections.
-
#debug_output ⇒ Object
Sends debug_output to this IO via Net::HTTP#set_debug_output.
-
#extra_chain_cert ⇒ Object
Extra certificates to be added to the certificate chain.
-
#generation ⇒ Object
readonly
Current connection generation.
-
#headers ⇒ Object
readonly
Headers that are added to every request using Net::HTTP#add_field.
-
#http_versions ⇒ Object
readonly
Maps host:port to an HTTP version.
-
#idle_timeout ⇒ Object
Maximum time an unused connection can remain idle before being automatically closed.
-
#keep_alive ⇒ Object
The value sent in the Keep-Alive header.
-
#max_requests ⇒ Object
Maximum number of requests on a connection before it is considered expired and automatically closed.
-
#max_retries ⇒ Object
Number of retries to perform if a request fails.
-
#max_version ⇒ Object
Maximum SSL version to use, e.g.
-
#min_version ⇒ Object
Minimum SSL version to use, e.g.
-
#name ⇒ Object
readonly
The name for this collection of persistent connections.
-
#no_proxy ⇒ Object
readonly
List of host suffixes which will not be proxied.
-
#open_timeout ⇒ Object
Seconds to wait until a connection is opened.
-
#override_headers ⇒ Object
readonly
Headers that are added to every request using Net::HTTP#[]=.
-
#pool ⇒ Object
readonly
Test-only accessor for the connection pool.
-
#private_key ⇒ Object
(also: #key)
This client’s SSL private key.
-
#proxy_uri ⇒ Object
readonly
The URL through which requests will be proxied.
-
#read_timeout ⇒ Object
Seconds to wait until reading one block.
-
#reuse_ssl_sessions ⇒ Object
By default SSL sessions are reused to avoid extra SSL handshakes.
-
#socket_options ⇒ Object
readonly
An array of options for Socket#setsockopt.
-
#ssl_generation ⇒ Object
readonly
Current SSL connection generation.
-
#ssl_timeout ⇒ Object
SSL session lifetime.
-
#ssl_version ⇒ Object
SSL version to use.
-
#timeout_key ⇒ Object
readonly
Where this instance’s last-use times live in the thread local variables.
-
#verify_callback ⇒ Object
SSL verification callback.
-
#verify_depth ⇒ Object
Sets the depth of SSL certificate verification.
-
#verify_hostname ⇒ Object
HTTPS verify_hostname.
-
#verify_mode ⇒ Object
HTTPS verify mode.
-
#write_timeout ⇒ Object
Seconds to wait until writing one block.
Class Method Summary collapse
-
.detect_idle_timeout(uri, max = 10) ⇒ Object
Use this method to detect the idle timeout of the host at
uri
.
Instance Method Summary collapse
-
#connection_for(uri) ⇒ Object
Creates a new connection for
uri
. -
#escape(str) ⇒ Object
CGI::escape wrapper.
-
#expired?(connection) ⇒ Boolean
Returns true if the connection should be reset due to an idle timeout, or maximum request count, false otherwise.
-
#finish(connection) ⇒ Object
Finishes the Net::HTTP
connection
. -
#http_version(uri) ⇒ Object
Returns the HTTP protocol version for
uri
. -
#initialize(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ Persistent
constructor
Creates a new Net::HTTP::Persistent.
-
#normalize_uri(uri) ⇒ Object
Adds “http://” to the String
uri
if it is missing. -
#pipeline(uri, requests, &block) ⇒ Object
Pipelines
requests
to the HTTP server aturi
yielding responses if a block is given. -
#proxy=(proxy) ⇒ Object
Sets the proxy server.
-
#proxy_bypass?(host, port) ⇒ Boolean
Returns true when proxy should by bypassed for host.
-
#proxy_from_env ⇒ Object
Creates a URI for an HTTP proxy server from ENV variables.
-
#reconnect ⇒ Object
Forces reconnection of all HTTP connections, including TLS/SSL connections.
-
#reconnect_ssl ⇒ Object
Forces reconnection of only TLS/SSL connections.
-
#request(uri, req = nil, &block) ⇒ Object
Makes a request on
uri
. -
#request_setup(req_or_uri) ⇒ Object
Creates a GET request if
req_or_uri
is a URI and adds headers to the request. -
#reset(connection) ⇒ Object
Finishes then restarts the Net::HTTP
connection
. -
#shutdown ⇒ Object
Shuts down all connections.
-
#ssl(connection) ⇒ Object
Enables SSL on
connection
. -
#start(http) ⇒ Object
Starts the Net::HTTP
connection
. -
#unescape(str) ⇒ Object
CGI::unescape wrapper.
Constructor Details
#initialize(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ Persistent
Creates a new Net::HTTP::Persistent.
Set a name
for fun. Your library name should be good enough, but this otherwise has no purpose.
proxy
may be set to a URI::HTTP or :ENV to pick up proxy options from the environment. See proxy_from_env for details.
In order to use a URI for the proxy you may need to do some extra work beyond URI parsing if the proxy requires a password:
proxy = URI 'http://proxy.example'
proxy.user = 'AzureDiamond'
proxy.password = 'hunter2'
Set pool_size
to limit the maximum number of connections allowed. Defaults to 1/4 the number of allowed file handles or 256 if your OS does not support a limit on allowed file handles. You can have no more than this many threads with active HTTP transactions.
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
# File 'lib/net/http/persistent.rb', line 501 def initialize name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE @name = name @debug_output = nil @proxy_uri = nil @no_proxy = [] @headers = {} @override_headers = {} @http_versions = {} @keep_alive = 30 @open_timeout = nil @read_timeout = nil @write_timeout = nil @idle_timeout = 5 @max_requests = nil @max_retries = 1 @socket_options = [] @ssl_generation = 0 # incremented when SSL session variables change @socket_options << [Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1] if Socket.const_defined? :TCP_NODELAY @pool = Net::HTTP::Persistent::Pool.new size: pool_size do |http_args| Net::HTTP::Persistent::Connection.new Net::HTTP, http_args, @ssl_generation end @certificate = nil @ca_file = nil @ca_path = nil @ciphers = nil @private_key = nil @ssl_timeout = nil @ssl_version = nil @min_version = nil @max_version = nil @verify_callback = nil @verify_depth = nil @verify_mode = nil @verify_hostname = nil @cert_store = nil @generation = 0 # incremented when proxy URI changes if HAVE_OPENSSL then @verify_mode = OpenSSL::SSL::VERIFY_PEER @reuse_ssl_sessions = OpenSSL::SSL.const_defined? :Session end self.proxy = proxy if proxy end |
Instance Attribute Details
#ca_file ⇒ Object
An SSL certificate authority. Setting this will set verify_mode to VERIFY_PEER.
257 258 259 |
# File 'lib/net/http/persistent.rb', line 257 def ca_file @ca_file end |
#ca_path ⇒ Object
A directory of SSL certificates to be used as certificate authorities. Setting this will set verify_mode to VERIFY_PEER.
263 264 265 |
# File 'lib/net/http/persistent.rb', line 263 def ca_path @ca_path end |
#cert_store ⇒ Object
An SSL certificate store. Setting this will override the default certificate store. See verify_mode for more information.
269 270 271 |
# File 'lib/net/http/persistent.rb', line 269 def cert_store @cert_store end |
#certificate ⇒ Object Also known as: cert
This client’s OpenSSL::X509::Certificate
246 247 248 |
# File 'lib/net/http/persistent.rb', line 246 def certificate @certificate end |
#ciphers ⇒ Object
The ciphers allowed for SSL connections
274 275 276 |
# File 'lib/net/http/persistent.rb', line 274 def ciphers @ciphers end |
#debug_output ⇒ Object
Sends debug_output to this IO via Net::HTTP#set_debug_output.
Never use this method in production code, it causes a serious security hole.
287 288 289 |
# File 'lib/net/http/persistent.rb', line 287 def debug_output @debug_output end |
#extra_chain_cert ⇒ Object
Extra certificates to be added to the certificate chain
279 280 281 |
# File 'lib/net/http/persistent.rb', line 279 def extra_chain_cert @extra_chain_cert end |
#generation ⇒ Object (readonly)
Current connection generation
292 293 294 |
# File 'lib/net/http/persistent.rb', line 292 def generation @generation end |
#headers ⇒ Object (readonly)
Headers that are added to every request using Net::HTTP#add_field
297 298 299 |
# File 'lib/net/http/persistent.rb', line 297 def headers @headers end |
#http_versions ⇒ Object (readonly)
Maps host:port to an HTTP version. This allows us to enable version specific features.
303 304 305 |
# File 'lib/net/http/persistent.rb', line 303 def http_versions @http_versions end |
#idle_timeout ⇒ Object
Maximum time an unused connection can remain idle before being automatically closed.
309 310 311 |
# File 'lib/net/http/persistent.rb', line 309 def idle_timeout @idle_timeout end |
#keep_alive ⇒ Object
The value sent in the Keep-Alive header. Defaults to 30. Not needed for HTTP/1.1 servers.
This may not work correctly for HTTP/1.0 servers
This method may be removed in a future version as RFC 2616 does not require this header.
333 334 335 |
# File 'lib/net/http/persistent.rb', line 333 def keep_alive @keep_alive end |
#max_requests ⇒ Object
Maximum number of requests on a connection before it is considered expired and automatically closed.
315 316 317 |
# File 'lib/net/http/persistent.rb', line 315 def max_requests @max_requests end |
#max_retries ⇒ Object
Number of retries to perform if a request fails.
See also #max_retries=, Net::HTTP#max_retries=.
322 323 324 |
# File 'lib/net/http/persistent.rb', line 322 def max_retries @max_retries end |
#max_version ⇒ Object
Maximum SSL version to use, e.g. :TLS1_2
By default, the version will be negotiated automatically between client and server. Ruby 2.5 and newer only.
437 438 439 |
# File 'lib/net/http/persistent.rb', line 437 def max_version @max_version end |
#min_version ⇒ Object
Minimum SSL version to use, e.g. :TLS1_1
By default, the version will be negotiated automatically between client and server. Ruby 2.5 and newer only.
429 430 431 |
# File 'lib/net/http/persistent.rb', line 429 def min_version @min_version end |
#name ⇒ Object (readonly)
The name for this collection of persistent connections.
338 339 340 |
# File 'lib/net/http/persistent.rb', line 338 def name @name end |
#no_proxy ⇒ Object (readonly)
List of host suffixes which will not be proxied
368 369 370 |
# File 'lib/net/http/persistent.rb', line 368 def no_proxy @no_proxy end |
#open_timeout ⇒ Object
Seconds to wait until a connection is opened. See Net::HTTP#open_timeout
343 344 345 |
# File 'lib/net/http/persistent.rb', line 343 def open_timeout @open_timeout end |
#override_headers ⇒ Object (readonly)
Headers that are added to every request using Net::HTTP#[]=
348 349 350 |
# File 'lib/net/http/persistent.rb', line 348 def override_headers @override_headers end |
#pool ⇒ Object (readonly)
Test-only accessor for the connection pool
373 374 375 |
# File 'lib/net/http/persistent.rb', line 373 def pool @pool end |
#private_key ⇒ Object Also known as: key
This client’s SSL private key
353 354 355 |
# File 'lib/net/http/persistent.rb', line 353 def private_key @private_key end |
#proxy_uri ⇒ Object (readonly)
The URL through which requests will be proxied
363 364 365 |
# File 'lib/net/http/persistent.rb', line 363 def proxy_uri @proxy_uri end |
#read_timeout ⇒ Object
Seconds to wait until reading one block. See Net::HTTP#read_timeout
378 379 380 |
# File 'lib/net/http/persistent.rb', line 378 def read_timeout @read_timeout end |
#reuse_ssl_sessions ⇒ Object
By default SSL sessions are reused to avoid extra SSL handshakes. Set this to false if you have problems communicating with an HTTPS server like:
SSL_connect [...] read finished A: unexpected message (OpenSSL::SSL::SSLError)
392 393 394 |
# File 'lib/net/http/persistent.rb', line 392 def reuse_ssl_sessions @reuse_ssl_sessions end |
#socket_options ⇒ Object (readonly)
An array of options for Socket#setsockopt.
By default the TCP_NODELAY option is set on sockets.
To set additional options append them to this array:
http. << [Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1]
403 404 405 |
# File 'lib/net/http/persistent.rb', line 403 def @socket_options end |
#ssl_generation ⇒ Object (readonly)
Current SSL connection generation
408 409 410 |
# File 'lib/net/http/persistent.rb', line 408 def ssl_generation @ssl_generation end |
#ssl_timeout ⇒ Object
SSL session lifetime
413 414 415 |
# File 'lib/net/http/persistent.rb', line 413 def ssl_timeout @ssl_timeout end |
#ssl_version ⇒ Object
SSL version to use.
By default, the version will be negotiated automatically between client and server. Ruby 1.9 and newer only. Deprecated since Ruby 2.5.
421 422 423 |
# File 'lib/net/http/persistent.rb', line 421 def ssl_version @ssl_version end |
#timeout_key ⇒ Object (readonly)
Where this instance’s last-use times live in the thread local variables
442 443 444 |
# File 'lib/net/http/persistent.rb', line 442 def timeout_key @timeout_key end |
#verify_callback ⇒ Object
SSL verification callback. Used when ca_file or ca_path is set.
447 448 449 |
# File 'lib/net/http/persistent.rb', line 447 def verify_callback @verify_callback end |
#verify_depth ⇒ Object
Sets the depth of SSL certificate verification
452 453 454 |
# File 'lib/net/http/persistent.rb', line 452 def verify_depth @verify_depth end |
#verify_hostname ⇒ Object
HTTPS verify_hostname.
If a client sets this to true and enables SNI with SSLSocket#hostname=, the hostname verification on the server certificate is performed automatically during the handshake using OpenSSL::SSL.verify_certificate_identity().
You can set verify_hostname
as true to use hostname verification during the handshake.
NOTE: This works with Ruby > 3.0.
478 479 480 |
# File 'lib/net/http/persistent.rb', line 478 def verify_hostname @verify_hostname end |
#verify_mode ⇒ Object
HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER which verifies the server certificate.
If no ca_file, ca_path or cert_store is set the default system certificate store is used.
You can use verify_mode
to override any default values.
463 464 465 |
# File 'lib/net/http/persistent.rb', line 463 def verify_mode @verify_mode end |
#write_timeout ⇒ Object
Seconds to wait until writing one block. See Net::HTTP#write_timeout
383 384 385 |
# File 'lib/net/http/persistent.rb', line 383 def write_timeout @write_timeout end |
Class Method Details
.detect_idle_timeout(uri, max = 10) ⇒ Object
Use this method to detect the idle timeout of the host at uri
. The value returned can be used to configure #idle_timeout. max
controls the maximum idle timeout to detect.
After
Idle timeout detection is performed by creating a connection then performing a HEAD request in a loop until the connection terminates waiting one additional second per loop.
NOTE: This may not work on ruby > 1.9.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/net/http/persistent.rb', line 207 def self.detect_idle_timeout uri, max = 10 uri = URI uri unless URI::Generic === uri uri += '/' req = Net::HTTP::Head.new uri.request_uri http = new 'net-http-persistent detect_idle_timeout' http.connection_for uri do |connection| sleep_time = 0 http = connection.http loop do response = http.request req $stderr.puts "HEAD #{uri} => #{response.code}" if $DEBUG unless Net::HTTPOK === response then raise Error, "bad response code #{response.code} detecting idle timeout" end break if sleep_time >= max sleep_time += 1 $stderr.puts "sleeping #{sleep_time}" if $DEBUG sleep sleep_time end end rescue # ignore StandardErrors, we've probably found the idle timeout. ensure return sleep_time unless $! end |
Instance Method Details
#connection_for(uri) ⇒ Object
Creates a new connection for uri
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'lib/net/http/persistent.rb', line 619 def connection_for uri use_ssl = uri.scheme.downcase == 'https' net_http_args = [uri.hostname, uri.port] # I'm unsure if uri.host or uri.hostname should be checked against # the proxy bypass list. if @proxy_uri and not proxy_bypass? uri.host, uri.port then net_http_args.concat @proxy_args else net_http_args.concat [nil, nil, nil, nil] end connection = @pool.checkout net_http_args http = connection.http connection.ressl @ssl_generation if connection.ssl_generation != @ssl_generation if not http.started? then ssl http if use_ssl start http elsif expired? connection then reset connection end http.keep_alive_timeout = @idle_timeout if @idle_timeout http.max_retries = @max_retries if http.respond_to?(:max_retries=) http.read_timeout = @read_timeout if @read_timeout http.write_timeout = @write_timeout if @write_timeout && http.respond_to?(:write_timeout=) return yield connection rescue Errno::ECONNREFUSED if http.proxy? address = http.proxy_address port = http.proxy_port else address = http.address port = http.port end raise Error, "connection refused: #{address}:#{port}" rescue Errno::EHOSTDOWN if http.proxy? address = http.proxy_address port = http.proxy_port else address = http.address port = http.port end raise Error, "host down: #{address}:#{port}" ensure @pool.checkin net_http_args end |
#escape(str) ⇒ Object
CGI::escape wrapper
680 681 682 |
# File 'lib/net/http/persistent.rb', line 680 def escape str CGI.escape str if str end |
#expired?(connection) ⇒ Boolean
Returns true if the connection should be reset due to an idle timeout, or maximum request count, false otherwise.
696 697 698 699 700 701 702 |
# File 'lib/net/http/persistent.rb', line 696 def expired? connection return true if @max_requests && connection.requests >= @max_requests return false unless @idle_timeout return true if @idle_timeout.zero? Time.now - connection.last_use > @idle_timeout end |
#finish(connection) ⇒ Object
Finishes the Net::HTTP connection
725 726 727 728 729 730 731 |
# File 'lib/net/http/persistent.rb', line 725 def finish connection connection.finish connection.http.instance_variable_set :@last_communicated, nil connection.http.instance_variable_set :@ssl_session, nil unless @reuse_ssl_sessions end |
#http_version(uri) ⇒ Object
Returns the HTTP protocol version for uri
736 737 738 |
# File 'lib/net/http/persistent.rb', line 736 def http_version uri @http_versions["#{uri.hostname}:#{uri.port}"] end |
#normalize_uri(uri) ⇒ Object
Adds “http://” to the String uri
if it is missing.
743 744 745 |
# File 'lib/net/http/persistent.rb', line 743 def normalize_uri uri (uri =~ /^https?:/) ? uri : "http://#{uri}" end |
#pipeline(uri, requests, &block) ⇒ Object
Pipelines requests
to the HTTP server at uri
yielding responses if a block is given. Returns all responses received.
See Net::HTTP::Pipeline for further details.
Only if net-http-pipeline
was required before net-http-persistent
#pipeline will be present.
775 776 777 778 779 |
# File 'lib/net/http/persistent.rb', line 775 def pipeline uri, requests, &block # :yields: responses connection_for uri do |connection| connection.http.pipeline requests, &block end end |
#proxy=(proxy) ⇒ Object
Sets the proxy server. The proxy
may be the URI of the proxy server, the symbol :ENV
which will read the proxy from the environment or nil to disable use of a proxy. See #proxy_from_env for details on setting the proxy from the environment.
If the proxy URI is set after requests have been made, the next request will shut-down and re-open all connections.
The no_proxy
query parameter can be used to specify hosts which shouldn’t be reached via proxy; if set it should be a comma separated list of hostname suffixes, optionally with :port
appended, for example example.com,some.host:8080
.
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 |
# File 'lib/net/http/persistent.rb', line 807 def proxy= proxy @proxy_uri = case proxy when :ENV then proxy_from_env when URI::HTTP then proxy when nil then # ignore else raise ArgumentError, 'proxy must be :ENV or a URI::HTTP' end @no_proxy.clear if @proxy_uri then @proxy_args = [ @proxy_uri.hostname, @proxy_uri.port, unescape(@proxy_uri.user), unescape(@proxy_uri.password), ] @proxy_connection_id = [nil, *@proxy_args].join ':' if @proxy_uri.query then @no_proxy = CGI.parse(@proxy_uri.query)['no_proxy'].join(',').downcase.split(',').map { |x| x.strip }.reject { |x| x.empty? } end end reconnect reconnect_ssl end |
#proxy_bypass?(host, port) ⇒ Boolean
Returns true when proxy should by bypassed for host.
881 882 883 884 885 886 887 888 889 890 891 |
# File 'lib/net/http/persistent.rb', line 881 def proxy_bypass? host, port host = host.downcase host_port = [host, port].join ':' @no_proxy.each do |name| return true if host[-name.length, name.length] == name or host_port[-name.length, name.length] == name end false end |
#proxy_from_env ⇒ Object
Creates a URI for an HTTP proxy server from ENV variables.
If HTTP_PROXY
is set a proxy will be returned.
If HTTP_PROXY_USER
or HTTP_PROXY_PASS
are set the URI is given the indicated user and password unless HTTP_PROXY contains either of these in the URI.
The NO_PROXY
ENV variable can be used to specify hosts which shouldn’t be reached via proxy; if set it should be a comma separated list of hostname suffixes, optionally with :port
appended, for example example.com,some.host:8080
. When set to *
no proxy will be returned.
For Windows users, lowercase ENV variables are preferred over uppercase ENV variables.
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 |
# File 'lib/net/http/persistent.rb', line 854 def proxy_from_env env_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY'] return nil if env_proxy.nil? or env_proxy.empty? uri = URI normalize_uri env_proxy env_no_proxy = ENV['no_proxy'] || ENV['NO_PROXY'] # '*' is special case for always bypass return nil if env_no_proxy == '*' if env_no_proxy then uri.query = "no_proxy=#{escape(env_no_proxy)}" end unless uri.user or uri.password then uri.user = escape ENV['http_proxy_user'] || ENV['HTTP_PROXY_USER'] uri.password = escape ENV['http_proxy_pass'] || ENV['HTTP_PROXY_PASS'] end uri end |
#reconnect ⇒ Object
Forces reconnection of all HTTP connections, including TLS/SSL connections.
897 898 899 |
# File 'lib/net/http/persistent.rb', line 897 def reconnect @generation += 1 end |
#reconnect_ssl ⇒ Object
Forces reconnection of only TLS/SSL connections.
904 905 906 |
# File 'lib/net/http/persistent.rb', line 904 def reconnect_ssl @ssl_generation += 1 end |
#request(uri, req = nil, &block) ⇒ Object
Makes a request on uri
. If req
is nil a Net::HTTP::Get is performed against uri
.
If a block is passed #request behaves like Net::HTTP#request (the body of the response will not have been read).
req
must be a Net::HTTPGenericRequest subclass (see Net::HTTP for a list).
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
# File 'lib/net/http/persistent.rb', line 936 def request uri, req = nil, &block uri = URI uri req = request_setup req || uri response = nil connection_for uri do |connection| http = connection.http begin connection.requests += 1 response = http.request req, &block if req.connection_close? or (response.http_version <= '1.0' and not response.connection_keep_alive?) or response.connection_close? then finish connection end rescue Exception # make sure to close the connection when it was interrupted finish connection raise ensure connection.last_use = Time.now end end @http_versions["#{uri.hostname}:#{uri.port}"] ||= response.http_version response end |
#request_setup(req_or_uri) ⇒ Object
Creates a GET request if req_or_uri
is a URI and adds headers to the request.
Returns the request.
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 |
# File 'lib/net/http/persistent.rb', line 975 def request_setup req_or_uri # :nodoc: req = if req_or_uri.respond_to? 'request_uri' then Net::HTTP::Get.new req_or_uri.request_uri else req_or_uri end @headers.each do |pair| req.add_field(*pair) end @override_headers.each do |name, value| req[name] = value end unless req['Connection'] then req.add_field 'Connection', 'keep-alive' req.add_field 'Keep-Alive', @keep_alive end req end |
#reset(connection) ⇒ Object
Finishes then restarts the Net::HTTP connection
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'lib/net/http/persistent.rb', line 911 def reset connection http = connection.http finish connection start http rescue Errno::ECONNREFUSED e = Error.new "connection refused: #{http.address}:#{http.port}" e.set_backtrace $@ raise e rescue Errno::EHOSTDOWN e = Error.new "host down: #{http.address}:#{http.port}" e.set_backtrace $@ raise e end |
#shutdown ⇒ Object
Shuts down all connections
NOTE: Calling shutdown for can be dangerous!
If any thread is still using a connection it may cause an error! Call #shutdown when you are completely done making requests!
1006 1007 1008 |
# File 'lib/net/http/persistent.rb', line 1006 def shutdown @pool.shutdown { |http| http.finish } end |
#ssl(connection) ⇒ Object
Enables SSL on connection
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 |
# File 'lib/net/http/persistent.rb', line 1013 def ssl connection connection.use_ssl = true connection.ciphers = @ciphers if @ciphers connection.ssl_timeout = @ssl_timeout if @ssl_timeout connection.ssl_version = @ssl_version if @ssl_version connection.min_version = @min_version if @min_version connection.max_version = @max_version if @max_version connection.verify_depth = @verify_depth connection.verify_mode = @verify_mode connection.verify_hostname = @verify_hostname if @verify_hostname != nil && connection.respond_to?(:verify_hostname=) if OpenSSL::SSL::VERIFY_PEER == OpenSSL::SSL::VERIFY_NONE and not Object.const_defined?(:I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG) then warn <<-WARNING !!!SECURITY WARNING!!! The SSL HTTP connection to: #{connection.address}:#{connection.port} !!!MAY NOT BE VERIFIED!!! On your platform your OpenSSL implementation is broken. There is no difference between the values of VERIFY_NONE and VERIFY_PEER. This means that attempting to verify the security of SSL connections may not work. This exposes you to man-in-the-middle exploits, snooping on the contents of your connection and other dangers to the security of your data. To disable this warning define the following constant at top-level in your application: I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG = nil WARNING end connection.ca_file = @ca_file if @ca_file connection.ca_path = @ca_path if @ca_path if @ca_file or @ca_path then connection.verify_mode = OpenSSL::SSL::VERIFY_PEER connection.verify_callback = @verify_callback if @verify_callback end if @certificate and @private_key then connection.cert = @certificate connection.key = @private_key end if defined?(@extra_chain_cert) and @extra_chain_cert connection.extra_chain_cert = @extra_chain_cert end connection.cert_store = if @cert_store then @cert_store else store = OpenSSL::X509::Store.new store.set_default_paths store end end |
#start(http) ⇒ Object
Starts the Net::HTTP connection
707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
# File 'lib/net/http/persistent.rb', line 707 def start http http.set_debug_output @debug_output if @debug_output http.open_timeout = @open_timeout if @open_timeout http.start socket = http.instance_variable_get :@socket if socket then # for fakeweb @socket_options.each do |option| socket.io.setsockopt(*option) end end end |
#unescape(str) ⇒ Object
CGI::unescape wrapper
687 688 689 |
# File 'lib/net/http/persistent.rb', line 687 def unescape str CGI.unescape str if str end |