Class/Module Index [+]

Quicksearch

Excon

Attributes

ssl_ca_path[RW]

@return [String] The filesystem path to the SSL Certificate Authority

ssl_verify_peer[R]

@return [true, false] Whether or not to verify the peer's SSL certificate / chain

Public Class Methods

mock() click to toggle source

Status of mocking

# File lib/excon.rb, line 30
def mock
  puts("Excon#mock is deprecated, pass :mock to the initializer (#{caller.first})")
  @mock
end
mock=(new_mock) click to toggle source

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

# 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
new(url, params = {}) click to toggle source

@see Connection#initialize 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
# File lib/excon.rb, line 48
def new(url, params = {})
  Excon::Connection.new(url, params)
end
ssl_verify_peer=(new_ssl_verify_peer) click to toggle source

Change the status of ssl peer verification @see Excon#ssl_verify_peer (attr_reader)

# File lib/excon.rb, line 54
def ssl_verify_peer=(new_ssl_verify_peer)
  @ssl_verify_peer = new_ssl_verify_peer && true || false
end
stub(request_params, response_params = nil) click to toggle source

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
# 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
stubs() click to toggle source

get a list of defined stubs

# File lib/excon.rb, line 78
def stubs
  @stubs ||= []
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.