kdonovan-trufina 0.2.4 → 0.2.5

data/README.rdoc

@@ -125,12 +125,45 @@ which is exactly the format Trufina requires to indicate we want to receive the
 
 (meaning you don't have to remember that Trufina randomly uses Surname, and breaks their convention by using MiddleName rather than simply Middle).
 
+== Rails Integration
+
+Personally, I set up a controller dedicated to handling Trufina's postbacks (Success, Failure, and Cancel) as well as their AccessNotification.  If (as I'd suggest) you use the +current_user+'s ID as your PRT, then when a user wants to sign up with Trufina:
+
+  redirect_url = Trufina.login_url(current_user.id, :requested => REQUESTED_DATA, :seed => SEED_DATA)
+
+
+
+The biggest gotcha is that Trufina only uses the PRT for the login_info_request / login_info_response messages -- after that they use their own identifier (the PUR) to indicate which user a given response refers to, so you'll need to store the PUR provided in the login_info_request somewhere and use that going forward. Your success action will end up looking something like this:
+
+  def success
+    info = Trufina.login_info_request( params[:tlid )
+    user = User.find(info.prt)
+    user.pur = info.pur
+    ...
+  end
+
+
+Also, note that an AccessNotification will be sent immediately upon a new user's registration with Trufina.  You can just ignore any AccessNotification with an unknown PUR value, or it's also possible to use the Trufina.info_request in response to this first AccessNotification and avoid using the login_info_response altogether.
+
+Once you've verified the user, you just need to handle any AccessNotifications you may receive:
+
+  def handle_access_notification
+    tnid = params[:trufina_access_notification][:tnid]
+    info = Trufina.info_request( tnid )
+    user = User.find_by_pur( info.pur )
+
+    # Now take appropriate actions to handle user either revoking or adding 
+    # permissions for you to access certain subsets of their verified data.
+    ...
+  end
+
+
+
 
 == Unsupported functionality
 
 * Does not handle requesting comparisons or other request attributes
   * (Note that Trufina[http://www.trufina.com] itself doesn't support maxAge or timeframe yet)
-* Setting ResidenceAddress seed data isn't yet supported
 
 == API Version
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/elements.rb

@@ -161,10 +161,10 @@ class Trufina
       # element :birth_date,        Date,     :tag => 'DateOfBirth',    :attributes => RESPONSE_XML_ATTRIBUTES
       # element :birth_country,     String,   :tag => 'CountryOfBirth', :attributes => RESPONSE_XML_ATTRIBUTES
       element :phone,             String,   :tag => 'Phone',          :attributes => RESPONSE_XML_ATTRIBUTES
+      element :age,               String,   :tag => 'Age',            :attributes => RESPONSE_XML_ATTRIBUTES
       element :residence_address, ResidenceAddressResponse,           :single => true
       element :ssn,               String,   :tag => 'fullSSN',        :attributes => RESPONSE_XML_ATTRIBUTES
       element :last_4_ssn,        String,   :tag => 'Last4SSN',       :attributes => RESPONSE_XML_ATTRIBUTES
-      element :age,               String,   :tag => 'Age',            :attributes => RESPONSE_XML_ATTRIBUTES
     end
 
     # Encapsulates all data we can request from Trufina
@@ -177,10 +177,10 @@ class Trufina
       element :birth_date,        Date,     :tag => 'DateOfBirth'
       element :birth_country,     String,   :tag => 'CountryOfBirth'
       element :phone,             String,   :tag => 'Phone'           # If Trufina implemented it, could have timeframe and maxAge attributes
+      element :age,               String,   :tag => 'Age',            :attributes => {:comparison => String}
       element :residence_address, ResidenceAddressRequest,            :single => true   # If Trufina implemented it, could have timeframe and maxAge attributes
       element :ssn,               String,   :tag => 'fullSSN'
       element :last_4_ssn,        String,   :tag => 'Last4SSN'
-      element :age,               String,   :tag => 'Age',            :attributes => {:comparison => String}
     end
     
     # Encapsulates all seed data Trufina accepts
@@ -193,10 +193,10 @@ class Trufina
       element :birth_date,        Date,     :tag => 'DateOfBirth'
       element :birth_country,     String,   :tag => 'CountryOfBirth'
       element :phone,             String,   :tag => 'Phone'
+      element :age,               String,   :tag => 'Age'
       element :residence_address, ResidenceAddressResponse,           :single => true
       element :ssn,               String,   :tag => 'fullSSN'
       element :last_4_ssn,        String,   :tag => 'Last4SSN'
-      element :age,               String,   :tag => 'Age'
     end
     
   end

data/lib/requests.rb

@@ -46,8 +46,8 @@ class Trufina
       # We have access to Trufina's XML schema, so we might as well validate against it before we hit their servers
       # http://codeidol.com/other/rubyckbk/XML-and-HTML/Validating-an-XML-Document/
       def validate_against_schema
-        libxml = XML::Document.string( self.to_xml )
-        libxml.validate(Trufina.schema)
+        lxml = XML::Document.string( self.to_xml )
+        lxml.validate(Trufina.schema)
       end
     
     end
@@ -131,9 +131,9 @@ class Trufina
         super(args)
         
         # Trufina is brilliant, and they fail if this isn't in the request (even though they don't actually read the value)
-        seed.residence_address.timeframe = 'current'
+        seed.residence_address.timeframe = 'current' if seed && seed.residence_address
       end
     end
   
   end
-end
+end

data/lib/responses.rb

@@ -10,11 +10,7 @@ class Trufina
     def self.parse(raw_xml)
       xml = LibXML::XML::Parser.string(raw_xml).parse
       
-      if Trufina::Config.debug?
-        puts "Received XML:\n\n"
-        puts xml
-        puts "\n\n"
-      end
+      puts "Received XML:\n\n#{xml}\n\n" if Trufina::Config.debug?
       
       # Try to find an appropriate local happymapper class
       begin

data/lib/trufina.rb

@@ -78,6 +78,11 @@ class Trufina
       sendToTrufina(xml)
     end
 
+    # Retreive Trufina's XSD Schema
+    def schema
+      @@schema ||= XML::Schema.from_string(open("http://www.trufina.com/api/truapi.xsd").read)
+    end
+
 
     protected
 
@@ -89,10 +94,6 @@ class Trufina
       '/WebServices/API/'
     end
 
-    def schema
-      @@schema ||= XML::Schema.from_string(open("http://www.trufina.com/api/truapi.xsd").read)
-    end
-
     # Send the specified XML to Trufina's servers
     def sendToTrufina(xml)
       puts "Sending XML to #{domain}#{endpoint}:\n\n#{xml}\n\n" if Trufina::Config.debug?

data/trufina.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trufina}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]
-  s.date = %q{2009-09-07}
+  s.date = %q{2009-09-17}
   s.description = %q{Provides a DSL to easily interact with the XML API offered by Trufina.com, an identity verification company.}
   s.email = %q{kali.donovan@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kdonovan-trufina
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Kali Donovan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-07 00:00:00 -07:00
+date: 2009-09-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - trufina.yml.template
 has_rdoc: false
 homepage: http://github.com/kdonovan/trufina
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: DSL to easily interact with Trufina's verification API