Connect to Teamwork Data in Ruby

The CData API Driver for ODBC makes it easy to integrate connectivity to live Teamwork data in Ruby. This article shows how to create a simple Ruby app that connects to Teamwork data, executes a query, and displays the results.

Create an ODBC Connection to Teamwork Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

Create a Ruby 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:

#connect to the DSN
require 'dbi'
cnxn = DBI.connect('DBI:ODBC:CData API Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Name FROM Account WHERE ChatEnabled = 'true'")

#display the names of the columns
resultSet.column_names.each do |name|
  print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
  (0..resultSet.column_names.size - 1).each do |n|
    print row[n], "\t"
  end
  puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

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

ruby APISelect.rb

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