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,
lib/excon/middlewares/response_parser.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.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'
VALID_CONNECTION_KEYS = 
[
  :body,
  :captures,
  :chunk_size,
  :client_key,
  :client_cert,
  :certificate,
  :private_key,
  :connect_timeout,
  :connection,
  :debug_request,
  :debug_response,
  :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,
  :tcp_nodelay,
  :uri_parser,
  :user,
  :ssl_ca_file,
  :ssl_verify_peer,
  :stack,
  :write_timeout
]
VERSION = 
'0.25.2'
USER_AGENT = 
'excon/' << VERSION

Class Method Summary collapse

Class Method Details

.defaults ⇒ Hash

Returns defaults for Excon connections.

Returns:

  • (Hash) —

    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
41
42
43
44
45
 
# File 'lib/excon.rb', line 17

def defaults
  @defaults ||= {
    :chunk_size         => CHUNK_SIZE || DEFAULT_CHUNK_SIZE,
    :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



49
50
51
 
# File 'lib/excon.rb', line 49

def defaults=(new_defaults)
  @defaults = new_defaults
end

.display_warning(warning) ⇒ Object 



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

def display_warning(warning)
  # Ruby convention mandates complete silence when VERBOSE == nil
  $stderr.puts(warning) if !ENV['VERBOSE'].nil?
end

.mock ⇒ Object

Status of mocking



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

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



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

def mock=(new_mock)
  display_warning("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

See Also:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/excon.rb', line 123

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.

Returns:

  • (String) —

    The filesystem path to the SSL Certificate Authority



93
94
95
96
 
# File 'lib/excon.rb', line 93

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



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

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_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



106
107
108
109
 
# File 'lib/excon.rb', line 106

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:



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

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



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
 
# File 'lib/excon.rb', line 141

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.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



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
208
209
210
 
# File 'lib/excon.rb', line 176

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|
    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



213
214
215
 
# File 'lib/excon.rb', line 213

def stubs
  @stubs ||= []
end