class Faker::Internet

Public Class Methods

base64(length: 16, padding: false, urlsafe: true) click to toggle source

Produces a random string of alphabetic characters, (no digits)

@param length [Integer] The length of the string to generate @param padding [Boolean] Toggles if a final equal '=' will be added. @param urlsafe [Boolean] Toggles charset to '-' and '_' instead of '+' and '/'.

@return [String]

@example

Faker::Internet.base64
  #=> "r_hbZ2DSD-ZACzZT"

@example

Faker::Internet.base64(length: 4, padding: true, urlsafe: false)
  #=> "x1/R="

@faker.version 2.11.0

# File lib/faker/default/internet.rb, line 315
def base64(length: 16, padding: false, urlsafe: true)
  char_range = [
    Array('0'..'9'),
    Array('A'..'Z'),
    Array('a'..'z'),
    urlsafe ? %w[- _] : %w[+ /]
  ].flatten
  s = Array.new(length) { sample(char_range) }.join
  s += '=' if padding
  s
end
device_token() click to toggle source
# File lib/faker/default/internet.rb, line 276
def device_token
  shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join
end
domain_name(legacy_subdomain = NOT_GIVEN, subdomain: false, domain: nil) click to toggle source
# File lib/faker/default/internet.rb, line 138
def domain_name(legacy_subdomain = NOT_GIVEN, subdomain: false, domain: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :subdomain if legacy_subdomain != NOT_GIVEN
  end

  with_locale(:en) do
    if domain
      domain
        .split('.')
        .map { |domain_part| Char.prepare(domain_part) }
        .tap do |domain_elements|
          domain_elements << domain_suffix if domain_elements.length < 2
          domain_elements.unshift(Char.prepare(domain_word)) if subdomain && domain_elements.length < 3
        end.join('.')
    else
      [domain_word, domain_suffix].tap do |domain_elements|
        domain_elements.unshift(Char.prepare(domain_word)) if subdomain
      end.join('.')
    end
  end
end
domain_suffix() click to toggle source
# File lib/faker/default/internet.rb, line 172
def domain_suffix
  fetch('internet.domain_suffix')
end
domain_word() click to toggle source
# File lib/faker/default/internet.rb, line 168
def domain_word
  with_locale(:en) { Char.prepare(Company.name.split(' ').first) }
end
email(legacy_name = NOT_GIVEN, legacy_separators = NOT_GIVEN, name: nil, separators: nil, domain: nil) click to toggle source
# File lib/faker/default/internet.rb, line 6
def email(legacy_name = NOT_GIVEN, legacy_separators = NOT_GIVEN, name: nil, separators: nil, domain: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :name if legacy_name != NOT_GIVEN
    keywords << :separators if legacy_separators != NOT_GIVEN
  end

  if separators
    [username(specifier: name, separators: separators), domain_name(domain: domain)].join('@')
  else
    [username(specifier: name), domain_name(domain: domain)].join('@')
  end
end
fix_umlauts(legacy_string = NOT_GIVEN, string: '') click to toggle source
# File lib/faker/default/internet.rb, line 160
def fix_umlauts(legacy_string = NOT_GIVEN, string: '')
  warn_for_deprecated_arguments do |keywords|
    keywords << :string if legacy_string != NOT_GIVEN
  end

  Char.fix_umlauts(string)
end
free_email(legacy_name = NOT_GIVEN, name: nil) click to toggle source
# File lib/faker/default/internet.rb, line 19
def free_email(legacy_name = NOT_GIVEN, name: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :name if legacy_name != NOT_GIVEN
  end

  [username(specifier: name), fetch('internet.free_email')].join('@')
end
ip_v4_address() click to toggle source
# File lib/faker/default/internet.rb, line 186
def ip_v4_address
  [rand_in_range(0, 255), rand_in_range(0, 255),
   rand_in_range(0, 255), rand_in_range(0, 255)].join('.')
end
ip_v4_cidr() click to toggle source
# File lib/faker/default/internet.rb, line 242
def ip_v4_cidr
  "#{ip_v4_address}/#{rand(1..31)}"
end
ip_v6_address() click to toggle source
# File lib/faker/default/internet.rb, line 246
def ip_v6_address
  (1..8).map { rand(65_536).to_s(16) }.join(':')
end
ip_v6_cidr() click to toggle source
# File lib/faker/default/internet.rb, line 250
def ip_v6_cidr
  "#{ip_v6_address}/#{rand(1..127)}"
end
mac_address(legacy_prefix = NOT_GIVEN, prefix: '') click to toggle source
# File lib/faker/default/internet.rb, line 176
def mac_address(legacy_prefix = NOT_GIVEN, prefix: '')
  warn_for_deprecated_arguments do |keywords|
    keywords << :prefix if legacy_prefix != NOT_GIVEN
  end

  prefix_digits = prefix.split(':').map { |d| d.to_i(16) }
  address_digits = Array.new((6 - prefix_digits.size)) { rand(256) }
  (prefix_digits + address_digits).map { |d| format('%02x', d) }.join(':')
end
password(legacy_min_length = NOT_GIVEN, legacy_max_length = NOT_GIVEN, legacy_mix_case = NOT_GIVEN, legacy_special_characters = NOT_GIVEN, min_length: 8, max_length: 16, mix_case: true, special_characters: false) click to toggle source

Produces a randomized string of characters suitable for passwords

@param min_length [Integer] The minimum length of the password @param max_length [Integer] The maximum length of the password @param mix_case [Boolean] Toggles if uppercased letters are allowed. If true, at least one will be added. @param special_characters [Boolean] Toggles if special characters are allowed. If true, at least one will be added.

@return [String]

@example

Faker::Internet.password #=> "Vg5mSvY1UeRg7"

@example

Faker::Internet.password(min_length: 8) #=> "YfGjIk0hGzDqS0"

@example

Faker::Internet.password(min_length: 10, max_length: 20) #=> "EoC9ShWd1hWq4vBgFw"

@example

Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true) #=> "3k5qS15aNmG"

@example

Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special_characters: true) #=> "*%NkOnJsH4"

@faker.version 2.1.3

# File lib/faker/default/internet.rb, line 100
def password(legacy_min_length = NOT_GIVEN, legacy_max_length = NOT_GIVEN, legacy_mix_case = NOT_GIVEN, legacy_special_characters = NOT_GIVEN, min_length: 8, max_length: 16, mix_case: true, special_characters: false)
  # rubocop:enable Metrics/ParameterLists
  warn_for_deprecated_arguments do |keywords|
    keywords << :min_length if legacy_min_length != NOT_GIVEN
    keywords << :max_length if legacy_max_length != NOT_GIVEN
    keywords << :mix_case if legacy_mix_case != NOT_GIVEN
    keywords << :special_characters if legacy_special_characters != NOT_GIVEN
  end

  min_alpha = mix_case ? 2 : 0
  temp = Lorem.characters(number: min_length, min_alpha: min_alpha)
  diff_length = max_length - min_length

  if diff_length.positive?
    diff_rand = rand(diff_length + 1)
    temp += Lorem.characters(number: diff_rand)
  end

  if mix_case
    alpha_count = 0
    temp.chars.each_with_index do |char, index|
      if char =~ /[[:alpha:]]/
        temp[index] = char.upcase if alpha_count.even?
        alpha_count += 1
      end
    end
  end

  if special_characters
    chars = %w[! @ # $ % ^ & *]
    rand(1..min_length).times do |i|
      temp[i] = chars[rand(chars.length)]
    end
  end

  temp
end
private_ip_v4_address() click to toggle source
# File lib/faker/default/internet.rb, line 191
def private_ip_v4_address
  addr = nil
  loop do
    addr = ip_v4_address
    break if private_net_checker[addr]
  end
  addr
end
private_net_checker() click to toggle source
# File lib/faker/default/internet.rb, line 222
def private_net_checker
  ->(addr) { private_nets_regex.any? { |net| net =~ addr } }
end
private_nets_regex() click to toggle source
# File lib/faker/default/internet.rb, line 209
def private_nets_regex
  [
    /^10\./,                                       # 10.0.0.0    - 10.255.255.255
    /^100\.(6[4-9]|[7-9]\d|1[0-1]\d|12[0-7])\./,   # 100.64.0.0  - 100.127.255.255
    /^127\./,                                      # 127.0.0.0   - 127.255.255.255
    /^169\.254\./,                                 # 169.254.0.0 - 169.254.255.255
    /^172\.(1[6-9]|2\d|3[0-1])\./,                 # 172.16.0.0  - 172.31.255.255
    /^192\.0\.0\./,                                # 192.0.0.0   - 192.0.0.255
    /^192\.168\./,                                 # 192.168.0.0 - 192.168.255.255
    /^198\.(1[8-9])\./                             # 198.18.0.0  - 198.19.255.255
  ]
end
public_ip_v4_address() click to toggle source
# File lib/faker/default/internet.rb, line 200
def public_ip_v4_address
  addr = nil
  loop do
    addr = ip_v4_address
    break unless reserved_net_checker[addr]
  end
  addr
end
reserved_net_checker() click to toggle source
# File lib/faker/default/internet.rb, line 238
def reserved_net_checker
  ->(addr) { (private_nets_regex + reserved_nets_regex).any? { |net| net =~ addr } }
end
reserved_nets_regex() click to toggle source
# File lib/faker/default/internet.rb, line 226
def reserved_nets_regex
  [
    /^0\./,                 # 0.0.0.0      - 0.255.255.255
    /^192\.0\.2\./,         # 192.0.2.0    - 192.0.2.255
    /^192\.88\.99\./,       # 192.88.99.0  - 192.88.99.255
    /^198\.51\.100\./,      # 198.51.100.0 - 198.51.100.255
    /^203\.0\.113\./,       # 203.0.113.0  - 203.0.113.255
    /^(22[4-9]|23\d)\./,    # 224.0.0.0    - 239.255.255.255
    /^(24\d|25[0-5])\./     # 240.0.0.0    - 255.255.255.254  and  255.255.255.255
  ]
end
safe_email(legacy_name = NOT_GIVEN, name: nil) click to toggle source
# File lib/faker/default/internet.rb, line 27
def safe_email(legacy_name = NOT_GIVEN, name: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :name if legacy_name != NOT_GIVEN
  end

  [username(specifier: name), 'example.' + sample(%w[org com net])].join('@')
end
slug(legacy_words = NOT_GIVEN, legacy_glue = NOT_GIVEN, words: nil, glue: nil) click to toggle source
# File lib/faker/default/internet.rb, line 266
def slug(legacy_words = NOT_GIVEN, legacy_glue = NOT_GIVEN, words: nil, glue: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :words if legacy_words != NOT_GIVEN
    keywords << :glue if legacy_glue != NOT_GIVEN
  end

  glue ||= sample(%w[- _])
  (words || Faker::Lorem.words(number: 2).join(' ')).delete(',.').gsub(' ', glue).downcase
end
url(legacy_host = NOT_GIVEN, legacy_path = NOT_GIVEN, legacy_scheme = NOT_GIVEN, host: domain_name, path: "/ click to toggle source

rubocop:disable Metrics/ParameterLists

# File lib/faker/default/internet.rb, line 255
def url(legacy_host = NOT_GIVEN, legacy_path = NOT_GIVEN, legacy_scheme = NOT_GIVEN, host: domain_name, path: "/#{username}", scheme: 'http')
  # rubocop:enable Metrics/ParameterLists
  warn_for_deprecated_arguments do |keywords|
    keywords << :host if legacy_host != NOT_GIVEN
    keywords << :path if legacy_path != NOT_GIVEN
    keywords << :scheme if legacy_scheme != NOT_GIVEN
  end

  "#{scheme}://#{host}#{path}"
end
user_agent(legacy_vendor = NOT_GIVEN, vendor: nil) click to toggle source
# File lib/faker/default/internet.rb, line 280
def user_agent(legacy_vendor = NOT_GIVEN, vendor: nil)
  warn_for_deprecated_arguments do |keywords|
    keywords << :vendor if legacy_vendor != NOT_GIVEN
  end

  agent_hash = translate('faker.internet.user_agent')
  agents = vendor.respond_to?(:to_sym) && agent_hash[vendor.to_sym] || agent_hash[sample(agent_hash.keys)]
  sample(agents)
end
user_name(legacy_specifier = NOT_GIVEN, legacy_separators = NOT_GIVEN, specifier: nil, separators: %w[. _])
Alias for: username
username(legacy_specifier = NOT_GIVEN, legacy_separators = NOT_GIVEN, specifier: nil, separators: %w[. _]) click to toggle source
# File lib/faker/default/internet.rb, line 35
def username(legacy_specifier = NOT_GIVEN, legacy_separators = NOT_GIVEN, specifier: nil, separators: %w[. _])
  warn_for_deprecated_arguments do |keywords|
    keywords << :specifier if legacy_specifier != NOT_GIVEN
    keywords << :separators if legacy_separators != NOT_GIVEN
  end

  with_locale(:en) do
    return shuffle(specifier.scan(/[[:word:]]+/)).join(sample(separators)).downcase if specifier.respond_to?(:scan)

    if specifier.is_a?(Integer)
      # If specifier is Integer and has large value, Argument error exception is raised to overcome memory full error
      raise ArgumentError, 'Given argument is too large' if specifier > 10**6

      tries = 0 # Don't try forever in case we get something like 1_000_000.
      result = nil
      loop do
        result = username(specifier: nil, separators: separators)
        tries += 1
        break unless result.length < specifier && tries < 7
      end
      return result * (specifier / result.length + 1) if specifier.positive?
    elsif specifier.is_a?(Range)
      tries = 0
      result = nil
      loop do
        result = username(specifier: specifier.min, separators: separators)
        tries += 1
        break unless !specifier.include?(result.length) && tries < 7
      end
      return result[0...specifier.max]
    end

    sample([
             Char.prepare(Name.first_name),
             [Name.first_name, Name.last_name].map do |name|
               Char.prepare(name)
             end.join(sample(separators))
           ])
  end
end
Also aliased as: user_name
uuid() click to toggle source
# File lib/faker/default/internet.rb, line 290
def uuid
  # borrowed from: https://github.com/ruby/ruby/blob/d48783bb0236db505fe1205d1d9822309de53a36/lib/securerandom.rb#L250
  ary = Faker::Config.random.bytes(16).unpack('NnnnnN')
  ary[2] = (ary[2] & 0x0fff) | 0x4000
  ary[3] = (ary[3] & 0x3fff) | 0x8000
  '%08x-%04x-%04x-%04x-%04x%08x' % ary # rubocop:disable Style/FormatString
end