Module: Excon

Defined in:
lib/excon.rb,
lib/excon/error.rb,
lib/excon/utils.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/test/server.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/test/plugin/server/exec.rb,
lib/excon/test/plugin/server/puma.rb,
lib/excon/middlewares/instrumentor.rb,
lib/excon/test/plugin/server/unicorn.rb,
lib/excon/test/plugin/server/webrick.rb,
lib/excon/middlewares/capture_cookies.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, Test, Utils Classes: Connection, Error, Headers, PrettyPrinter, Response, SSLSocket, Socket, StandardInstrumentor, UnixSocket

Constant Summary collapse

VERSION = 
'0.58.0'
CR_NL = 
"\r\n"
DEFAULT_CA_FILE = 
File.expand_path(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,
  :retry_interval,
  :versions,
  :write_timeout
]
VALID_CONNECTION_KEYS = 
VALID_REQUEST_KEYS + [
  :ciphers,
  :client_key,
  :client_key_data,
  :client_key_pass,
  :client_cert,
  :client_cert_data,
  :certificate,
  :certificate_path,
  :disable_proxy,
  :private_key,
  :private_key_path,
  :connect_timeout,
  :family,
  :host,
  :hostname,
  :omit_default_port,
  :nonblock,
  :reuseaddr,
  :password,
  :port,
  :proxy,
  :scheme,
  :socket,
  :ssl_ca_file,
  :ssl_ca_path,
  :ssl_cert_store,
  :ssl_verify_callback,
  :ssl_verify_peer,
  :ssl_verify_peer_host,
  :ssl_version,
  :tcp_nodelay,
  :thread_safe_sockets,
  :uri_parser,
  :user
]
DEFAULTS =

these come last as they rely on the above

{
  :chunk_size           => CHUNK_SIZE || DEFAULT_CHUNK_SIZE,
  # see https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29
  :ciphers              => 'ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES256-SHA:ECDHE-ECDSA-DES-CBC3-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:DES-CBC3-SHA:!DSS',
  :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,
  :ssl_uri_schemes      => [HTTPS],
  :stubs                => :global,
  :tcp_nodelay          => false,
  :thread_safe_sockets  => true,
  :uri_parser           => URI,
  :versions             => VERSIONS,
  :write_timeout        => 60
}

Class Method Summary collapse

Class Method Details

.defaults ⇒ Hash

Returns defaults for Excon connections.

Returns:

  • (Hash) —

    defaults for Excon connections



46
47
48
 
# File 'lib/excon.rb', line 46

def defaults
  @defaults ||= DEFAULTS
end

.defaults=(new_defaults) ⇒ Hash

Change defaults for Excon connections

Returns:

  • (Hash) —

    defaults for Excon connections



52
53
54
 
# File 'lib/excon.rb', line 52

def defaults=(new_defaults)
  @defaults = new_defaults
end

.display_warning(warning) ⇒ Object 



56
57
58
59
60
61
 
# File 'lib/excon.rb', line 56

def display_warning(warning)
  # Show warning if $VERBOSE or ENV['EXCON_DEBUG'] is set
  if $VERBOSE || ENV['EXCON_DEBUG']
    $stderr.puts "[excon][WARNING] #{warning}\n#{ caller.join("\n") }"
  end
end

.mock ⇒ Object

Status of mocking



64
65
66
67
 
# File 'lib/excon.rb', line 64

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



72
73
74
75
 
# File 'lib/excon.rb', line 72

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

See Also:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/excon.rb', line 108

def new(url, params = {})
  uri_parser = params[:uri_parser] || defaults[:uri_parser]
  uri = uri_parser.parse(url)
  if params[:path]
    uri_parser.parse(params[:path])
  end
  unless uri.scheme
    raise ArgumentError.new("Invalid URI: #{uri}")
  end
  params = {
    :host       => uri.host,
    :hostname   => uri.hostname,
    :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.

Returns:

  • (String) —

    The filesystem path to the SSL Certificate Authority



78
79
80
81
 
# File 'lib/excon.rb', line 78

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

Returns:

  • (String) —

    The filesystem path to the SSL Certificate Authority



85
86
87
88
 
# File 'lib/excon.rb', line 85

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.

Returns:

  • (true, false) —

    Whether or not to verify the peer’s SSL certificate / chain



91
92
93
94
 
# File 'lib/excon.rb', line 91

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

See Also:



98
99
100
101
 
# File 'lib/excon.rb', line 98

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



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
169
170
171
172
173
174
175
176
 
# File 'lib/excon.rb', line 137

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



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
208
209
210
211
212
213
214
215
 
# File 'lib/excon.rb', line 181

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



218
219
220
221
222
223
224
225
 
# File 'lib/excon.rb', line 218

def stubs
  case Excon.defaults[:stubs]
  when :global
    @stubs ||= []
  when :local
    Thread.current[:_excon_stubs] ||= []
  end
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



230
231
232
233
 
# File 'lib/excon.rb', line 230

def unstub(request_params = {})
  stub = stub_for(request_params)
  Excon.stubs.delete_at(Excon.stubs.index(stub))
end