Module: Excon
- Defined in:
- lib/excon.rb,
lib/excon.rb,
lib/excon/errors.rb,
lib/excon/socket.rb,
lib/excon/response.rb,
lib/excon/constants.rb,
lib/excon/connection.rb,
lib/excon/ssl_socket.rb,
lib/excon/middlewares/base.rb,
lib/excon/middlewares/mock.rb,
lib/excon/middlewares/expects.rb,
lib/excon/standard_instrumentor.rb,
lib/excon/middlewares/idempotent.rb,
lib/excon/middlewares/instrumentor.rb
Overview
Define defaults first so they will be available to other files
Defined Under Namespace
Modules: Errors, Middleware Classes: Connection, Response, SSLSocket, Socket, StandardInstrumentor
Constant Summary collapse
- CR_NL =
"\r\n"
- DEFAULT_CA_FILE =
File.(File.join(File.dirname(__FILE__), "..", "..", "data", "cacert.pem"))
- DEFAULT_CHUNK_SIZE =
1 megabyte
1048576
- CHUNK_SIZE =
DEFAULT_CHUNK_SIZE
- DEFAULT_NONBLOCK =
OpenSSL::SSL::SSLSocket.public_method_defined?(:connect_nonblock) && OpenSSL::SSL::SSLSocket.public_method_defined?(:read_nonblock) && OpenSSL::SSL::SSLSocket.public_method_defined?(:write_nonblock)
- DEFAULT_RETRY_LIMIT =
4
- FORCE_ENC =
CR_NL.respond_to?(:force_encoding)
- HTTP_1_1 =
" HTTP/1.1\r\n"
- HTTP_VERBS =
%w{connect delete get head options post put trace patch}
- HTTPS =
'https'
- NO_ENTITY =
[204, 205, 304].freeze
- REDACTED =
'REDACTED'
- VALID_CONNECTION_KEYS =
[ :body, :captures, :chunk_size, :client_key, :client_cert, :connect_timeout, :connection, :error, :exception, :expects, :family, :headers, :host, :idempotent, :instrumentor, :instrumentor_name, :method, :middlewares, :mock, :nonblock, :omit_default_port, :password, :path, :pipeline, :port, :proxy, :query, :read_timeout, :request_block, :response, :response_block, :retries_remaining, :retry_limit, :scheme, :uri_parser, :user, :ssl_ca_file, :ssl_verify_peer, :stack, :write_timeout ]
- VERSION =
'0.22.0'
Class Method Summary collapse
-
.defaults ⇒ Hash
Defaults for Excon connections.
-
.defaults=(new_defaults) ⇒ Hash
Change defaults for Excon connections.
-
.mock ⇒ Object
Status of mocking.
-
.mock=(new_mock) ⇒ Object
Change the status of mocking false is the default and works as expected true returns a value from stubs or raises.
-
.new(url, params = {}) ⇒ Object
Initializes a new keep-alive session for a given remote host @param [String] url The destination URL @param [Hash<Symbol, >] params One or more option params to set on the Connection instance @return [Connection] A new Excon::Connection instance.
-
.ssl_ca_path ⇒ String
The filesystem path to the SSL Certificate Authority.
-
.ssl_ca_path=(new_ssl_ca_path) ⇒ String
Change path to the SSL Certificate Authority.
-
.ssl_verify_peer ⇒ true, false
Whether or not to verify the peer’s SSL certificate / chain.
-
.ssl_verify_peer=(new_ssl_verify_peer) ⇒ Object
Change the status of ssl peer verification.
-
.stub(request_params = {}, response_params = nil) ⇒ Object
push an additional stub onto the list to check for mock requests @param [Hash<Symbol, >] request params to match against, omitted params match all @param [Hash<Symbol, >] response params to return from matched request or block to call with params.
-
.stub_for(request_params = {}) ⇒ Object
get a stub matching params or nil.
-
.stubs ⇒ Object
get a list of defined stubs.
Class Method Details
.defaults ⇒ Hash
Returns defaults for Excon connections.
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/excon.rb', line 17 def defaults @defaults ||= { :chunk_size => CHUNK_SIZE || DEFAULT_CHUNK_SIZE, :connect_timeout => 60, :headers => {}, :idempotent => false, :instrumentor_name => 'excon', :middlewares => [ Excon::Middleware::Expects, Excon::Middleware::Idempotent, Excon::Middleware::Instrumentor, Excon::Middleware::Mock ], :mock => false, :nonblock => DEFAULT_NONBLOCK, :omit_default_port => false, :read_timeout => 60, :retry_limit => DEFAULT_RETRY_LIMIT, :ssl_ca_file => DEFAULT_CA_FILE, :ssl_verify_peer => RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|cygwin|mingw/i, :uri_parser => URI, :write_timeout => 60 } end |
.defaults=(new_defaults) ⇒ Hash
Change defaults for Excon connections
44 45 46 |
# File 'lib/excon.rb', line 44 def defaults=(new_defaults) @defaults = new_defaults end |
.mock ⇒ Object
Status of mocking
68 69 70 71 |
# File 'lib/excon.rb', line 68 def mock $stderr.puts("Excon#mock is deprecated, pass Excon.defaults[:mock] instead (#{caller.first})") self.defaults[:mock] end |
.mock=(new_mock) ⇒ Object
Change the status of mocking false is the default and works as expected true returns a value from stubs or raises
76 77 78 79 |
# File 'lib/excon.rb', line 76 def mock=(new_mock) $stderr.puts("Excon#mock is deprecated, pass Excon.defaults[:mock]= instead (#{caller.first})") self.defaults[:mock] = new_mock end |
.new(url, params = {}) ⇒ Object
Initializes a new keep-alive session for a given remote host
@param [String] url The destination URL
@param [Hash<Symbol, >] params One or more option params to set on the Connection instance
@return [Connection] A new Excon::Connection instance
112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/excon.rb', line 112 def new(url, params = {}) uri_parser = params[:uri_parser] || Excon.defaults[:uri_parser] uri = uri_parser.parse(url) params = { :host => uri.host, :path => uri.path, :port => uri.port.to_s, :query => uri.query, :scheme => uri.scheme, :user => (URI.decode(uri.user) if uri.user), :password => (URI.decode(uri.password) if uri.password), }.merge!(params) Excon::Connection.new(params) end |
.ssl_ca_path ⇒ String
Returns The filesystem path to the SSL Certificate Authority.
82 83 84 85 |
# File 'lib/excon.rb', line 82 def ssl_ca_path $stderr.puts("Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead (#{caller.first})") self.defaults[:ssl_ca_path] end |
.ssl_ca_path=(new_ssl_ca_path) ⇒ String
Change path to the SSL Certificate Authority
89 90 91 92 |
# File 'lib/excon.rb', line 89 def ssl_ca_path=(new_ssl_ca_path) $stderr.puts("Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead (#{caller.first})") self.defaults[:ssl_ca_path] = new_ssl_ca_path end |
.ssl_verify_peer ⇒ true, false
Returns Whether or not to verify the peer’s SSL certificate / chain.
95 96 97 98 |
# File 'lib/excon.rb', line 95 def ssl_verify_peer $stderr.puts("Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead (#{caller.first})") self.defaults[:ssl_verify_peer] end |
.ssl_verify_peer=(new_ssl_verify_peer) ⇒ Object
Change the status of ssl peer verification
102 103 104 105 |
# File 'lib/excon.rb', line 102 def ssl_verify_peer=(new_ssl_verify_peer) $stderr.puts("Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead (#{caller.first})") self.defaults[:ssl_verify_peer] = new_ssl_verify_peer end |
.stub(request_params = {}, response_params = nil) ⇒ Object
push an additional stub onto the list to check for mock requests
@param [Hash<Symbol, >] request params to match against, omitted params match all
@param [Hash<Symbol, >] response params to return from matched request or block to call with params
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/excon.rb', line 130 def stub(request_params = {}, response_params = nil) if url = request_params.delete(:url) uri = URI.parse(url) request_params.update( :host => uri.host, :path => uri.path, :port => uri.port.to_s, :query => uri.query, :scheme => uri.scheme ) if uri.user || uri.password request_params[:headers] ||= {} user, pass = URI.decode_www_form_component(uri.user.to_s), URI.decode_www_form_component(uri.password.to_s) request_params[:headers]['Authorization'] ||= 'Basic ' << ['' << user << ':' << pass].pack('m').delete(Excon::CR_NL) end end if block_given? if response_params raise(ArgumentError.new("stub requires either response_params OR a block")) else stub = [request_params, Proc.new] end elsif response_params stub = [request_params, response_params] else raise(ArgumentError.new("stub requires either response_params OR a block")) end stubs.unshift(stub) stub end |
.stub_for(request_params = {}) ⇒ Object
get a stub matching params or nil
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/excon.rb', line 162 def stub_for(request_params={}) Excon.stubs.each do |stub, response| captures = { :headers => {} } headers_match = !stub.has_key?(:headers) || stub[:headers].keys.all? do |key| case value = stub[:headers][key] when Regexp if match = value.match(request_params[:headers][key]) captures[:headers][key] = match.captures end match else value == request_params[:headers][key] end end non_headers_match = (stub.keys - [:headers]).all? do |key| case value = stub[key] when Regexp if match = value.match(request_params[key]) captures[key] = match.captures end match else value == request_params[key] end end if headers_match && non_headers_match request_params[:captures] = captures return response end end nil end |
.stubs ⇒ Object
get a list of defined stubs
196 197 198 |
# File 'lib/excon.rb', line 196 def stubs @stubs ||= [] end |