Connect to BugHerd Data in JRuby

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

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

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

BugHerd API Profile Settings

BugHerd uses HTTP Basic authentication with an API key as the username. To obtain an API key:

1. Sign in to your BugHerd account at https://www.bugherd.com
2. Navigate to Settings > General Settings
3. Locate the API Key section and copy the generated key

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 BugHerd API key. The driver uses the key as the Basic auth username and sets the password internally to the literal value 'x' as required by BugHerd.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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