Class: MastercardMerchantCheckout::Card

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

Overview

This class contains card details for available cards.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Card

Returns a new instance of Card.



61
62
63
64
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
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 61

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?(:brand_id)
    self.brand_id = attributes[:brand_id]
  end
  
  if attributes.has_key?(:brand_name)
    self.brand_name = attributes[:brand_name]
  end
  
  if attributes.has_key?(:account_number)
    self. = attributes[:account_number]
  end
  
  if attributes.has_key?(:card_holder_name)
    self.card_holder_name = attributes[:card_holder_name]
  end
  
  if attributes.has_key?(:expiry_month)
    self.expiry_month = attributes[:expiry_month]
  end
  
  if attributes.has_key?(:expiry_year)
    self.expiry_year = attributes[:expiry_year]
  end
  
  if attributes.has_key?(:billing_address)
    self.billing_address = attributes[:billing_address]
  end
  
  if attributes.has_key?(:last_four)
    self.last_four = attributes[:last_four]
  end
  
end

Instance Attribute Details

#account_number ⇒ String

Returns the card number, also known as Primary Account Number (PAN).

Returns:

  • (String) —

    the card number, also known as Primary Account Number (PAN)



23
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 23

xml_accessor :account_number, :from =>"accountNumber"

#billing_address ⇒ Address

Returns the billing address associated with the card.

Returns:

  • (Address) —

    the billing address associated with the card.



39
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 39

xml_accessor :billing_address, :from =>"billingAddress",:as => Address

#brand_id ⇒ String

Returns the card brand id referenced by Masterpass (master, amex, diners, discover, jcb, maestro, visa).

Returns:

  • (String) —

    the card brand id referenced by Masterpass (master, amex, diners, discover, jcb, maestro, visa).



15
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 15

xml_accessor :brand_id, :from =>"brandId"

#brand_name ⇒ String

Returns the card brand full name (Mastercard, American Express, Diners Club, Discover, JCB, Maestro, Visa).

Returns:

  • (String) —

    the card brand full name (Mastercard, American Express, Diners Club, Discover, JCB, Maestro, Visa).



19
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 19

xml_accessor :brand_name, :from =>"brandName"

#card_holder_name ⇒ String

Returns the cardholder’s name.

Returns:

  • (String) —

    the cardholder’s name.



27
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 27

xml_accessor :card_holder_name, :from =>"cardHolderName"

#expiry_month ⇒ Integer

Returns the PAN expiration month, returned as a two-digit string.

Returns:

  • (Integer) —

    the PAN expiration month, returned as a two-digit string.



31
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 31

xml_accessor :expiry_month, :from =>"expiryMonth"

#expiry_year ⇒ Integer

Returns the PAN expiration year, returned as a two-digit string (for the year 2020, Masterpass will return 20).

Returns:

  • (Integer) —

    the PAN expiration year, returned as a two-digit string (for the year 2020, Masterpass will return 20).



35
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 35

xml_accessor :expiry_year, :from =>"expiryYear"

#last_four ⇒ String

Returns the last four digits of the PAN.

Returns:

  • (String) —

    the last four digits of the PAN.



43
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 43

xml_accessor :last_four, :from =>"lastFour"

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 47

def self.attribute_map
  {
    :brand_id => :brandId ,
    :brand_name => :brandName ,
    :account_number => :accountNumber ,
    :card_holder_name => :cardHolderName ,
    :expiry_month => :expiryMonth ,
    :expiry_year => :expiryYear ,
    :billing_address => :billingAddress ,
    :last_four => :lastFour 
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 106

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      brand_id == o.brand_id &&
      brand_name == o.brand_name &&
       == o. &&
      card_holder_name == o.card_holder_name &&
      expiry_month == o.expiry_month &&
      expiry_year == o.expiry_year &&
      billing_address == o.billing_address &&
      last_four == o.last_four
end

#_deserialize(type, value) ⇒ Object 



149
150
151
152
153
154
155
156
157
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
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 149

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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 208

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 130

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


120
121
122
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 120

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



125
126
127
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 125

def hash
  [brand_id, brand_name, , card_holder_name, expiry_month, expiry_year, billing_address, last_four].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



189
190
191
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 189

def to_body
  to_hash
end

#to_hash(include_root = false) ⇒ Object

return the object in the form of hash



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 194

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 ? { "Card" => hash } : hash  
  return attributes_hash
end

#to_s ⇒ Object 



184
185
186
 
# File 'lib/mastercard_merchant_checkout/models/card.rb', line 184

def to_s
  to_hash.to_s
end