Exception: OpenfigiRuby::ApiError

Inherits:

Error

• Object
• StandardError
• Error
• OpenfigiRuby::ApiError

Defined in:

lib/openfigi_ruby/error.rb

Overview

Raised when the API returns a non-successful HTTP status.

Direct Known Subclasses

AuthenticationError, InvalidRequestError, RateLimitError, ServerError

Instance Attribute Summary

• #body ⇒ String^? readonly

  Raw response body.

• #status_code ⇒ Integer^? readonly

  HTTP status code from the response.

Instance Method Summary

• #initialize(message = nil, status_code: nil, body: nil) ⇒ ApiError constructor

  A new instance of ApiError.

Constructor Details

#initialize(message = nil, status_code: nil, body: nil) ⇒ ApiError

Returns a new instance of ApiError.

# File 'lib/openfigi_ruby/error.rb', line 16

def initialize(message = nil, status_code: nil, body: nil)
  super(message)
  @status_code = status_code
  @body = body
end

Instance Attribute Details

#body ⇒ String^? (readonly)

Returns raw response body.

Returns:

• (String, nil) —

  raw response body

# File 'lib/openfigi_ruby/error.rb', line 13

class ApiError < Error
  attr_reader :status_code, :body

  def initialize(message = nil, status_code: nil, body: nil)
    super(message)
    @status_code = status_code
    @body = body
  end
end

#status_code ⇒ Integer^? (readonly)

Returns HTTP status code from the response.

Returns:

• (Integer, nil) —

  HTTP status code from the response

# File 'lib/openfigi_ruby/error.rb', line 13

class ApiError < Error
  attr_reader :status_code, :body

  def initialize(message = nil, status_code: nil, body: nil)
    super(message)
    @status_code = status_code
    @body = body
  end
end