Purpose

[top]

Dependencies

[top]

• neturl
• luajson
• luasec (default) or Lua-cURLv3

Basic Usage

[top]

1. Log in to the google developer console.
2. Go to the Drive API link under the Google Apps APIs
3. Enable this API and download a credentials file
4. From the credentials file take the installed json table and paste in a new file creds.json and place the file in the same directory as this demo file
5. Now execute the code

local oauth2 = require 'oauth2'
config = {
    auth_uri = 'https://accounts.google.com/o/oauth2/auth',
    token_url = 'https://accounts.google.com/o/oauth2/token',
 
    approval_prompt = 'force',
    access_type = 'offline',
    scope = 'https://www.googleapis.com/auth/drive', 
    creds_file = 'creds.json',     -- Place the creds file if the file is used 
    tokens_file = 'tokens.json',  -- Where to save the tokens file
}
 
oa,msg = oauth2.new(config)
if oa then
    -- Acquire the token
    status, msg = oa:acquireToken()
    if status then
        -- Get the token from the user and give it to the object
    print("Go to the following URL and grant permissions and get the authorization code:")
    print(status[1])
    print("Enter the authorization code:")
    code = io.read()
    status,msg,content = status[2](code)
    if not status then
        print("Code authorization failed: "..msg,content)
    else
        print('Token acquired successfully.')
                -- Now try a request to get the root directory listing
                local url = 'https://www.googleapis.com/drive/v2/files/root?alt=json'
                resp, code = oa:request(url)
                if code < 200 or code > 206 then
                      print("Error "..code)
                else
                      print("Result:\n"..resp)
                end
        end
    else
        print("Error acquiring token "..msg)
    end
else
   print("Error creating oAuth 2.0 object "..msg)
end

API Reference

[top]

Module

[top]

API

[top]

new

[top]

new((config: table)) -> (oauth2 Object: table)

oa,msg = new(config)

• creds_file: [OPTIONAL] Full path and name for the credentials file. This parameter if not given then the credentials must be provided in the creds table described below.
• creds: [OPTIONAL] Table containing the connection credentials. This table must have the following keys:
  • client_id: String key for the client id.
  • client_secret: String key for the client secret.
  • redirect_uris: [OPTIONAL] Redirect URIs provided by the service
  • auth_uri or auth_url: [OPTIONAL] URL string for requesting authorization. NOTE: If this is given it will overwrite the auth_uri or auth_url given in the main config table
  • token_uri or token_url: [OPTIONAL] URL string for requesting token. NOTE: If this is given it will overwrite the token_uri or token_url given in the main config table
• tokens_file: [OPTIONAL] Full path and name for the tokens file. This file will be used to read the token and save the updated token. NOTE: If both the tokens_file and tokens table have valid tokens then the tokens_file token is used.
• tokens: [OPTIONAL] Table containing the access tokens for the oAuth object. This table must have the following keys:
  • access_token
  • token_type
  • refresh_token
  • expires
• scope: Scope of the access
• access_type: [OPTIONAL] The access_type parameter to be inserted in the query parameter of the endpoint
• redirect_uri: [OPTIONAL] The redirect_uri parameter to be inserted in the query parameter of the endpoint
• approval_prompt: [OPTIONAL] The approval_prompt parameter to be inserted in the query parameter of the endpoint

• oAuth2.0 access object on success
• nil and an error message on failure

oAuth 2.0 object

[top]

API

[top]

acquireToken

[top]

acquireToken((oauth2 object: table)) -> (Function table: table)

status,msg = oa:acquireToken()

• oa: The oAuth 2.0 object

• nil and an error message on failure
• table containing URL string and token add function - The URL string is the URL to follow to obtain the token code from the online service. The second return is a function that needs to be called once the code is obtained by passing the code to the function to finish acquiring the token

request

[top]

request((oauth2 object: table),(url: string)[, (payload: string or table)][,(headers: table)][,(verb: string)])
                             -> (response: string), (https response code: number), (token update flag: boolean)

status,msg = oa:request(url,payload,headers,verb)

• oa: The oAuth 2.0 object
• url: The url where to make the request
• payload: [OPTIONAL] Data to post to the URL. This can be a string or a table. The function implementation of this is not implemented yet so that we can have a source function to stream data.
• headers: [OPTIONAL] Table of headers to send the URL
• verb: [OPTIONAL] The https request verb. Default is GET. If there is a payload then default is POST.

• nil and an error message on failure
• The response as a string, the https response code and a boolean flag which is true if the token was refreshed on success request completion

Objects

[top]

creds

[top]

config

[top]

tokens

[top]

Credits

[top]