trulioo 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a255bcac10cd99492b2f008bd7b182435b29376b
-  data.tar.gz: '08c61063bc7a9c77391cf2076602b1ffe737a5b0'
+  metadata.gz: 191257b3e8b433aa2199e63afeb709d4eee059bd
+  data.tar.gz: b614d15602b4bae2a18e6fff86b3deef208d3068
 SHA512:
-  metadata.gz: 4678a9116c8e69966ea9f5560fe265c914492b6d994593b17c7e90378a6342612e058940c35c5eaeaf4c6d9002746f5a1e4ab0fa2892d3493f68d63fe718978e
-  data.tar.gz: dafc67619a0e3544a3be2c0d7998a7d1616740896f62d8b65bb744a04924e257547bafdb24aae8533b283591fbbdd638c17fa00064410ecbc4de9631452721da
+  metadata.gz: d72e2038291a957836ca323a1a570a93f72b26ecf10974b2383f8c993dce42b315802ad05e418e8d8a9fcb34dba60ab7072d654695ffce84b8057abd0704ac0a
+  data.tar.gz: 9421437ebc7bea4e39bc3233a1c7a160d0efbfe0c4330ae5b6d88f6ab7f2f2cce4cd92fee85333886e539a1026f0645999e60d8ce7e676c83b1c4f002d22ca63

data/README.md

@@ -97,6 +97,17 @@ the key `AcceptTruliooTermsAndConditions` as it is already included.
 client.verifications.verify({ CountryCode: 'US', ... })
 ```
 
+#### Result
+
+These two endpoints return a `Trulioo::API::Verifications::Result` instance.
+This makes it easy to navigate through the response. For example, use the
+following to get the TransactionRecordID:
+
+```ruby
+result = client.verifications.verify({ ... })
+result.transaction_record.id
+```
+
 ### Configuration
 
 Information regarding how your account is configured.

data/lib/trulioo/api.rb

@@ -4,6 +4,9 @@ require 'trulioo/api/base'
 require 'trulioo/api/configuration'
 require 'trulioo/api/connection'
 require 'trulioo/api/verifications'
+require 'trulioo/api/verifications/datasource'
+require 'trulioo/api/verifications/transaction_record'
+require 'trulioo/api/verifications/result'
 
 module Trulioo
   # Trulioo::API is where the endpoints will be handled.

data/lib/trulioo/api/verifications.rb

@@ -5,14 +5,34 @@ module Trulioo
     # Trulioo::Verifications manages the "Verifications" API endpoints. This
     # accesses the Normalized API.
     class Verifications < Trulioo::API::Base
+      class << self
+        def format_value(value)
+          if /true/i.match value
+            true
+          elsif /false/i.match value
+            false
+          else
+            value
+          end
+        end
+
+        def parse_fields(fields, value_field)
+          return [] unless fields
+          fields.each_with_object({}) do |field, h|
+            key = field['FieldName'].gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+            h[key] = format_value(field[value_field])
+          end
+        end
+      end
+
       def transaction_record(transaction_id, option = nil)
         action = "transactionrecord/#{transaction_id}"
-        action += "/#{option}" if option.try(:to_sym).in?(options)
-        get(action, auth: true)
+        action += "/#{option}" if option && option.to_sym.in?(options)
+        Result.new(get(action, auth: true))
       end
 
       def verify(data)
-        post('verify', auth: true, body: data)
+        Result.new(post('verify', auth: true, body: data))
       end
 
       private

data/lib/trulioo/api/verifications/datasource.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    class Verifications
+      # Trulioo::API:Verifications:Datasource is the result of an individual
+      # datasource.
+      class Datasource
+        attr_reader :appended_fields,
+                    :datasource_fields,
+                    :errors,
+                    :field_groups,
+                    :name
+
+        def initialize(datasource)
+          @name = datasource['DatasourceName']
+          @datasource_fields = Verifications.parse_fields(
+            datasource['DatasourceFields'],
+            'Status'
+          )
+          @appended_fields = Verifications.parse_fields(
+            datasource['AppendedFields'],
+            'Data'
+          )
+          @errors = datasource['Errors']
+          @field_groups = datasource['FieldGroups']
+        end
+      end
+    end
+  end
+end

data/lib/trulioo/api/verifications/result.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    class Verifications
+      # Trulioo::API:Verifications:Result is a wrapper for the verifications
+      # endpoints' response.
+      class Result
+        attr_reader :code,
+                    :errors,
+                    :input_fields,
+                    :response,
+                    :transaction_id,
+                    :transaction_record,
+                    :uploaded_at
+
+        def initialize(response)
+          @code = response.code
+          @response = response
+          parse_response(response.parsed_response) if code == 200
+        end
+
+        private
+
+        def parse_response(r)
+          @transaction_id = r['TransactionID']
+          @uploaded_at = Time.parse(r['UploadedDt'])
+          @input_fields = Verifications.parse_fields(r['InputFields'], 'Value')
+          @errors = r['Errors']
+          @transaction_record = TransactionRecord.new(r['Record'])
+        end
+      end
+    end
+  end
+end

data/lib/trulioo/api/verifications/transaction_record.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    class Verifications
+      # Trulioo::API:Verifications:TransactionRecord holds the information of
+      # the transaction record.
+      class TransactionRecord
+        attr_reader :datasources, :errors, :id, :rule, :status
+
+        def initialize(record)
+          @id = record['TransactionRecordID']
+          @datasources = parse_datasources(record['DatasourceResults'])
+          @status = record['RecordStatus']
+          @errors = record['Errors']
+          @rule = { record['Rule']['RuleName'] => record['Rule']['Note'] }
+        end
+
+        private
+
+        def parse_datasources(results)
+          results.each_with_object([]) { |ds, ary| ary << Datasource.new(ds) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trulioo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Dave Nguyen
@@ -14,16 +14,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.15'
 description: 
 email: d@fundamerica.com
 executables: []
@@ -38,6 +38,9 @@ files:
 - lib/trulioo/api/configuration.rb
 - lib/trulioo/api/connection.rb
 - lib/trulioo/api/verifications.rb
+- lib/trulioo/api/verifications/datasource.rb
+- lib/trulioo/api/verifications/result.rb
+- lib/trulioo/api/verifications/transaction_record.rb
 - lib/trulioo/client.rb
 - lib/trulioo/connector.rb
 - lib/trulioo/settings.rb