Connect to Chargebee Data in JRuby

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

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

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

Chargebee API Profile Settings

Generate an API Key from your Chargebee account via Settings > Configure Chargebee > API Keys and Webhooks. Your site name is the subdomain from your Chargebee account URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Chargebee.apip;ProfileSettings='APIKey=your_api_key;Site=your_site_name';

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

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

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

jruby -S APISelect.rb

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