kdonovan-trufina 0.1.1 → 0.1.2

data/README.rdoc

@@ -31,7 +31,7 @@ do this by hand, a template file will be created automatically the first time yo
 Trufina will raise a ConfigFileError until you fill out the config file with meaningful data.
 
 
-== Example
+== Examples
 
 Once installation has been completed, using the code itself is really easy -- the most complicated step is understanding
 Trufina[http://www.trufina.com]'s various flows.  We'll walk through an example:
@@ -58,7 +58,7 @@ you'll be redirected to whatever you put as your success endpoint in +trufina.ym
 information about the user Trufina[http://www.trufina.com] has verified.
 
   info = Trufina.login_info_request(870)
-  info.data.present_and_verified # => [{:name=>[{:first=>"TEST_FIRNAME"}, {:surname=>"TEST_SURNAME"}]}] (or whatever names you entered on the staging server)
+  info.data.present_and_verified # => [{:name=>[{:first=>"FIRSTNAME"}, {:last=>"LASTNAME"}]}] (or whatever names you entered on the staging server)
 
 
 That completes the simplest use-case.  Say we decide we want more information about the user, like their middle 
@@ -90,18 +90,40 @@ data used to prepopulate the fields the user will encounter on Trufina.com (see
 for all options).  Prepopulated data will be specified as the value of a :seed key in the options hash of either
 method. Example:
 
-  Trufina.login_request(4, :seed => {:name => {:first => 'Foo', :surname => 'Bar'}})
+  Trufina.login_request(4, :seed => {:name => {:first => 'Foo', :last => 'Bar'}})
 
 === Request Data
 
 A number of the API calls allow you to supply a list of the data you'd like returned about the user in question.
 You may do this as follows:
 
-  Trufina.login_request(4, :requested => [:age, {:name => [:first, :middle, :surname]}])
+  Trufina.login_request(4, :requested => [:age, {:name => [:first, :middle, :last]}])
 
 or
 
-  Trufina.access_request({:pur => 4, :prt => 4}, [:age, {:name => [:first, :middle, :surname]}])
+  Trufina.access_request({:pur => 4, :prt => 4}, [:age, {:name => [:first, :middle, :last]}])
+
+Note that an array item creates an empty node (e.g. <age/>) unless it's a hash, in which case it creates a node named from the hash key containing and recurses into the hash value inside the node.  That is to say,
+
+  :name => [:first, :middle, :last]
+  
+will generate something like:
+
+  <name>
+    <first/>
+    <middle/>
+    <last/>
+  </name>
+  
+which is exactly the format Trufina requires to indicate we want to receive the first and middle names of the specified user.  Note that the gem does some additional work to hide irregularities of the Trufina API from the user (i.e. you), so the above code really renders:
+
+  <Name>
+    <First/>
+    <MiddleName/>
+    <Surname/>
+  </Name>
+
+(meaning you don't have to remember that Trufina randomly uses Surname, and breaks their convention by using MiddleName rather than simply Middle).
 
 
 == Unsupported functionality

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/elements.rb

@@ -89,7 +89,7 @@ class Trufina
       element :first,   String, :tag => 'First',                :attributes => RESPONSE_XML_ATTRIBUTES
       element :middle,  String, :tag => 'MiddleName',           :attributes => RESPONSE_XML_ATTRIBUTES
       element :middle_initial, String, :tag => 'MiddleInitial', :attributes => RESPONSE_XML_ATTRIBUTES
-      element :surname, String, :tag => 'Surname',              :attributes => RESPONSE_XML_ATTRIBUTES
+      element :last,    String, :tag => 'Surname',              :attributes => RESPONSE_XML_ATTRIBUTES
       element :suffix,  String, :tag => 'Suffix',               :attributes => RESPONSE_XML_ATTRIBUTES
     end
     

data/lib/trufina.rb

@@ -13,13 +13,13 @@ class Trufina
     # Examples:
     #
     #   Trufina.login_request(Time.now)
-    #   Trufina.login_request(Time.now, :requested => [:phone], :seed => {:name => {:first => 'Foo', :surname => 'Bar'}})
+    #   Trufina.login_request(Time.now, :requested => [:phone], :seed => {:name => {:first => 'Foo', :last => 'Bar'}})
     #
     # Options:
     #   * requested -- Hash of requested info to be returned once the user is done with Trufina
     #   * seed  -- Hash of seed data used to prefill the user's forms at Trufina's website
     def login_request(prt, opts = {})
-      opts[:requested] ||= {:name => [:first, :surname]}
+      opts[:requested] ||= {:name => [:first, :last]}
       opts[:seed]
       xml = Requests::LoginRequest.new(:prt => prt, :data => opts[:requested], :seed => opts[:seed]).render
       sendToTrufina(xml)

data/trufina.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trufina}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kdonovan-trufina
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Kali Donovan