Reference documentation and code samples for the googleauth module Google::Auth::ScopeUtil.
Small utility for normalizing scopes into canonical form.
The canonical form of scopes is as an array of strings, each in the form of a full URL. This utility converts space-delimited scope strings into this form, and handles a small number of common aliases.
This is used by UserRefreshCredentials to verify that a credential grants a requested scope.
Methods
.as_array
def self.as_array(scope) -> Array<String>Ensure the input is an array. If a single string is passed in, splits it via whitespace. Does not interpret aliases.
- scope (String, Array<String>) — Input scope(s)
- (Array<String>) — Always an array of strings
- — ArgumentError If the input is not a string or array of strings
.normalize
def self.normalize(scope) -> Array<String>Normalize the input, which may be an array of scopes or a whitespace- delimited scope string. The output is always an array, even if a single scope is input.
- scope (String, Array<String>) — Input scope(s)
- (Array<String>) — An array of scopes in canonical form.
Constants
ALIASES
value: {
"email" => "https://www.googleapis.com/auth/userinfo.email";,
"profile" => "https://www.googleapis.com/auth/userinfo.profile";,
"openid" => "https://www.googleapis.com/auth/plus.me";
}.freeze
Aliases understood by this utility