Connect to EmailOctopus Data in JRuby

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

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

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

EmailOctopus API Profile Settings

Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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