Class: MastercardMerchantCheckout::Address

Inherits:
Object
  • Object
show all
Includes:
ROXML
Defined in:
lib/mastercard_merchant_checkout/models/address.rb

Overview

This class contains methods to get the consumer’s address details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Returns a new instance of Address.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 65

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?(:city)
    self.city = attributes[:city]
  end
  
  if attributes.has_key?(:country)
    self.country = attributes[:country]
  end
  
  if attributes.has_key?(:subdivision)
    self.subdivision = attributes[:subdivision]
  end
  
  if attributes.has_key?(:line1)
    self.line1 = attributes[:line1]
  end
  
  if attributes.has_key?(:line2)
    self.line2 = attributes[:line2]
  end
  
  if attributes.has_key?(:line3)
    self.line3 = attributes[:line3]
  end
  
  if attributes.has_key?(:line4)
    self.line4 = attributes[:line4]
  end
  
  if attributes.has_key?(:line5)
    self.line5 = attributes[:line5]
  end
  
  if attributes.has_key?(:postal_code)
    self.postal_code = attributes[:postal_code]
  end
  
end

Instance Attribute Details

#city ⇒ String

Returns the cardholder’s city.

Returns:

  • (String) —

    the cardholder’s city.



14
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 14

xml_accessor :city, :from =>"city"

#country ⇒ String

Returns the cardholder’s country as defined by ISO 3166-1 alpha-2 country codes.

Returns:

  • (String) —

    the cardholder’s country as defined by ISO 3166-1 alpha-2 country codes.



18
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 18

xml_accessor :country, :from =>"country"

#line1 ⇒ String

Returns the cardholder’s house number and the street name.

Returns:

  • (String) —

    the cardholder’s house number and the street name.



26
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 26

xml_accessor :line1, :from =>"line1"

#line2 ⇒ String

Returns the cardholder’s apartment number, suite number, etc.

Returns:

  • (String) —

    the cardholder’s apartment number, suite number, etc.



30
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 30

xml_accessor :line2, :from =>"line2"

#line3 ⇒ String

Returns the cardholder’s remaining address information that does not fit in lines 1 and 2.

Returns:

  • (String) —

    the cardholder’s remaining address information that does not fit in lines 1 and 2.



34
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 34

xml_accessor :line3, :from =>"line3"

#line4 ⇒ String

Returns the line4 is only returned for addresses in Brazil, and provides the cardholder’s billing house number. If no data is returned for this field, then reference card​.billingAddress​.line1.

Returns:

  • (String) —

    the line4 is only returned for addresses in Brazil, and provides the cardholder’s billing house number. If no data is returned for this field, then reference card​.billingAddress​.line1



38
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 38

xml_accessor :line4, :from =>"line4"

#line5 ⇒ String

Returns the line5 is only returned for addresses in Brazil, and provides the cardholder’s billing street name. If no data is returned for this field, then reference card​.billingAddress​.line1.

Returns:

  • (String) —

    the line5 is only returned for addresses in Brazil, and provides the cardholder’s billing street name. If no data is returned for this field, then reference card​.billingAddress​.line1



42
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 42

xml_accessor :line5, :from =>"line5"

#postal_code ⇒ String

Returns the cardholder’s postal code or zip code.

Returns:

  • (String) —

    the cardholder’s postal code or zip code.



46
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 46

xml_accessor :postal_code, :from =>"postalCode"

#subdivision ⇒ String

Returns the cardholder’s country’s subdivision as defined by ISO 3166-1 alpha-2 code for US, CA, AU, JP, and BR. All other countries use a freeform text field.

Returns:

  • (String) —

    the cardholder’s country’s subdivision as defined by ISO 3166-1 alpha-2 code for US, CA, AU, JP, and BR. All other countries use a freeform text field.



22
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 22

xml_accessor :subdivision, :from =>"subdivision"

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 50

def self.attribute_map
  {
    :city => :city ,
    :country => :country ,
    :subdivision => :subdivision ,
    :line1 => :line1 ,
    :line2 => :line2 ,
    :line3 => :line3 ,
    :line4 => :line4 ,
    :line5 => :line5 ,
    :postal_code => :postalCode 
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      city == o.city &&
      country == o.country &&
      subdivision == o.subdivision &&
      line1 == o.line1 &&
      line2 == o.line2 &&
      line3 == o.line3 &&
      line4 == o.line4 &&
      line5 == o.line5 &&
      postal_code == o.postal_code
end

#_deserialize(type, value) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 158

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.to_s =~ /\A(true|t|yes|y|1)\z/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 = MastercardMerchantCheckout.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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 217

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 139

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


129
130
131
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



134
135
136
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 134

def hash
  [city, country, subdivision, line1, line2, line3, line4, line5, postal_code].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



198
199
200
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 198

def to_body
  to_hash
end

#to_hash(include_root = false) ⇒ Object

return the object in the form of hash



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 203

def to_hash(include_root = false)
  attributes_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
  attributes_hash = include_root ? { "Address" => hash } : hash  
  return attributes_hash
end

#to_s ⇒ Object 



193
194
195
 
# File 'lib/mastercard_merchant_checkout/models/address.rb', line 193

def to_s
  to_hash.to_s
end