Exception: FriendlyShipping::ApiError

Inherits:

StandardError

• Object
• StandardError
• FriendlyShipping::ApiError

Defined in:

lib/friendly_shipping/api_error.rb

Overview

Raised when an API error is returned. Parent of carrier-specific API error classes.

Direct Known Subclasses

Services::RL::ApiError, Services::ShipEngine::ApiError, Services::TForceFreight::ApiError, Services::USPSShip::ApiError, Services::UpsFreight::ApiError, Services::UpsJson::ApiError

Instance Attribute Summary

• #cause ⇒ RestClient::Exception readonly

  The cause of the error.

Instance Method Summary

• #initialize(cause, message = nil) ⇒ ApiError constructor

  A new instance of ApiError.

Constructor Details

#initialize(cause, message = nil) ⇒ ApiError

Returns a new instance of ApiError.

Parameters:

• cause (RestClient::Exception, nil) —

  the cause of the error

• message (String) (defaults to: nil) —

  optional descriptive message

Raises:

• (ArgumentError)

# File 'lib/friendly_shipping/api_error.rb', line 11

def initialize(cause, message = nil)
  raise ArgumentError, "Must provide either a cause or a message" if cause.nil? && message.nil?

  @cause = cause
  super(message || cause&.message)
end

Instance Attribute Details

#cause ⇒ RestClient::Exception (readonly)

Returns the cause of the error.

Returns:

• (RestClient::Exception) —

  the cause of the error

# File 'lib/friendly_shipping/api_error.rb', line 7

def cause
  @cause
end