toopher_api 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/demo/toopher_demo.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/ruby
+require_relative '../lib/toopher_api'
+
+key = ENV['TOOPHER_CONSUMER_KEY']
+secret = ENV['TOOPHER_CONSUMER_SECRET']
+if key.empty? or secret.empty?
+  puts 'enter consumer credentials (set environment variables to prevent prompting):'
+  print 'TOOPHER_CONSUMER_KEY='
+  STDOUT.flush
+  key = gets
+  key.chomp!
+  print 'TOOPHER_CONSUMER_SECRET='
+  STDOUT.flush
+  secret = gets
+  secret.chomp!
+end
+
+toopher = ToopherAPI.new(key, secret)
+
+puts 'STEP 1: Pair device'
+puts 'enter pairing phrase:'
+phrase = gets
+phrase.chomp!
+puts 'enter user name:'
+user = gets
+user.chomp!
+
+pairing = toopher.pair(phrase, user)
+
+while(!pairing['enabled'])
+  puts 'waiting for authorization...'
+  sleep(1)
+  pairing = toopher.get_pairing_status(pairing['id'])
+end
+
+puts 'paired successfully!'
+
+puts 'STEP 2: Authenticate login'
+puts 'enter terminal name:'
+terminal_name = gets;
+terminal_name.chomp!
+puts 'enter action name, or [ENTER] for none:'
+while (true)
+  action = gets;
+  action.chomp!
+
+  puts 'sending authentication request...'
+  auth = toopher.authenticate(pairing['id'], terminal_name, action)
+
+  while(auth['pending'])
+    puts 'waiting for authentication...'
+    sleep(1)
+    auth = toopher.get_authentication_status(auth['id'])
+  end
+
+  puts "Successfully authorized action '" + action + "'.  Enter another action to authorize again, or [Ctrl-C] to exit"
+end
+

data/lib/toopher_api.rb

@@ -0,0 +1,117 @@
+=begin
+Copyright (c) 2012 Toopher, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+=end
+
+require 'rubygems'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+require 'oauth'
+
+class ToopherApiError < StandardError
+end
+
+class ToopherAPI
+
+  DEFAULT_BASE_URL = 'https://toopher-api.appspot.com/v1/'
+
+  def initialize(key,secret,options={}, base_url = DEFAULT_BASE_URL)
+    consumer_key = key
+    consumer_secret = secret
+
+    consumer_key.empty? and raise ArgumentError, "Toopher consumer key cannot be empty!"
+    consumer_secret.empty? and raise ArgumentError, "Toopher consumer secret cannot be empty!"
+
+    @base_url = base_url
+    @oauth_consumer = OAuth::Consumer.new(consumer_key, consumer_secret)
+    @oauth_options = options
+  end
+
+  def pair(pairing_phrase, user_name)
+    return make_pair_response(post('pairings/create', {
+      'pairing_phrase' => pairing_phrase,
+      'user_name' => user_name
+    }))
+  end
+
+  def get_pairing_status(pairing_request_id)
+    return make_pair_response(get('pairings/' + pairing_request_id))
+  end
+
+  def authenticate(pairing_id, terminal_name, action_name = '')
+    parameters = {
+      'pairing_id' => pairing_id,
+      'terminal_name' => terminal_name
+    }
+    action_name.empty? or (parameters['action_name'] = action_name)
+    return make_auth_response(post('authentication_requests/initiate', parameters))
+  end
+
+  def get_authentication_status(authentication_request_id)
+    return make_auth_response(get('authentication_requests/' + authentication_request_id))
+  end
+
+  private
+  def make_pair_response(result)
+    return {
+      'id' => result['id'],
+      'enabled' => result['enabled'],
+      'user_id' => result['user']['id'],
+      'user_name' => result['user']['name']
+    }
+  end
+  def make_auth_response(result)
+    return {
+      'id' => result['id'],
+      'pending' => result['pending'],
+      'granted' => result['granted'],
+      'automated' => result['automated'],
+      'reason' => result['reason'],
+      'terminal_id' => result['terminal']['id'],
+      'terminal_name' => result['terminal']['name']
+    }
+  end
+  def post(endpoint, parameters)
+    url = URI.parse(@base_url + endpoint)
+    req = Net::HTTP::Post.new(url.path)
+    req.set_form_data(parameters)
+    return request(url, req)
+  end
+
+  def get(endpoint)
+    url = URI.parse(@base_url + endpoint)
+    req = Net::HTTP::Get.new(url.path)
+    return request(url, req)
+  end
+
+  def request(url, req)
+    http = Net::HTTP::new(url.host, url.port)
+    http.use_ssl = url.port == 443
+    req.oauth!(http, @oauth_consumer, nil, @oauth_options)
+    res = http.request(req)
+    decoded = JSON.parse(res.body)
+    if(decoded.has_key?("error_code"))
+      raise ToopherApiError, "Error code " + decoded['error_code'].to_s + ": " + decoded['error_message']
+    end
+    return decoded
+  end
+end

data/test/test_toopher_api.rb

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'test/unit'
+require 'webmock/test_unit'
+require 'toopher_api'
+
+class TestToopher < Test::Unit::TestCase
+  def test_constructor()
+
+    assert_raise ArgumentError do
+      api = ToopherAPI.new
+    end
+
+    assert_raise ArgumentError do
+      api = ToopherAPI.new('key')
+    end
+
+    assert_raise ArgumentError do
+      api = ToopherAPI.new('', 'secret')
+    end
+
+    assert_nothing_raised do
+      api = ToopherAPI.new('key', 'secret')
+    end
+
+  end
+
+  def test_create_pairing_immediate_success()
+    stub_http_request(:post, "https://toopher-api.appspot.com/v1/pairings/create").
+      with(
+#        :headers => {
+#          'Authorization' => 'OAuth oauth_consumer_key="key",oauth_nonce="nonce",oauth_signature="%2FW9rUAFDuJTTBtfSxeQ%2FDxWpVQY%3D",oauth_signature_method="HMAC-SHA1",oauth_timestamp="0",oauth_version="1.0"'
+#          },
+        :body => { 'pairing_phrase' => 'immediate_pair', 'user_name' => 'user' }
+      ).
+      to_return(
+        :body => '{"id":"1","enabled":true,"user":{"id":"1","name":"user"}}',
+        :status => 200
+      )
+
+      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+      pairing = toopher.pair('immediate_pair', 'user')
+      assert(pairing['id'] == '1', 'bad pairing id')
+      assert(pairing['enabled'] == true, 'pairing not enabled')
+      assert(pairing['user_id'] == '1', 'bad user id')
+      assert(pairing['user_name'] == 'user', 'bad user name')
+
+  end
+  def test_get_pairing_status()
+    stub_http_request(:get, "https://toopher-api.appspot.com/v1/pairings/1").
+      to_return(
+        :body => '{"id":"1","enabled":true,"user":{"id":"1","name":"paired user"}}',
+        :status => 200
+      )
+    stub_http_request(:get, "https://toopher-api.appspot.com/v1/pairings/2").
+      to_return(
+        :body => '{"id":"2","enabled":false,"user":{"id":"2","name":"unpaired user"}}',
+        :status => 200
+      )
+
+      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+      pairing = toopher.get_pairing_status('1')
+      assert(pairing['id'] == '1', 'bad pairing id')
+      assert(pairing['enabled'] == true, 'pairing not enabled')
+      assert(pairing['user_id'] == '1', 'bad user id')
+      assert(pairing['user_name'] == 'paired user', 'bad user name')
+
+      pairing = toopher.get_pairing_status('2')
+      assert(pairing['id'] == '2', 'bad pairing id')
+      assert(pairing['enabled'] == false, 'pairing should not be enabled')
+      assert(pairing['user_id'] == '2', 'bad user id')
+      assert(pairing['user_name'] == 'unpaired user', 'bad user name')
+  end
+
+  def test_create_authentication_with_no_action()
+    stub_http_request(:post, "https://toopher-api.appspot.com/v1/authentication_requests/initiate").
+      with(
+        :body => { 'pairing_id' => '1', 'terminal_name' => 'term name' }
+      ).
+      to_return(
+        :body => '{"id":"1","pending":false,"granted":true,"automated":true,"reason":"some reason","terminal":{"id":"1","name":"term name"}}',
+        :status => 200
+      )
+
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+    auth = toopher.authenticate('1', 'term name')
+    assert(auth['id'] == '1', 'wrong auth id')
+    assert(auth['pending'] == false, 'wrong auth pending')
+    assert(auth['granted'] == true, 'wrong auth granted')
+    assert(auth['automated'] == true, 'wrong auth automated')
+    assert(auth['reason'] == 'some reason', 'wrong auth reason')
+    assert(auth['terminal_id'] == '1', 'wrong auth terminal id')
+    assert(auth['terminal_name'] == 'term name', 'wrong auth terminal name')
+  end
+
+  def test_get_authentication_status()
+    stub_http_request(:get, "https://toopher-api.appspot.com/v1/authentication_requests/1").
+      to_return(
+        :body => '{"id":"1","pending":false,"granted":true,"automated":true,"reason":"some reason","terminal":{"id":"1","name":"term name"}}',
+        :status => 200
+      )
+    stub_http_request(:get, "https://toopher-api.appspot.com/v1/authentication_requests/2").
+      to_return(
+        :body => '{"id":"2","pending":true,"granted":false,"automated":false,"reason":"some other reason","terminal":{"id":"2","name":"another term name"}}',
+        :status => 200
+      )
+
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+    auth = toopher.get_authentication_status('1')
+    assert(auth['id'] == '1', 'wrong auth id')
+    assert(auth['pending'] == false, 'wrong auth pending')
+    assert(auth['granted'] == true, 'wrong auth granted')
+    assert(auth['automated'] == true, 'wrong auth automated')
+    assert(auth['reason'] == 'some reason', 'wrong auth reason')
+    assert(auth['terminal_id'] == '1', 'wrong auth terminal id')
+    assert(auth['terminal_name'] == 'term name', 'wrong auth terminal name')
+
+    auth = toopher.get_authentication_status('2')
+    assert(auth['id'] == '2', 'wrong auth id')
+    assert(auth['pending'] == true, 'wrong auth pending')
+    assert(auth['granted'] == false, 'wrong auth granted')
+    assert(auth['automated'] == false, 'wrong auth automated')
+    assert(auth['reason'] == 'some other reason', 'wrong auth reason')
+    assert(auth['terminal_id'] == '2', 'wrong auth terminal id')
+    assert(auth['terminal_name'] == 'another term name', 'wrong auth terminal name')
+  end
+
+  def test_toopher_request_error()
+    stub_http_request(:get, "https://toopher-api.appspot.com/v1/authentication_requests/1").
+      to_return(
+        :body => '{"error_code":401,"error_message":"Not a valid OAuth signed request"}',
+        :status => 401
+      )
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+    assert_raise ToopherApiError do
+      auth = toopher.get_authentication_status('1')
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: toopher_api
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Toopher, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 4
+        - 7
+        version: 0.4.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 7
+        - 5
+        version: 1.7.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 1
+        - 9
+        - 0
+        version: 1.9.0
+  type: :development
+  version_requirements: *id003
+description: Synchronous interface to the toopher.com authentication api.
+email: support@toopher.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/toopher_api.rb
+- test/test_toopher_api.rb
+- demo/toopher_demo.rb
+homepage: http://toopher.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Interface to the toopher.com authentication api
+test_files: []
+