Connect to Suadeo Data in Ruby

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

Create an ODBC Connection to Suadeo 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.

The driver uses the OAuth 2.0 Resource Owner Password Credentials (ROPC) grant to authenticate to Suadeo. Authentication occurs directly using your credentials; there is no browser-based authorization flow or refresh token.

Set the following connection properties:

• URL: The base URL of your Suadeo instance.
• User: Your Suadeo username.
• Password: Your Suadeo password.
• AuthenticationName: The name identifier for the authentication configuration in your Suadeo instance. Different authentication names can be configured for different environments or use cases.

When you connect, the driver sends your credentials to the Suadeo OAuth token endpoint, receives an access token, and uses it for all subsequent requests. A new access token is obtained automatically when needed during the session.

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 Suadeo Data

Create a new Ruby file (for example: SuadeoSelect.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 Suadeo Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Name FROM Customers WHERE Status = 'Active'")

#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 Suadeo data with Ruby. To do so, simply run your file from the command line:

ruby SuadeoSelect.rb

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