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/unix_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/decompress.rb,
lib/excon/middlewares/idempotent.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 Classes: Connection, Response, SSLSocket, Socket, StandardInstrumentor, UnixSocket

Constant Summary collapse

VERSION =
'0.27.3'
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_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 patch post put trace}
HTTPS =
'https'
NO_ENTITY =
[204, 205, 304].freeze
REDACTED =
'REDACTED'
UNIX =
'unix'
USER_AGENT =
'excon/' << VERSION
VALID_REQUEST_KEYS =
[
  :body,
  :captures,
  :chunk_size,
  :debug_request,
  :debug_response,
  :expects,
  :headers,
  :idempotent,
  :instrumentor,
  :instrumentor_name,
  :method,
  :middlewares,
  :mock,
  :nonblock,
  :path,
  :pipeline,
  :query,
  :read_timeout,
  :request_block,
  :response_block,
  :retries_remaining, # used internally
  :retry_limit,
  :write_timeout
]
VALID_CONNECTION_KEYS =
VALID_REQUEST_KEYS + [
  :ciphers,
  :client_key,
  :client_cert,
  :certificate,
  :certificate_path,
  :private_key,
  :private_key_path,
  :connect_timeout,
  :family,
  :host,
  :omit_default_port,
  :password,
  :port,
  :proxy,
  :scheme,
  :socket,
  :ssl_ca_file,
  :ssl_verify_peer,
  :tcp_nodelay,
  :uri_parser,
  :user
]

Class Method Summary collapse

Class Method Details

.defaultsHash

Returns defaults for Excon connections.

Returns:

  • (Hash)

    defaults for Excon connections



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/excon.rb', line 19

def defaults
  @defaults ||= {
    :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           => DEFAULT_NONBLOCK,
    :omit_default_port  => false,
    :read_timeout       => 60,
    :retry_limit        => DEFAULT_RETRY_LIMIT,
    :ssl_verify_peer    => true,
    :tcp_nodelay        => false,
    :uri_parser         => URI,
    :write_timeout      => 60
  }
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



79
80
81
82
83
84
# File 'lib/excon.rb', line 79

def display_warning(warning)
  # Respect Ruby's $VERBOSE setting, unless EXCON_DEBUG is set
  if !$VERBOSE.nil? || ENV['EXCON_DEBUG']
    $stderr.puts(warning)
  end
end

.mockObject

Status of mocking



87
88
89
90
# File 'lib/excon.rb', line 87

def mock
  display_warning("Excon#mock is deprecated, use 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



95
96
97
98
# File 'lib/excon.rb', line 95

def mock=(new_mock)
  display_warning("Excon#mock is deprecated, use 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


131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/excon.rb', line 131

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,
    :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_pathString

Returns The filesystem path to the SSL Certificate Authority.

Returns:

  • (String)

    The filesystem path to the SSL Certificate Authority



101
102
103
104
# File 'lib/excon.rb', line 101

def ssl_ca_path
  display_warning("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

Returns:

  • (String)

    The filesystem path to the SSL Certificate Authority



108
109
110
111
# File 'lib/excon.rb', line 108

def ssl_ca_path=(new_ssl_ca_path)
  display_warning("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_peertrue, 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



114
115
116
117
# File 'lib/excon.rb', line 114

def ssl_verify_peer
  display_warning("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

See Also:



121
122
123
124
# File 'lib/excon.rb', line 121

def ssl_verify_peer=(new_ssl_verify_peer)
  display_warning("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


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
177
178
179
180
181
# File 'lib/excon.rb', line 149

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.update(
      :host              => uri.host,
      :path              => uri.path,
      :port              => uri.port,
      :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

@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


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
216
217
218
219
220
# File 'lib/excon.rb', line 186

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

.stubsObject

get a list of defined stubs



223
224
225
# File 'lib/excon.rb', line 223

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


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