Class: MastercardCoreSdk::Error

Inherits:
Object
  • Object
show all
Includes:
ROXML
Defined in:
lib/mastercard_core_sdk/models/error.rb

Overview

Defines attributes require for error handling.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Error

Returns a new instance of Error.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 50

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  if attributes.has_key?(:description)
    self.description = attributes[:description]
  end

  if attributes.has_key?(:reason_code)
    self.reason_code = attributes[:reason_code]
  end

  if attributes.has_key?(:recoverable)
    self.recoverable = attributes[:recoverable]
  end

  if attributes.has_key?(:source)
    self.source = attributes[:source]
  end

  if attributes.has_key?(:details)
    self.details = attributes[:details]
  end

  if attributes.has_key?(:extension_point)
    self.extension_point = attributes[:extension_point]
  end
end

Instance Attribute Details

#description ⇒ String

Returns the error description.

Returns:

  • (String) —

    the error description.



16
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 16

xml_accessor :description, :from => "Description"

#details ⇒ Details

Returns the error details.

Returns:



32
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 32

xml_accessor :details, :from => "Details", :as => Details

#extension_point ⇒ ExtensionPoint

Returns the ExtensionPoint for future enhancement.

Returns:



36
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 36

xml_accessor :extension_point, :from => "ExtensionPoint", :as => ExtensionPoint

#reason_code ⇒ String

Returns the error reason code.

Returns:

  • (String) —

    the error reason code.



20
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 20

xml_accessor :reason_code, :from => "ReasonCode"

#recoverable ⇒ BOOLEAN

Returns the error recoverable info.

Returns:

  • (BOOLEAN) —

    the error recoverable info.



24
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 24

xml_accessor :recoverable, :from => "Recoverable"

#source ⇒ String

Returns the source of error.

Returns:

  • (String) —

    the source of error.



28
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 28

xml_accessor :source, :from => "Source"

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 39

def self.attribute_map
  {
    :description => :Description,
    :reason_code => :ReasonCode,
    :recoverable => :Recoverable,
    :source => :Source,
    :details => :Details,
    :extension_point => :ExtensionPoint
  }
end

.datatype_map ⇒ Object

Attribute type mapping.



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 197

def self.datatype_map
  {
    :description => 'String',
    :reason_code => 'String',
    :recoverable => 'BOOLEAN',
    :source => 'String',
    :details => 'Details',
    :extension_point => 'ExtensionPoint'
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 82

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
  description == o.description &&
  reason_code == o.reason_code &&
  recoverable == o.recoverable &&
  source == o.source &&
  details == o.details &&
  extension_point == o.extension_point
end

#_deserialize(type, value) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 123

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model

  _model = MastercardCoreSdk.const_get(type).new
  _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 180

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 104

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.datatype_map.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
      #TODO show warning in debug mode

      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
    # data not found in attributes(hash), not an issue as the data can be optional

    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


94
95
96
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 94

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



99
100
101
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 99

def hash
  [description, reason_code, recoverable, source, details, extension_point].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



163
164
165
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 163

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



168
169
170
171
172
173
174
175
176
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 168

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



158
159
160
 
# File 'lib/mastercard_core_sdk/models/error.rb', line 158

def to_s
  to_hash.to_s
end