Ready to get started?

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

Download Now

Connect to WooCommerce Data in Ruby

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

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

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

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from &service; settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

  • ConsumerKey
  • ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, you will need to set the Url property to the URL of the WooCommerce instance.

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

Create a new Ruby file (for example: WooCommerceSelect.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 WooCommerce Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT ParentId, Total FROM Orders WHERE ParentId = '3'") #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 WooCommerce data with Ruby. To do so, simply run your file from the command line:

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