class HTTParty::ConnectionAdapter
Default connection adapter that returns a new Net::HTTP each time
Custom Connection Factories¶ ↑
If you like to implement your own connection adapter, subclassing HTTParty::ConnectionAdapter
will make it easier. Just override the connection
method. The uri and options attributes will have all the info you need to construct your http connection. Whatever you return from your connection method needs to adhere to the Net::HTTP interface as this is what HTTParty
expects.
@example log the uri and options
class LoggingConnectionAdapter < HTTParty::ConnectionAdapter def connection puts uri puts options Net::HTTP.new(uri) end end
@example count number of http calls
class CountingConnectionAdapter < HTTParty::ConnectionAdapter @@count = 0 self.count @@count end def connection self.count += 1 super end end
Configuration¶ ↑
There is lots of configuration data available for your connection adapter in the options
attribute. It is up to you to interpret them within your connection adapter. Take a look at the implementation of HTTParty::ConnectionAdapter#connection
for examples of how they are used. The keys used in options are
-
:
timeout
: timeout in seconds -
:
open_timeout
: http connection open_timeout in seconds, overrides timeout if set -
:
read_timeout
: http connection read_timeout in seconds, overrides timeout if set -
:
write_timeout
: http connection write_timeout in seconds, overrides timeout if set (Ruby >= 2.6.0 required) -
:
debug_output
: seeHTTParty::ClassMethods.debug_output
. -
:
cert_store
: contains certificate data. see method ‘attach_ssl_certificates’ -
:
pem
: contains pem client certificate data. see method ‘attach_ssl_certificates’ -
:
p12
: contains PKCS12 client client certificate data. see method ‘attach_ssl_certificates’ -
:
verify
: verify the server’s certificate against the ca certificate. -
:
verify_peer
: set to false to turn off server verification but still send client certificate -
:
ssl_ca_file
: seeHTTParty::ClassMethods.ssl_ca_file
. -
:
ssl_ca_path
: seeHTTParty::ClassMethods.ssl_ca_path
. -
:
ssl_version
: SSL versions to allow. see method ‘attach_ssl_certificates’ -
:
ciphers
: The list of SSL ciphers to support -
:
connection_adapter_options
: contains the hash you passed to HTTParty.connection_adapter when you configured your connection adapter -
:
local_host
: The local address to bind to -
:
local_port
: The local port to bind to -
:
http_proxyaddr
: HTTP Proxy address -
:
http_proxyport
: HTTP Proxy port -
:
http_proxyuser
: HTTP Proxy user -
:
http_proxypass
: HTTP Proxy password
Inherited methods¶ ↑
-
:
clean_host
: Method used to sanitize host names
Constants
- OPTION_DEFAULTS
- StripIpv6BracketsRegex
-
Private: Regex used to strip brackets from IPv6 URIs.
Attributes
Public Class Methods
Source
# File lib/httparty/connection_adapter.rb, line 79 def self.call(uri, options) new(uri, options).connection end
Public
Source
# File lib/httparty/connection_adapter.rb, line 83 def self.default_cert_store @default_cert_store ||= OpenSSL::X509::Store.new.tap do |cert_store| cert_store.set_default_paths end end
Source
# File lib/httparty/connection_adapter.rb, line 91 def initialize(uri, options = {}) uri_adapter = options[:uri_adapter] || URI raise ArgumentError, "uri must be a #{uri_adapter}, not a #{uri.class}" unless uri.is_a? uri_adapter @uri = uri @options = OPTION_DEFAULTS.merge(options) end
Public Instance Methods
Source
# File lib/httparty/connection_adapter.rb, line 99 def connection host = clean_host(uri.host) port = uri.port || (uri.scheme == 'https' ? 443 : 80) if options.key?(:http_proxyaddr) http = Net::HTTP.new( host, port, options[:http_proxyaddr], options[:http_proxyport], options[:http_proxyuser], options[:http_proxypass] ) else http = Net::HTTP.new(host, port) end http.use_ssl = ssl_implied?(uri) attach_ssl_certificates(http, options) if add_timeout?(options[:timeout]) http.open_timeout = options[:timeout] http.read_timeout = options[:timeout] from_ruby_version('2.6.0', option: :write_timeout, warn: false) do http.write_timeout = options[:timeout] end end if add_timeout?(options[:read_timeout]) http.read_timeout = options[:read_timeout] end if add_timeout?(options[:open_timeout]) http.open_timeout = options[:open_timeout] end if add_timeout?(options[:write_timeout]) from_ruby_version('2.6.0', option: :write_timeout) do http.write_timeout = options[:write_timeout] end end if add_max_retries?(options[:max_retries]) from_ruby_version('2.5.0', option: :max_retries) do http.max_retries = options[:max_retries] end end if options[:debug_output] http.set_debug_output(options[:debug_output]) end if options[:ciphers] http.ciphers = options[:ciphers] end # Bind to a specific local address or port # # @see https://bugs.ruby-lang.org/issues/6617 if options[:local_host] from_ruby_version('2.0.0', option: :local_host) do http.local_host = options[:local_host] end end if options[:local_port] from_ruby_version('2.0.0', option: :local_port) do http.local_port = options[:local_port] end end http end
Private Instance Methods
Source
# File lib/httparty/connection_adapter.rb, line 188 def add_max_retries?(max_retries) max_retries && max_retries.is_a?(Integer) && max_retries >= 0 end
Source
# File lib/httparty/connection_adapter.rb, line 184 def add_timeout?(timeout) timeout && (timeout.is_a?(Integer) || timeout.is_a?(Float)) end
Source
# File lib/httparty/connection_adapter.rb, line 208 def attach_ssl_certificates(http, options) if http.use_ssl? if options.fetch(:verify, true) http.verify_mode = OpenSSL::SSL::VERIFY_PEER if options[:cert_store] http.cert_store = options[:cert_store] else # Use the default cert store by default, i.e. system ca certs http.cert_store = self.class.default_cert_store end else http.verify_mode = OpenSSL::SSL::VERIFY_NONE end # Client certificate authentication # Note: options[:pem] must contain the content of a PEM file having the private key appended if options[:pem] http.cert = OpenSSL::X509::Certificate.new(options[:pem]) http.key = OpenSSL::PKey.read(options[:pem], options[:pem_password]) http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE end # PKCS12 client certificate authentication if options[:p12] p12 = OpenSSL::PKCS12.new(options[:p12], options[:p12_password]) http.cert = p12.certificate http.key = p12.key http.verify_mode = verify_ssl_certificate? ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE end # SSL certificate authority file and/or directory if options[:ssl_ca_file] http.ca_file = options[:ssl_ca_file] http.verify_mode = OpenSSL::SSL::VERIFY_PEER end if options[:ssl_ca_path] http.ca_path = options[:ssl_ca_path] http.verify_mode = OpenSSL::SSL::VERIFY_PEER end # This is only Ruby 1.9+ if options[:ssl_version] && http.respond_to?(:ssl_version=) http.ssl_version = options[:ssl_version] end end end
Source
# File lib/httparty/connection_adapter.rb, line 192 def clean_host(host) strip_ipv6_brackets(host) end
Source
# File lib/httparty/connection_adapter.rb, line 176 def from_ruby_version(ruby_version, option: nil, warn: true) if RUBY_VERSION >= ruby_version yield elsif warn Kernel.warn("Warning: option #{ option } requires Ruby version #{ ruby_version } or later") end end
Source
# File lib/httparty/connection_adapter.rb, line 200 def ssl_implied?(uri) uri.port == 443 || uri.scheme == 'https' end
Source
# File lib/httparty/connection_adapter.rb, line 196 def strip_ipv6_brackets(host) StripIpv6BracketsRegex =~ host ? $1 : host end
Source
# File lib/httparty/connection_adapter.rb, line 204 def verify_ssl_certificate? !(options[:verify] == false || options[:verify_peer] == false) end