Connect to USPS Data in JRuby

Ready to get started?

Download for a free trial:

Download Now

Learn more:


Rapidly create and deploy powerful Java applications that integrate with USPS data including Packages, Shipments, Recipients, and more!

Create a simple JRuby app with access to live USPS data.

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

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

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

To authenticate with USPS, set the following connection properties.

  • PostageProvider: The postage provider to use to process requests. Available options are ENDICIA and STAMPS. If unspecified, this property will default to ENDICIA.
  • UseSandbox: This controls whether live or test requests are sent to the production or sandbox servers. If set to true, the Password, AccountNumber, and StampsUserId properties are ignored.
  • StampsUserId: This value is used for logging into authentication to the Stamps servers. This value is not applicable for Endicia and is optional if UseSandbox is true.
  • Password: This value is used for logging into Endicia and Stamps servers. If the postage provider is Endicia, this will be the pass phrase associated with your postage account. It is optional if UseSandbox is true.
  • AccountNumber: The shipper's account number. It is optional if UseSandbox is true.
  • PrintLabelLocation: This property is required to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

The Cache Database

Many of the useful task available from USPS require a lot of data. To ensure this data is easy to input and recall later, utilize a cache database to make requests. Set the cache connection properties in order to use the cache:

  • CacheLocation: The path to the cache location, for which a connection will be configured with the default cache provider. For example, C:\users\username\documents\uspscache

As an alternative to CacheLocation, set the combination of CacheConnection and CacheProvider to configure a cache connection using a provider separate from the default.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the USPS JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.usps.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for USPS:

jdbc:usps:PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'

Create a JRuby App with Connectivity to USPS Data

Create a new Ruby file (for example: USPSSelect.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 USPS 2018/lib/cdata.jdbc.usps.jar' url = "jdbc:usps:PostageProvider=ENDICIA; RequestId=12345; Password='abcdefghijklmnopqr'; AccountNumber='12A3B4C'" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT FirstName, Phone FROM Senders") while ( do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S USPSSelect.rb

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