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) 

327
328
329
330
331
332
333
334
335
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 327

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


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

def card_companies
  CARD_COMPANY_DETECTORS.keys
end

#electron?(number) ⇒ Boolean

Returns:

  • (Boolean) 

337
338
339
340
341
342
343
344
345
346
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 337

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 


353
354
355
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 353

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

#last_digits(number) ⇒ Object 


357
358
359
360
361
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 357

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

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

#mask(number) ⇒ Object 


363
364
365
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 363

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) 

368
369
370
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 368

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

#matching_type?(number, brand) ⇒ Boolean

Returns:

  • (Boolean) 

372
373
374
375
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 372

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) 

348
349
350
351
 
# File 'lib/active_merchant/billing/credit_card_methods.rb', line 348

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) 

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

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