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/ssl_socket.rb,
lib/excon/connection.rb

Defined Under Namespace

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

Constant Summary

VERSION =

'0.9.5'

CHUNK_SIZE =

1 megabyte

1048576

CR_NL =

"\r\n"

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 post put trace}

HTTPS =

'https'

NO_ENTITY =

[204, 205, 304].freeze

Class Attribute Summary (collapse)

• + (String) ssl_ca_path

  The filesystem path to the SSL Certificate Authority.

• + (true, false) ssl_verify_peer

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

Class Method Summary (collapse)

• + (Object) mock

  Status of mocking.

• + (Object) mock=(new_mock)

  Change the status of mocking false is the default and works as expected true returns a value from stubs or raises.

• + (Object) new(url, params = {})

  Initializes a new keep-alive session for a given remote host.

• + (Object) stub(request_params, response_params = nil)

  push an additional stub onto the list to check for mock requests.

• + (Object) stubs

  get a list of defined stubs.

21
22
23

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

def ssl_ca_path
  @ssl_ca_path
end

24
25
26

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

def ssl_verify_peer
  @ssl_verify_peer
end

30
31
32
33

# File 'lib/excon.rb', line 30

def mock
  puts("Excon#mock is deprecated, pass :mock to the initializer (#{caller.first})")
  @mock
end

38
39
40
41

# File 'lib/excon.rb', line 38

def mock=(new_mock)
  puts("Excon#mock= is deprecated, pass :mock to the initializer (#{caller.first})")
  @mock = new_mock
end

@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

48
49
50

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

def new(url, params = {})
  Excon::Connection.new(url, params)
end

@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

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# File 'lib/excon.rb', line 61

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

78
79
80

# File 'lib/excon.rb', line 78

def stubs
  @stubs ||= []
end