Exception: OpenFec::ClientError

Inherits:

Error

• Object
• StandardError
• Error
• OpenFec::ClientError

Defined in:

lib/open_fec/error.rb

Overview

Raised for 4xx HTTP responses.

Direct Known Subclasses

BadRequestError, ForbiddenError, NotFoundError, RateLimitError, UnauthorizedError, UnprocessableEntityError

Instance Attribute Summary

• #body ⇒ Hash, ... readonly

  Response body.

• #status ⇒ Integer^? readonly

  HTTP status code.

Instance Method Summary

• #initialize(message = nil, status: nil, body: nil) ⇒ ClientError constructor

  A new instance of ClientError.

Constructor Details

#initialize(message = nil, status: nil, body: nil) ⇒ ClientError

Returns a new instance of ClientError.

Parameters:

• message (String, nil) (defaults to: nil)
• status (Integer, nil) (defaults to: nil)
• body (Hash, String, nil) (defaults to: nil)

# File 'lib/open_fec/error.rb', line 17

def initialize(message = nil, status: nil, body: nil)
  @status = status
  @body   = body
  super(message || "HTTP #{status}: #{body}")
end

Instance Attribute Details

#body ⇒ Hash, ... (readonly)

Returns response body.

Returns:

• (Hash, String, nil) —

  response body

# File 'lib/open_fec/error.rb', line 12

def body
  @body
end

#status ⇒ Integer^? (readonly)

Returns HTTP status code.

Returns:

• (Integer, nil) —

  HTTP status code

# File 'lib/open_fec/error.rb', line 10

def status
  @status
end