class Faraday::Request
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
Public Class Methods
create(request_method) { |request| ... }
click to toggle source
# File lib/faraday/request.rb, line 24 def self.create(request_method) new(request_method).tap do |request| yield(request) if block_given? end end
Public Instance Methods
[](key)
click to toggle source
# File lib/faraday/request.rb, line 64 def [](key) headers[key] end
[]=(key, value)
click to toggle source
# File lib/faraday/request.rb, line 68 def []=(key, value) headers[key] = value end
headers=(hash)
click to toggle source
Public: Replace request headers, preserving the existing hash type
Calls superclass method
# File lib/faraday/request.rb, line 40 def headers=(hash) if headers headers.replace hash else super end end
marshal_dump()
click to toggle source
# File lib/faraday/request.rb, line 72 def marshal_dump { :method => method, :body => body, :headers => headers, :path => path, :params => params, :options => options } end
marshal_load(serialised)
click to toggle source
# File lib/faraday/request.rb, line 83 def marshal_load(serialised) self.method = serialised[:method] self.body = serialised[:body] self.headers = serialised[:headers] self.path = serialised[:path] self.params = serialised[:params] self.options = serialised[:options] end
params=(hash)
click to toggle source
Public: Replace params, preserving the existing hash type
Calls superclass method
# File lib/faraday/request.rb, line 31 def params=(hash) if params params.replace hash else super end end
to_env(connection)
click to toggle source
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.
# File lib/faraday/request.rb, line 108 def to_env(connection) Env.new(method, body, connection.build_exclusive_url(path, params), options, headers, connection.ssl, connection.parallel_manager) end
url(path, params = nil)
click to toggle source
# File lib/faraday/request.rb, line 48 def url(path, params = nil) if path.respond_to? :query if query = path.query path = path.dup path.query = nil end else anchor_index = path.index('#') path = path.slice(0, anchor_index) unless anchor_index.nil? path, query = path.split('?', 2) end self.path = path self.params.merge_query query, options.params_encoder self.params.update(params) if params end