Class: FriendlyShipping::ApiFailure

Inherits:

ApiResult

• Object
• ApiResult
• FriendlyShipping::ApiFailure

Defined in:

lib/friendly_shipping/api_failure.rb

Overview

Wraps an API result from a request that failed.

Instance Attribute Summary

• #data ⇒ Object (also: #failure) readonly

  The API failure (typically an exception).

Attributes inherited from ApiResult

#original_request, #original_response

Instance Method Summary

• #to_s ⇒ #to_s

  A string representation of the failure.

Methods inherited from ApiResult

#initialize

Constructor Details

This class inherits a constructor from FriendlyShipping::ApiResult

Instance Attribute Details

#data ⇒ Object (readonly) Also known as: failure

The API failure (typically an exception)

# File 'lib/friendly_shipping/api_failure.rb', line 8

alias_method :failure, :data

Instance Method Details

#to_s ⇒ #to_s

Returns a string representation of the failure.

Returns:

• (#to_s) —

  a string representation of the failure

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

def to_s
  failure.to_s
end