Connect to TimeCamp Data in JRuby

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

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

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

TimeCamp API Profile Settings

TimeCamp uses token-based authentication. To obtain an API Token:

1. Log in to your TimeCamp account at https://app.timecamp.com
2. Click your profile avatar in the top-right corner
3. Select Profile Settings
4. Copy the API token shown at the bottom of the page

After obtaining your API Token, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your TimeCamp API token.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\TimeCamp.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_token';

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

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

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

jruby -S APISelect.rb

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