class Faraday::Response::RaiseError

RaiseError is a Faraday middleware that raises exceptions on common HTTP client or server error responses.

Constants

ClientErrorStatuses: rubocop:disable Naming/ConstantName
ClientErrorStatusesWithCustomExceptions
DEFAULT_OPTIONS: rubocop:enable Naming/ConstantName
ServerErrorStatuses

Public Instance Methods

# File lib/faraday/response/raise_error.rb, line 25
def on_complete(env)
  return if Array(options[:allowed_statuses]).include?(env[:status])

  case env[:status]
  when *ClientErrorStatusesWithCustomExceptions.keys
    raise ClientErrorStatusesWithCustomExceptions[env[:status]], response_values(env)
  when 407
    # mimic the behavior that we get with proxy requests with HTTPS
    msg = %(407 "Proxy Authentication Required")
    raise Faraday::ProxyAuthError.new(msg, response_values(env))
  when ClientErrorStatuses
    raise Faraday::ClientError, response_values(env)
  when ServerErrorStatuses
    raise Faraday::ServerError, response_values(env)
  when nil
    raise Faraday::NilStatusError, response_values(env)
  end
end

query_params (env)

# File lib/faraday/response/raise_error.rb, line 75
def query_params(env)
  env.request.params_encoder ||= Faraday::Utils.default_params_encoder
  env.params_encoder.decode(env.url.query)
end

response_values (env)

Returns a hash of response data with the following keys:

- status
- headers
- body
- request

The ‘request` key is omitted when the middleware is explicitly configured with the option `include_request: false`.

# File lib/faraday/response/raise_error.rb, line 52
def response_values(env)
  response = {
    status: env.status,
    headers: env.response_headers,
    body: env.body
  }

  # Include the request data by default. If the middleware was explicitly
  # configured to _not_ include request data, then omit it.
  return response unless options[:include_request]

  response.merge(
    request: {
      method: env.method,
      url: env.url,
      url_path: env.url.path,
      params: query_params(env),
      headers: env.request_headers,
      body: env.request_body
    }
  )
end