Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add YARD docs to Faker::Omniauth #2051

Merged
merged 2 commits into from
Jun 12, 2020
Merged

Add YARD docs to Faker::Omniauth #2051

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f730209
Add YARD docs to Faker::Omniauth
Jun 12, 2020
7369607
Add punctuation to make formatting uniform
Jun 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
63 changes: 58 additions & 5 deletions lib/faker/default/omniauth.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ def initialize(name: nil, email: nil)
end

class << self
##
# 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
# rubocop:disable Metrics/ParameterLists
def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 9).to_s)
# rubocop:enable Metrics/ParameterLists
Expand Down Expand Up @@ -72,6 +82,17 @@ def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_G
}
end

##
# 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
# rubocop:disable Metrics/ParameterLists
def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
# rubocop:enable Metrics/ParameterLists
Expand Down Expand Up @@ -123,6 +144,16 @@ def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username
}
end

##
# 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
# rubocop:disable Metrics/ParameterLists
def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
# rubocop:enable Metrics/ParameterLists
Expand Down Expand Up @@ -204,6 +235,16 @@ def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = N
}
end

##
# 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
# rubocop:disable Metrics/ParameterLists
def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 6).to_s)
# rubocop:enable Metrics/ParameterLists
Expand Down Expand Up @@ -275,6 +316,16 @@ def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT
}
end

##
# 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
# rubocop:disable Metrics/ParameterLists
def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 8).to_s)
# rubocop:enable Metrics/ParameterLists
Expand Down Expand Up @@ -342,13 +393,15 @@ def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_G
end

##
# Generate a mock Omniauth response from Apple
# 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.
#
# @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.
#
# @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 ||= "#{Number.number(digits: 6)}.#{Number.hexadecimal(digits: 32)}.#{Number.number(digits: 4)}"
auth = Omniauth.new(name: name, email: email)
Expand Down