toopher_api 1.0.0 → 1.0.1

data/demo/toopher_demo.rb

@@ -27,10 +27,10 @@ user.chomp!
 
 pairing = toopher.pair(phrase, user)
 
-while(!pairing['enabled'])
+while(!pairing.enabled)
   puts 'waiting for authorization...'
   sleep(1)
-  pairing = toopher.get_pairing_status(pairing['id'])
+  pairing = toopher.get_pairing_status(pairing.id)
 end
 
 puts 'paired successfully!'
@@ -45,12 +45,12 @@ while (true)
   action.chomp!
 
   puts 'sending authentication request...'
-  auth = toopher.authenticate(pairing['id'], terminal_name, action)
+  auth = toopher.authenticate(pairing.id, terminal_name, action)
 
   while(auth['pending'])
     puts 'waiting for authentication...'
     sleep(1)
-    auth = toopher.get_authentication_status(auth['id'])
+    auth = toopher.get_authentication_status(auth.id)
   end
 
   puts "Successfully authorized action '" + action + "'.  Enter another action to authorize again, or [Ctrl-C] to exit"

data/lib/toopher_api.rb

@@ -34,6 +34,12 @@ class ToopherAPI
 
   DEFAULT_BASE_URL = 'https://toopher-api.appspot.com/v1/'
 
+  # Creates a Toopher API consumer
+  #
+  # @param [String] key Your Toopher API Key
+  # @param [String] secret Your Toopher API Secret
+  # @param [Hash] options OAuth Options hash.
+  # @param [string] base_url The base URL to use for the Toopher API
   def initialize(key,secret,options={}, base_url = DEFAULT_BASE_URL)
     consumer_key = key
     consumer_secret = secret
@@ -46,15 +52,22 @@ class ToopherAPI
     @oauth_options = options
   end
 
+  # Create the pairing between a particular user and their mobile device
+  #
+  # @param [String] pairing_phrase The pairing phrase (from the user's mobile device).
+  # @param [String] user_name User name
+  #
+  # @return [PairingStatus] Information about the pairing request
   def pair(pairing_phrase, user_name)
-    return make_pair_response(post('pairings/create', {
+    return PairingStatus.new(post('pairings/create', {
       'pairing_phrase' => pairing_phrase,
       'user_name' => user_name
     }))
   end
 
+  # Check on the status of a previous pairing request
   def get_pairing_status(pairing_request_id)
-    return make_pair_response(get('pairings/' + pairing_request_id))
+    return PairingStatus.new(get('pairings/' + pairing_request_id))
   end
 
   def authenticate(pairing_id, terminal_name, action_name = '')
@@ -63,33 +76,14 @@ class ToopherAPI
       'terminal_name' => terminal_name
     }
     action_name.empty? or (parameters['action_name'] = action_name)
-    return make_auth_response(post('authentication_requests/initiate', parameters))
+    return AuthenticationStatus.new(post('authentication_requests/initiate', parameters))
   end
 
   def get_authentication_status(authentication_request_id)
-    return make_auth_response(get('authentication_requests/' + authentication_request_id))
+    return AuthenticationStatus.new(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)
@@ -115,3 +109,37 @@ class ToopherAPI
     return decoded
   end
 end
+
+class PairingStatus
+  attr_accessor :id
+  attr_accessor :enabled
+  attr_accessor :user_id
+  attr_accessor :user_name
+
+  def initialize(json_obj)
+    @id = json_obj['id']
+    @enabled = json_obj['enabled']
+    @user_id = json_obj['user']['id']
+    @user_name = json_obj['user']['name']
+  end
+end
+
+class AuthenticationStatus
+  attr_accessor :id
+  attr_accessor :pending
+  attr_accessor :granted
+  attr_accessor :automated
+  attr_accessor :reason
+  attr_accessor :terminal_id
+  attr_accessor :terminal_name
+
+  def initialize(json_obj)
+    @id = json_obj['id']
+    @pending = json_obj['pending']
+    @granted = json_obj['granted']
+    @automated = json_obj['automated']
+    @reason = json_obj['reason']
+    @terminal_id = json_obj['terminal']['id']
+    @terminal_name = json_obj['terminal']['name']
+  end
+end

data/test/test_toopher_api.rb

@@ -39,10 +39,10 @@ class TestToopher < Test::Unit::TestCase
 
       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')
+      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()
@@ -59,16 +59,16 @@ class TestToopher < Test::Unit::TestCase
 
       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')
+      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')
+      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()
@@ -83,13 +83,13 @@ class TestToopher < Test::Unit::TestCase
 
     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')
+    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()
@@ -106,22 +106,22 @@ class TestToopher < Test::Unit::TestCase
 
     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')
+    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')
+    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()

metadata

@@ -1,115 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: toopher_api
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Toopher, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: oauth
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 4
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.7
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
-        - 5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.7.5
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 1
-        - 9
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.9.0
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 description: Synchronous interface to the toopher.com authentication api.
 email: support@toopher.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-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: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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: []
-