Connect to Short.io Data in JRuby

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

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

JRuby natively supports JDBC, so you can easily connect to Short.io and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Using API Key Authentication

Short.io uses API Key authentication. To obtain your API key:

1. Log in to your Short.io account
2. Navigate to Settings > Integrations & API > API
3. Click Create API Key and copy your API key

After obtaining the API key, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Short.io API key obtained from Settings > Integrations & API > API.

Example connection string:

Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Available Tables

The Short.io profile provides access to the following tables:

• Domains - Short.io domains associated with the authenticated account
• Links - Short links for a domain
• LinkExpand - Expand a short link by domain and path
• LinksByOriginalUrl - Retrieve multiple short links matching a given original destination URL
• Folders - Link folders within a specific domain
• LinkPermissions - Permission records for a specific link within a domain
• CountryTargeting - Country-based redirect targeting rules for a specific short link
• RegionTargeting - Region-based redirect targeting rules for a specific short link
• Regions - List of available regions/states for a given country code
• DomainStatistics - Aggregated click and traffic statistics for a Short.io domain
• LinkStatistics - Aggregated click and traffic statistics for a specific Short.io link

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

url = "jdbc:api:Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ,  FROM Domains")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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