Connect to Respond.io Data in JRuby

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

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

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

Respondio API Profile Settings

Respond.io uses API key authentication. To obtain an API key:

1. Log in to your Respond.io account.
2. Navigate to Settings in your workspace.
3. Select Developer under the Integrations section.
4. Copy the API key displayed on the page.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Respond.io API key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Respondio.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

url = "jdbc:api:Profile=C:\profiles\Respondio.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Email FROM Contacts")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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