CkOAuth1 Ruby Reference Documentation

CkOAuth1

OAuth 1.0a signature generator.

Object Creation

obj = Chilkat::CkOAuth1.new()

Properties

# strVal is a string
# ckStr is a CkString
oAuth1.get_AuthorizationHeader(ckStr);
strVal = oAuth1.authorizationHeader();

Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

# strVal is a string
# ckStr is a CkString
oAuth1.get_BaseString(ckStr);
strVal = oAuth1.baseString();

Introduced in version 9.5.0.53

This is the exact string that was signed. For example, if the signature method is HMAC-SHA1, the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set the BaseString property. The BaseString is exposed as a property to allow for debugging and to see the exact string that is signed.

# strVal is a string
# ckStr is a CkString
oAuth1.get_ConsumerKey(ckStr);
strVal = oAuth1.consumerKey();
oAuth1.put_ConsumerKey(strVal);

Introduced in version 9.5.0.53

The consumer key.

# strVal is a string
# ckStr is a CkString
oAuth1.get_ConsumerSecret(ckStr);
strVal = oAuth1.consumerSecret();
oAuth1.put_ConsumerSecret(strVal);

Introduced in version 9.5.0.53

The consumer secret.

# strVal is a string
# ckStr is a CkString
oAuth1.get_DebugLogFilePath(ckStr);
strVal = oAuth1.debugLogFilePath();
oAuth1.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
oAuth1.get_EncodedSignature(ckStr);
strVal = oAuth1.encodedSignature();

Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

# strVal is a string
# ckStr is a CkString
oAuth1.get_GeneratedUrl(ckStr);
strVal = oAuth1.generatedUrl();

Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

# strVal is a string
# ckStr is a CkString
oAuth1.get_HmacKey(ckStr);
strVal = oAuth1.hmacKey();

Introduced in version 9.5.0.53

The exact HMAC key used to sign the BaseString. An application does not directly set the HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it exists) and the token secret (if it exists).

# strVal is a string
# ckStr is a CkString
oAuth1.get_LastErrorHtml(ckStr);
strVal = oAuth1.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
oAuth1.get_LastErrorText(ckStr);
strVal = oAuth1.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
oAuth1.get_LastErrorXml(ckStr);
strVal = oAuth1.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 = oAuth1.get_LastMethodSuccess();
oAuth1.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.

# strVal is a string
# ckStr is a CkString
oAuth1.get_Nonce(ckStr);
strVal = oAuth1.nonce();
oAuth1.put_Nonce(strVal);

Introduced in version 9.5.0.53

The nonce.

# strVal is a string
# ckStr is a CkString
oAuth1.get_OauthMethod(ckStr);
strVal = oAuth1.oauthMethod();
oAuth1.put_OauthMethod(strVal);

Introduced in version 9.5.0.53

The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".

# strVal is a string
# ckStr is a CkString
oAuth1.get_OauthUrl(ckStr);
strVal = oAuth1.oauthUrl();
oAuth1.put_OauthUrl(strVal);

Introduced in version 9.5.0.53

The OAuth URL, such as "http://echo.lab.madgex.com/echo.ashx". See http://bettiolo.github.io/oauth-reference-page/ to compare Chilkat results with another tool's results.

Note: The OAuthUrl should not include query parameters. For example, do not set the OAuthUrl equal to

https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1
Instead, set OAuthUrl equal to
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl
and then subsequently call AddParam for each query parameter.

# strVal is a string
# ckStr is a CkString
oAuth1.get_OauthVersion(ckStr);
strVal = oAuth1.oauthVersion();
oAuth1.put_OauthVersion(strVal);

Introduced in version 9.5.0.53

The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.

# strVal is a string
# ckStr is a CkString
oAuth1.get_QueryString(ckStr);
strVal = oAuth1.queryString();

Introduced in version 9.5.0.53

Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.

# strVal is a string
# ckStr is a CkString
oAuth1.get_Realm(ckStr);
strVal = oAuth1.realm();
oAuth1.put_Realm(strVal);

Introduced in version 9.5.0.70

The realm (optional).

# strVal is a string
# ckStr is a CkString
oAuth1.get_Signature(ckStr);
strVal = oAuth1.signature();

Introduced in version 9.5.0.53

The generated base64 signature.

# strVal is a string
# ckStr is a CkString
oAuth1.get_SignatureMethod(ckStr);
strVal = oAuth1.signatureMethod();
oAuth1.put_SignatureMethod(strVal);

Introduced in version 9.5.0.53

The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC1-SHA256", "RSA-SHA1", and "RSA-SHA2".

# strVal is a string
# ckStr is a CkString
oAuth1.get_Timestamp(ckStr);
strVal = oAuth1.timestamp();
oAuth1.put_Timestamp(strVal);

Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

# strVal is a string
# ckStr is a CkString
oAuth1.get_Token(ckStr);
strVal = oAuth1.token();
oAuth1.put_Token(strVal);

Introduced in version 9.5.0.53

The token.

# strVal is a string
# ckStr is a CkString
oAuth1.get_TokenSecret(ckStr);
strVal = oAuth1.tokenSecret();
oAuth1.put_TokenSecret(strVal);

Introduced in version 9.5.0.53

The token secret

# boolVal is a boolean
boolVal = oAuth1.get_Utf8();
oAuth1.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 = oAuth1.get_VerboseLogging();
oAuth1.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
oAuth1.get_Version(ckStr);
strVal = oAuth1.version();

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

Methods

# name is a string
# value is a string
status = oAuth1.AddParam(name, value);

Introduced in version 9.5.0.53

Adds an extra name/value parameter to the OAuth1 signature.

Returns true for success, false for failure.

REST OAuth1 with Params

status = oAuth1.Generate();

Introduced in version 9.5.0.53

Generate the signature based on the property settings. Input properties are OauthVersion, OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp. Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature, QueryString, GeneratedUrl, andAuthorizationHeader.

Returns true for success, false for failure.

Generate OAuth 1.0 Signature

# numBytes is an integer
status = oAuth1.GenNonce(numBytes);

Introduced in version 9.5.0.55

Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.

Returns true for success, false for failure.

status = oAuth1.GenTimestamp();

Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns true for success, false for failure.

# name is a string
status = oAuth1.RemoveParam(name);

Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns true for success, false for failure.

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

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

Returns true for success, false for failure.

# privKey is a CkPrivateKey
status = oAuth1.SetRsaKey(privKey);

Introduced in version 9.5.0.64

Sets the RSA key to be used when the SignatureMethod is set to "RSA-SHA1" or "RSA-SHA2".

Returns true for success, false for failure.