Access Live Gumroad Data in TIBCO Data Virtualization

TIBCO Data Virtualization (TDV) is an enterprise data virtualization solution that orchestrates access to multiple and varied data sources. When paired with the CData API Driver for Tibco DV, you get federated access to live Gumroad data directly within TIBCO Data Virtualization. This article explains how to deploy an adapter and create a new data source based on Gumroad.

With built-in optimized data processing, the CData TIBCO DV Adapter offers unmatched performance for interacting with live Gumroad data. When you issue complex SQL queries to Gumroad, the adapter pushes supported SQL operations, like filters and aggregations, directly to Gumroad. Its built-in dynamic metadata querying allows you to work with and analyze Gumroad data using native data types.

Deploy the Gumroad TIBCO DV Adapter

1. In a console, navigate to the bin folder in the TDV Server installation directory. If there is a current version of the adapter installed, you will need to undeploy it.

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name API
   

2. Extract the CData TIBCO DV Adapter to a local folder and deploy the JAR file (tdv.api.jar) to the server from the extract location.

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.api.jar
   

You may need to restart the server to ensure the new JAR file is loaded properly, which can be accomplished by running the composite.bat script located at: C:\Program Files\TIBCO\TDV Server <version>\bin. Note that reauthenticating to the TDV Studio is required after restarting the server.

Sample Restart Call

.\composite.bat monitor restart

Authenticate with Gumroad Using OAuth

Since Gumroad authenticates using the OAuth protocol and TDV Studio does not support browser-based authentication internally, you will need to create and run a simple Java application to retrieve the OAuth tokens. Once retrieved, the tokens are used to connect to Gumroad directly from the adapter.

Create the Java Application

1. Create a new Java file with preferred name for example GenOAuthSettings.java. This Java file leverages the APIOAuth class contained within the TDV Adapter JAR to initiate a test connection and perform the required OAuth authentication flow
2. Copy and insert the following code into the .java file:

public class GenOAuthSettings {
    public static void main(String[] args) {
        try {
    	    if (args.length != 2) {
    			throw new Exception("Input must have two arguments: 'data source', 'connection string'");
    		}
    
    		String source = args[0].replace(" ", "").toLowerCase();
    		String connectionString = args[1];
    		String prefix;
    
    		if (source.equals("api")) {
    			prefix = "jdbc:api:";
    
    			com.cdata.cis.api.APIOAuth oauth = new com.cdata.cis.api.APIOAuth();
    
    			if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
    			oauth.generateOAuthSettingsFile(connectionString);
    		}
    		// More sources can be added below using the same format.  You must add the import statement and ensure the jar file resides in the classpath
			//            else if (source.equals("googlebigquery") || source.equals("bigquery")) {
			//                prefix = "jdbc:googlebigquery:";
			//
			//                com.cdata.cis.googlebigquery.GoogleBigQueryOAuth oauth = new com.cdata.cis.googlebigquery.GoogleBigQueryOAuth();
			//
			//                if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
			//                oauth.generateOAuthSettingsFile(connectionString);
			//            }
    		else {
				throw new Exception("Data Source not supported.  Available Data Sources: Gumroad");
			}
			
			System.out.println("Test Connection Successful!");
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

3. Place the .java file in the same directory as the tdv.api.jar file. This is required to prevent classpath resolution errors during compilation and execution

Build and run the Java Application

1. Open Console and navigate to the directory containing the .java file and adapter jar
2. Compile the Java file using the following command:

javac -cp .;tdv.api.jar GenOAuthSettings.java

3. Execute the application using one of the following commands:

java -cp .;tdv.api.jar GenOAuthSettings "API" "connection string"

This command initiates the OAuth authentication flow and generates the OAuth settings file at the location specified in the OAuthSettingsLocation parameter. Once you deploy the adapter and authenticate, you can create a new data source for Gumroad in TDV Studio.

Create a Gumroad Data Source in TDV Studio

With the CData API Driver for Tibco DV, you can easily create a data source for Gumroad and introspect the data source to add resources to TDV.

Create the Data Source

1. Right-click on the folder you wish to add the data source to and select New -> New Data Source
2. Scroll until you find the adapter (e.g. Gumroad) and click Next
3. Name the data source (e.g. CData Gumroad Source)
4. Fill in the required connection properties

Using OAuth Authentication

To authenticate to Gumroad and connect to your own data or to allow other users to connect to their data, you can use the OAuth 2.0 standard. This is the recommended authentication method.

First you need to register an OAuth application with Gumroad. You can create an OAuth application by visiting your Gumroad account settings at https://app.gumroad.com/settings/advanced and navigating to the Applications section.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. The CData API Profile for Gumroad will automatically walk through the OAuth process in order to obtain the access token.
• OAuthClientID: Set this to the client_id that is specified in your app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI you specified in your app settings.

Example connection string

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

NOTE: Ensure that the OAuthSettingsLocation property in the DV Adapter is set to the same file path used during the OAuth authentication process. Additionally, set the InitiateOAuth property to REFRESH so that the adapter can automatically handle OAuth access-token refreshes in the background without requiring any user action.


5. Click Create & Close.

Introspect the Data Source

Once the data source is created, you can introspect the data source by right-clicking and selecting Open. In the dashboard, click Add/Remove Resources and select the Tables, Views, and Stored Procedures to include as part of the data source. Click Next and Finish to add the selected Gumroad tables, views, and stored procedures as resources.

After creating and introspecting the data source, you are ready to work with Gumroad data in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.