Connect to LionDesk Data in JRuby

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

Configure a JDBC Connection to LionDesk 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 LionDesk\lib).

JRuby natively supports JDBC, so you can easily connect to LionDesk 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 LionDesk Profile on disk (e.g. C:\profiles\LionDesk.apip). Next, set the ProfileSettings connection property to the connection string for LionDesk (see below).

LionDesk API Profile Settings

Register an OAuth application via the LionDesk Developer Center Apps Page to obtain your Client ID and Client Secret.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the LionDesk 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 LionDesk:

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

Create a JRuby App with Connectivity to LionDesk 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 LionDesk 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\LionDesk.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 CampaignId, Id FROM CampaignActions")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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