Class: Spree::CreditCard
- Includes:
- ActiveMerchant::Billing::CreditCardMethods, Metadata, 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
-
#encrypted_data ⇒ Object
Returns the value of attribute encrypted_data.
-
#imported ⇒ Object
Returns the value of attribute imported.
-
#manual_entry ⇒ Object
Returns the value of attribute manual_entry.
-
#number ⇒ Object
Returns the value of attribute number.
-
#track_data ⇒ String
ActiveMerchant::Billing::CreditCard added this accessor used by some gateways.
-
#verification_value ⇒ Object
Returns the value of attribute verification_value.
Class Method Summary collapse
Instance Method Summary collapse
- #actions ⇒ Object
-
#can_capture?(payment) ⇒ Boolean
Indicates whether its possible to capture the payment.
-
#can_credit?(payment) ⇒ Boolean
Indicates whether its possible to credit the payment.
-
#can_void?(payment) ⇒ Boolean
Indicates whether its possible to void the payment.
-
#cc_type=(type) ⇒ Object
cc_type is set by jquery.payment, which helpfully provides different types from Active Merchant.
- #display_brand ⇒ Object
-
#display_number ⇒ Object
Show the card number, with all but last 4 numbers replace with “X”.
- #expiry=(expiry) ⇒ Object
-
#first_name ⇒ Object
ActiveMerchant needs first_name/last_name because we pass it a Spree::CreditCard and it calls those methods on it.
- #has_payment_profile? ⇒ Boolean
- #last_name ⇒ Object
- #set_last_digits ⇒ Object
- #to_active_merchant ⇒ Object
- #try_type_from_number ⇒ Object
- #verification_value? ⇒ Boolean
Methods inherited from Base
belongs_to_required_by_default, for_store, has_many_inversing, json_api_columns, json_api_type, page, spree_base_scopes, spree_base_uniqueness_scope
Methods included from Preferences::Preferable
#clear_preferences, #default_preferences, #defined_preferences, #deprecated_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_deprecated, #preference_type, #set_preference
Instance Attribute Details
#encrypted_data ⇒ Object
Returns the value of attribute encrypted_data.
28 29 30 |
# File 'app/models/spree/credit_card.rb', line 28 def encrypted_data @encrypted_data end |
#imported ⇒ Object
Returns the value of attribute imported.
28 29 30 |
# File 'app/models/spree/credit_card.rb', line 28 def imported @imported end |
#manual_entry ⇒ Object
Returns the value of attribute manual_entry.
28 29 30 |
# File 'app/models/spree/credit_card.rb', line 28 def manual_entry @manual_entry end |
#number ⇒ Object
Returns the value of attribute number.
27 28 29 |
# File 'app/models/spree/credit_card.rb', line 27 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
56 57 58 |
# File 'app/models/spree/credit_card.rb', line 56 def track_data @track_data end |
#verification_value ⇒ Object
Returns the value of attribute verification_value.
27 28 29 |
# File 'app/models/spree/credit_card.rb', line 27 def verification_value @verification_value end |
Class Method Details
.json_api_permitted_attributes ⇒ Object
181 182 183 184 185 186 187 188 |
# File 'app/models/spree/credit_card.rb', line 181 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
#actions ⇒ Object
135 136 137 |
# File 'app/models/spree/credit_card.rb', line 135 def actions %w{capture void credit} end |
#can_capture?(payment) ⇒ Boolean
Indicates whether its possible to capture the payment
140 141 142 |
# File 'app/models/spree/credit_card.rb', line 140 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.
151 152 153 |
# File 'app/models/spree/credit_card.rb', line 151 def can_credit?(payment) payment.completed? && payment.credit_allowed > 0 end |
#can_void?(payment) ⇒ Boolean
Indicates whether its possible to void the payment.
145 146 147 |
# File 'app/models/spree/credit_card.rb', line 145 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.
99 100 101 102 103 104 105 106 107 |
# File 'app/models/spree/credit_card.rb', line 99 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 ⇒ Object
131 132 133 |
# File 'app/models/spree/credit_card.rb', line 131 def display_brand brand.present? ? brand.upcase : Spree.t(:no_cc_type) end |
#display_number ⇒ Object
Show the card number, with all but last 4 numbers replace with “X”. (XXXX-XXXX-XXXX-4338)
127 128 129 |
# File 'app/models/spree/credit_card.rb', line 127 def display_number "XXXX-XXXX-XXXX-#{last_digits}" end |
#expiry=(expiry) ⇒ Object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'app/models/spree/credit_card.rb', line 73 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.
162 163 164 |
# File 'app/models/spree/credit_card.rb', line 162 def first_name name.to_s.split(/[[:space:]]/, 2)[0] end |
#has_payment_profile? ⇒ Boolean
155 156 157 |
# File 'app/models/spree/credit_card.rb', line 155 def has_payment_profile? gateway_customer_profile_id.present? || gateway_payment_profile_id.present? end |
#last_name ⇒ Object
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 ⇒ Object
113 114 115 |
# File 'app/models/spree/credit_card.rb', line 113 def set_last_digits self.last_digits ||= number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1) end |
#to_active_merchant ⇒ Object
170 171 172 173 174 175 176 177 178 179 |
# File 'app/models/spree/credit_card.rb', line 170 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
117 118 119 120 |
# File 'app/models/spree/credit_card.rb', line 117 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
122 123 124 |
# File 'app/models/spree/credit_card.rb', line 122 def verification_value? verification_value.present? end |