Class: Faraday::Response::RaiseError

Inherits:
Middleware show all
Defined in:
lib/faraday/response/raise_error.rb

Overview

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

Constant Summary collapse

ClientErrorStatuses =

rubocop:disable Naming/ConstantName

(400...500)
ServerErrorStatuses = 
(500...600)
ClientErrorStatusesWithCustomExceptions = 
{
  400 => Faraday::BadRequestError,
  401 => Faraday::UnauthorizedError,
  403 => Faraday::ForbiddenError,
  404 => Faraday::ResourceNotFound,
  408 => Faraday::RequestTimeoutError,
  409 => Faraday::ConflictError,
  422 => Faraday::UnprocessableEntityError,
  429 => Faraday::TooManyRequestsError
}.freeze
DEFAULT_OPTIONS =

rubocop:enable Naming/ConstantName

{ include_request: true, allowed_statuses: [] }.freeze

Constants inherited from Middleware

Middleware::LOCK

Instance Attribute Summary

Attributes inherited from Middleware

#app, #options

Instance Method Summary collapse

Methods inherited from Middleware

#call, #close, default_options, default_options=, #initialize

Methods included from MiddlewareRegistry

#lookup_middleware, #register_middleware, #registered_middleware, #unregister_middleware

Constructor Details

This class inherits a constructor from Faraday::Middleware

Instance Method Details

#on_complete(env) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# 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) ⇒ Object 



75
76
77
78
 
# 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) ⇒ Object

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.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# 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