Define defaults first so they will be available to other files
@return [Hash] defaults for Excon connections
# 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 => true, :omit_default_port => false, :persistent => false, :read_timeout => 60, :retry_limit => DEFAULT_RETRY_LIMIT, :ssl_verify_peer => true, :tcp_nodelay => false, :uri_parser => URI, :write_timeout => 60 } end
# File lib/excon.rb, line 83 def display_warning(warning) # Respect Ruby's $VERBOSE setting, unless EXCON_DEBUG is set if !$VERBOSE.nil? || ENV['EXCON_DEBUG'] $stderr.puts '[excon][WARNING] ' << warning << "\n#{ caller.join("\n") }" end end
Status of mocking
# File lib/excon.rb, line 91 def mock display_warning('Excon#mock is deprecated, use Excon.defaults[:mock] instead.') self.defaults[:mock] end
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 99 def mock=(new_mock) display_warning('Excon#mock is deprecated, use Excon.defaults[:mock]= instead.') self.defaults[:mock] = new_mock end
@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 135 def new(url, params = {}) uri_parser = params[:uri_parser] || Excon.defaults[:uri_parser] uri = uri_parser.parse(url) raise ArgumentError.new("Invalid URI: #{uri}") unless uri.scheme params = { :host => uri.host, :path => uri.path, :port => uri.port, :query => uri.query, :scheme => uri.scheme, :user => (Utils.unescape_uri(uri.user) if uri.user), :password => (Utils.unescape_uri(uri.password) if uri.password) }.merge!(params) Excon::Connection.new(params) end
@return [String] The filesystem path to the SSL Certificate Authority
# File lib/excon.rb, line 105 def ssl_ca_path display_warning('Excon#ssl_ca_path is deprecated, use Excon.defaults[:ssl_ca_path] instead.') self.defaults[:ssl_ca_path] end
Change path to the SSL Certificate Authority @return [String] The filesystem path to the SSL Certificate Authority
# File lib/excon.rb, line 112 def ssl_ca_path=(new_ssl_ca_path) display_warning('Excon#ssl_ca_path= is deprecated, use Excon.defaults[:ssl_ca_path]= instead.') self.defaults[:ssl_ca_path] = new_ssl_ca_path end
@return [true, false] Whether or not to verify the peer’s SSL certificate / chain
# File lib/excon.rb, line 118 def ssl_verify_peer display_warning('Excon#ssl_verify_peer is deprecated, use Excon.defaults[:ssl_verify_peer] instead.') self.defaults[:ssl_verify_peer] end
Change the status of ssl peer verification @see Excon#ssl_verify_peer (attr_reader)
# File lib/excon.rb, line 125 def ssl_verify_peer=(new_ssl_verify_peer) display_warning('Excon#ssl_verify_peer= is deprecated, use Excon.defaults[:ssl_verify_peer]= instead.') self.defaults[:ssl_verify_peer] = new_ssl_verify_peer end
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 154 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 = Utils.unescape_form(uri.user.to_s), Utils.unescape_form(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
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
# File lib/excon.rb, line 191 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
get a list of defined stubs
# File lib/excon.rb, line 228 def stubs @stubs ||= [] end
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
# File lib/excon.rb, line 235 def unstub(request_params = {}) stub = stub_for(request_params) Excon.stubs.delete_at(Excon.stubs.index(stub)) end
Generated with the Darkfish Rdoc Generator 2.