touchpass 0.0.8.1

data/spec/touchpass_client_spec.rb

@@ -0,0 +1,319 @@
+# Geodica Touchpass
+# (C) Copyright 2009-2012 Geodica, a Carpadium Pty Ltd Venture
+# All rights reserved
+
+require 'spec_helper'
+
+describe "Touchpass Client" do
+
+  # Assume localhost unless TPC_HOST is passed in an ENV variable
+  TPC_HOSTNAME = ENV['TPC_HOST'].nil?   ? "https://localhost:3000" : ENV['TPC_HOST']
+  TPC_DEBUG    = ENV['TPC_DEBUG'].nil?  ? false                    : ENV['TPC_DEBUG']
+
+  # Instatiate a Touchpass client instance that can be used across all specs
+  let(:tpclient)         { Touchpass::Client.new(TPC_HOSTNAME, TPC_DEBUG) }
+  let(:tpclient_default) { Touchpass::Client.new }
+
+  # Check that defaulting of hostname and output output works
+  context "Setup" do
+    it "should have a default value for hostname" do
+      tpclient.hostname.should eql(TPC_HOSTNAME)
+      tpclient.debug.should eql(TPC_DEBUG)
+    end
+    it "should have a populated value for hostname" do
+      tpclient_default.hostname.should eql(Touchpass::Client::DFT_HOSTNAME)
+      tpclient_default.debug.should eql(Touchpass::Client::DFT_DEBUG)
+    end
+  end
+  
+  # Ensure that we can register a new party
+  context "Register Party" do
+    it "should allow a party to register with valid username, email and password" do
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      email     = "#{username}@geodica.com"
+      password  = "#{username}"
+      new_party = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should_not be nil
+      new_party['username'].should == username
+      new_party['email'   ].should == email
+      new_party['state'   ].should == 'created'
+      new_party['api_key' ].should_not be nil  
+    end
+    it "should not allow a party to register with an empty username" do
+      username  = ""
+      email     = "#{username}@geodica.com"
+      password  = "password"
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should be nil
+      new_party['username'].should == ["can't be blank", "is too short (minimum is 4 characters)"]
+      new_party['email'   ].should == ['is invalid']
+      new_party['state'   ].should be nil
+      new_party['api_key' ].should be nil  
+    end    
+    it "should not allow a party to register with an username > 15" do
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)}"
+      username.length.should be >= 15
+      email     = "#{username}@geodica.com"
+      password  = "password"
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should be nil
+      new_party['username'].should == ["is too long (maximum is 15 characters)"]
+      new_party['email'   ].should be nil
+      new_party['state'   ].should be nil
+      new_party['api_key' ].should be nil  
+    end    
+    it "should not allow a party to register with an empty email address" do
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      email     = ""
+      password  = "#{username}"
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should be nil
+      new_party['username'].should be nil
+      new_party['email'   ].should == ['can\'t be blank']
+      new_party['state'   ].should be nil
+      new_party['api_key' ].should be nil  
+    end
+    it "should not allow a party to register with an empty password" do
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      email     = "#{username}@geodica.com"
+      password  = ""
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should be nil
+      new_party['username'].should be nil
+      new_party['email'   ].should be nil
+      new_party['state'   ].should be nil
+      new_party['api_key' ].should be nil  
+    end        
+  end
+  
+  # Check that a new rego provides an API key and that we can use the API key to access info
+  context "Validate api_key for newly registered user" do
+    it "should provide a valid API key that can be used to access the party record" do
+      # create a new party and get that party's api_key
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      email     = "#{username}@geodica.com"
+      password  = "#{username}"
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should_not be nil
+      new_party['username'].should == username
+      new_party['email'   ].should == email
+      new_party['state'   ].should == 'created'
+      new_party['api_key' ].should_not be nil   
+      # Use the api key to access info for that party
+      authenticated_party = tpclient.authenticate_party(:login => username, :password => password)
+      authenticated_party['api_key'].should_not be nil
+      authenticated_party['id'     ].should_not be nil
+      
+      shown_party1 = tpclient.get_party(:id => new_party['id']) # by api_key and id
+      shown_party1['id'].should       == new_party['id']
+      shown_party1['username'].should == new_party['username']
+      shown_party1['email'].should    == new_party['email']
+      shown_party1['state'].should    == new_party['state']
+      shown_party2     = tpclient.get_party(:username => new_party['username']) # by api_key and username
+      shown_party2['id'].should       == new_party['id']
+      shown_party2['username'].should == new_party['username']
+      shown_party2['email'].should    == new_party['email']
+      shown_party2['state'].should    == new_party['state']      
+    end
+  end
+  
+  # Check that party details can be updated
+  context "Make changes to a registered party" do
+    it "should allow changes to be made to a party" do
+      # create a new party and get that party's api_key
+      username  = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      email     = "#{username}@geodica.com"
+      password  = "#{username}"
+      new_party  = tpclient.register_party(:email => email, :username => username, :password => password)
+      new_party['id'      ].should_not be nil
+      new_party['api_key' ].should_not be nil         
+      # Set the party's first_name and last_name
+      updated_party = tpclient.update_party(:username => new_party['username'], :first_name => username, :last_name => 'Hemplworth')
+      updated_party['first_name'].should == username
+      updated_party['last_name'].should  == 'Hemplworth'
+      # Set the party's email address
+      updated_party      = tpclient.update_party(:username => new_party['username'], :email => "#{username}@hemplworth.com")
+      updated_party['email'].should == "#{username}@hemplworth.com"
+    end
+  end
+  
+  # Validate addition of new devices
+  context "Add, get and update a device" do
+    before(:each) do
+      @username   = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      @email      = "#{@username}@geodica.com"
+      @password   = "#{@username}"
+      @new_party  = tpclient.register_party(:email => @email, :username => @username, :password => @password)
+    end
+
+    it "should create a new party first" do
+      @new_party['id'      ].should_not be nil
+      @new_party['api_key' ].should_not be nil
+    end 
+    
+    it "should allow for the addition and retrieval of a new device" do
+      # create a new device for this party
+      udid            = Touchpass::Crypt.encrypt(Touchpass::Crypt.salt) # a random string
+      messaging_value = Touchpass::Crypt.encrypt(Touchpass::Crypt.salt) # another random string
+      new_device = tpclient.register_device(:username        => @new_party['username'],
+                                            :udid            => udid, 
+                                            :name            => "#{@username}'s Device",
+                                            :messaging_type  => 'apn-development', 
+                                            :messaging_value => messaging_value )                                             
+                                             
+      new_device['id'     ].should_not be nil
+      new_device['udid'   ].should == udid     
+      new_device['name'   ].should == "#{@username}'s Device"
+      new_device['pub_key'].should_not be nil
+
+      # retrieve the newly created device
+      retrieved_devices = tpclient.get_devices(:username => @username)      
+      retrieved_devices['devices'].should_not be nil
+      retrieved_devices['devices'].size.should_not be 0
+      retrieved_devices['devices'][0].should_not be nil
+      retrieved_devices['devices'][0]['id'     ].should_not be nil
+      retrieved_devices['devices'][0]['udid'   ].should_not be nil
+      retrieved_devices['devices'][0]['name'   ].should_not be nil
+      retrieved_devices['devices'][0]['pub_key'].should_not be nil
+    
+      # retrieve the new device to be retrieved by id
+      retrieved_device = tpclient.get_device(:username => @username, :id => new_device['id'])
+      retrieved_device.should_not be nil
+      retrieved_device['id'     ].should == new_device['id'     ]
+      retrieved_device['udid'   ].should == new_device['udid'   ]
+      retrieved_device['name'   ].should == new_device['name'   ]
+      retrieved_device['pub_key'].should == new_device['pub_key']      
+    end
+    
+    it "should allow for removal of a device by id" do
+      udid            = Touchpass::Crypt.encrypt(Touchpass::Crypt.salt) # a random string
+      messaging_value = Touchpass::Crypt.encrypt(Touchpass::Crypt.salt) # another random string      
+      
+      new_device = tpclient.register_device(:username        => @new_party['username'], 
+                                            :udid            => udid, 
+                                            :name            => "#{@username}'s Device",
+                                            :messaging_type  => 'apn-development', 
+                                            :messaging_value => messaging_value )
+                                             
+      remove_device = tpclient.remove_device(:username      => @new_party['username'], 
+                                             :id            => new_device['id'] )
+                                               
+      retrieved_devices = tpclient.get_devices(:username => @username)
+      
+      retrieved_devices['devices'].should_not be nil
+      retrieved_devices['devices'].size.should be 0
+      
+      retrieved_device = tpclient.get_device(:username => @username, :id => new_device['id'])
+      retrieved_device['errors'].should_not be nil
+    end
+    
+  end
+
+  # Work with verifications
+  context "Work with verifications" do
+    before(:each) do
+      @vp_client = Touchpass::Client.new(TPC_HOSTNAME, TPC_DEBUG)
+      @rp_client = Touchpass::Client.new(TPC_HOSTNAME, TPC_DEBUG)
+
+      # create a new verifying party
+      @vp_username   = "tp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      @vp_email      = "#{@vp_username}@geodica.com"
+      @vp_password   = "#{@vp_username}"
+      @new_vp        = @vp_client.register_party(:email => @vp_email, :username => @vp_username, :password => @vp_password)
+      
+      # create a new relying party
+      @rp_username   = "rp#{Touchpass::Crypt.encrypt(Touchpass::Crypt.salt)[0..12]}"
+      @rp_email      = "#{@rp_username}@geodica.com"
+      @rp_password   = "#{@rp_username}"
+      @new_rp        = @rp_client.register_party(:email => @rp_email, :username => @rp_username, :password => @rp_password)      
+      
+      # add a device to the VP
+      @new_device = @vp_client.register_device(:username        => @new_vp['username'], 
+                                             :udid            => Touchpass::Crypt.encrypt(Touchpass::Crypt.salt), 
+                                             :name            => "#{@username}'s Device",
+                                             :messaging_type  => 'apn-development', 
+                                             :messaging_value => Touchpass::Crypt.encrypt(Touchpass::Crypt.salt) )                                                       
+    end
+
+    it "should create the new rp and vp to work with" do
+      @new_vp.should_not be nil
+      @new_vp['id'      ].should_not be nil
+      @new_vp['username'].should == @vp_username
+      @new_vp['email'   ].should == @vp_email
+      @new_rp.should_not be nil
+      @new_rp['id'      ].should_not be nil
+      @new_rp['username'].should == @rp_username
+      @new_rp['email'   ].should == @rp_email
+      @new_device.should_not be nil
+      @new_device['id'  ].should_not be nil
+    end
+
+    it "should allow for a relying party to create a simple (non-location) verification" do
+      # create the verification as the rp
+      verification = @rp_client.create_verification(:to_party => @new_vp['username'])
+      
+      verification.should_not be nil
+      verification['crypted_tokens'                ].should_not be nil
+      verification['id'                            ].should_not be nil
+      verification['reference'                     ].should_not be nil
+      verification['requested_at'                  ].should_not be nil
+      verification['responded_at'                  ].should_not be nil
+      verification['from_party']['id'              ].should == @new_rp['id'      ]
+      verification['from_party']['username'        ].should == @new_rp['username']      
+      verification['to_party'  ]['id'              ].should == @new_vp['id'      ]
+      verification['to_party'  ]['username'        ].should == @new_vp['username']      
+      verification['location_verification'         ].should be nil
+      verification['resolution'                    ].should == ""
+      verification['location_verified'             ].should be nil
+      verification['crypted_tokens'                ].size().should be 1
+      verification['crypted_tokens'][0]['device_id'].should be == @new_device['id']
+      verification['crypted_tokens'][0]['value'    ].should_not be nil
+      verification['crypted_salts'                 ].size().should be 0
+      verification['crypted_messages'              ].size().should be 0
+      verification['state'                         ].should == "created"
+      
+      # Get the list of verifications for the vp and make sure that our new one is in it
+      verifications_response = @vp_client.get_verifications(:username => @vp_username) 
+      verifications_response.should_not be nil
+      verifications_response.size.should be > 0
+      verifications_response['total_entries'].should == 1
+      verifications_response['total_pages'  ].should == 1
+      verifications_response['current_page' ].should == 1
+      verifications_response['next_page'    ].should be_nil
+      verifications_response['previous_page'].should be_nil
+      verifications_response['verifications'].size.should == 1
+      
+      # This can be an array of verifications in general but will only be one in this case
+      got_verification = verifications_response['verifications'][0]
+      got_verification.should_not be nil
+
+      # Run through the returned hash and make sure that it is the same as the original verification
+      got_verification.each_key do |key| 
+        got_verification[key].should == verification[key]
+      end
+      
+      # Also check that we can get the specific verification directly
+      got_specific_verification = @vp_client.get_verification(:id => verification['id'])
+      got_specific_verification.should_not be nil
+      
+      got_specific_verification.each_key do |key| 
+        got_specific_verification[key].should == verification[key]
+      end
+      
+      # Validate that we can update it so that it is completed
+      updated_verification = @vp_client.update_verification(:id => verification['id'], :device_id => @new_device['id'])
+
+      updated_verification['state'       ].should == 'verified'
+      updated_verification['responded_at'].should_not be nil
+      
+      # We should *not* be able to canel or reject this verification since it's already been validated
+      cancelled_verification = @vp_client.cancel_verification(:id => verification['id'])
+      
+      cancelled_verification['base'][0].should == "Verification has already been responded"
+      rejected_verification = @vp_client.reject_verification(:id => verification['id'])
+      
+      rejected_verification['base'][0].should == "Verification has already been responded"
+    end
+  end
+
+end

data/touchpass.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "touchpass/version"
+
+Gem::Specification.new do |s|
+  s.name        = "touchpass"
+  s.version     = Touchpass::VERSION
+  s.authors     = ["Geodica"]
+  s.email       = ["info@geodica.com"]
+  s.homepage    = ""
+  s.summary     = %q{Touchpass}
+  s.description = %q{Geodica Touchpass}
+
+  s.rubyforge_project = "touchpass"
+
+  s.files         = `git ls-files | grep -v pkg`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "app"]
+
+  # Gem dependencies
+  s.add_dependency("httparty",      "~> 0.8.0")
+  s.add_dependency("json",          "~> 1.6.5")
+  s.add_dependency("thor",          "~> 0.14.6")
+  s.add_dependency("geocoder",      "~> 1.1.0")
+  s.add_dependency("xml-simple",    "~> 1.1.1")
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: touchpass
+version: !ruby/object:Gem::Version
+  version: 0.0.8.1
+  prerelease: 
+platform: ruby
+authors:
+- Geodica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70262118260300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70262118260300
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70262118259800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70262118259800
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70262118259340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70262118259340
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: &70262118258880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70262118258880
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &70262118258420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70262118258420
+description: Geodica Touchpass
+email:
+- info@geodica.com
+executables:
+- tpcli.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- Rakefile
+- app/controllers/touchpass/verifications_controller.rb
+- bin/tpcli.rb
+- config/routes.rb
+- lib/engine.rb
+- lib/generators/templates/config/initializers/devise.rb
+- lib/generators/templates/config/initializers/touchpass.rb
+- lib/generators/templates/config/locales/devise.en.yml
+- lib/generators/touchpass/install_generator.rb
+- lib/touchpass.rb
+- lib/touchpass/client.rb
+- lib/touchpass/crypt.rb
+- lib/touchpass/device.rb
+- lib/touchpass/key_file_creator.rb
+- lib/touchpass/prp.rb
+- lib/touchpass/verification.rb
+- lib/touchpass/version.rb
+- spec/bounding_box_spec.rb
+- spec/geocode_spec.rb
+- spec/helpers/client_spec_helper.rb
+- spec/helpers/gtp_spec_helper.rb
+- spec/key_file_creator_spec.rb
+- spec/proximity_spec.rb
+- spec/prp_spec.rb
+- spec/resolution_spec.rb
+- spec/spec_helper.rb
+- spec/touchpass_client_spec.rb
+- touchpass.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- app
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: touchpass
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Touchpass
+test_files:
+- spec/bounding_box_spec.rb
+- spec/geocode_spec.rb
+- spec/helpers/client_spec_helper.rb
+- spec/helpers/gtp_spec_helper.rb
+- spec/key_file_creator_spec.rb
+- spec/proximity_spec.rb
+- spec/prp_spec.rb
+- spec/resolution_spec.rb
+- spec/spec_helper.rb
+- spec/touchpass_client_spec.rb
+has_rdoc: