kdonovan-trufina 0.1.2 → 0.2.0

data/README.rdoc

@@ -132,6 +132,11 @@ which is exactly the format Trufina requires to indicate we want to receive the
   * (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
+
+This is compatible with the latest Trufina API version as of the creation date: Trufina API 1.0.4
+
+
 == Compatibility
 
 The goal of this module is to be relatively framework agnostic.  That being said, I've personally only tried to use it

data/TODO

@@ -1,8 +1,5 @@
 PENDING:
   * Schema validation against the provided .xsd fails
-  * Unable to set ResidenceAddress in seed data (e.g. Trufina.login_request(4, :seed => {:residence_address => {:state => 'CA'}}))
-    Yields error: Attribute 'timeframe' must appear on element 'ResidenceAddress' (noted in README)
 
 UNSUPPORTED:
-  * Setting StreetAddress seed data is unsupported (will generate extra <.> tags, and it is unclear how to set multiple lines)
   * Comparison or other request attributes (note that maxAge and timeframe are not even supported by Trufina yet)

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/elements.rb

@@ -7,53 +7,61 @@ class Trufina
   module AllowCreationFromHash
     
     def initialize(seed_data = {})
-      seed_data.is_a?(Array) ? create_empty_nodes(seed_data) : create_nodes(seed_data)
-    end
+      create_nodes(seed_data)
 
-    protected
-    
-    # e.g. Trufina::Name.new([:first, :suffix]) - no values provided, print empty nodes
-    #
-    #     <Name>
-    #       <First/>
-    #       <Suffix/>
-    #     </Name>
-    def create_empty_nodes(nodes)
-      nodes.each do |node|
-        create_node(node)
+      # Define attributes
+      self.class.attributes.each do |attr|
+        self.send("#{attr.method_name}=", nil) unless self.send(attr.method_name)
+      end
+      
+      # Define elements
+      self.class.attributes.each do |elem|
+        self.send("#{elem.method_name}=", nil) unless self.send(elem.method_name)
       end
     end
 
-    # e.g. Trufina::Name.new({:first => 'Bob', :suffix => 'III'}) - print nodes with values
-    # 
-    #     <Name>
-    #       <First>Bob</First>
-    #       <Suffix>III</Suffix>
-    #     </Name>
-    def create_nodes(nodes)
-      nodes.each do |node, content|
-        create_node(node, content)
+    protected
+    
+    def create_nodes(data)
+      data.each do |key, value|
+        create_node(key, value)
       end
     end
     
     # Handle the actual node creation
     def create_node(name, content = nil)
+      return create_nodes(name) if content.nil? && name.is_a?(Hash) # Handle accidentally passing in a full hash
+      
+      element   = self.class.elements.detect{|e| e.method_name.to_sym == name}
+      raise Exceptions::InvalidElement.new("No known element named '#{name}'") unless element || self.respond_to?("#{name}=")
+      
       case name
-      when Array then create_empty_nodes(name)
       when Hash then create_nodes(name)
+      when Array  then create_empty_nodes(name)
       else
-        element   = self.class.elements.detect{|e| e.method_name.to_sym == name}
-        raise Exceptions::InvalidElement.new("No known element named '#{name}'") unless element
-
-        value = if HappyMapper::Item::Types.include?(element.type)
-          content ? content : ''
-        else 
-          content ? element.type.new(content) : element.type.new
+        value = if content.nil?
+          make_object?(element) ? element.type.new : ''
+        elsif content.is_a?(Array) && (element && !element.options[:single])
+          # If elements expects multiple instances, instantiate them all (e.g. StreetAddresses)
+          # Note that this assumes the object (only known case is Trufina::Elements::StreetAddress) has a :name element
+          out = content.collect do |local_content|
+            make_object?(element) ? element.type.new(:name => local_content) : local_content
+          end
+        else
+          make_object?(element) ? element.type.new(content) : content
         end
+        
         self.send("#{name}=", value)
       end
     end
     
+    # Returns false if the given content is a simple type like a string, and we should just assign it.
+    # Returns true if the given content is another HappyMapper class, and we should instantiate the class 
+    # rather than merely assigning the value.
+    def make_object?(element)
+      element && !HappyMapper::Item::Types.include?(element.type)
+    end
+    
   end
 
   module Elements
@@ -93,29 +101,39 @@ class Trufina
       element :suffix,  String, :tag => 'Suffix',               :attributes => RESPONSE_XML_ATTRIBUTES
     end
     
-    # Wrapper attempting to allow access to multiple StreetAddress tags per single ResidenceAddress
-    class StreetAddress
+    # Encapsulates Trufina's address fields - has multiple street address fields
+    class ResidenceAddressResponse
       include AllowCreationFromHash
       include HappyMapper
       include EasyElementAccess
-      tag 'StreetAddress'
-      
-      element :name, String, :tag => '.', :attributes => RESPONSE_XML_ATTRIBUTES
-    end
+      tag 'ResidenceAddress'
+
+      has_many :street_addresses, String,         :tag => 'StreetAddress',  :attributes => RESPONSE_XML_ATTRIBUTES
+      element :city,              String,         :tag => 'City',           :attributes => RESPONSE_XML_ATTRIBUTES
+      element :state,             String,         :tag => 'State',          :attributes => RESPONSE_XML_ATTRIBUTES
+      element :zip,               String,         :tag => 'PostalCode',     :attributes => RESPONSE_XML_ATTRIBUTES
+      attribute :timeframe,       String
 
-    # Encapsulates Trufina's address fields
-    class ResidenceAddress
+      def street_address=(adr)
+        self.street_addresses ||= []
+        self.street_addresses << adr
+      end
+    end
+    
+    # Encapsulates Trufina's address fields - only one street address field
+    class ResidenceAddressRequest
       include AllowCreationFromHash
       include HappyMapper
       include EasyElementAccess
       tag 'ResidenceAddress'
 
-      has_many :street_addresses, StreetAddress,  :tag => 'StreetAddress',  :attributes => RESPONSE_XML_ATTRIBUTES
+      element :street_address,    String,         :tag => 'StreetAddress',  :attributes => RESPONSE_XML_ATTRIBUTES
       element :city,              String,         :tag => 'City',           :attributes => RESPONSE_XML_ATTRIBUTES
       element :state,             String,         :tag => 'State',          :attributes => RESPONSE_XML_ATTRIBUTES
-      element :postal_code,       String,         :tag => 'PostalCode',     :attributes => RESPONSE_XML_ATTRIBUTES
+      element :zip,               String,         :tag => 'PostalCode',     :attributes => RESPONSE_XML_ATTRIBUTES
     end
 
+
     # Encapsulates all response data Trufina may send back
     class AccessResponseGroup
       include AllowCreationFromHash
@@ -123,11 +141,11 @@ class Trufina
       include EasyElementAccess
       tag 'AccessResponse'
   
-      element :name,              Name,     :single => true,          :attributes => RESPONSE_XML_ATTRIBUTES
+      element :name,              Name,     :single => true
       # 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 :residence_address, ResidenceAddress, :single => true,  :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
@@ -143,7 +161,7 @@ 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 :residence_address, ResidenceAddress, :single => true   # If Trufina implemented it, could have timeframe and maxAge attributes
+      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}
@@ -156,15 +174,14 @@ class Trufina
       tag 'SeedInfo'
       
       element :name,              Name,     :single => true
-      element :email,             String,   :single => true
       element :birth_date,        Date,     :tag => 'DateOfBirth'
       element :birth_country,     String,   :tag => 'CountryOfBirth'
       element :phone,             String,   :tag => 'Phone'
-      element :residence_address, ResidenceAddress, :single => true
+      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
-end
+end

data/lib/requests.rb

@@ -126,6 +126,13 @@ class Trufina
     
       element :data,  Elements::AccessRequest, :single => true
       element :seed,  Elements::SeedInfoGroup, :single => true
+      
+      def initialize *args
+        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'
+      end
     end
   
   end

data/lib/trufina.rb

@@ -20,8 +20,7 @@ class 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, :last]}
-      opts[:seed]
-      xml = Requests::LoginRequest.new(:prt => prt, :data => opts[:requested], :seed => opts[:seed]).render
+      xml = Requests::LoginRequest.new(:prt => prt, :data => opts[:requested], :seed => remove_empties_from_hash(opts[:seed] || [])).render
       sendToTrufina(xml)
     end
 
@@ -137,5 +136,16 @@ class Trufina
       "http://#{domain}#{path}"
     end
     
+    # Removes any hash keys with empty values - seed data can't have any blanks, or Trufina gets mad
+    def remove_empties_from_hash(old_hash)
+      new_hash = {}
+      old_hash.each do |key, value|
+        next if value.nil? || value == '' || value == [] || value == {}
+        new_hash[key] = value.is_a?(Hash) ? remove_empties_from_hash(value) : value
+      end
+      
+      return new_hash
+    end
+    
   end
 end

data/trufina.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{trufina}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kali Donovan"]
-  s.date = %q{2009-09-03}
+  s.date = %q{2009-09-04}
   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.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kali Donovan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-03 00:00:00 -07:00
+date: 2009-09-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,6 +63,7 @@ files:
 - trufina.yml.template
 has_rdoc: false
 homepage: http://github.com/kdonovan/trufina
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -83,7 +84,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