Connect to Yotpo Data in JRuby

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

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

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

Yotpo API Profile Settings

To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuthClient.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to your Yotpo AppKey.
• OAuthClientSecret: Set this to your Yotpo AppSecret.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;

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

url = "jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT TotalReview, AverageScore FROM ProductBottomLine")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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