Description

Install

$ gem install googleauth

Example Usage

require'googleauth'# Get the environment configured authorizationscopes=['https://www.googleapis.com/auth/cloud-platform','https://www.googleapis.com/auth/compute']authorization=Google::Auth.get_application_default(scopes)# Add the the access token obtained using the authorization to a hash, e.g# headers.some_headers={}authorization.apply(some_headers)

Application Default Credentials

User Credentials

Example (Web)

require'googleauth'require'googleauth/web_user_authorizer'require'googleauth/stores/redis_token_store'require'redis'client_id=Google::Auth::ClientId.from_file('/path/to/client_secrets.json')scope=['https://www.googleapis.com/auth/drive']token_store=Google::Auth::Stores::RedisTokenStore.new(redis:Redis.new)authorizer=Google::Auth::WebUserAuthorizer.new(client_id,scope,token_store,'/oauth2callback')get('/authorize')do# NOTE: Assumes the user is already authenticated to the appuser_id=request.session['user_id']credentials=authorizer.get_credentials(user_id,request)ifcredentials.nil?redirectauthorizer.get_authorization_url(login_hint:user_id,request:request)end# Credentials are valid, can call APIs# ...endget('/oauth2callback')dotarget_url=Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request)redirecttarget_urlend

Example (Command Line)

require'googleauth'require'googleauth/stores/file_token_store'OOB_URI='urn:ietf:wg:oauth:2.0:oob'scope='https://www.googleapis.com/auth/drive'client_id=Google::Auth::ClientId.from_file('/path/to/client_secrets.json')token_store=Google::Auth::Stores::FileTokenStore.new(:file=>'/path/to/tokens.yaml')authorizer=Google::Auth::UserAuthorizer.new(client_id,scope,token_store)user_id=ENV['USER']credentials=authorizer.get_credentials(user_id)ifcredentials.nil?url=authorizer.get_authorization_url(base_url:OOB_URI)puts"Open#{url} in your browser and enter the resulting code:"code=getscredentials=authorizer.get_and_store_credentials_from_code(user_id:user_id,code:code,base_url:OOB_URI)end# OK to use credentials

Example (Service Account)

scope='https://www.googleapis.com/auth/androidpublisher'authorizer=Google::Auth::ServiceAccountCredentials.make_creds(json_key_io:File.open('/path/to/service_account_json_key.json'),scope:scope)authorizer.fetch_access_token!

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account_json_key.json

require'googleauth'require'google/apis/drive_v3'Drive= ::Google::Apis::DriveV3drive=Drive::DriveService.newscope='https://www.googleapis.com/auth/drive'authorizer=Google::Auth::ServiceAccountCredentials.from_env(scope:scope)drive.authorization=authorizerlist_files=drive.list_files()

3-Legged OAuth with a Service Account

scope='https://www.googleapis.com/auth/androidpublisher'authorizer=Google::Auth::ServiceAccountCredentials.make_creds(json_key_io:File.open('/path/to/service_account_json_key.json'),scope:scope)authorizer.update!(sub:"email-to-impersonate@your-domain.com")authorizer.fetch_access_token!

Example (Environment Variables)

export GOOGLE_ACCOUNT_TYPE=service_accountexport GOOGLE_CLIENT_ID=000000000000000000000export GOOGLE_CLIENT_EMAIL=xxxx@xxxx.iam.gserviceaccount.comexport GOOGLE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n"

require'googleauth'require'google/apis/drive_v3'Drive= ::Google::Apis::DriveV3drive=Drive::DriveService.new# Auths with ENV vars:# "GOOGLE_CLIENT_ID",# "GOOGLE_CLIENT_EMAIL",# "GOOGLE_ACCOUNT_TYPE",# "GOOGLE_PRIVATE_KEY"auth= ::Google::Auth::ServiceAccountCredentials.make_creds(scope:'https://www.googleapis.com/auth/drive')drive.authorization=authlist_files=drive.list_files()

Storage

Supported Ruby Versions

License

Contributing

Support