Class: Faker::Internet

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

Constant Summary

Constants inherited from Base

Base::Letters, 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

.device_tokenObject


186
187
188
# File 'lib/faker/default/internet.rb', line 186

def device_token
  shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join
end

.domain_name(subdomain: false) ⇒ Object


83
84
85
86
87
88
89
# File 'lib/faker/default/internet.rb', line 83

def domain_name(subdomain: false)
  with_locale(:en) do
    domain_elements = [Char.prepare(domain_word), domain_suffix]
    domain_elements.unshift(Char.prepare(domain_word)) if subdomain
    domain_elements.join('.')
  end
end

.domain_suffixObject


99
100
101
# File 'lib/faker/default/internet.rb', line 99

def domain_suffix
  fetch('internet.domain_suffix')
end

.domain_wordObject


95
96
97
# File 'lib/faker/default/internet.rb', line 95

def domain_word
  with_locale(:en) { Char.prepare(Company.name.split(' ').first) }
end

.email(name: nil, separators: nil) ⇒ Object


6
7
8
9
10
11
12
# File 'lib/faker/default/internet.rb', line 6

def email(name: nil, separators: nil)
  if separators
    [username(specifier: name, separators: separators), domain_name].join('@')
  else
    [username(specifier: name), domain_name].join('@')
  end
end

.fix_umlauts(string: '') ⇒ Object


91
92
93
# File 'lib/faker/default/internet.rb', line 91

def fix_umlauts(string: '')
  Char.fix_umlauts(string)
end

.free_email(name: nil) ⇒ Object


14
15
16
# File 'lib/faker/default/internet.rb', line 14

def free_email(name: nil)
  [username(specifier: name), fetch('internet.free_email')].join('@')
end

.ip_v4_addressObject


109
110
111
112
# File 'lib/faker/default/internet.rb', line 109

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_cidrObject


165
166
167
# File 'lib/faker/default/internet.rb', line 165

def ip_v4_cidr
  "#{ip_v4_address}/#{rand(1..31)}"
end

.ip_v6_addressObject


169
170
171
# File 'lib/faker/default/internet.rb', line 169

def ip_v6_address
  (1..8).map { rand(65_536).to_s(16) }.join(':')
end

.ip_v6_cidrObject


173
174
175
# File 'lib/faker/default/internet.rb', line 173

def ip_v6_cidr
  "#{ip_v6_address}/#{rand(1..127)}"
end

.mac_address(prefix: '') ⇒ Object


103
104
105
106
107
# File 'lib/faker/default/internet.rb', line 103

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


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/faker/default/internet.rb', line 58

def password(min_length: 8, max_length: 16, mix_case: true, special_characters: false)
  temp = Lorem.characters(number: min_length)
  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
    temp.chars.each_with_index do |char, index|
      temp[index] = char.upcase if index.even?
    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_addressObject


114
115
116
117
118
119
120
121
# File 'lib/faker/default/internet.rb', line 114

def private_ip_v4_address
  addr = nil
  loop do
    addr = ip_v4_address
    break if private_net_checker[addr]
  end
  addr
end

.private_net_checkerObject


145
146
147
# File 'lib/faker/default/internet.rb', line 145

def private_net_checker
  ->(addr) { private_nets_regex.any? { |net| net =~ addr } }
end

.private_nets_regexObject


132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/faker/default/internet.rb', line 132

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_addressObject


123
124
125
126
127
128
129
130
# File 'lib/faker/default/internet.rb', line 123

def public_ip_v4_address
  addr = nil
  loop do
    addr = ip_v4_address
    break unless reserved_net_checker[addr]
  end
  addr
end

.reserved_net_checkerObject


161
162
163
# File 'lib/faker/default/internet.rb', line 161

def reserved_net_checker
  ->(addr) { (private_nets_regex + reserved_nets_regex).any? { |net| net =~ addr } }
end

.reserved_nets_regexObject


149
150
151
152
153
154
155
156
157
158
159
# File 'lib/faker/default/internet.rb', line 149

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(name: nil) ⇒ Object


18
19
20
# File 'lib/faker/default/internet.rb', line 18

def safe_email(name: nil)
  [username(specifier: name), 'example.' + sample(%w[org com net])].join('@')
end

.slug(words: nil, glue: nil) ⇒ Object


181
182
183
184
# File 'lib/faker/default/internet.rb', line 181

def slug(words: nil, glue: nil)
  glue ||= sample(%w[- _])
  (words || Faker::Lorem.words(number: 2).join(' ')).delete(',.').gsub(' ', glue).downcase
end

.url(host: domain_name, path: "/#{username}", scheme: 'http') ⇒ Object


177
178
179
# File 'lib/faker/default/internet.rb', line 177

def url(host: domain_name, path: "/#{username}", scheme: 'http')
  "#{scheme}://#{host}#{path}"
end

.user_agent(vendor: nil) ⇒ Object


190
191
192
193
194
# File 'lib/faker/default/internet.rb', line 190

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[. _]) ⇒ Object Also known as: user_name


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/faker/default/internet.rb', line 22

def username(specifier: nil, separators: %w[. _])
  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

.uuidObject


196
197
198
199
200
201
202
# File 'lib/faker/default/internet.rb', line 196

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