faker 2.0.0 → 3.8.0

data/lib/faker/default/omniauth.rb

@@ -9,14 +9,26 @@ module Faker
                 :email
 
     def initialize(name: nil, email: nil)
-      @name = name || "#{Name.first_name} #{Name.last_name}"
-      @email = email || Internet.safe_email(name: self.name)
+      super()
+
+      @name = name || "#{Faker::Name.first_name} #{Faker::Name.last_name}"
+      @email = email || Faker::Internet.email(name: self.name)
       @first_name, @last_name = self.name.split
     end
 
     class << self
-      def google(name: nil, email: nil, uid: Number.number(digits: 9).to_s)
-        auth = Omniauth.new(name: name, email: email)
+      ##
+      # Generate a mock Omniauth response from Google.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-google.
+      #
+      # @faker.version 1.8.0
+      def google(name: nil, email: nil, uid: Faker::Number.number(digits: 9).to_s)
+        auth = new(name: name, email: email)
         {
           provider: 'google_oauth2',
           uid: uid,
@@ -27,15 +39,15 @@ module Faker
             email: auth.email,
             image: image
           },
-          credentials:  {
-            token: Crypto.md5,
-            refresh_token: Crypto.md5,
-            expires_at: Time.forward.to_i,
+          credentials: {
+            token: Faker::Crypto.md5,
+            refresh_token: Faker::Crypto.md5,
+            expires_at: Faker::Time.forward.to_i,
             expires: true
           },
           extra: {
             raw_info: {
-              sub:  uid,
+              sub: uid,
               email: auth.email,
               email_verified: random_boolean.to_s,
               name: auth.name,
@@ -44,28 +56,39 @@ module Faker
               profile: "https://plus.google.com/#{uid}",
               picture: image,
               gender: gender,
-              birthday: Date.backward(days: 36_400).strftime('%Y-%m-%d'),
-              local: 'en',
-              hd: "#{Company.name.downcase}.com"
+              birthday: Faker::Date.backward(days: 36_400).strftime('%Y-%m-%d'),
+              locale: 'en',
+              hd: "#{Faker::Company.name.downcase}.com"
             },
             id_info: {
-              'iss' => 'accounts.google.com',
-              'at_hash' => Crypto.md5,
-              'email_verified' => true,
-              'sub' => Number.number(digits: 28).to_s,
-              'azp' => 'APP_ID',
-              'email' => auth.email,
-              'aud' => 'APP_ID',
-              'iat' => Time.forward.to_i,
-              'exp' => Time.forward.to_i,
-              'openid_id' => "https://www.google.com/accounts/o8/id?id=#{uid}"
+              iss: 'accounts.google.com',
+              at_hash: Faker::Crypto.md5,
+              email_verified: true,
+              sub: Faker::Number.number(digits: 28).to_s,
+              azp: 'APP_ID',
+              email: auth.email,
+              aud: 'APP_ID',
+              iat: Faker::Time.forward.to_i,
+              exp: Faker::Time.forward.to_i,
+              openid_id: "https://www.google.com/accounts/o8/id?id=#{uid}"
             }
           }
         }
       end
 
-      def facebook(name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
-        auth = Omniauth.new(name: name, email: email)
+      ##
+      # Generate a mock Omniauth response from Facebook.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param username [String] A specific username to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-facebook.
+      #
+      # @faker.version 1.8.0
+      def facebook(name: nil, email: nil, username: nil, uid: Faker::Number.number(digits: 7).to_s)
+        auth = new(name: name, email: email)
         username ||= "#{auth.first_name.downcase[0]}#{auth.last_name.downcase}"
         {
           provider: 'facebook',
@@ -79,7 +102,7 @@ module Faker
             verified: random_boolean
           },
           credentials: {
-            token: Crypto.md5,
+            token: Faker::Crypto.md5,
             expires_at: Time.forward.to_i,
             expires: true
           },
@@ -92,7 +115,7 @@ module Faker
               link: "http://www.facebook.com/#{username}",
               username: username,
               location: {
-                id: Number.number(digits: 9).to_s,
+                id: Faker::Number.number(digits: 9).to_s,
                 name: city_state
               },
               gender: gender,
@@ -100,17 +123,27 @@ module Faker
               timezone: timezone,
               locale: 'en_US',
               verified: random_boolean,
-              updated_time: Time.backward.iso8601
+              updated_time: Faker::Time.backward.iso8601
             }
           }
         }
       end
 
-      def twitter(name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
-        auth = Omniauth.new(name: name)
+      ##
+      # Generate a mock Omniauth response from Twitter.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param nickname [String] A specific nickname to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-twitter.
+      #
+      # @faker.version 1.8.0
+      def twitter(name: nil, nickname: nil, uid: Faker::Number.number(digits: 6).to_s)
+        auth = new(name: name)
         nickname ||= auth.name.downcase.delete(' ')
         location = city_state
-        description = Lorem.sentence
+        description = Faker::Lorem.sentence
         {
           provider: 'twitter',
           uid: uid,
@@ -126,26 +159,26 @@ module Faker
             }
           },
           credentials: {
-            token: Crypto.md5,
-            secret: Crypto.md5
+            token: Faker::Crypto.md5,
+            secret: Faker::Crypto.md5
           },
           extra: {
             access_token: '',
             raw_info: {
               name: auth.name,
               listed_count: random_number_from_range(1..10),
-              profile_sidebar_border_color: Color.hex_color,
+              profile_sidebar_border_color: Faker::Color.hex_color,
               url: nil,
               lang: 'en',
               statuses_count: random_number_from_range(1..1000),
               profile_image_url: image,
               profile_background_image_url_https: image,
               location: location,
-              time_zone: Address.city,
+              time_zone: Faker::Address.city,
               follow_request_sent: random_boolean,
               id: uid,
               profile_background_tile: random_boolean,
-              profile_sidebar_fill_color: Color.hex_color,
+              profile_sidebar_fill_color: Faker::Color.hex_color,
               followers_count: random_number_from_range(1..10_000),
               default_profile_image: random_boolean,
               screen_name: '',
@@ -153,7 +186,7 @@ module Faker
               utc_offset: timezone,
               verified: random_boolean,
               favourites_count: random_number_from_range(1..10),
-              profile_background_color: Color.hex_color,
+              profile_background_color: Faker::Color.hex_color,
               is_translator: random_boolean,
               friends_count: random_number_from_range(1..10_000),
               notifications: random_boolean,
@@ -161,8 +194,8 @@ module Faker
               profile_background_image_url: image,
               protected: random_boolean,
               description: description,
-              profile_link_color: Color.hex_color,
-              created_at: Time.backward.strftime('%a %b %d %H:%M:%S %z %Y'),
+              profile_link_color: Faker::Color.hex_color,
+              created_at: Faker::Time.backward.strftime('%a %b %d %H:%M:%S %z %Y'),
               id_str: uid,
               profile_image_url_https: image,
               default_profile: random_boolean,
@@ -179,71 +212,91 @@ module Faker
         }
       end
 
-      def linkedin(name: nil, email: nil, uid: Number.number(digits: 6).to_s)
+      ##
+      # Generate a mock Omniauth response from LinkedIn.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-linkedin.
+      #
+      # @faker.version 1.8.0
+      def linkedin(name: nil, email: nil, uid: Faker::Number.number(digits: 6).to_s)
         auth = Omniauth.new(name: name, email: email)
         first_name = auth.first_name.downcase
         last_name = auth.last_name.downcase
         location = city_state
-        description = Lorem.sentence
-        token = Crypto.md5
-        secret = Crypto.md5
-        industry = Commerce.department
+        description = Faker::Lorem.sentence
+        token = Faker::Crypto.md5
+        secret = Faker::Crypto.md5
+        industry = Faker::Commerce.department
         url = "http://www.linkedin.com/in/#{first_name}#{last_name}"
         {
-          'provider' => 'linkedin',
-          'uid' => uid,
-          'info' => {
-            'name' => auth.name,
-            'email' => auth.email,
-            'nickname' => auth.name,
-            'first_name' => auth.first_name,
-            'last_name' => auth.last_name,
-            'location' => location,
-            'description' => description,
-            'image' => image,
-            'phone' => PhoneNumber.phone_number,
-            'headline' => description,
-            'industry' => industry,
-            'urls' => {
-              'public_profile' => url
+          provider: 'linkedin',
+          uid: uid,
+          info: {
+            name: auth.name,
+            email: auth.email,
+            nickname: auth.name,
+            first_name: auth.first_name,
+            last_name: auth.last_name,
+            location: location,
+            description: description,
+            image: image,
+            phone: Faker::PhoneNumber.phone_number,
+            headline: description,
+            industry: industry,
+            urls: {
+              public_profile: url
             }
           },
-          'credentials' => {
-            'token' => token,
-            'secret' => secret
+          credentials: {
+            token: token,
+            secret: secret
           },
-          'extra' => {
-            'access_token' => {
-              'token' => token,
-              'secret' => secret,
-              'consumer' => nil,
-              'params' => {
+          extra: {
+            access_token: {
+              token: token,
+              secret: secret,
+              consumer: nil,
+              params: {
                 oauth_token: token,
                 oauth_token_secret: secret,
                 oauth_expires_in: Time.forward.to_i,
                 oauth_authorization_expires_in: Time.forward.to_i
               },
-              'response' => nil
+              response: nil
             },
-            'raw_info' => {
-              'firstName' => auth.first_name,
-              'headline' => description,
-              'id' => uid,
-              'industry' => industry,
-              'lastName' => auth.last_name,
-              'location' => {
-                'country' => { 'code' => Address.country_code.downcase },
-                'name' => city_state.split(', ').first
+            raw_info: {
+              firstName: auth.first_name,
+              headline: description,
+              id: uid,
+              industry: industry,
+              lastName: auth.last_name,
+              location: {
+                country: { code: Faker::Address.country_code.downcase },
+                name: city_state.split(', ').first
               },
-              'pictureUrl' => image,
-              'publicProfileUrl' => url
+              pictureUrl: image,
+              publicProfileUrl: url
             }
           }
         }
       end
 
-      def github(name: nil, email: nil, uid: Number.number(digits: 8).to_s)
-        auth = Omniauth.new(name: name, email: email)
+      ##
+      # Generate a mock Omniauth response from Github.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-github.
+      #
+      # @faker.version 1.8.0
+      def github(name: nil, email: nil, uid: Faker::Number.number(digits: 8).to_s)
+        auth = new(name: name, email: email)
         login = auth.name.downcase.tr(' ', '-')
         html_url = "https://github.com/#{login}"
         api_url = "https://api.github.com/users/#{login}"
@@ -261,7 +314,7 @@ module Faker
           },
           credentials: {
             token: Crypto.md5,
-            expires:  false
+            expires: false
           },
           extra: {
             raw_info: {
@@ -281,7 +334,7 @@ module Faker
               events_url: "#{api_url}/events{/privacy}",
               received_events_url: "#{api_url}/received_events",
               type: 'User',
-              site_admin:  random_boolean,
+              site_admin: random_boolean,
               name: auth.name,
               company: nil,
               blog: nil,
@@ -293,8 +346,96 @@ module Faker
               public_gists: random_number_from_range(1..1000),
               followers: random_number_from_range(1..1000),
               following: random_number_from_range(1..1000),
-              created_at: Time.backward(days: 36_400).iso8601,
-              updated_at: Time.backward(days: 2).iso8601
+              created_at: Faker::Time.backward(days: 36_400).iso8601,
+              updated_at: Faker::Time.backward(days: 2).iso8601
+            }
+          }
+        }
+      end
+
+      ##
+      # Generate a mock Omniauth response from Apple.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-apple.
+      #
+      # @faker.version 2.3.0
+      def apple(name: nil, email: nil, uid: nil)
+        uid ||= "#{Faker::Number.number(digits: 6)}.#{Faker::Number.hexadecimal(digits: 32)}.#{Faker::Number.number(digits: 4)}"
+        auth = new(name: name, email: email)
+        {
+          provider: 'apple',
+          uid: uid,
+          info: {
+            sub: uid,
+            email: auth.email,
+            first_name: auth.first_name,
+            last_name: auth.last_name
+          },
+          credentials: {
+            token: Faker::Crypto.md5,
+            refresh_token: Faker::Crypto.md5,
+            expires_at: Faker::Time.forward.to_i,
+            expires: true
+          },
+          extra: {
+            raw_info: {
+              iss: 'https://appleid.apple.com',
+              aud: 'CLIENT_ID',
+              exp: Faker::Time.forward.to_i,
+              iat: Faker::Time.forward.to_i,
+              sub: uid,
+              at_hash: Faker::Crypto.md5,
+              auth_time: Faker::Time.forward.to_i,
+              email: auth.email,
+              email_verified: true
+            }
+          }
+        }
+      end
+
+      ##
+      # Generate a mock Omniauth response from Auth0.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-auth0.
+      #
+      # @faker.version next
+      def auth0(name: nil, email: nil, uid: nil)
+        uid ||= "auth0|#{Faker::Number.hexadecimal(digits: 24)}"
+        auth = new(name: name, email: email)
+        {
+          provider: 'auth0',
+          uid: uid,
+          info: {
+            name: uid,
+            nickname: auth.name,
+            email: auth.email,
+            image: image
+          },
+          credentials: {
+            expires_at: Time.forward.to_i,
+            expires: true,
+            token_type: 'Bearer',
+            id_token: Faker::Crypto.sha256,
+            token: Faker::Crypto.md5,
+            refresh_token: Faker::Crypto.md5
+          },
+          extra: {
+            raw_info: {
+              email: auth.email,
+              email_verified: true,
+              iss: 'https://auth0.com/',
+              sub: uid,
+              aud: 'Auth012345',
+              iat: Faker::Time.forward.to_i,
+              exp: Faker::Time.forward.to_i
             }
           }
         }
@@ -303,27 +444,27 @@ module Faker
       private
 
       def gender
-        shuffle(%w[male female]).pop
+        sample(%w[male female])
       end
 
       def timezone
-        shuffle((-12..12).to_a).pop
+        sample((-12..12).to_a)
       end
 
       def image
-        Placeholdit.image
+        Faker::Placeholdit.image
       end
 
       def city_state
-        "#{Address.city}, #{Address.state}"
+        "#{Faker::Address.city}, #{Faker::Address.state}"
       end
 
       def random_number_from_range(range)
-        shuffle(range.to_a).pop
+        sample(range.to_a)
       end
 
       def random_boolean
-        shuffle([true, false]).pop
+        sample([true, false])
       end
     end
   end

data/lib/faker/default/phone_number.rb

@@ -3,45 +3,147 @@
 module Faker
   class PhoneNumber < Base
     class << self
+      ##
+      # Produces a phone number in a random format without the country code and it can have different dividers.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.phone_number #=> "(504) 113-1705"
+      #   Faker::PhoneNumber.phone_number #=> "662.291.7201"
+      #   Faker::PhoneNumber.phone_number #=> "9415283713"
+      #
+      # @faker.version 0.3.0
       def phone_number
         parse('phone_number.formats')
       end
 
+      ##
+      # Produces a random cell phone number in a random format without the country code and it can have different dividers.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.cell_phone #=> "(836) 115-8995"
+      #   Faker::PhoneNumber.cell_phone #=> "382-597-5739"
+      #   Faker::PhoneNumber.cell_phone #=> "316.828.1822"
+      #
+      # @faker.version 1.0.0
       def cell_phone
         parse('cell_phone.formats')
       end
 
+      ##
+      # Produces a random country code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.country_code #=> "+20"
+      #   Faker::PhoneNumber.country_code #=> "+39"
+      #   Faker::PhoneNumber.country_code #=> "+852"
+      #
+      # @faker.version 1.9.2
       def country_code
-        "+#{fetch('country_code')}"
+        "+#{fetch('phone_number.country_code')}"
       end
 
+      ##
+      # Produces a random phone number with country code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+55 466-746-6882"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+81 3718219558"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+49 140 957 9846"
+      #
+      # @faker.version 1.9.2
       def phone_number_with_country_code
         "#{country_code} #{phone_number}"
       end
 
+      ##
+      # Produces a random cell phone number with country code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+852 (190) 987-9034"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+64 (820) 583-6474"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+1 591.871.7985"
+      #
+      # @faker.version 1.9.2
       def cell_phone_with_country_code
         "#{country_code} #{cell_phone}"
       end
 
-      # US and Canada only
+      ##
+      # Produces a random phone number in e164 format, i.e., without any dividers.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+542024834991"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+8522846847703"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+649477546575"
+      #
+      # @faker.version 1.9.2
+      def cell_phone_in_e164
+        cell_phone_with_country_code.delete('^+0-9')
+      end
+
+      ##
+      # Produces a random area code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.area_code #=> "201"
+      #   Faker::PhoneNumber.area_code #=> "613"
+      #   Faker::PhoneNumber.area_code #=> "321"
+      #
+      # @faker.version 1.3.0
       def area_code
         fetch('phone_number.area_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
-      # US and Canada only
+      ##
+      # Produces a random exchange code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.exchange_code #=> "208"
+      #   Faker::PhoneNumber.exchange_code #=> "415"
+      #   Faker::PhoneNumber.exchange_code #=> "652"
+      #
+      # @faker.version 1.3.0
       def exchange_code
         fetch('phone_number.exchange_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
-      # US and Canada only
-      # Can be used for both extensions and last four digits of phone number.
-      # Since extensions can be of variable length, this method taks a length parameter
+      ##
+      # Produces a random extension / subscriber number. Can be used for both extensions and last four digits of phone number.
+      #
+      # @param length [Integer] Specifies the length of the return value. Defaults to 4.
+      # @return [String]
+      #
+      # @example
+      #   Faker::PhoneNumber.subscriber_number #=> "3873"
+      #   Faker::PhoneNumber.subscriber_number(length: 2) #=> "39"
+      #   Faker::PhoneNumber.extension #=> "3764"
+      #   Faker::PhoneNumber.extension(length: 2) => "37"
+      #
+      # @faker.version 1.3.0
       def subscriber_number(length: 4)
-        rand.to_s[2..(1 + length)]
+        if !length.is_a?(Integer) || length > 10
+          raise ArgumentError, 'length must be an Integer and be lesser than 10'
+        end
+
+        generate(:string) do |g|
+          g.int(length: length)
+        end
       end
 
       alias extension subscriber_number