CkAuthGoogle Ruby Reference Documentation

CkAuthGoogle

Provides functionality for authenticating calls to the Google Cloud Platform API and Google Apps API using a service account.

Object Creation

obj = Chilkat::CkAuthGoogle.new()

Properties

# strVal is a string
# ckStr is a CkString
authGoogle.get_AccessToken(ckStr);
strVal = authGoogle.accessToken();
authGoogle.put_AccessToken(strVal);

Introduced in version 9.5.0.58

The access token to be used in Google API requests. This property is set on a successful call to ObtainAccessToken.

Important: This class is used for authenticating calls to the Google Cloud Platform API and Google Apps API using a service account.. 
For 3-legged OAuth2, where a browser must be used to interactively get permission from the Google account owner, use the Chilkat OAuth2 class/object.

# strVal is a string
# ckStr is a CkString
authGoogle.get_DebugLogFilePath(ckStr);
strVal = authGoogle.debugLogFilePath();
authGoogle.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

# strVal is a string
# ckStr is a CkString
authGoogle.get_EmailAddress(ckStr);
strVal = authGoogle.emailAddress();
authGoogle.put_EmailAddress(strVal);

Introduced in version 9.5.0.58

The client email address of the service account. If a JSON key is used, then the client_email should already be specified within the JSON key, and this property is unused. This property must be set if using a P12 key.

Get Google API Access Token using P12 Service Account Key

# intVal is an integer
intVal = authGoogle.get_ExpireNumSeconds();
authGoogle.put_ExpireNumSeconds(intVal);

Introduced in version 9.5.0.58

The expiration time, in seconds, of the access token to be requested. The maximum value is 1 hour (3600 seconds). The default value is 3600.

# strVal is a string
# ckStr is a CkString
authGoogle.get_JsonKey(ckStr);
strVal = authGoogle.jsonKey();
authGoogle.put_JsonKey(strVal);

Introduced in version 9.5.0.58

The JSON key for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

Get Google API Access Token using JSON Private Key

# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorHtml(ckStr);
strVal = authGoogle.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorText(ckStr);
strVal = authGoogle.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
authGoogle.get_LastErrorXml(ckStr);
strVal = authGoogle.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

# boolVal is a boolean
boolVal = authGoogle.get_LastMethodSuccess();
authGoogle.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

# intVal is an integer
intVal = authGoogle.get_NumSecondsRemaining();

Introduced in version 9.5.0.58

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

# strVal is a string
# ckStr is a CkString
authGoogle.get_Scope(ckStr);
strVal = authGoogle.scope();
authGoogle.put_Scope(strVal);

Introduced in version 9.5.0.58

A space-delimited list of the permissions that the application requests.

# strVal is a string
# ckStr is a CkString
authGoogle.get_SubEmailAddress(ckStr);
strVal = authGoogle.subEmailAddress();
authGoogle.put_SubEmailAddress(strVal);

Introduced in version 9.5.0.58

The email address of the user for which the application is requesting delegated access.

# boolVal is a boolean
boolVal = authGoogle.get_Utf8();
authGoogle.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

# boolVal is a boolean
boolVal = authGoogle.get_Valid();

Introduced in version 9.5.0.58

true if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

# boolVal is a boolean
boolVal = authGoogle.get_VerboseLogging();
authGoogle.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

# strVal is a string
# ckStr is a CkString
authGoogle.get_Version(ckStr);
strVal = authGoogle.version();

Version of the component/library, such as "9.5.0.63"

Methods

# returns a CkPfx
ret_pfx = authGoogle.GetP12();

Introduced in version 9.5.0.58

Returns the private key in a PFX (P12) object. This is only possible if the private key was previously set by calling SetP12.

Returns nil on failure

# connection is a CkSocket
status = authGoogle.ObtainAccessToken(connection);

Introduced in version 9.5.0.58

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The connection is an existing connection to www.googleapis.com.

Returns true for success, false for failure.

Get Google API Access Token using JSON Private Key

# returns a CkTask
# connection is a CkSocket
ret_task = authGoogle.ObtainAccessTokenAsync(connection);

Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns nil on failure

How to Run an Asynchronous Task

# path is a string
status = authGoogle.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# key is a CkPfx
status = authGoogle.SetP12(key);

Introduced in version 9.5.0.58

Sets the P12 private key to be used for obtaining an access token. An application must set either the P12 or JSON private key, but not both.

Returns true for success, false for failure.

Get Google API Access Token using P12 Service Account Key