Ruby bindings for the Toopher web service API
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
lib
test
.gitignore
.travis.yml
Gemfile
README.md
Rakefile
toopher_api.gemspec

README.md

ToopherAPI Ruby Client

Introduction

ToopherAPI Ruby Client simplifies the task of interfacing with the Toopher API from Ruby code. To use, just gem install toopher_api and you'll be ready to go.

Learn the Toopher API

Make sure you visit http://dev.toopher.com to get acquainted with the Toopher API fundamentals. The documentation there will tell you the details about the operations this API wrapper library provides.

OAuth Authentication

The first step to accessing the Toopher API is to sign up for an account at the development portal (http://dev.toopher.com) and create a "requester". When that process is complete, your requester is issued OAuth 1.0a credentials in the form of a consumer key and secret. Your key is used to identify your requester when Toopher interacts with your customers, and the secret is used to sign each request so that we know it is generated by you. This library properly formats each request with your credentials automatically.

The Toopher Two-Step

Interacting with the Toopher web service involves two steps: pairing, and authenticating.

Pair

Before you can enhance your website's actions with Toopher, your customers will need to pair their phone's Toopher app with your website. To do this, they generate a unique, nonsensical "pairing phrase" from within the app on their phone. You will need to prompt them for a pairing phrase as part of the Toopher enrollment process. Once you have a pairing phrase, just send it to the Toopher API along with your requester credentials and we'll return a pairing ID that you can use whenever you want to authenticate an action for that user.

Authenticate

You have complete control over what actions you want to authenticate using Toopher (for example: logging in, changing account information, making a purchase, etc.). Just send us the user's pairing ID, a name for the terminal they're using, and a description of the action they're trying to perform and we'll make sure they actually want it to happen.

Librarified

This library makes it super simple to do the Toopher two-step. Check it out:

require 'toopher_api'

# Create an API object using your credentials
toopher = ToopherAPI.new("key", "secret")

# Step 1 - Pair with their phone's Toopher app
pairing = toopher.pair("pairing phrase", "username@yourservice.com")

# Step 2 - Authenticate a log in
auth_status = toopher.authenticate(pairing.id, 'my computer')

# Once they've responded you can then check the status
while auth_status.pending
    auth_status = toopher.get_authentication_status(auth_status.id)
    sleep(1)
end

if auth_status.granted
    # Success!
else
    # user declined the authorization!
end

Dependencies

'ToopherAPI Ruby Client depends on the oauth and json gems. 'gem' will make sure these are installed. To install manually:

$ gem install oauth
$ gem install json

Additionally, you will need the webmock library if you wish to run the unit tests:

$ gem install webmock

Handling Errors

If any request runs into an error a ToopherApiError will be raised with more details on what went wrong.

Example code

Check out demo/toopher_demo.rb for an example program that walks you through the whole process! Simply execute the script as follows:

$ ruby demo/toopher_demo.ruby

To avoid being prompted for your Toopher API key and secret, you can define them in the $TOOPHER_CONSUMER_KEY and $TOOPHER_CONSUMER_SECRET environment variables

Known Issues / Workarouds

When running the demo code with ruby 1.9.3, you might receive an OpenSSL error stating that the certificate verify failed. This is a known issue with rubygems, refer to this railsapps page for a discussion of the problem and an exhaustive list of potential workarounds. Here's what worked for us (using rvm and homebrew):

$ rvm remove 1.9.3
$ brew install openssl
$ rvm install 1.9.3 --with-openssl-dir=`brew --prefix openssl`

Tests

To run all unit tests:

$ rake test   # (or just 'rake')

Build Status