# frozen_string_literal: true
module Faker
class Internet < Base
class << self
##
# Returns the email address
#
# @return [String]
#
# @param name [String]
# @param separators [Array]
# @param domain [String]
#
# @example
# Faker::Internet.email #=> "samsmith@faker.com"
# Faker::Internet.email(name: 'smith') #=> "smith@faker.com"
# Faker::Internet.email(name: 'sam smith', separators: ['-']) #=> "sam-smith@faker.com"
# Faker::Internet.email(name: 'sam smith', separators: ['-'], domain: 'gmail') #=> "sam-smith@gmail.com"
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
local_part = if separators
username(specifier: name, separators: separators)
else
username(specifier: name)
end
sanitized_local_part = sanitize_email_local_part(local_part)
construct_email(sanitized_local_part, domain_name(domain: domain))
end
##
# Returns the email address with doamin either gmail.com, yahoo.com or hotmail.com
#
# @return [String]
#
# @param name [String]
#
# @example
# Faker::Internet.free_email #=> "samsmith@gmail.com"
# Faker::Internet.free_email(name: 'smith') #=> "smith@yahoo.com"
def free_email(legacy_name = NOT_GIVEN, name: nil)
warn_for_deprecated_arguments do |keywords|
keywords << :name if legacy_name != NOT_GIVEN
end
construct_email(
sanitize_email_local_part(username(specifier: name)),
fetch('internet.free_email')
)
end
##
# Returns the email address with fixed domain name as 'example'
#
# @return [String]
#
# @param name [String]
#
# @example
# Faker::Internet.safe_email #=> "samsmith@example.com"
# Faker::Internet.safe_email(name: 'smith') #=> "smith@example.net"
def safe_email(legacy_name = NOT_GIVEN, name: nil)
warn_for_deprecated_arguments do |keywords|
keywords << :name if legacy_name != NOT_GIVEN
end
construct_email(
sanitize_email_local_part(username(specifier: name)),
"example.#{sample(%w[org com net])}"
)
end
##
# Returns the username
#
# @return [String]
#
# @param specifier [Integer, Range] When int value passed it returns the username longer than specifier. Max value can be 10^6
# @param separator [Array]
#
# @wxample
# Faker::Internet.username(specifier: 10) #=> "lulu.goodwin"
# Faker::Internet.username(specifier: 5..10) #=> "morris"
# Faker::Internet.username(specifier: 5..10) #=> "berryberry"
# Faker::Internet.username(specifier: 20, separators: ['-']) #=> "nikki_sawaynnikki_saway"
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)
case specifier
when 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?
when 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
# rubocop:disable Metrics/ParameterLists
##
# 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
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)
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 && min_length > 1 ? 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
# rubocop:enable Metrics/ParameterLists
##
# Returns the domain name
#
# @return [String]
#
# @param subdomain [Bool] If true passed adds a subdomain in response
# @param domain [String]
#
# @example
# Faker::Internet.domain_name #=> "test.net"
# Faker::Internet.domain_name(subdomain: true) #=> "test.faker.io"
# Faker::Internet.domain_name(subdomain: true, domain: 'example') #=> "faker.example.com"
# Faker::Internet.domain_name(domain: 'faker') #=> "faker.org"
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
# rubocop:disable Style/AsciiComments
##
# Fixes ä, ö, ü, ß characters in string passed with ae, oe, ue, ss resp.
#
# @return [String]
#
# @param string [String]
#
# @example
# Faker::Internet.fix_umlauts #=> ""
# Faker::Internet.fix_umlauts(string: 'faker') #=> "faker"
# Faker::Internet.fix_umlauts(string: 'faküer') #=> "fakueer"
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
# rubocop:enable Style/AsciiComments
##
# Returns the domain word for internet
#
# @return [String]
#
# @example
# Faker::Internet.domain_word #=> "senger"
def domain_word
with_locale(:en) { Char.prepare(Company.name.split(' ').first) }
end
## Returns the domain suffix e.g. com, org, co, biz, info etc.
#
# @return [String]
#
# @wxample
# Faker::Internet.domain_suffix #=> "com"
# Faker::Internet.domain_suffix #=> "biz"
def domain_suffix
fetch('internet.domain_suffix')
end
##
# Returns the MAC address
#
# @return [String]
#
# @example
# Faker::Internet.mac_address #=> "74:d0:c9:22:95:12"
# Faker::Internet.mac_address(prefix: 'a') #=> "0a:91:ce:24:89:3b"
# Faker::Internet.mac_address(prefix: 'aa') #=> "aa:38:a0:3e:e8:41"
# Faker::Internet.mac_address(prefix: 'aa:44') #=> "aa:44:30:88:6e:95"
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
##
# Returns the IPv4 address
#
# @return [String]
#
# @example
# Faker::Internet.ip_v4_address #=> "97.117.128.93"
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
##
# Returns the private IPv4 address
#
# @return [String]
#
# @example
# Faker::Internet.private_ip_v4_address #=> "127.120.80.42"
def private_ip_v4_address
addr = nil
loop do
addr = ip_v4_address
break if private_net_checker[addr]
end
addr
end
##
# Returns the public IPv4 address
#
# @return [String]
#
# @example
# Faker::Internet.public_ip_v4_address #=> "127.120.80.42"
def public_ip_v4_address
addr = nil
loop do
addr = ip_v4_address
break unless reserved_net_checker[addr]
end
addr
end
##
# Returns the private network regular expressions
#
# @return [Array]
#
# @example
# Faker::Internet.private_nets_regex #=> [/^10\./, /^100\.(6[4-9]|[7-9]\d|1[0-1]\d|12[0-7])\./, /^127\./, /^169\.254\./, /^172\.(1[6-9]|2\d|3[0-1])\./, /^192\.0\.0\./, /^192\.168\./, /^198\.(1[8-9])\./]
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
##
# Returns lambda to check if address passed is private or not
#
# @return [Lambda]
#
# @example
# Faker::Internet.private_net_checker.call("127.120.80.42") #=> true
# Faker::Internet.private_net_checker.call("148.120.80.42") #=> false
def private_net_checker
->(addr) { private_nets_regex.any? { |net| net =~ addr } }
end
##
# Returns the reserved network regular expressions
#
# @return [Array]
#
# @example
# Faker::Internet.reserved_nets_regex #=> [/^0\./, /^192\.0\.2\./, /^192\.88\.99\./, /^198\.51\.100\./, /^203\.0\.113\./, /^(22[4-9]|23\d)\./, /^(24\d|25[0-5])\./]
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
##
# Returns lambda function to check address passed is reserverd or not
#
# @return [Lambda]
#
# @example
# Faker::Internet.reserved_net_checker.call('192.88.99.255') #=> true
# Faker::Internet.reserved_net_checker.call('192.88.199.255') #=> false
def reserved_net_checker
->(addr) { (private_nets_regex + reserved_nets_regex).any? { |net| net =~ addr } }
end
##
# Returns Ipv4 address with CIDR, range from 1 to 31
#
# @return [String]
#
# @example
# Faker::Internet.ip_v4_cidr #=> "129.162.99.74/16"
# Faker::Internet.ip_v4_cidr #=> "129.162.99.74/24"
def ip_v4_cidr
"#{ip_v4_address}/#{rand(1..31)}"
end
##
# Returns Ipv6 address
#
# @return [String]
#
# @example
# Faker::Internet.ip_v6_address #=> "7754:76d4:c7aa:7646:ea68:1abb:4055:4343"
def ip_v6_address
(1..8).map { rand(65_536).to_s(16) }.join(':')
end
##
# Returns Ipv6 address with CIDR, range between 1 to 127
#
# @return [String]
#
# @example
# Faker::Internet.ip_v6_cidr #=> "beca:9b99:4bb6:9712:af2f:516f:8507:96e1/99"
def ip_v6_cidr
"#{ip_v6_address}/#{rand(1..127)}"
end
# rubocop:disable Metrics/ParameterLists
##
# Returns URL
#
# @return [String]
#
# @param host [String]
# @param path [String]
# @param scheme [String]
#
# @example
# Faker::Internet.url #=> "http://sipes-okon.com/hung.macejkovic"
# Faker::Internet.url(host: 'faker') #=> "http://faker/shad"
# Faker::Internet.url(host: 'faker', path: '/fake_test_path') #=> "http://faker/fake_test_path"
# Faker::Internet.url(host: 'faker', path: '/fake_test_path', scheme: 'https') #=> "https://faker/fake_test_path"
def url(legacy_host = NOT_GIVEN, legacy_path = NOT_GIVEN, legacy_scheme = NOT_GIVEN, host: domain_name, path: "/#{username}", scheme: 'http')
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
# rubocop:enable Metrics/ParameterLists
##
# Returns unique string in URL
#
# @return [String]
#
# @param words [String] Comma or period separated words list
# @param glue [String] Separator to add between words passed, default used are '-' or '_'
#
# @example
# Faker::Internet.slug #=> "repudiandae-sed"
# Faker::Internet.slug(words: 'test, faker') #=> "test-faker"
# Faker::Internet.slug(words: 'test. faker') #=> "test-faker"
# Faker::Internet.slug(words: 'test. faker', glue: '$') #=> "test$faker"
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
##
# Generates random token
#
# @return[String]
#
# @example
# Faker::Internet.device_token #=> "749f535671cf6b34d8e794d212d00c703b96274e07161b18b082d0d70ef1052f"
def device_token
shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join
end
##
# Generates the random browser identifier
#
# @return [String]
#
# @param vendor [String] Name of vendor, supported vendors are aol, chrome, firefox, internet_explorer, netscape, opera, safari
#
# @example
# Faker::Internet.user_agent #=> "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"
# Faker::Internet.user_agent(vendor: 'chrome') #=> "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36"
# Faker::Internet.user_agent(vendor: 'safari') #=> "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.75.14 (KHTML, like Gecko) Version/7.0.3 Safari/7046A194A"
# Faker::Internet.user_agent(vendor: 'faker') #=> "Mozilla/5.0 (Windows; U; Win 9x 4.90; SG; rv:1.9.2.4) Gecko/20101104 Netscape/9.1.0285"
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
##
# Generated universally unique identifier
#
# @return [String]
#
# @example
# Faker::Internet.uuid #=> "8a6cdd40-6d78-4fdb-912b-190e3057197f"
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
##
# 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
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
alias user_name username
private
def sanitize_email_local_part(local_part)
char_range = [
Array('0'..'9'),
Array('A'..'Z'),
Array('a'..'z'),
"!#$%&'*+-/=?^_`{|}~.".split(//)
].flatten
local_part.split(//).map do |char|
char_range.include?(char) ? char : '#'
end.join
end
def construct_email(local_part, domain_name)
[local_part, domain_name].join('@')
end
end
end
end