Public: Follow HTTP 301, 302, 303, and 307 redirects for GET, PATCH, POST, PUT, and DELETE requests.
This middleware does not follow the HTTP specification for HTTP 302, by default, in that it follows the improper implementation used by most major web browsers which forces the redirected request to become a GET request regardless of the original request method.
For HTTP 301, 302, and 303, the original request is transformed into a GET request to the response Location, by default. However, with standards compliance enabled, a 302 will instead act in accordance with the HTTP specification, which will replay the original request to the received Location, just as with a 307.
For HTTP 307, the original request is replayed to the response Location, including original HTTP request method (GET, POST, PUT, DELETE, PATCH), original headers, and original body.
This middleware currently only works with synchronous requests; in other words, it doesn't support parallelism.
HTTP methods for which 30x redirects can be followed
Keys in env hash which will get cleared between requests
Default value for max redirects followed
HTTP redirect status codes that this middleware implements
Public: Initialize the middleware.
options - An options Hash (default: {}):
limit - A Numeric redirect limit (default: 3) standards_compliant - A Boolean indicating whether to respect the HTTP spec when following 302 (default: false) cookie - Use either an array of strings (e.g. ['cookie1', 'cookie2']) to choose kept cookies or :all to keep all cookies.
# File lib/faraday_middleware/response/follow_redirects.rb, line 56 def initialize(app, options = {}) super(app) @options = options @replay_request_codes = Set.new [307] @replay_request_codes << 302 if standards_compliant? end
# File lib/faraday_middleware/response/follow_redirects.rb, line 64 def call(env) perform_with_redirection(env, follow_limit) end
# File lib/faraday_middleware/response/follow_redirects.rb, line 115 def follow_limit @options.fetch(:limit, FOLLOW_LIMIT) end
# File lib/faraday_middleware/response/follow_redirects.rb, line 110 def follow_redirect?(env, response) ALLOWED_METHODS.include? env[:method] and REDIRECT_CODES.include? response.status end
# File lib/faraday_middleware/response/follow_redirects.rb, line 77 def perform_with_redirection(env, follows) request_body = env[:body] response = @app.call(env) response.on_complete do |env| if follow_redirect?(env, response) raise RedirectLimitReached, response if follows.zero? env = update_env(env, request_body, response) response = perform_with_redirection(env, follows - 1) end end response end
# File lib/faraday_middleware/response/follow_redirects.rb, line 138 def standards_compliant? @options.fetch(:standards_compliant, false) end
# File lib/faraday_middleware/response/follow_redirects.rb, line 70 def transform_into_get?(response) return false if [:head, :options].include? response.env[:method] # Never convert head or options to a get. That would just be silly. !@replay_request_codes.include? response.status end
# File lib/faraday_middleware/response/follow_redirects.rb, line 91 def update_env(env, request_body, response) env[:url] += response['location'] if @options[:cookies] cookies = keep_cookies(env) env[:request_headers][:cookies] = cookies unless cookies.nil? end if transform_into_get?(response) env[:method] = :get env[:body] = nil else env[:body] = request_body end ENV_TO_CLEAR.each {|key| env.delete key } env end