Class: PaypalServerSdk::ErrorException

Inherits:
APIException
  • Object
show all
Defined in:
lib/paypal_server_sdk/exceptions/error_exception.rb

Overview

The error details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(reason, response) ⇒ ErrorException

The constructor.

Parameters:

  • reason (String) —

    The reason for raising an exception.

  • response (HttpResponse) —

    The HttpReponse of the API call.



36
37
38
39
40
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 36

def initialize(reason, response)
  super(reason, response)
  hash = APIHelper.json_deserialize(@response.raw_body)
  unbox(hash)
end

Instance Attribute Details

#debug_id ⇒ String

The PayPal internal ID. Used for correlation purposes.

Returns:

  • (String) 


22
23
24
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 22

def debug_id
  @debug_id
end

#details ⇒ Array[ErrorDetails]

An array of additional details about the error.

Returns:



26
27
28
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 26

def details
  @details
end

#links ⇒ Array[LinkDescription]

An array of request-related [HATEOAS links](/api/rest/responses/#hateoas-links).

Returns:



31
32
33
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 31

def links
  @links
end

#message ⇒ String

The message that describes the error.

Returns:

  • (String) 


18
19
20
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 18

def message
  @message
end

#name ⇒ String

The human-readable, unique name of the error.

Returns:

  • (String) 


14
15
16
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 14

def name
  @name
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



81
82
83
84
85
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 81

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name.inspect}, message: #{@message.inspect}, debug_id:"\
  " #{@debug_id.inspect}, details: #{@details.inspect}, links: #{@links.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



74
75
76
77
78
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 74

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} name: #{@name}, message: #{@message}, debug_id: #{@debug_id}, details:"\
  " #{@details}, links: #{@links}>"
end

#unbox(hash) ⇒ Object

Populates this object by extracting properties from a hash. response body.

Parameters:

  • hash (Hash) —

    The deserialized response sent by the server in the



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/paypal_server_sdk/exceptions/error_exception.rb', line 45

def unbox(hash)
  return nil unless hash

  @name = hash.key?('name') ? hash['name'] : nil
  @message = hash.key?('message') ? hash['message'] : nil
  @debug_id = hash.key?('debug_id') ? hash['debug_id'] : nil
  # Parameter is an array, so we need to iterate through it
  @details = nil
  unless hash['details'].nil?
    @details = []
    hash['details'].each do |structure|
      @details << (ErrorDetails.from_hash(structure) if structure)
    end
  end

  @details = SKIP unless hash.key?('details')
  # Parameter is an array, so we need to iterate through it
  @links = nil
  unless hash['links'].nil?
    @links = []
    hash['links'].each do |structure|
      @links << (LinkDescription.from_hash(structure) if structure)
    end
  end

  @links = SKIP unless hash.key?('links')
end