Connect to ChargeOver Data in JRuby

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

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

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

ChargeOver API Profile Settings

Log into ChargeOver, navigate to Settings > Developer > REST API, enable the API, and copy your Public Key (APIKey) and Private Key (APISecret).

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Chargeover.apip;ProfileSettings='APIKey=your_public_key;APISecret=your_private_key;Domain=your_subdomain';

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

url = "jdbc:api:Profile=C:\profiles\Chargeover.apip;ProfileSettings='APIKey=your_public_key;APISecret=your_private_key;Domain=your_subdomain';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Email FROM AdminWorkers")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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