Class Faraday::Request
In: lib/faraday/request.rb
Parent: Struct.new(:method, :path, :params, :headers, :body, :options)

Used to setup urls, params, headers, and the request body in a sane manner.

  @connection.post do |req|
    req.url 'http://localhost', 'a' => '1' # 'http://localhost?a=1'
    req.headers['b'] = '2' # Header
    req.params['c']  = '3' # GET Param
    req['b']         = '2' # also Header
    req.body = 'abc'
  end

Methods

[]   []=   create   headers=   params=   to_env   url  

Classes and Modules

Class Faraday::Request::Authorization
Class Faraday::Request::BasicAuthentication
Class Faraday::Request::Multipart
Class Faraday::Request::Retry
Class Faraday::Request::TokenAuthentication
Class Faraday::Request::UrlEncoded

Public Class methods

Public Instance methods

Public: Replace request headers, preserving the existing hash type

Public: Replace params, preserving the existing hash type

ENV Keys :method - a symbolized request method (:get, :post) :body - the request body that will eventually be converted to a string. :url - URI instance for the current request. :status - HTTP response status code :request_headers - hash of HTTP Headers to be sent to the server :response_headers - Hash of HTTP headers from the server :parallel_manager - sent if the connection is in parallel mode :request - Hash of options for configuring the request.

  :timeout      - open/read timeout Integer in seconds
  :open_timeout - read timeout Integer in seconds
  :proxy        - Hash of proxy options
    :uri        - Proxy Server URI
    :user       - Proxy server username
    :password   - Proxy server password

:ssl - Hash of options for configuring SSL requests.

[Validate]