Connect to Teamwork Data in JRuby

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

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

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

Teamwork API Profile Settings

Register an OAuth application on the Teamwork Developer Portal to obtain your Client ID and Secret. Set the Domain property to your Teamwork site's subdomain.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Teamwork.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

url = "jdbc:api:Profile=C:\profiles\Teamwork.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Name FROM Account")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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