Module Faraday
In: lib/faraday/connection.rb
lib/faraday/parameters.rb
lib/faraday/request/url_encoded.rb
lib/faraday/request/multipart.rb
lib/faraday/request/instrumentation.rb
lib/faraday/request/authorization.rb
lib/faraday/request/basic_authentication.rb
lib/faraday/request/retry.rb
lib/faraday/request/token_authentication.rb
lib/faraday/error.rb
lib/faraday/upload_io.rb
lib/faraday/utils.rb
lib/faraday/middleware.rb
lib/faraday/adapter/excon.rb
lib/faraday/adapter/em_http.rb
lib/faraday/adapter/rack.rb
lib/faraday/adapter/em_synchrony/parallel_manager.rb
lib/faraday/adapter/net_http_persistent.rb
lib/faraday/adapter/typhoeus.rb
lib/faraday/adapter/em_synchrony.rb
lib/faraday/adapter/test.rb
lib/faraday/adapter/net_http.rb
lib/faraday/adapter/patron.rb
lib/faraday/adapter/httpclient.rb
lib/faraday/response.rb
lib/faraday/response/raise_error.rb
lib/faraday/response/logger.rb
lib/faraday/options.rb
lib/faraday/rack_builder.rb
lib/faraday/request.rb
lib/faraday/autoload.rb
lib/faraday/adapter.rb
lib/faraday.rb

Public: This is the main namespace for Faraday. You can either use it to create Faraday::Connection objects, or access it directly.

Examples

  Faraday.get "http://faraday.com"

  conn = Faraday.new "http://faraday.com"
  conn.get '/'

Methods

Classes and Modules

Module Faraday::AutoloadHelper
Module Faraday::FlatParamsEncoder
Module Faraday::MiddlewareRegistry
Module Faraday::NestedParamsEncoder
Module Faraday::Request
Module Faraday::Utils
Class Faraday::Adapter
Class Faraday::ClientError
Class Faraday::CompositeReadIO
Class Faraday::Connection
Class Faraday::ConnectionFailed
Class Faraday::ConnectionOptions
Class Faraday::Env
Class Faraday::Error
Class Faraday::Middleware
Class Faraday::MissingDependency
Class Faraday::Options
Class Faraday::ParsingError
Class Faraday::ProxyOptions
Class Faraday::RackBuilder
Class Faraday::Request
Class Faraday::RequestOptions
Class Faraday::ResourceNotFound
Class Faraday::Response
Class Faraday::SSLError
Class Faraday::SSLOptions
Class Faraday::TimeoutError

Constants

UploadIO = ::UploadIO
Parts = ::Parts
VERSION = "0.9.2"
Timer = SystemTimer
Timer = Timeout

External Aliases

require_libs -> require_lib

Attributes

default_adapter  [R]  Public: Gets or sets the Symbol key identifying a default Adapter to use for the default Faraday::Connection.
default_connection  [W]  Public: Sets the default Faraday::Connection for simple scripts that access the Faraday constant directly.
    Faraday.get "https://faraday.com"
default_connection_options  [W]  Public: Sets the default options used when calling Faraday#new.
lib_path  [RW]  Public: Gets or sets the path that the Faraday libs are loaded from.
root_path  [RW]  Public: Gets or sets the root path that Faraday is being loaded from. This is the root from where the libraries are auto-loaded from.

Public Class methods

Public: Updates default adapter while resetting default_connection.

Returns the new default_adapter.

Gets the default connection used for simple scripts.

Returns a Faraday::Connection, configured with the default_adapter.

Gets the default connection options used when calling Faraday#new.

Returns a Faraday::ConnectionOptions.

Public: Initializes a new Faraday::Connection.

url - The optional String base URL to use as a prefix for all

          requests.  Can also be the options Hash.

options - The optional Hash used to configure this Faraday::Connection.

          Any of these values will be set on every request made, unless
          overridden for a specific request.
          :url     - String base URL.
          :params  - Hash of URI query unencoded key/value pairs.
          :headers - Hash of unencoded HTTP header key/value pairs.
          :request - Hash of request options.
          :ssl     - Hash of SSL options.
          :proxy   - Hash of Proxy options.

Examples

  Faraday.new 'http://faraday.com'

  # http://faraday.com?page=1
  Faraday.new 'http://faraday.com', :params => {:page => 1}

  # same

  Faraday.new :url => 'http://faraday.com',
    :params => {:page => 1}

Returns a Faraday::Connection.

Internal: Requires internal Faraday libraries.

*libs - One or more relative String names to Faraday classes.

Returns nothing.

Public Instance methods

has_key?(k)

Alias for include?

key?(k)

Alias for include?

member?(k)

Alias for include?

update(other)

Alias for merge!

Protected Instance methods

[Validate]