Class: Net::HTTP::Persistent

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/vendor/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.

Multiple Net::HTTP::Persistent objects will share the same set of connections.

For each thread you start a new connection will be created. A Net::HTTP::Persistent connection will not be shared across threads.

You can shut down the HTTP connections when done by calling #shutdown. You should name your Net::HTTP::Persistent object if you intend to call this method.

Example:

require 'net/http/persistent'

uri = URI 'http://example.com/awesome/web/service'

http = Net::HTTP::Persistent.new 'my_app_name'

# perform a GET
response = http.request uri

# 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

SSL

SSL connections are automatically created depending upon the scheme of the URI. SSL 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 SSL settings, see the individual methods for documentation:

#certificate

This client's certificate

#ca_file

The certificate-authority

#cert_store

An SSL certificate store

#private_key

The client's SSL private key

#reuse_ssl_sessions

Reuse a previously opened SSL session for a new connection

#ssl_version

Which specific SSL version to use

#verify_callback

For server certificate verification

#verify_mode

How connections should be verified

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

By providing an application name to ::new you can separate your connections from the connections of other applications.

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

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.

Non-Idempotent Requests

By default non-idempotent requests will not be retried per RFC 2616. By setting retry_change_requests to true requests will automatically be retried once.

Only do this when you know that retrying a POST or other non-idempotent request is safe for your application and will not create duplicate resources.

The recommended way to handle non-idempotent requests is the following:

require 'net/http/persistent'

uri = URI 'http://example.com/awesome/web/service'
post_uri = uri + 'create'

http = Net::HTTP::Persistent.new 'my_app_name'

post = Net::HTTP::Post.new post_uri.path
# ... fill in POST request

begin
  response = http.request post_uri, post
rescue Net::HTTP::Persistent::Error

  # POST failed, make a new request to verify the server did not process
  # the request
  exists_uri = uri + '...'
  response = http.get exists_uri

  # Retry if it failed
  retry if response.code == '404'
end

The method of determining if the resource was created or not is unique to the particular service you are using. Of course, you will want to add protection from infinite looping.

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

EPOCH =

The beginning of Time

Time.at 0
VERSION =

The version of Net::HTTP::Persistent you are using

'2.8'

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Persistent) initialize(name = nil, proxy = nil)

Creates a new Net::HTTP::Persistent.

Set name to keep your connections apart from everybody else's. Not required currently, but highly recommended. Your library name should be good enough. This parameter will be required in a future version.

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'


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File 'lib/bundler/vendor/net/http/persistent.rb', line 432

def initialize name = nil, proxy = nil
  @name = name

  @debug_output     = nil
  @proxy_uri        = nil
  @no_proxy         = []
  @headers          = {}
  @override_headers = {}
  @http_versions    = {}
  @keep_alive       = 30
  @open_timeout     = nil
  @read_timeout     = nil
  @idle_timeout     = 5
  @socket_options   = []

  @socket_options << [Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1] if
    Socket.const_defined? :TCP_NODELAY

  key = ['net_http_persistent', name].compact
  @generation_key     = [key, 'generations'    ].join('_').intern
  @ssl_generation_key = [key, 'ssl_generations'].join('_').intern
  @request_key        = [key, 'requests'       ].join('_').intern
  @timeout_key        = [key, 'timeouts'       ].join('_').intern

  @certificate        = nil
  @ca_file            = nil
  @private_key        = nil
  @ssl_version        = nil
  @verify_callback    = nil
  @verify_mode        = OpenSSL::SSL::VERIFY_PEER
  @cert_store         = nil

  @generation         = 0 # incremented when proxy URI changes
  @ssl_generation     = 0 # incremented when SSL session variables change
  @reuse_ssl_sessions = OpenSSL::SSL.const_defined? :Session

  @retry_change_requests = false

  self.proxy = proxy if proxy
end

Instance Attribute Details

- (Object) ca_file

An SSL certificate authority. Setting this will set verify_mode to VERIFY_PEER.



247
248
249
# File 'lib/bundler/vendor/net/http/persistent.rb', line 247

def ca_file
  @ca_file
end

- (Object) cert_store

An SSL certificate store. Setting this will override the default certificate store. See verify_mode for more information.



253
254
255
# File 'lib/bundler/vendor/net/http/persistent.rb', line 253

def cert_store
  @cert_store
end

- (Object) certificate Also known as: cert

This client's OpenSSL::X509::Certificate



238
239
240
# File 'lib/bundler/vendor/net/http/persistent.rb', line 238

def certificate
  @certificate
end

- (Object) debug_output

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.



261
262
263
# File 'lib/bundler/vendor/net/http/persistent.rb', line 261

def debug_output
  @debug_output
end

- (Object) generation (readonly)

Current connection generation



266
267
268
# File 'lib/bundler/vendor/net/http/persistent.rb', line 266

def generation
  @generation
end

- (Object) generation_key (readonly)

Where this instance's connections live in the thread local variables



271
272
273
# File 'lib/bundler/vendor/net/http/persistent.rb', line 271

def generation_key
  @generation_key
end

- (Object) headers (readonly)

Headers that are added to every request using Net::HTTP#add_field



276
277
278
# File 'lib/bundler/vendor/net/http/persistent.rb', line 276

def headers
  @headers
end

- (Object) http_versions (readonly)

Maps host:port to an HTTP version. This allows us to enable version specific features.



282
283
284
# File 'lib/bundler/vendor/net/http/persistent.rb', line 282

def http_versions
  @http_versions
end

- (Object) idle_timeout

Maximum time an unused connection can remain idle before being automatically closed.



288
289
290
# File 'lib/bundler/vendor/net/http/persistent.rb', line 288

def idle_timeout
  @idle_timeout
end

- (Object) keep_alive

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.



299
300
301
# File 'lib/bundler/vendor/net/http/persistent.rb', line 299

def keep_alive
  @keep_alive
end

- (Object) name (readonly)

A name for this connection. Allows you to keep your connections apart from everybody else's.



305
306
307
# File 'lib/bundler/vendor/net/http/persistent.rb', line 305

def name
  @name
end

- (Object) no_proxy (readonly)

List of host suffixes which will not be proxied



333
334
335
# File 'lib/bundler/vendor/net/http/persistent.rb', line 333

def no_proxy
  @no_proxy
end

- (Object) open_timeout

Seconds to wait until a connection is opened. See Net::HTTP#open_timeout



310
311
312
# File 'lib/bundler/vendor/net/http/persistent.rb', line 310

def open_timeout
  @open_timeout
end

- (Object) override_headers (readonly)

Headers that are added to every request using Net::HTTP#[]=



315
316
317
# File 'lib/bundler/vendor/net/http/persistent.rb', line 315

def override_headers
  @override_headers
end

- (Object) private_key Also known as: key

This client's SSL private key



320
321
322
# File 'lib/bundler/vendor/net/http/persistent.rb', line 320

def private_key
  @private_key
end

- (Object) proxy_uri (readonly)

The URL through which requests will be proxied



328
329
330
# File 'lib/bundler/vendor/net/http/persistent.rb', line 328

def proxy_uri
  @proxy_uri
end

- (Object) read_timeout

Seconds to wait until reading one block. See Net::HTTP#read_timeout



338
339
340
# File 'lib/bundler/vendor/net/http/persistent.rb', line 338

def read_timeout
  @read_timeout
end

- (Object) request_key (readonly)

Where this instance's request counts live in the thread local variables



343
344
345
# File 'lib/bundler/vendor/net/http/persistent.rb', line 343

def request_key
  @request_key
end

- (Object) retry_change_requests

Enable retries of non-idempotent requests that change data (e.g. POST requests) when the server has disconnected.

This will in the worst case lead to multiple requests with the same data, but it may be useful for some applications. Take care when enabling this option to ensure it is safe to POST or perform other non-idempotent requests to the server.



413
414
415
# File 'lib/bundler/vendor/net/http/persistent.rb', line 413

def retry_change_requests
  @retry_change_requests
end

- (Object) reuse_ssl_sessions

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)


352
353
354
# File 'lib/bundler/vendor/net/http/persistent.rb', line 352

def reuse_ssl_sessions
  @reuse_ssl_sessions
end

- (Object) socket_options (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_options << [Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1]


363
364
365
# File 'lib/bundler/vendor/net/http/persistent.rb', line 363

def socket_options
  @socket_options
end

- (Object) ssl_generation (readonly)

Current SSL connection generation



368
369
370
# File 'lib/bundler/vendor/net/http/persistent.rb', line 368

def ssl_generation
  @ssl_generation
end

- (Object) ssl_generation_key (readonly)

Where this instance's SSL connections live in the thread local variables



373
374
375
# File 'lib/bundler/vendor/net/http/persistent.rb', line 373

def ssl_generation_key
  @ssl_generation_key
end

- (Object) ssl_version

Returns the value of attribute ssl_version



381
382
383
# File 'lib/bundler/vendor/net/http/persistent.rb', line 381

def ssl_version
  @ssl_version
end

- (Object) timeout_key (readonly)

Where this instance's last-use times live in the thread local variables



386
387
388
# File 'lib/bundler/vendor/net/http/persistent.rb', line 386

def timeout_key
  @timeout_key
end

- (Object) verify_callback

SSL verification callback. Used when ca_file is set.



391
392
393
# File 'lib/bundler/vendor/net/http/persistent.rb', line 391

def verify_callback
  @verify_callback
end

- (Object) verify_mode

HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER which verifies the server certificate.

If no ca_file or cert_store is set the default system certificate store is used.

You can use verify_mode to override any default values.



402
403
404
# File 'lib/bundler/vendor/net/http/persistent.rb', line 402

def verify_mode
  @verify_mode
end

Class Method Details

+ (Object) detect_idle_timeout(uri, max = 10)

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.



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/bundler/vendor/net/http/persistent.rb', line 201

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'

  connection = http.connection_for uri

  sleep_time = 0

  loop do
    response = connection.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
ensure
  http.shutdown

  return sleep_time unless $!
end

Instance Method Details

- (Boolean) can_retry?(req)

Is the request idempotent or is retry_change_requests allowed

Returns:

  • (Boolean)


684
685
686
# File 'lib/bundler/vendor/net/http/persistent.rb', line 684

def can_retry? req
  retry_change_requests or idempotent?(req)
end

- (Object) cleanup(generation, thread = Thread.current, generation_key = @generation_key)

Finishes all connections on the given thread that were created before the given generation in the threads generation_key list.

See #shutdown for a bunch of scary warning about misusing this method.



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
# File 'lib/bundler/vendor/net/http/persistent.rb', line 510

def cleanup(generation, thread = Thread.current,
            generation_key = @generation_key) # :nodoc:
  timeouts = thread[@timeout_key]

  (0...generation).each do |old_generation|
    next unless thread[generation_key]

    conns = thread[generation_key].delete old_generation

    conns.each_value do |conn|
      finish conn, thread

      timeouts.delete conn.object_id if timeouts
    end if conns
  end
end

- (Boolean) connection_close?(header)

Workaround for missing Net::HTTPRequest#connection_close? on Ruby 1.8

Returns:

  • (Boolean)


692
693
694
# File 'lib/bundler/vendor/net/http/persistent.rb', line 692

def connection_close? header
  header.connection_close?
end

- (Object) connection_for(uri)

Creates a new connection for uri



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'lib/bundler/vendor/net/http/persistent.rb', line 530

def connection_for uri
  Thread.current[@generation_key]     ||= Hash.new { |h,k| h[k] = {} }
  Thread.current[@ssl_generation_key] ||= Hash.new { |h,k| h[k] = {} }
  Thread.current[@request_key]        ||= Hash.new 0
  Thread.current[@timeout_key]        ||= Hash.new EPOCH

  use_ssl = uri.scheme.downcase == 'https'

  if use_ssl then
    ssl_generation = @ssl_generation

    ssl_cleanup ssl_generation

    connections = Thread.current[@ssl_generation_key][ssl_generation]
  else
    generation = @generation

    cleanup generation

    connections = Thread.current[@generation_key][generation]
  end

  net_http_args = [uri.host, uri.port]
  connection_id = net_http_args.join ':'

  if @proxy_uri and not proxy_bypass? uri.host, uri.port then
    connection_id << @proxy_connection_id
    net_http_args.concat @proxy_args
  end

  connection = connections[connection_id]

  unless connection = connections[connection_id] then
    connections[connection_id] = http_class.new(*net_http_args)
    connection = connections[connection_id]
    ssl connection if use_ssl
  else
    reset connection if expired? connection
  end

  start connection unless connection.started?

  connection.read_timeout = @read_timeout if @read_timeout

  connection
rescue Errno::ECONNREFUSED
  address = connection.proxy_address || connection.address
  port    = connection.proxy_port    || connection.port

  raise Error, "connection refused: #{address}:#{port}"
rescue Errno::EHOSTDOWN
  address = connection.proxy_address || connection.address
  port    = connection.proxy_port    || connection.port

  raise Error, "host down: #{address}:#{port}"
end

- (Boolean) connection_keep_alive?(header)

Workaround for missing Net::HTTPRequest#connection_keep_alive? on Ruby 1.8

Returns:

  • (Boolean)


699
700
701
# File 'lib/bundler/vendor/net/http/persistent.rb', line 699

def connection_keep_alive? header
  header.connection_keep_alive?
end

- (Object) error_message(connection)

Returns an error message containing the number of requests performed on this connection



591
592
593
594
595
596
597
598
599
# File 'lib/bundler/vendor/net/http/persistent.rb', line 591

def error_message connection
  requests = Thread.current[@request_key][connection.object_id] - 1 # fixup
  last_use = Thread.current[@timeout_key][connection.object_id]

  age = Time.now - last_use

  "after #{requests} requests on #{connection.object_id}, " \
    "last used #{age} seconds ago"
end

- (Object) escape(str)

URI::escape wrapper



604
605
606
# File 'lib/bundler/vendor/net/http/persistent.rb', line 604

def escape str
  CGI.escape str if str
end

- (Boolean) expired?(connection)

Returns true if the connection should be reset due to an idle timeout, false otherwise.

Returns:

  • (Boolean)


612
613
614
615
616
617
618
619
# File 'lib/bundler/vendor/net/http/persistent.rb', line 612

def expired? connection
  return false unless @idle_timeout
  return true  if     @idle_timeout.zero?

  last_used = Thread.current[@timeout_key][connection.object_id]

  Time.now - last_used > @idle_timeout
end

- (Object) finish(connection, thread = Thread.current)

Finishes the Net::HTTP connection



642
643
644
645
646
647
648
649
# File 'lib/bundler/vendor/net/http/persistent.rb', line 642

def finish connection, thread = Thread.current
  if requests = thread[@request_key] then
    requests.delete connection.object_id
  end

  connection.finish
rescue IOError
end

- (Object) http_class

:nodoc:



651
652
653
654
655
656
657
658
659
660
661
# File 'lib/bundler/vendor/net/http/persistent.rb', line 651

def http_class # :nodoc:
  if RUBY_VERSION > '2.0' then
    Net::HTTP
  elsif [:Artifice, :FakeWeb, :WebMock].any? { |klass|
           Object.const_defined?(klass)
        } or not @reuse_ssl_sessions then
      Net::HTTP
  else
    Net::HTTP::Persistent::SSLReuse
  end
end

- (Object) http_version(uri)

Returns the HTTP protocol version for uri



666
667
668
# File 'lib/bundler/vendor/net/http/persistent.rb', line 666

def http_version uri
  @http_versions["#{uri.host}:#{uri.port}"]
end

- (Boolean) idempotent?(req)

Is req idempotent according to RFC 2616?

Returns:

  • (Boolean)


673
674
675
676
677
678
679
# File 'lib/bundler/vendor/net/http/persistent.rb', line 673

def idempotent? req
  case req
  when Net::HTTP::Delete, Net::HTTP::Get, Net::HTTP::Head,
       Net::HTTP::Options, Net::HTTP::Put, Net::HTTP::Trace then
    true
  end
end

- (Object) max_age

Deprecated in favor of #expired?



723
724
725
726
727
# File 'lib/bundler/vendor/net/http/persistent.rb', line 723

def max_age # :nodoc:
  return Time.now + 1 unless @idle_timeout

  Time.now - @idle_timeout
end

- (Object) normalize_uri(uri)

Adds “http://” to the String uri if it is missing.



732
733
734
# File 'lib/bundler/vendor/net/http/persistent.rb', line 732

def normalize_uri uri
  (uri =~ /^https?:/) ? uri : "http://#{uri}"
end

- (Object) pipeline(uri, requests, &block)

Pipelines requests to the HTTP server at uri yielding responses if a block is given. Returns all responses recieved.

See Net::HTTP::Pipeline for further details.

Only if net-http-pipeline was required before net-http-persistent #pipeline will be present.



747
748
749
750
751
# File 'lib/bundler/vendor/net/http/persistent.rb', line 747

def pipeline uri, requests, &block # :yields: responses
  connection = connection_for uri

  connection.pipeline requests, &block
end

- (Object) proxy=(proxy)

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.



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
# File 'lib/bundler/vendor/net/http/persistent.rb', line 779

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.host,
      @proxy_uri.port,
      @proxy_uri.user,
      @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

- (Boolean) proxy_bypass?(host, port)

Returns true when proxy should by bypassed for host.

Returns:

  • (Boolean)


853
854
855
856
857
858
859
860
861
862
863
# File 'lib/bundler/vendor/net/http/persistent.rb', line 853

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

- (Object) proxy_from_env

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.



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File 'lib/bundler/vendor/net/http/persistent.rb', line 826

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

- (Object) reconnect

Forces reconnection of HTTP connections.



868
869
870
# File 'lib/bundler/vendor/net/http/persistent.rb', line 868

def reconnect
  @generation += 1
end

- (Object) reconnect_ssl

Forces reconnection of SSL connections.



875
876
877
# File 'lib/bundler/vendor/net/http/persistent.rb', line 875

def reconnect_ssl
  @ssl_generation += 1
end

- (Object) request(uri, req = nil, &block)

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::HTTPRequest subclass (see Net::HTTP for a list).

If there is an error and the request is idempontent according to RFC 2616 it will be retried automatically.



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
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
968
969
970
971
972
973
974
975
976
977
# File 'lib/bundler/vendor/net/http/persistent.rb', line 907

def request uri, req = nil, &block
  retried      = false
  bad_response = false

  req = Net::HTTP::Get.new uri.request_uri unless req

  @headers.each do |pair|
    req.add_field(*pair)
  end

  if uri.user or uri.password
    req.basic_auth uri.user, uri.password
  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

  connection = connection_for uri
  connection_id = connection.object_id

  begin
    Thread.current[@request_key][connection_id] += 1
    response = connection.request req, &block

    if connection_close?(req) or
       (response.http_version <= '1.0' and
        not connection_keep_alive?(response)) or
       connection_close?(response) then
      connection.finish
    end
  rescue Net::HTTPBadResponse => e
    message = error_message connection

    finish connection

    raise Error, "too many bad responses #{message}" if
      bad_response or not can_retry? req

    bad_response = true
    retry
  rescue IOError, EOFError, Timeout::Error,
         Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EPIPE,
         Errno::EINVAL, OpenSSL::SSL::SSLError => e

    if retried or not can_retry? req
      due_to = "(due to #{e.message} - #{e.class})"
      message = error_message connection

      finish connection

      raise Error, "too many connection resets #{due_to} #{message}"
    end

    reset connection

    retried = true
    retry
  ensure
    Thread.current[@timeout_key][connection_id] = Time.now
  end

  @http_versions["#{uri.host}:#{uri.port}"] ||= response.http_version

  response
end

- (Object) reset(connection)

Finishes then restarts the Net::HTTP connection



882
883
884
885
886
887
888
889
890
891
892
893
# File 'lib/bundler/vendor/net/http/persistent.rb', line 882

def reset connection
  Thread.current[@request_key].delete connection.object_id
  Thread.current[@timeout_key].delete connection.object_id

  finish connection

  start connection
rescue Errno::ECONNREFUSED
  raise Error, "connection refused: #{connection.address}:#{connection.port}"
rescue Errno::EHOSTDOWN
  raise Error, "host down: #{connection.address}:#{connection.port}"
end

- (Object) shutdown(thread = Thread.current)

Shuts down all connections for thread.

Uses the current thread by default.

If you've used Net::HTTP::Persistent across multiple threads you should call this in each thread when you're done making HTTP requests.

NOTE: Calling shutdown for another thread can be dangerous!

If the thread is still using the connection it may cause an error! It is best to call #shutdown in the thread at the appropriate time instead!



992
993
994
995
996
997
998
999
1000
1001
# File 'lib/bundler/vendor/net/http/persistent.rb', line 992

def shutdown thread = Thread.current
  generation = reconnect
  cleanup generation, thread, @generation_key

  ssl_generation = reconnect_ssl
  cleanup ssl_generation, thread, @ssl_generation_key

  thread[@request_key] = nil
  thread[@timeout_key] = nil
end

- (Object) shutdown_in_all_threads

Shuts down all connections in all threads

NOTE: THIS METHOD IS VERY DANGEROUS!

Do not call this method if other threads are still using their connections! Call #shutdown at the appropriate time instead!

Use this method only as a last resort!



1013
1014
1015
1016
1017
1018
1019
# File 'lib/bundler/vendor/net/http/persistent.rb', line 1013

def shutdown_in_all_threads
  Thread.list.each do |thread|
    shutdown thread
  end

  nil
end

- (Object) ssl(connection)

Enables SSL on connection



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
# File 'lib/bundler/vendor/net/http/persistent.rb', line 1024

def ssl connection
  connection.use_ssl = true

  connection.ssl_version = @ssl_version if @ssl_version

  connection.verify_mode = @verify_mode

  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

  if @ca_file then
    connection.ca_file = @ca_file
    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

  connection.cert_store = if @cert_store then
                            @cert_store
                          else
                            store = OpenSSL::X509::Store.new
                            store.set_default_paths
                            store
                          end
end

- (Object) ssl_cleanup(generation)

Finishes all connections that existed before the given SSL parameter generation.



1082
1083
1084
# File 'lib/bundler/vendor/net/http/persistent.rb', line 1082

def ssl_cleanup generation # :nodoc:
  cleanup generation, Thread.current, @ssl_generation_key
end

- (Object) start(connection)

Starts the Net::HTTP connection



624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'lib/bundler/vendor/net/http/persistent.rb', line 624

def start connection
  connection.set_debug_output @debug_output if @debug_output
  connection.open_timeout = @open_timeout if @open_timeout

  connection.start

  socket = connection.instance_variable_get :@socket

  if socket then # for fakeweb
    @socket_options.each do |option|
      socket.io.setsockopt(*option)
    end
  end
end