Class: Spree::CreditCard

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/credit_card.rb

Constant Summary collapse

CARD_TYPES = 
{
  visa: /^4[0-9]{12}(?:[0-9]{3})?$/,
  master: /(^5[1-5][0-9]{14}$)|(^6759[0-9]{2}([0-9]{10})$)|(^6759[0-9]{2}([0-9]{12})$)|(^6759[0-9]{2}([0-9]{13})$)/,
  diners_club: /^3(?:0[0-5]|[68][0-9])[0-9]{11}$/,
  american_express: /^3[47][0-9]{13}$/,
  discover: /^6(?:011|5[0-9]{2})[0-9]{12}$/,
  jcb: /^(?:2131|1800|35\d{3})\d{11}$/
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Preferences::Preferable

#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.



14
15
16
 
# File 'app/models/spree/credit_card.rb', line 14

def encrypted_data
  @encrypted_data
end

#imported ⇒ Object

Returns the value of attribute imported.



14
15
16
 
# File 'app/models/spree/credit_card.rb', line 14

def imported
  @imported
end

#number ⇒ Object

Returns the value of attribute number.



14
15
16
 
# File 'app/models/spree/credit_card.rb', line 14

def number
  @number
end

#verification_value ⇒ Object

Returns the value of attribute verification_value.



14
15
16
 
# File 'app/models/spree/credit_card.rb', line 14

def verification_value
  @verification_value
end

Instance Method Details

#actions ⇒ Array<String>

Returns the actions available on this credit card.

Returns:

  • (Array<String>) —

    the actions available on this credit card



108
109
110
 
# File 'app/models/spree/credit_card.rb', line 108

def actions
  %w{capture void credit}
end

#can_capture?(payment) ⇒ Boolean

Returns true when the payment is in the pending or checkout states.

Parameters:

  • payment (Spree::Payment) —

    the payment we want to know if can be captured

Returns:

  • (Boolean) —

    true when the payment is in the pending or checkout states



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

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.

Parameters:

  • payment (Spree::Payment) —

    the payment we want to know if can be credited

Returns:

  • (Boolean) —

    true when the payment is completed and can be credited



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

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

#can_void?(payment) ⇒ Boolean

Returns true when the payment is not failed or voided.

Parameters:

  • payment (Spree::Payment) —

    the payment we want to know if can be voided

Returns:

  • (Boolean) —

    true when the payment is not failed or voided



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

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

#cc_type=(type) ⇒ Object

Sets the credit card type, converting it to the preferred internal representation from jquery.payment’s representation when appropriate.

Parameters:

  • type (String) —

    the desired credit card type



70
71
72
73
74
75
76
77
78
79
80
 
# File 'app/models/spree/credit_card.rb', line 70

def cc_type=(type)
  # cc_type is set by jquery.payment, which helpfully provides different
  # types from Active Merchant. Converting them is necessary.
  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 ⇒ String

Returns the card number, with all but last 4 numbers replace with “X”, as in “XXXX-XXXX-XXXX-4338”.

Returns:

  • (String) —

    the card number, with all but last 4 numbers replace with “X”, as in “XXXX-XXXX-XXXX-4338”



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

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

#expiry=(expiry) ⇒ Object

Sets the expiry date on this credit card.

Parameters:

  • expiry (String) —

    the desired new expiry date in one of the following formats: “mm/yy”, “mm / yyyy”, “mmyy”, “mmyyyy”



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'app/models/spree/credit_card.rb', line 43

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

  self[:month], self[:year] =
  if expiry.match(/\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].length == 2
    self[:year] = self[:year].to_i
  end
  self[:month] = self[:month].to_i if self[:month]
end

#first_name ⇒ String

TODO:

We should probably be calling #to_active_merchant before passing the object to ActiveMerchant.

Note:

ActiveMerchant needs first_name/last_name because we pass it a Spree::CreditCard and it calls those methods on it.

Returns the first name on this credit card.

Returns:

  • (String) —

    the first name on this credit card



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

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

#has_payment_profile? ⇒ Boolean

Returns true when there is a gateway customer or payment profile id present.

Returns:

  • (Boolean) —

    true when there is a gateway customer or payment profile id present



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

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

#last_name ⇒ String

TODO:

We should probably be calling #to_active_merchant before passing the object to ActiveMerchant.

Note:

ActiveMerchant needs first_name/last_name because we pass it a Spree::CreditCard and it calls those methods on it.

Returns the last name on this credit card.

Returns:

  • (String) —

    the last name on this credit card



154
155
156
 
# File 'app/models/spree/credit_card.rb', line 154

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

#set_last_digits ⇒ Object

Sets the last digits field based on the assigned credit card number.



83
84
85
86
87
 
# File 'app/models/spree/credit_card.rb', line 83

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 ⇒ ActiveMerchant::Billing::CreditCard

Returns an ActiveMerchant credit card that represents this credit card.

Returns:

  • (ActiveMerchant::Billing::CreditCard) —

    an ActiveMerchant credit card that represents this credit card



160
161
162
163
164
165
166
167
168
169
 
# File 'app/models/spree/credit_card.rb', line 160

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

Returns the credit card type if it can be determined from the number, otherwise the empty string.

Returns:

  • (String) —

    the credit card type if it can be determined from the number, otherwise the empty string



91
92
93
94
 
# File 'app/models/spree/credit_card.rb', line 91

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 true when a verification value is present.

Returns:

  • (Boolean) —

    true when a verification value is present



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

def verification_value?
  verification_value.present?
end