Class: Faker::Finance

Inherits:
Base
  • Object
show all
Defined in:
lib/faker/default/finance.rb

Constant Summary collapse

CREDIT_CARD_TYPES = 
%i[visa mastercard discover american_express
diners_club jcb switch solo dankort
maestro forbrugsforeningen laser].freeze
MARKET_LIST = 
%i[nyse nasdaq].freeze

Constants inherited from Base

Base::LLetters, Base::Letters, Base::NOT_GIVEN, Base::Numbers, Base::ULetters

Class Method Summary collapse

Methods inherited from Base

bothify, disable_enforce_available_locales, fetch, fetch_all, flexible, letterify, method_missing, numerify, parse, rand, rand_in_range, regexify, resolve, respond_to_missing?, sample, shuffle, translate, unique, with_locale

Class Method Details

.credit_card(*types) ⇒ String

Produces a random credit card number.

Examples:

Faker::Finance.credit_card #=> "3018-348979-1853"
Faker::Finance.credit_card(:mastercard) #=> "6771-8921-2291-6236"
Faker::Finance.credit_card(:mastercard, :visa) #=> "4448-8934-1277-7195"

Parameters:

  • types (String) —

    Specific credit card type.

Returns:

  • (String)

Available since:

  • 1.2.0


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/faker/default/finance.rb', line 24

def credit_card(*types)
  types = CREDIT_CARD_TYPES if types.empty?
  type = sample(types)
  template = numerify(fetch("finance.credit_card.#{type}"))

  # calculate the luhn checksum digit
  multiplier = 1
  luhn_sum = template.gsub(/[^0-9]/, '').split('').reverse.map(&:to_i).inject(0) do |sum, digit|
    multiplier = (multiplier == 2 ? 1 : 2)
    sum + (digit * multiplier).to_s.split('').map(&:to_i).inject(0) { |digit_sum, cur| digit_sum + cur }
  end

  # the sum plus whatever the last digit is must be a multiple of 10. So, the
  # last digit must be 10 - the last digit of the sum.
  luhn_digit = (10 - (luhn_sum % 10)) % 10

  template.gsub('L', luhn_digit.to_s)
end

.ticker(*markets) ⇒ String

Returns a randomly-selected stock ticker from a specified market.

Examples:

Faker::Finance.ticker #=> 'AMZN'
Faker::Finance.vat_number('NASDAQ') #=> 'GOOG'

Parameters:

  • markets (String) —

    The name of the market to choose the ticker from (e.g. NYSE, NASDAQ)

Returns:

  • (String)

Available since:

  • next


80
81
82
83
84
85
86
 
# File 'lib/faker/default/finance.rb', line 80

def ticker(*markets)
  markets = MARKET_LIST if markets.empty?
  market = sample(markets)
  fetch("finance.ticker.#{market}")
rescue I18n::MissingTranslationData
  raise ArgumentError, "Could not find market named #{market}"
end

.vat_number(legacy_country = NOT_GIVEN, country: 'BR') ⇒ String

Produces a random vat number.

Examples:

Faker::Finance.vat_number #=> "BR38.395.329/2471-83"
Faker::Finance.vat_number('DE') #=> "DE593306671"
Faker::Finance.vat_number('ZA') #=> "ZA79494416181"

Parameters:

  • country (String) (defaults to: 'BR') —

    Two capital letter country code to use for the vat number.

Returns:

  • (String)

Available since:

  • 1.9.2


55
56
57
58
59
60
61
62
63
 
# File 'lib/faker/default/finance.rb', line 55

def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
  warn_for_deprecated_arguments do |keywords|
    keywords << :country if legacy_country != NOT_GIVEN
  end

  numerify(fetch("finance.vat_number.#{country}"))
rescue I18n::MissingTranslationData
  raise ArgumentError, "Could not find vat number for #{country}"
end

.vat_number_keys ⇒ Object 


65
66
67
 
# File 'lib/faker/default/finance.rb', line 65

def vat_number_keys
  translate('faker.finance.vat_number').keys
end