Class: Spree::CreditCard

Inherits:
Object
  • Object
show all
Includes:
ActiveMerchant::Billing::CreditCardMethods, Metadata, PaymentSourceConcern, Security::CreditCards, Webhooks::HasWebhooks
Defined in:
app/models/spree/credit_card.rb

Constant Summary collapse

CARD_TYPES = 
{
  visa: /^4\d{12}(\d{3})?(\d{3})?$/,
  master: /^(5[1-5]\d{4}|677189|222[1-9]\d{2}|22[3-9]\d{3}|2[3-6]\d{4}|27[01]\d{3}|2720\d{2})\d{10}$/,
  discover: /^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/,
  american_express: /^3[47]\d{13}$/,
  diners_club: /^3(0[0-5]|[68]\d)\d{11}$/,
  jcb: /^35(28|29|[3-8]\d)\d{12}$/,
  switch: /^6759\d{12}(\d{2,3})?$/,
  solo: /^6767\d{12}(\d{2,3})?$/,
  dankort: /^5019\d{12}$/,
  maestro: /^(5[06-8]|6\d)\d{10,17}$/,
  forbrugsforeningen: /^600722\d{10}$/,
  laser: /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PaymentSourceConcern

#actions, #can_capture?, #can_credit?, #can_void?, #has_payment_profile?

Instance Attribute Details

#encrypted_data ⇒ Object

Returns the value of attribute encrypted_data.



31
32
33
 
# File 'app/models/spree/credit_card.rb', line 31

def encrypted_data
  @encrypted_data
end

#imported ⇒ Object

Returns the value of attribute imported.



31
32
33
 
# File 'app/models/spree/credit_card.rb', line 31

def imported
  @imported
end

#manual_entry ⇒ Object

Returns the value of attribute manual_entry.



31
32
33
 
# File 'app/models/spree/credit_card.rb', line 31

def manual_entry
  @manual_entry
end

#number ⇒ Object

Returns the value of attribute number.



30
31
32
 
# File 'app/models/spree/credit_card.rb', line 30

def number
  @number
end

#track_data ⇒ String

ActiveMerchant::Billing::CreditCard added this accessor used by some gateways. More info: github.com/spree/spree/issues/6209

Returns or sets the track data for the card

Returns:

  • (String) 


68
69
70
 
# File 'app/models/spree/credit_card.rb', line 68

def track_data
  @track_data
end

#verification_value ⇒ Object

Returns the value of attribute verification_value.



30
31
32
 
# File 'app/models/spree/credit_card.rb', line 30

def verification_value
  @verification_value
end

Class Method Details

.json_api_permitted_attributes ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'app/models/spree/credit_card.rb', line 183

def self.json_api_permitted_attributes
  [
    'number', 'month', 'year', 'expiry', 'verification_value', 'first_name', 'last_name',
    'cc_type', 'gateway_customer_profile_id', 'gateway_payment_profile_id', 'last_digits',
    'name', 'encrypted_data', 'address_id', 'created_at', 'updated_at', 'user_id',
    'payment_method_id', 'default', 'deleted_at'
  ]
end

Instance Method Details

#cc_type=(type) ⇒ Object Also known as: brand=

cc_type is set by jquery.payment, which helpfully provides different types from Active Merchant. Converting them is necessary.



111
112
113
114
115
116
117
118
119
 
# File 'app/models/spree/credit_card.rb', line 111

def cc_type=(type)
  self[:cc_type] = case type
                   when 'mastercard', 'maestro' then 'master'
                  when 'amex' then 'american_express'
                   when 'dinersclub' then 'diners_club'
                   when '' then try_type_from_number
                   else type
                   end
end

#display_brand ⇒ String

Show the card brand, eg. “VISA”, “MASTERCARD”, etc.

Returns:

  • (String) 


150
151
152
 
# File 'app/models/spree/credit_card.rb', line 150

def display_brand
  brand.present? ? brand.upcase : Spree.t(:no_cc_type)
end

#display_number ⇒ String

Show the card number, with all but last 4 numbers replace with “X”. (XXXX-XXXX-XXXX-4338)

Returns:

  • (String) 


144
145
146
 
# File 'app/models/spree/credit_card.rb', line 144

def display_number
  "XXXX-XXXX-XXXX-#{last_digits}"
end

#expiry=(expiry) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'app/models/spree/credit_card.rb', line 85

def expiry=(expiry)
  return unless expiry.present?

  self[:month], self[:year] =
    if expiry =~ /\d{2}\s?\/\s?\d{2,4}/ # will match mm/yy and mm / yyyy
      expiry.delete(' ').split('/')
    elsif match = expiry.match(/(\d{2})(\d{2,4})/) # will match mmyy and mmyyyy
      [match[1], match[2]]
    end
  if self[:year]
    self[:year] = "20#{self[:year]}" if (self[:year] / 100).zero?
    self[:year] = self[:year].to_i
  end
  self[:month] = self[:month].to_i if self[:month]
end

#first_name ⇒ String

ActiveMerchant needs first_name/last_name because we pass it a Spree::CreditCard and it calls those methods on it. Looking at the ActiveMerchant source code we should probably be calling #to_active_merchant before passing the object to ActiveMerchant but this should do for now.

Returns the first name of the cardholder.

Returns:

  • (String) 


160
161
162
 
# File 'app/models/spree/credit_card.rb', line 160

def first_name
  name.to_s.split(/[[:space:]]/, 2)[0]
end

#last_name ⇒ String

Returns the last name of the cardholder.

Returns:

  • (String) 


166
167
168
 
# File 'app/models/spree/credit_card.rb', line 166

def last_name
  name.to_s.split(/[[:space:]]/, 2)[1]
end

#set_last_digits ⇒ String

Returns the last 4 digits of the card number.

Returns:

  • (String) —

    , eg. “4338”



129
130
131
 
# File 'app/models/spree/credit_card.rb', line 129

def set_last_digits
  self.last_digits ||= number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
end

#to_active_merchant ⇒ ActiveMerchant::Billing::CreditCard

Returns an ActiveMerchant::Billing::CreditCard object.

Returns:

  • (ActiveMerchant::Billing::CreditCard) 


172
173
174
175
176
177
178
179
180
181
 
# File 'app/models/spree/credit_card.rb', line 172

def to_active_merchant
  ActiveMerchant::Billing::CreditCard.new(
    number: number,
    month: month,
    year: year,
    verification_value: verification_value,
    first_name: first_name,
    last_name: last_name
  )
end

#try_type_from_number ⇒ Object 



133
134
135
136
 
# File 'app/models/spree/credit_card.rb', line 133

def try_type_from_number
  numbers = number.delete(' ') if number
  CARD_TYPES.find { |type, pattern| return type.to_s if numbers =~ pattern }.to_s
end

#verification_value? ⇒ Boolean

Returns:

  • (Boolean) 


138
139
140
 
# File 'app/models/spree/credit_card.rb', line 138

def verification_value?
  verification_value.present?
end

#wallet_type ⇒ String

Returns the type of wallet the card is associated with, eg. “apple_pay”, “google_pay”, etc.

Returns:

  • (String) 


58
59
60
 
# File 'app/models/spree/credit_card.rb', line 58

def wallet_type
  wallet&.[]('type')
end