toopher_api 1.0.4 → 1.0.5

data/demo/toopher_demo.rb

@@ -19,7 +19,9 @@ while secret.nil? or secret.empty?
   secret.chomp!
 end
 
-toopher = ToopherAPI.new(key, secret)
+url = ENV['TOOPHER_BASE_URL']
+puts 'using base url = ' + url
+toopher = ToopherAPI.new(key, secret, url)
 
 puts 'STEP 1: Pair device'
 puts 'enter pairing phrase:'
@@ -43,7 +45,7 @@ puts 'STEP 2: Authenticate login'
 puts 'enter terminal name:'
 terminal_name = gets;
 terminal_name.chomp!
-puts 'enter action name, or [ENTER] for none:'
+puts 'enter action name, or press [ENTER] for the default action ("log in"):'
 while (true)
   action = gets;
   action.chomp!
@@ -57,6 +59,8 @@ while (true)
     auth = toopher.get_authentication_status(auth.id)
   end
 
-  puts "Successfully authorized action '" + action + "'.  Enter another action to authorize again, or [Ctrl-C] to exit"
+  automation = auth.automated ? 'automatically ' : ''
+  result = auth.granted ? 'granted' : 'denied'
+  puts 'The request was ' + automation + result + "! Enter another action to authorize again, or [Ctrl-C] to exit"
 end
 

data/lib/toopher_api.rb

@@ -61,11 +61,11 @@ class ToopherAPI
   # @param [String] user_name A human recognizable string which represents the user making the request (usually their username). This is displayed to the user on the mobile app when authenticating.
   #
   # @return [PairingStatus] Information about the pairing request
-  def pair(pairing_phrase, user_name)
+  def pair(pairing_phrase, user_name, options = {})
     return PairingStatus.new(post('pairings/create', {
       'pairing_phrase' => pairing_phrase,
       'user_name' => user_name
-    }))
+    }.merge(options)))
   end
 
   # Check on the status of a previous pairing request
@@ -84,13 +84,13 @@ class ToopherAPI
   # @param [String] action_name Optional action name, defaults to "log in" (displayed to the user)
   #
   # @return [AuthenticationStatus] Information about the authentication request
-  def authenticate(pairing_id, terminal_name, action_name = '')
+  def authenticate(pairing_id, terminal_name = '', action_name = '', options = {})
     parameters = {
       'pairing_id' => pairing_id,
       'terminal_name' => terminal_name
     }
     action_name.empty? or (parameters['action_name'] = action_name)
-    return AuthenticationStatus.new(post('authentication_requests/initiate', parameters))
+    return AuthenticationStatus.new(post('authentication_requests/initiate', parameters.merge(options)))
   end
 
   # Check on the status of a previous authentication request
@@ -146,11 +146,16 @@ class PairingStatus
   #   @return [String] The human recognizable user name associated with the given id.
   attr_accessor :user_name
 
+  # @!attribute raw
+  #   @return [hash] The raw data returned from the Toopher API
+  attr_accessor :raw
+
   def initialize(json_obj)
     @id = json_obj['id']
     @enabled = json_obj['enabled']
     @user_id = json_obj['user']['id']
     @user_name = json_obj['user']['name']
+    @raw = json_obj
   end
 end
 
@@ -185,6 +190,10 @@ class AuthenticationStatus
   #   @return [String] The human recognizable terminal name associated with the given id.
   attr_accessor :terminal_name
 
+  # @!attribute raw
+  #   @return [hash] The raw data returned from the Toopher API
+  attr_accessor :raw
+
   def initialize(json_obj)
     @id = json_obj['id']
     @pending = json_obj['pending']
@@ -193,5 +202,6 @@ class AuthenticationStatus
     @reason = json_obj['reason']
     @terminal_id = json_obj['terminal']['id']
     @terminal_name = json_obj['terminal']['name']
+    @raw = json_obj
   end
 end

data/test/test_toopher_api.rb

@@ -25,7 +25,7 @@ class TestToopher < Test::Unit::TestCase
   end
 
   def test_create_pairing_immediate_success()
-    stub_http_request(:post, "https://toopher-api.appspot.com/v1/pairings/create").
+    stub_http_request(:post, "https://toopher.test/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"'
@@ -37,27 +37,46 @@ class TestToopher < Test::Unit::TestCase
         :status => 200
       )
 
-      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
       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.raw['user']['name'] == 'user', 'could not access raw data')
+  end
+
+  def test_create_pairing_with_optional_arg()
+    stub_http_request(:post, "https://toopher.test/v1/pairings/create").
+      with(
+        :body => { 'pairing_phrase' => 'immediate_pair', 'user_name' => 'user' , 'test_param' => 'foo'}
+      ).
+      to_return(
+        :body => '{"id":"1","enabled":true,"user":{"id":"1","name":"user"}}',
+        :status => 200
+      )
 
+      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
+      pairing = toopher.pair('immediate_pair', 'user', :test_param => 'foo')
+      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").
+    stub_http_request(:get, "https://toopher.test/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").
+    stub_http_request(:get, "https://toopher.test/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' })
+      toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
       pairing = toopher.get_pairing_status('1')
       assert(pairing.id == '1', 'bad pairing id')
       assert(pairing.enabled == true, 'pairing not enabled')
@@ -72,7 +91,7 @@ class TestToopher < Test::Unit::TestCase
   end
 
   def test_create_authentication_with_no_action()
-    stub_http_request(:post, "https://toopher-api.appspot.com/v1/authentication_requests/initiate").
+    stub_http_request(:post, "https://toopher.test/v1/authentication_requests/initiate").
       with(
         :body => { 'pairing_id' => '1', 'terminal_name' => 'term name' }
       ).
@@ -81,7 +100,7 @@ class TestToopher < Test::Unit::TestCase
         :status => 200
       )
 
-    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' })
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
     auth = toopher.authenticate('1', 'term name')
     assert(auth.id == '1', 'wrong auth id')
     assert(auth.pending == false, 'wrong auth pending')
@@ -92,19 +111,40 @@ class TestToopher < Test::Unit::TestCase
     assert(auth.terminal_name == 'term name', 'wrong auth terminal name')
   end
 
+  def test_create_authentication_with_optional_arg()
+    stub_http_request(:post, "https://toopher.test/v1/authentication_requests/initiate").
+      with(
+        :body => { 'pairing_id' => '1', 'terminal_name' => 'term name', 'test_param' => 'foo' }
+      ).
+      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' }, base_url="https://toopher.test/v1/")
+    auth = toopher.authenticate('1', 'term name', '', {'test_param' => 'foo'})
+    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").
+    stub_http_request(:get, "https://toopher.test/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").
+    stub_http_request(:get, "https://toopher.test/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' })
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
     auth = toopher.get_authentication_status('1')
     assert(auth.id == '1', 'wrong auth id')
     assert(auth.pending == false, 'wrong auth pending')
@@ -113,6 +153,7 @@ class TestToopher < Test::Unit::TestCase
     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.raw['terminal']['name'] == 'term name', 'could not access raw data')
 
     auth = toopher.get_authentication_status('2')
     assert(auth.id == '2', 'wrong auth id')
@@ -122,15 +163,16 @@ class TestToopher < Test::Unit::TestCase
     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.raw['terminal']['name'] == 'another term name', 'could not access raw data')
   end
 
   def test_toopher_request_error()
-    stub_http_request(:get, "https://toopher-api.appspot.com/v1/authentication_requests/1").
+    stub_http_request(:get, "https://toopher.test/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' })
+    toopher = ToopherAPI.new('key', 'secret', {:nonce => 'nonce', :timestamp => '0' }, base_url="https://toopher.test/v1/")
     assert_raise ToopherApiError do
       auth = toopher.get_authentication_status('1')
     end

metadata

@@ -1,131 +1,113 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: toopher_api
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 1.0.5
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 4
-  version: 1.0.4
 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: 2013-08-12 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
+        version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 1
-        - 9
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.9.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 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://dev.toopher.com
 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
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Interface to the toopher.com authentication api
 test_files: []
-
+has_rdoc: