Connect to Mocean Data in JRuby

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

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

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

Using API Key Authentication

Mocean uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Mocean account at https://dashboard.moceanapi.com
2. Navigate to your account settings or API credentials section
3. Copy your API Key

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

Example Connection String

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

Connecting to Mocean

Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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