Connect to ZohoInvoice Data in JRuby

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for ZohoInvoice makes it easy to integrate connectivity to live ZohoInvoice data in JRuby. This article shows how to create a simple JRuby app that connects to ZohoInvoice data, executes a query, and displays the results.

Configure a JDBC Connection to ZohoInvoice Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for ZohoInvoice\lib).

JRuby natively supports JDBC, so you can easily connect to ZohoInvoice and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Start by setting the Profile connection property to the location of the ZohoInvoice Profile on disk (e.g. C:\profiles\ZohoInvoice.apip). Next, set the ProfileSettings connection property to the connection string for ZohoInvoice (see below).

ZohoInvoice API Profile Settings

Register an OAuth application in the Zoho Developer Console as a server-based application. You will receive a Client ID, Client Secret, and must configure a redirect URI.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ZohoInvoice JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for ZohoInvoice:

jdbc:api:Profile=C:\profiles\ZohoInvoice.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Create a JRuby App with Connectivity to ZohoInvoice Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for ZohoInvoice 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\ZohoInvoice.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT OrganizationId, ContactId FROM ContactAddresses")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

With the file completed, you are ready to display your ZohoInvoice data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to ZohoInvoice allows you to quickly and easily incorporate ZohoInvoice data into your own JRuby applications. Download a free trial today!