Ready to get started?

Learn more about the CData ODBC Driver for Square or download a free trial:

Download Now

Connect to Square Data in Ruby

Connect to Square data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

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

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

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

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

Create a new Ruby file (for example: SquareSelect.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 Square Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Reason, RefundedMoneyAmount FROM Refunds") #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 Square data with Ruby. To do so, simply run your file from the command line:

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