Connect to Shippo Data in JRuby

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

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

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

Shippo API Profile Settings

In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';

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

url = "jdbc:api:Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ObjectId , OrderStatus FROM Orders")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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