Ruby

Get a Google People API OAuth2 Access Token

See more Google People Examples

Demonstrates how to get a Google People OAuth2 access token from a desktop application or script. Ruby

require 'chilkat'

success = false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

oauth2 = Chilkat::CkOAuth2.new()

# For Google OAuth2, set the ListenPort equal to the port specified in the authorized callback URI for the ClientID.
# See http://cknotes.com/setup-google-account-for-google-drive-api-walkthrough/
oauth2.put_ListenPort(3017)

oauth2.put_AuthorizationEndpoint("https://accounts.google.com/o/oauth2/v2/auth")
oauth2.put_TokenEndpoint("https://www.googleapis.com/oauth2/v4/token")

# Replace these with actual values.
oauth2.put_ClientId("GOOGLE-CLIENT-ID")
oauth2.put_ClientSecret("GOOGLE-CLIENT-SECRET")

oauth2.put_CodeChallenge(true)
oauth2.put_CodeChallengeMethod("S256")

# See Google People API Scopes for more scopes.
oauth2.put_Scope("profile https://www.googleapis.com/auth/contacts https://www.googleapis.com/auth/contacts.other.readonly https://www.googleapis.com/auth/directory.readonly")

# Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
url = oauth2.startAuth()
if (oauth2.get_LastMethodSuccess() == false)
    print oauth2.lastErrorText() + "\n";
    exit
end

# Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url)
if (success == false)
    print oauth2.lastErrorText() + "\n";
    exit
end

# Now wait for the authorization.
# We'll wait for a max of 30 seconds.
numMsWaited = 0
while (numMsWaited < 30000) and (oauth2.get_AuthFlowState() < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
end

# If there was no response from the browser within 30 seconds, then 
# the AuthFlowState will be equal to 1 or 2.
# 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
# 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
# In that case, cancel the background task started in the call to StartAuth.
if (oauth2.get_AuthFlowState() < 3)
    oauth2.Cancel()
    print "No response from the browser!" + "\n";
    exit
end

# Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
# The possible AuthFlowState values are:
# 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
# 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
# 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
if (oauth2.get_AuthFlowState() == 5)
    print "OAuth2 failed to complete." + "\n";
    print oauth2.failureInfo() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() == 4)
    print "OAuth2 authorization was denied." + "\n";
    print oauth2.accessTokenResponse() + "\n";
    exit
end

if (oauth2.get_AuthFlowState() != 3)
    print "Unexpected AuthFlowState:" + oauth2.get_AuthFlowState().to_s() + "\n";
    exit
end

# Save the full JSON access token response to a file.
sbJson = Chilkat::CkStringBuilder.new()
sbJson.Append(oauth2.accessTokenResponse())
sbJson.WriteFile("qa_data/tokens/googlePeople.json","utf-8",false)

# The saved JSON response looks like this:

# {
#   "access_token": "ya29.a0AfH6S ... LAZYFUkf0",
#   "expires_in": 3599,
#   "refresh_token": "1//0fL_Ov ... ee0",
#   "scope": "https://www.googleapis.com/auth/contacts",
#   "token_type": "Bearer"
# }

print "OAuth2 authorization granted!" + "\n";
print "Access Token = " + oauth2.accessToken() + "\n";