Module: ActiveMerchant::Billing::CreditCardMethods::ClassMethods

Defined in:
lib/active_merchant/billing/credit_card_methods.rb

Instance Method Summary collapse

Instance Method Details

#brand?(number) ⇒ Boolean

Returns a string containing the brand of card from the list of known information below.

Returns:

  • (Boolean)

277
278
279
280
281
282
283
284
285
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 277

def brand?(number)
  return 'bogus' if valid_test_mode_card_number?(number)

  CARD_COMPANY_DETECTORS.each do |company, func|
    return company.dup if func.call(number)
  end

  return nil
end

#card_companiesObject


272
273
274
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 272

def card_companies
  CARD_COMPANY_DETECTORS.keys
end

#electron?(number) ⇒ Boolean

Returns:

  • (Boolean)

287
288
289
290
291
292
293
294
295
296
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 287

def electron?(number)
  return false unless [16, 19].include?(number&.length)

  # don't recalculate for each range
  bank_identification_number = first_digits(number).to_i

  ELECTRON_RANGES.any? do |range|
    range.include?(bank_identification_number)
  end
end

#first_digits(number) ⇒ Object


303
304
305
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 303

def first_digits(number)
  number&.slice(0, 6) || ''
end

#last_digits(number) ⇒ Object


307
308
309
310
311
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 307

def last_digits(number)
  return '' if number.nil?

  number.length <= 4 ? number : number.slice(-4..-1)
end

#mask(number) ⇒ Object


313
314
315
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 313

def mask(number)
  "XXXX-XXXX-XXXX-#{last_digits(number)}"
end

#matching_brand?(number, brand) ⇒ Boolean

Checks to see if the calculated brand matches the specified brand

Returns:

  • (Boolean)

318
319
320
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 318

def matching_brand?(number, brand)
  brand?(number) == brand
end

#matching_type?(number, brand) ⇒ Boolean

Returns:

  • (Boolean)

322
323
324
325
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 322

def matching_type?(number, brand)
  ActiveMerchant.deprecated 'CreditCard#matching_type? is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#matching_brand? instead.'
  matching_brand?(number, brand)
end

#type?(number) ⇒ Boolean

Returns:

  • (Boolean)

298
299
300
301
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 298

def type?(number)
  ActiveMerchant.deprecated 'CreditCard#type? is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#brand? instead.'
  brand?(number)
end

#valid_number?(number) ⇒ Boolean

Returns true if it validates. Optionally, you can pass a card brand as an argument and make sure it is of the correct brand.

References:

Returns:

  • (Boolean)

265
266
267
268
269
270
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 265

def valid_number?(number)
  valid_test_mode_card_number?(number) ||
    valid_card_number_length?(number) &&
      valid_card_number_characters?(number) &&
      valid_by_algorithm?(brand?(number), number)
end