Module: Excon

Defined in:
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

Defined Under Namespace

Modules: Errors Classes: Connection, Response, SSLSocket, Socket

Constant Summary collapse

VERSION = 
'0.7.8'
CHUNK_SIZE =

1 megabyte

1048576
HTTP_VERBS = 
%w{connect delete get head options post put trace}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.ssl_ca_path ⇒ String

Returns The filesystem path to the SSL Certificate Authority.

Returns:

  • (String) —

    The filesystem path to the SSL Certificate Authority



21
22
23
 
# File 'lib/excon.rb', line 21

def ssl_ca_path
  @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



24
25
26
 
# File 'lib/excon.rb', line 24

def ssl_verify_peer
  @ssl_verify_peer
end

Class Method Details

.mock ⇒ Object

Status of mocking



33
34
35
 
# File 'lib/excon.rb', line 33

def mock
  @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



40
41
42
 
# File 'lib/excon.rb', line 40

def mock=(new_mock)
  @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:



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

def new(url, params = {})
  Excon::Connection.new(url, params)
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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/excon.rb', line 62

def stub(request_params, response_params = nil)
  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 << stub
  stub
end

.stubs ⇒ Object

get a list of defined stubs



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

def stubs
  @stubs ||= []
end