Class: Faker::Internet
- Defined in:
- lib/faker/default/internet.rb,
lib/faker/default/internet_http.rb
Defined Under Namespace
Classes: HTTP
Constant Summary collapse
- PRIVATE_IPV4_ADDRESS_RANGES =
Private, Host, and Link-Local network address blocks as defined in en.wikipedia.org/wiki/IPv4#Special-use_addresses
[ [10..10, 0..255, 0..255, 1..255], # 10.0.0.0/8 - Used for local communications within a private network [100..100, 64..127, 0..255, 1..255], # 100.64.0.0/10 - Shared address space for communications between an ISP and its subscribers [127..127, 0..255, 0..255, 1..255], # 127.0.0.0/8 - Used for loopback addresses to the local host [169..169, 254..254, 0..255, 1..255], # 169.254.0.0/16 - Used for link-local addresses between two hosts on a single link when [172..172, 16..31, 0..255, 1..255], # 172.16.0.0/12 - Used for local communications within a private network [192..192, 0..0, 0..0, 1..255], # 192.0.0.0/24 - IETF Protocol Assignments [192..192, 168..168, 0..255, 1..255], # 192.168.0.0/16 - Used for local communications within a private network [198..198, 18..19, 0..255, 1..255] # 198.18.0.0/15 - Used for benchmark testing of inter-network communications between subnets ].each(&:freeze).freeze
Constants inherited from Base
Base::LLetters, Base::Letters, Base::NOT_GIVEN, Base::Numbers, Base::ULetters
Class Method Summary collapse
-
.base64(length: 16, padding: false, urlsafe: true) ⇒ String
Produces a random string of alphabetic characters, (no digits).
-
.bot_user_agent(vendor: nil) ⇒ String
Generate Web Crawler’s user agents.
-
.device_token ⇒ Object
Generates random token.
-
.domain_name(subdomain: false, domain: nil) ⇒ String
Returns the domain name.
-
.domain_suffix(safe: nil) ⇒ String
Returns the domain suffix e.g.
-
.domain_word ⇒ String
Returns the domain word for internet.
-
.email(name: nil, separators: nil, domain: nil) ⇒ String
Returns the email address.
-
.fix_umlauts(string: '') ⇒ String
Fixes ä, ö, ü, ß characters in string passed with ae, oe, ue, ss resp.
-
.ip_v4_address ⇒ String
Returns the IPv4 address.
-
.ip_v4_cidr ⇒ String
Returns Ipv4 address with CIDR, range from 1 to 31.
-
.ip_v6_address ⇒ String
Returns Ipv6 address.
-
.ip_v6_cidr ⇒ String
Returns Ipv6 address with CIDR, range between 1 to 127.
-
.mac_address(prefix: '') ⇒ String
Returns the MAC address.
-
.password(min_length: 8, max_length: 16, mix_case: true, special_characters: false) ⇒ String
Produces a randomized string of characters suitable for passwords.
-
.private_ip_v4_address ⇒ String
Returns the private IPv4 address.
-
.private_net_checker ⇒ Lambda
Returns lambda to check if address passed is private or not.
-
.private_nets_regex ⇒ Array
Returns the private network regular expressions.
-
.public_ip_v4_address ⇒ String
Returns the public IPv4 address.
-
.reserved_net_checker ⇒ Lambda
Returns lambda function to check address passed is reserved or not.
-
.reserved_nets_regex ⇒ Array
Returns the reserved network regular expressions.
-
.slug(words: nil, glue: nil) ⇒ String
Returns unique string in URL.
-
.url(host: domain_name, path: "/#{username}", scheme: 'http') ⇒ String
Returns URL.
-
.user(*args) ⇒ hash
Produces a randomized hash of internet user details.
-
.user_agent(vendor: nil) ⇒ String
Generates the random browser identifier.
-
.username(specifier: nil, separators: %w[. _])) ⇒ String
(also: user_name)
Returns the username.
-
.uuid ⇒ String
Generated universally unique identifier.
Methods inherited from Base
bothify, disable_enforce_available_locales, fetch, fetch_all, flexible, generate, letterify, method_missing, numerify, parse, rand, rand_in_range, regexify, resolve, respond_to_missing?, sample, shuffle, shuffle!, translate, unique, with_locale
Class Method Details
.base64(length: 16, padding: false, urlsafe: true) ⇒ String
Produces a random string of alphabetic characters, (no digits)
526 527 528 529 530 531 532 533 534 535 536 |
# File 'lib/faker/default/internet.rb', line 526 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 |
.bot_user_agent(vendor: nil) ⇒ String
Generate Web Crawler’s user agents
488 489 490 491 492 |
# File 'lib/faker/default/internet.rb', line 488 def bot_user_agent(vendor: nil) agent_hash = translate('faker.internet.bot_user_agent') agents = vendor.respond_to?(:to_sym) && agent_hash[vendor.to_sym] || agent_hash[sample(agent_hash.keys)] sample(agents) end |
.device_token ⇒ Object
Generates random token
455 456 457 |
# File 'lib/faker/default/internet.rb', line 455 def device_token shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join end |
.domain_name(subdomain: false, domain: nil) ⇒ String
Returns the domain name
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/faker/default/internet.rb', line 191 def domain_name(subdomain: false, domain: nil) with_locale(:en) do if domain domain .split('.') .map { |domain_part| Char.prepare(domain_part) } .tap do |domain_elements| if domain_elements.length < 2 domain_elements << domain_suffix(safe: true) end if subdomain && domain_elements.length < 3 domain_elements.unshift(Char.prepare(domain_word)) end end.join('.') else [domain_word, domain_suffix(safe: true)].tap do |domain_elements| if subdomain domain_elements.unshift(Char.prepare(domain_word)) end end.join('.') end end end |
.domain_suffix(safe: nil) ⇒ String
Returns the domain suffix e.g. com, org, co, biz, info etc.
250 251 252 253 254 255 256 |
# File 'lib/faker/default/internet.rb', line 250 def domain_suffix(safe: nil) if safe fetch('internet.safe_domain_suffix') else fetch('internet.domain_suffix') end end |
.domain_word ⇒ String
Returns the domain word for internet
237 238 239 |
# File 'lib/faker/default/internet.rb', line 237 def domain_word with_locale(:en) { Char.prepare(Company.name.split.first) } end |
.email(name: nil, separators: nil, domain: nil) ⇒ String
Returns the email address
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/faker/default/internet.rb', line 33 def email(name: nil, separators: nil, domain: nil) local_part = if separators username(specifier: name, separators: separators) else username(specifier: name) end sanitized_local_part = sanitize_email_local_part(local_part) generate_domain = if domain.nil? domain_name else domain_name(domain: domain) end construct_email(sanitized_local_part, generate_domain) end |
.fix_umlauts(string: '') ⇒ String
Fixes ä, ö, ü, ß characters in string passed with ae, oe, ue, ss resp.
226 227 228 |
# File 'lib/faker/default/internet.rb', line 226 def fix_umlauts(string: '') Char.fix_umlauts(string) end |
.ip_v4_address ⇒ String
Returns the IPv4 address
281 282 283 284 |
# File 'lib/faker/default/internet.rb', line 281 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 ⇒ String
Returns Ipv4 address with CIDR, range from 1 to 31
384 385 386 |
# File 'lib/faker/default/internet.rb', line 384 def ip_v4_cidr "#{ip_v4_address}/#{rand(1..31)}" end |
.ip_v6_address ⇒ String
Returns Ipv6 address
395 396 397 |
# File 'lib/faker/default/internet.rb', line 395 def ip_v6_address (1..8).map { rand(65_536).to_s(16) }.join(':') end |
.ip_v6_cidr ⇒ String
Returns Ipv6 address with CIDR, range between 1 to 127
406 407 408 |
# File 'lib/faker/default/internet.rb', line 406 def ip_v6_cidr "#{ip_v6_address}/#{rand(1..127)}" end |
.mac_address(prefix: '') ⇒ String
Returns the MAC address
268 269 270 271 272 |
# File 'lib/faker/default/internet.rb', line 268 def mac_address(prefix: '') 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(min_length: 8, max_length: 16, mix_case: true, special_characters: false) ⇒ String
Produces a randomized string of characters suitable for passwords
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/faker/default/internet.rb', line 126 def password(min_length: 8, max_length: 16, mix_case: true, special_characters: false) raise ArgumentError, 'min_length and max_length must be greater than or equal to one' if min_length < 1 || max_length < 1 raise ArgumentError, 'min_length must be smaller than or equal to max_length' unless min_length <= max_length character_types = [] required_min_length = 0 if mix_case character_types << :mix_case required_min_length += 2 end if special_characters character_types << :special_characters required_min_length += 1 end raise ArgumentError, "min_length should be at least #{required_min_length} to enable #{character_types.join(', ')} configuration" if min_length < required_min_length target_length = rand(min_length..max_length) password = [] character_bag = [] # use lower_chars by default and add upper_chars if mix_case lower_chars = self::LLetters password << sample(lower_chars) character_bag += lower_chars digits = ('0'..'9').to_a password << sample(digits) character_bag += digits if mix_case upper_chars = self::ULetters password << sample(upper_chars) character_bag += upper_chars end if special_characters special_chars = %w[! @ # $ % ^ & *] password << sample(special_chars) character_bag += special_chars end password << sample(character_bag) while password.length < target_length shuffle(password).join end |
.private_ip_v4_address ⇒ String
Returns the private IPv4 address
293 294 295 |
# File 'lib/faker/default/internet.rb', line 293 def private_ip_v4_address sample(PRIVATE_IPV4_ADDRESS_RANGES).map { |range| rand(range) }.join('.') end |
.private_net_checker ⇒ Lambda
Returns lambda to check if address passed is private or not
341 342 343 |
# File 'lib/faker/default/internet.rb', line 341 def private_net_checker ->(addr) { private_nets_regex.any? { |net| net =~ addr } } end |
.private_nets_regex ⇒ Array
Returns the private network regular expressions
320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/faker/default/internet.rb', line 320 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 ⇒ String
Returns the public IPv4 address
304 305 306 307 308 309 310 311 |
# File 'lib/faker/default/internet.rb', line 304 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 ⇒ Lambda
Returns lambda function to check address passed is reserved or not
372 373 374 |
# File 'lib/faker/default/internet.rb', line 372 def reserved_net_checker ->(addr) { (private_nets_regex + reserved_nets_regex).any? { |net| net =~ addr } } end |
.reserved_nets_regex ⇒ Array
Returns the reserved network regular expressions
352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/faker/default/internet.rb', line 352 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 |
.slug(words: nil, glue: nil) ⇒ String
Returns unique string in URL
441 442 443 444 445 446 |
# File 'lib/faker/default/internet.rb', line 441 def slug(words: nil, glue: nil) glue ||= sample(%w[- _]) return words.delete(',.').gsub(' ', glue).downcase unless words.nil? sample(translate('faker.internet.slug'), 2).join(glue) end |
.url(host: domain_name, path: "/#{username}", scheme: 'http') ⇒ String
Returns URL
424 425 426 |
# File 'lib/faker/default/internet.rb', line 424 def url(host: domain_name, path: "/#{username}", scheme: 'http') "#{scheme}://#{host}#{path}" end |
.user(*args) ⇒ hash
Produces a randomized hash of internet user details
549 550 551 552 553 554 |
# File 'lib/faker/default/internet.rb', line 549 def user(*args) user_hash = {} args = %w[username email] if args.empty? args.each { |arg| user_hash[:"#{arg}"] = send(arg) } user_hash end |
.user_agent(vendor: nil) ⇒ String
Generates the random browser identifier
471 472 473 474 475 |
# File 'lib/faker/default/internet.rb', line 471 def user_agent(vendor: nil) 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 |
.username(specifier: nil, separators: %w[. _])) ⇒ String Also known as: user_name
Returns the username
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/faker/default/internet.rb', line 64 def username(specifier: nil, separators: %w[. _]) with_locale(:en) do case specifier when ::String names = specifier.gsub("'", '').scan(/[[:word:]]+/) shuffled_names = shuffle(names) return shuffled_names.join(sample(separators)).downcase 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 |
.uuid ⇒ String
Generated universally unique identifier
501 502 503 504 505 506 507 |
# File 'lib/faker/default/internet.rb', line 501 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 |