Module: Excon
- Defined in:
- lib/excon.rb,
lib/excon/utils.rb,
lib/excon/errors.rb,
lib/excon/socket.rb,
lib/excon/headers.rb,
lib/excon/response.rb,
lib/excon/constants.rb,
lib/excon/connection.rb,
lib/excon/ssl_socket.rb,
lib/excon/unix_socket.rb,
lib/excon/pretty_printer.rb,
lib/excon/middlewares/base.rb,
lib/excon/middlewares/mock.rb,
lib/excon/middlewares/expects.rb,
lib/excon/standard_instrumentor.rb,
lib/excon/middlewares/decompress.rb,
lib/excon/middlewares/idempotent.rb,
lib/excon/middlewares/escape_path.rb,
lib/excon/middlewares/instrumentor.rb,
lib/excon/middlewares/response_parser.rb,
lib/excon/middlewares/redirect_follower.rb
Overview
Define defaults first so they will be available to other files
Defined Under Namespace
Modules: Errors, Middleware, Utils Classes: Connection, Headers, PrettyPrinter, Response, SSLSocket, Socket, StandardInstrumentor, UnixSocket
Constant Summary collapse
- VERSION =
'0.39.5'
- 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_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 patch post put trace}
- HTTPS =
'https'
- NO_ENTITY =
[204, 205, 304].freeze
- REDACTED =
'REDACTED'
- UNIX =
'unix'
- USER_AGENT =
'excon/' << VERSION
- VERSIONS =
USER_AGENT + ' (' << RUBY_PLATFORM << ') ruby/' << RUBY_VERSION
- VALID_REQUEST_KEYS =
[ :body, :captures, :chunk_size, :debug_request, :debug_response, :expects, :headers, :idempotent, :instrumentor, :instrumentor_name, :method, :middlewares, :mock, :path, :persistent, :pipeline, :query, :read_timeout, :request_block, :response_block, :retries_remaining, # used internally :retry_limit, :versions, :write_timeout ]
- VALID_CONNECTION_KEYS =
VALID_REQUEST_KEYS + [ :ciphers, :client_key, :client_key_pass, :client_cert, :certificate, :certificate_path, :private_key, :private_key_path, :connect_timeout, :family, :host, :omit_default_port, :nonblock, :reuseaddr, :password, :port, :proxy, :scheme, :socket, :ssl_ca_file, :ssl_verify_callback, :ssl_verify_peer, :ssl_version, :tcp_nodelay, :uri_parser, :user ]
- DEFAULTS =
these come last as they rely on the above
{ :chunk_size => CHUNK_SIZE || DEFAULT_CHUNK_SIZE, :ciphers => 'HIGH:!SSLv2:!aNULL:!eNULL:!3DES', :connect_timeout => 60, :debug_request => false, :debug_response => false, :headers => { 'User-Agent' => USER_AGENT }, :idempotent => false, :instrumentor_name => 'excon', :middlewares => [ Excon::Middleware::ResponseParser, Excon::Middleware::Expects, Excon::Middleware::Idempotent, Excon::Middleware::Instrumentor, Excon::Middleware::Mock ], :mock => false, :nonblock => true, :omit_default_port => false, :persistent => false, :read_timeout => 60, :retry_limit => DEFAULT_RETRY_LIMIT, :ssl_verify_peer => true, :tcp_nodelay => false, :uri_parser => URI, :versions => VERSIONS, :write_timeout => 60 }
Class Method Summary collapse
-
.defaults ⇒ Hash
Defaults for Excon connections.
-
.defaults=(new_defaults) ⇒ Hash
Change defaults for Excon connections.
- .display_warning(warning) ⇒ Object
-
.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 @param [Hash<Symbol, >] request params to match against, omitted params match all @return [Hash<Symbol, >] response params to return from matched request or block to call with params.
-
.stubs ⇒ Object
get a list of defined stubs.
-
.unstub(request_params = {}) ⇒ Object
remove first/oldest stub matching request_params @param [Hash<Symbol, >] request params to match against, omitted params match all @return [Hash<Symbol, >] response params from deleted stub.
Class Method Details
.defaults ⇒ Hash
Returns defaults for Excon connections.
42 43 44 |
# File 'lib/excon.rb', line 42 def defaults @defaults ||= DEFAULTS end |
.defaults=(new_defaults) ⇒ Hash
Change defaults for Excon connections
48 49 50 |
# File 'lib/excon.rb', line 48 def defaults=(new_defaults) @defaults = new_defaults end |
.display_warning(warning) ⇒ Object
52 53 54 55 56 57 |
# File 'lib/excon.rb', line 52 def display_warning(warning) # Respect Ruby's $VERBOSE setting, unless EXCON_DEBUG is set if !$VERBOSE.nil? || ENV['EXCON_DEBUG'] $stderr.puts '[excon][WARNING] ' << warning << "\n#{ caller.join("\n") }" end end |
.mock ⇒ Object
Status of mocking
60 61 62 63 |
# File 'lib/excon.rb', line 60 def mock display_warning('Excon#mock is deprecated, use Excon.defaults[:mock] instead.') 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
68 69 70 71 |
# File 'lib/excon.rb', line 68 def mock=(new_mock) display_warning('Excon#mock is deprecated, use Excon.defaults[:mock]= instead.') 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
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/excon.rb', line 104 def new(url, params = {}) uri_parser = params[:uri_parser] || Excon.defaults[:uri_parser] uri = uri_parser.parse(url) unless uri.scheme raise ArgumentError.new("Invalid URI: #{uri}") end params = { :host => uri.host, :path => uri.path, :port => uri.port, :query => uri.query, :scheme => uri.scheme }.merge!(params) if uri.password params[:password] = Utils.unescape_uri(uri.password) end if uri.user params[:user] = Utils.unescape_uri(uri.user) end Excon::Connection.new(params) end |
.ssl_ca_path ⇒ String
Returns The filesystem path to the SSL Certificate Authority.
74 75 76 77 |
# File 'lib/excon.rb', line 74 def ssl_ca_path display_warning('Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead.') self.defaults[:ssl_ca_path] end |
.ssl_ca_path=(new_ssl_ca_path) ⇒ String
Change path to the SSL Certificate Authority
81 82 83 84 |
# File 'lib/excon.rb', line 81 def ssl_ca_path=(new_ssl_ca_path) display_warning('Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead.') 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.
87 88 89 90 |
# File 'lib/excon.rb', line 87 def ssl_verify_peer display_warning('Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead.') self.defaults[:ssl_verify_peer] end |
.ssl_verify_peer=(new_ssl_verify_peer) ⇒ Object
Change the status of ssl peer verification
94 95 96 97 |
# File 'lib/excon.rb', line 94 def ssl_verify_peer=(new_ssl_verify_peer) display_warning('Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead.') 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
129 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 160 161 162 163 164 165 166 167 168 |
# File 'lib/excon.rb', line 129 def stub(request_params = {}, response_params = nil) if method = request_params.delete(:method) request_params[:method] = method.to_s.downcase.to_sym end if url = request_params.delete(:url) uri = URI.parse(url) request_params = { :host => uri.host, :path => uri.path, :port => uri.port, :query => uri.query, :scheme => uri.scheme }.merge!(request_params) if uri.user || uri.password request_params[:headers] ||= {} user, pass = Utils.unescape_form(uri.user.to_s), Utils.unescape_form(uri.password.to_s) request_params[:headers]['Authorization'] ||= 'Basic ' << ['' << user << ':' << pass].pack('m').delete(Excon::CR_NL) end end if request_params.has_key?(:headers) headers = Excon::Headers.new request_params[:headers].each do |key, value| headers[key] = value end request_params[:headers] = headers 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
@param [Hash<Symbol, >] request params to match against, omitted params match all
@return [Hash<Symbol, >] response params to return from matched request or block to call with params
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/excon.rb', line 173 def stub_for(request_params={}) if method = request_params.delete(:method) request_params[:method] = method.to_s.downcase.to_sym end Excon.stubs.each do |stub, response_params| 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 [stub, response_params] end end nil end |
.stubs ⇒ Object
get a list of defined stubs
210 211 212 |
# File 'lib/excon.rb', line 210 def stubs @stubs ||= [] end |
.unstub(request_params = {}) ⇒ Object
remove first/oldest stub matching request_params
@param [Hash<Symbol, >] request params to match against, omitted params match all
@return [Hash<Symbol, >] response params from deleted stub
217 218 219 220 |
# File 'lib/excon.rb', line 217 def unstub(request_params = {}) stub = stub_for(request_params) Excon.stubs.delete_at(Excon.stubs.index(stub)) end |