Class: Spree::CreditCard

Inherits:
Base
  • Object
show all
Includes:
ActiveMerchant::Billing::CreditCardMethods
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

Instance Method Summary collapse

Methods inherited from Base

belongs_to_required_by_default, page, spree_base_scopes

Methods included from Preferences::Preferable

#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Instance Attribute Details

#encrypted_data ⇒ Object

Returns the value of attribute encrypted_data.



19
20
21
 
# File 'app/models/spree/credit_card.rb', line 19

def encrypted_data
  @encrypted_data
end

#imported ⇒ Object

Returns the value of attribute imported.



19
20
21
 
# File 'app/models/spree/credit_card.rb', line 19

def imported
  @imported
end

#manual_entry ⇒ Object

Returns the value of attribute manual_entry.



19
20
21
 
# File 'app/models/spree/credit_card.rb', line 19

def manual_entry
  @manual_entry
end

#number ⇒ Object

Returns the value of attribute number.



18
19
20
 
# File 'app/models/spree/credit_card.rb', line 18

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) 


42
43
44
 
# File 'app/models/spree/credit_card.rb', line 42

def track_data
  @track_data
end

#verification_value ⇒ Object

Returns the value of attribute verification_value.



19
20
21
 
# File 'app/models/spree/credit_card.rb', line 19

def verification_value
  @verification_value
end

Instance Method Details

#actions ⇒ Object 



115
116
117
 
# File 'app/models/spree/credit_card.rb', line 115

def actions
  %w{capture void credit}
end

#can_capture?(payment) ⇒ Boolean

Indicates whether its possible to capture the payment

Returns:

  • (Boolean) 


120
121
122
 
# File 'app/models/spree/credit_card.rb', line 120

def can_capture?(payment)
  payment.pending? || payment.checkout?
end

#can_credit?(payment) ⇒ Boolean

Indicates whether its possible to credit the payment. Note that most gateways require that the payment be settled first which generally happens within 12-24 hours of the transaction.

Returns:

  • (Boolean) 


131
132
133
 
# File 'app/models/spree/credit_card.rb', line 131

def can_credit?(payment)
  payment.completed? && payment.credit_allowed > 0
end

#can_void?(payment) ⇒ Boolean

Indicates whether its possible to void the payment.

Returns:

  • (Boolean) 


125
126
127
 
# File 'app/models/spree/credit_card.rb', line 125

def can_void?(payment)
  !payment.failed? && !payment.void?
end

#cc_type=(type) ⇒ Object

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



85
86
87
88
89
90
91
92
93
 
# File 'app/models/spree/credit_card.rb', line 85

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_number ⇒ Object

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



111
112
113
 
# File 'app/models/spree/credit_card.rb', line 111

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

#expiry=(expiry) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'app/models/spree/credit_card.rb', line 59

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 ⇒ Object

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.



142
143
144
 
# File 'app/models/spree/credit_card.rb', line 142

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

#has_payment_profile? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_payment_profile?
  gateway_customer_profile_id.present? || gateway_payment_profile_id.present?
end

#last_name ⇒ Object 



146
147
148
 
# File 'app/models/spree/credit_card.rb', line 146

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

#set_last_digits ⇒ Object 



95
96
97
98
99
 
# File 'app/models/spree/credit_card.rb', line 95

def set_last_digits
  number.to_s.gsub!(/\s/, '')
  verification_value.to_s.gsub!(/\s/, '')
  self.last_digits ||= number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
end

#to_active_merchant ⇒ Object 



150
151
152
153
154
155
156
157
158
159
 
# File 'app/models/spree/credit_card.rb', line 150

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 



101
102
103
104
 
# File 'app/models/spree/credit_card.rb', line 101

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) 


106
107
108
 
# File 'app/models/spree/credit_card.rb', line 106

def verification_value?
  verification_value.present?
end