We are happy to announce the release of the OCLC Auth Ruby gem via Github. This code library is the first implementation that the OCLC Developer Network will be releasing to assist developers working with our web services protected by our API key system.
In addition to this Ruby implementation, we are also planning to release versions for PHP and iOS and Android mobile environments. A Java implementation will be released a little further out. You can also dig into Terry Reese’s oclc_api on Github to see how he implemented some of the same functionality in C#.
This Ruby gem can be cloned or checked out from OCLC Developer Network repository and installed by users of OCLC Web Service Keys, or WSKeys. Once installed, your Ruby application can construct an OCLC::Auth::WSKey object using your API key and secret. This class can then be used
- to sign requests using our HMAC Signature pattern
- to determine the HTTP redirect Location to log a user in using our OAuth 2 and access token pattern
- to use as a reference implementation to write your own
The purpose of these code libraries is to provide a common interface to web service authentication so that clients of OCLC APIs spend less time duplicating the same API key-based authentication code. We want you to be able to focus more on the problem you are trying to solve for your libraries and less on the annoying bits like generating digital signatures or configuring the login URL for your users.
In addition, we will be hosting a free workshop, Web Service Keys for APIs, on January 7, 2014 at 11:00 am, U.S. Eastern Time describing our API key system. We will use the OCLC Auth gem for a code walkthrough portion of the presentation.
Technical Product Manager