alloy-kyc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d51359802cec9afbf0b07fe5cbd6aaf1fa37c203
+  data.tar.gz: 974ecb72d83b5d9d3355848beb1dcf768bf00b50
+SHA512:
+  metadata.gz: 764eae0db923c1d8fc5f119dac777284d6632cb9a796091e5397f3d6337cbdf5dcef2ac256f42f8c1c5c5ed5d0cb312d361568a66c9eade713ccd4f82e5e907a
+  data.tar.gz: 2d4c71319a76f7507bd3846efc82681fc817d184e9404b31b8173d6a98606d019db4a332c5cfae78ebee683959b4ac14b32685d7da364da7680f061426ccf962

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+* March 10, 2017 - 0.1.0
+Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alloy-kyc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Doug Ramsay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alloy-kyc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alloy-kyc
+
+## Usage
+
+Configure the gem using your issued Alloy credentials in an initializer file. For example, in config/initializers/alloy-kyc.rb:
+
+```ruby
+Alloy::KYC.configure do |config|
+  config.application_token = ENV['ALLOY_APPLICATION_TOKEN']
+  config.application_secret = ENV['ALLOY_APPLICATION_SECRET']
+end
+```
+
+Create a new evaluation:
+
+```ruby
+Alloy::KYC::Evaluation.create({
+    phone_number: "18042562188",
+    name_first: "Thomas",
+    name_last: "Nicholas",
+    email_address: "tommy@alloy.co",
+    birth_date: "1985-01-23",
+    address_line_1: "1717 E Test St",
+    address_city: "Richmond",
+    address_state: "VA",
+    document_ssn: "123456789",
+    address_postal_code: "23220",
+    address_country_code: "US",
+    social_twitter: "tommyrva"
+  })
+```
+
+If evaluation requires further information around out-of-wallet questions:
+
+```ruby
+evaluation = Alloy::KYC::Evaluation.create({phone_number: "18042562188", name_first: "Thomas",...})
+if evaluation.requires_oow?
+  # collect answers and either match locally or resubmit
+  updated_evaluation = evaluation.submit_oow_responses(responses)
+end
+```
+
+## Testing
+
+To prevent this gem from making API calls when your tests are running, use mock mode:
+
+```ruby
+Alloy::KYC.mock_mode!
+```
+
+When in mock mode methods will return "successful" results; i.e., a call to `Alloy::KYC::Evaluation.create` will return an `Evaluation` that doesn't require an out of wallet followup. To simulate a failure, call `Alloy::KYC::Evaluation.create` with a `document_ssn` of `111223333`:
+
+```ruby
+Alloy::KYC::Evaluation.create(document_ssn: "111223333", ...) # any other parameters are ignored
+```
+
+Similarly, you can simulate an out-of-wallet response that requires more responses by passing that same `document_ssn` to `submit_oow_responses`:
+
+```ruby
+# given an existing Evaluation e:
+e.submit_oow_responses({document_ssn: "111223333", ...}) # any other parameters are ignored
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/qedinvestors/alloy-kyc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alloy-kyc.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alloy/kyc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alloy-kyc"
+  spec.version       = Alloy::KYC::VERSION
+  spec.authors       = ["Doug Ramsay"]
+  spec.email         = ["doug@qedinvestors.com"]
+
+  spec.summary       = %q{Gem to wrap the Alloy.co API}
+  spec.description   = %q{Gem to wrap the Alloy.co API}
+  spec.homepage      = "https://github.com/qedinvestors/alloy-kyc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alloy/kyc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data/fake_create_evaluations_response_requires_oow.json

@@ -0,0 +1 @@
+{"evaluation_token":"S-1y1hBJt8qpXmjzzNmsIQ","error":null,"timestamp":1488488005916,"entity_token":"P-Jdr5V9jbZap5adZ0vIzO","application_token":"dpDD6z4olOSI7N4fMCsAlKjFa7reBYhu","application_version_id":11,"required":[{"key":"name_first","type":"string","description":"First name","regex":"^[^d]*$"},{"key":"name_last","type":"string","description":"Last name","regex":"^[^d]*$"},{"key":"address_line_1","type":"string","description":"Address field 1","regex":""},{"key":"address_city","type":"string","description":"Address city","regex":""},{"key":"address_state","type":"string","description":"US state","regex":""},{"key":"address_postal_code","type":"string","description":"Address postal code","regex":""},{"key":"birth_date","type":"date","description":"Birth date - valid ISO 8601 format","regex":""}],"optional":[{"key":"name_middle","type":"string","description":"Middle name","regex":"^[^d]*$"},{"key":"name_suffix","type":"string","description":"Name suffix","regex":"^[^d]*$"},{"key":"address_line_2","type":"string","description":"Address field 2","regex":""},{"key":"ip_address_v4","type":"string","description":null},{"key":"gender","type":"string","description":"Gender of evaluation target."},{"key":"email_address","type":"string","description":"Primary email address"},{"key":"document_ssn","type":"string","description":"US social security number"},{"key":"document_ssn_last4","type":"string","description":"Last four digits of a US social security number"}],"prompts":{},"or":{"required":[{"key":"document_ssn","type":"string","description":"US social security number"},{"key":"document_ssn_last4","type":"string","description":"Last four digits of a US social security number"}]}}

data/data/fake_create_evaluations_response_success.json

@@ -0,0 +1 @@
+{"status_code":201,"error":null,"timestamp":1488486910882,"evaluation_token":"S-povLiQYnBFQLGGs9bs2C","entity_token":"P-iBuYneyLEpBPAdE2qokA","application_token":"dpDD6z4olOSI7N4fMCsAlKjFa7reBYhu","application_version_id":11,"summary":{"result":"success","score":1,"tags":[],"outcome":null,"services":{"Lexis Nexis Instant ID":"executed"}},"supplied":{"address_city":"Richmond","address_country_code":"US","address_line_1":"1717 E Test St","address_postal_code":"23220","address_state":"VA","birth_date":"1985-01-23","document_ssn":"123456789","email_address":"tommy@alloy.co","name_first":"Thomas","name_last":"Nicholas","phone_number":"18042562188","social_twitter":"tommyrva"},"formatted":{"address_city":"Richmond","address_country_code":"US","address_line_1":"1717 E Test St","address_postal_code":"23220","address_state":"VA","birth_date":"1985-01-23","document_ssn":"123456789","email_address":"tommy@alloy.co","name_first":"Thomas","name_last":"Nicholas","phone_number":"+18042562188","social_twitter":"tommyrva"},"matching":{"name":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"address":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"ssn":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"dob":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"phone":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]}},"diligence":{"watchlists":{"lists":["BES","CFTC","DTC","EUDT","FBI","FCEN","FAR","IMW","OFAC","OCC","OSFI","PEP","SDT","UNNT","BIS","WBIF"],"matches":[]},"fraud":null,"financial":null,"identity_questions":null},"related_data":{},"raw_responses":{"Lexis Nexis Instant ID":[{"response":{"Header":{"Status":0,"TransactionId":"0"},"Result":{"InputEcho":{"SSN":"123456789","SSNLast4":"6789","IPAddress":"192.168.0.1","Name":{"Last":"Nicholas","First":"Thomas"},"Address":{"StreetAddress1":"1717 E Test St","StreetAddress2":"APT 2L","City":"Richmond","State":"VA","Zip5":"23220"},"DOB":{"Year":1985,"Month":1,"Day":23},"Channel":null,"Passport":{"Number":"","Country":"","ExpirationDate":null,"MachineReadableLine1":"","MachineReadableLine2":""},"HomePhone":"+18042562188","OwnOrRent":null,"ApplicationDateTime":{"Day":2,"Year":2017,"Month":3,"Hour24":20,"Minute":35,"Second":10}},"UniqueId":"1567805191","NameAddressSSNSummary":12,"AdditionalScore1":0,"AdditionalScore2":0,"PhoneOfNameAddress":8043563199,"SSNInfo":{"Valid":"G","IssuedEndDate":{"Year":"1979","Month":"12"},"IssuedLocation":"VIRGINIA","IssuedStartDate":{"Year":"1977","Month":"01"}},"CurrentName":{"Last":"NICHOLAS","First":"THOMAS"},"ReversePhone":{"Name":{"Last":"NICHOLAS","First":"THOMAS"},"Address":{"City":"RICHMOND","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"300","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE APT 1","UnitDesignation":"APT"}},"VerifiedInput":{"DOB":{"Day":"XX","Year":"1986","Month":"04"},"SSN":"61252xxxx","Name":{"Last":"NICHOLAS","First":"THOMAS"},"Address":{"City":"RICHMOND","Zip4":"2186","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"3000","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE","UnitDesignation":"APT"},"HomePhone":"8043563199"},"ComprehensiveVerification":{"ComprehensiveVerificationIndex":50,"PotentialFollowupActions":{"FollowupAction":[{"RiskCode":"B","Description":"Verify name with Social (via SSN card, DL if applicable, paycheck stub, or other Government Issued ID)"},{"RiskCode":"C","Description":"Verify name with Address (via DL, utility bill, Directory Assistance, paycheck stub, or other Government Issued ID)"}]},"RiskIndicators":{"RiskIndicator":[{"RiskCode":"PA","Sequence":1,"Description":"Potential address discrepancy - the Input address may be previous address"},{"RiskCode":"SD","Sequence":2,"Description":"The input address state is different than LN best address on file"},{"RiskCode":"10","Sequence":3,"Description":"The input phone number is a mobile number"}]}},"NameAddressPhone":{"Summary":12},"AddressPOBox":false,"SSNFoundForLexID":true,"AddressCMRA":false,"DOBMatchLevel":8,"PassportValidated":false,"InstantIDVersion":"1","ChronologyHistories":{"ChronologyHistory":[{"Address":{"City":"RICHMOND","Zip4":"2186","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"300","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE APT 1","UnitDesignation":"APT"},"DateLastSeen":{"Year":"2015","Month":"07"},"DateFirstSeen":{"Year":"2007","Month":"09"},"IsBestAddress":true},{"Phone":"8043563199","Address":{"City":"FORT WASHINGTON","Zip4":"4851","Zip5":"20749","State":"MD","StreetAddress1":"PO BOX 44851"},"DateLastSeen":{"Year":"2013","Month":"07"},"DateFirstSeen":{"Year":"1999","Month":"02"}},{"Phone":"8043563199","Address":{"City":"FREDERICKSBURG","Zip4":"6495","Zip5":"22406","State":"VA","StreetAddress1":"606 ENGLAND POINTE DR"},"DateLastSeen":{"Year":"2013","Month":"07"},"DateFirstSeen":{"Year":"2000","Month":"05"}}]},"DOBVerified":true,"WatchLists":{"WatchList":[]}}}}]},"formatted_responses":{"Lexis Nexis Instant ID":{"matching":{"name":{"score":1,"matched":true},"address":{"score":1,"matched":true},"ssn":{"score":1,"matched":true},"dob":{"score":1,"matched":true},"phone":{"score":1,"matched":true}},"diligence":{"watchlists":{"lists":["BES","CFTC","DTC","EUDT","FBI","FCEN","FAR","IMW","OFAC","OCC","OSFI","PEP","SDT","UNNT","BIS","WBIF"],"matches":[]},"fraud":{"score":null,"flags":null},"financial":{"credit":null,"banking":null},"identity_questions":null},"data":{"identity_theft_risk":1,"risk_codes":["PA","SD","10"],"followup_codes":[],"address":{"po_box":false,"commercial_mail":false},"ssn":{"issuance_start_date":"1977-01-1","issuance_end_date":"1979-12-1","issuance_state":"VIRGINIA"},"reverse_phone":{"name_first":"THOMAS","name_last":"NICHOLAS","address_city":"RICHMOND","address_state":"VA","address_postal_code_last5":"23220"},"reverse_name_address":{"phone_number":8043563199},"verification":{"dob_day":true,"dob_month":true,"dob_year":true,"name_first_last":true,"name_first_address":true,"name_last_address":true,"name_first_phone":true,"name_last_phone":true,"name_first_ssn":true,"name_last_ssn":true,"address_phone":true,"address_ssn":true,"name_first_last_address":true,"name_first_last_phone":true,"name_first_last_ssn":true,"name_first_address_phone":true,"name_last_address_phone":true,"name_first_last_address_phone":true,"name_first_address_ssn":true,"name_last_address_ssn":true,"name_first_last_address_ssn":true}}}},"audit_archive":null}

data/data/fake_fork_response_success.json

@@ -0,0 +1 @@
+{"status_code":201,"error":null,"timestamp":1488557844974,"evaluation_token":"S-ICca9HJX52eqfrAkDvij","entity_token":"P-cIoyTcsO7CFmQFBZJvSw","application_token":"dpDD6z4olOSI7N4fMCsAlKjFa7reBYhu","application_version_id":11,"summary":{"result":"success","score":1,"tags":[],"outcome":null,"services":{"Lexis Nexis Instant ID":"executed"}},"supplied":{"name_last":"Nicholas","birth_date":"1985-01-23","name_first":"Thomas","address_city":"Richmond","document_ssn":"123456789","phone_number":"18042562188","address_state":"VA","email_address":"tommy@alloy.co","address_line_1":"1717 E Test St","social_twitter":"tommyrva","address_postal_code":"23220","address_country_code":"US"},"formatted":{"name_last":"Nicholas","birth_date":"1985-01-23","name_first":"Thomas","address_city":"Richmond","document_ssn":"123456789","phone_number":"+18042562188","address_state":"VA","email_address":"tommy@alloy.co","address_line_1":"1717 E Test St","social_twitter":"tommyrva","address_postal_code":"23220","address_country_code":"US"},"matching":{"name":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"address":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"ssn":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"dob":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]},"phone":{"score":1,"matched":["Lexis Nexis Instant ID"],"unmatched":[]}},"diligence":{"watchlists":{"lists":["BES","CFTC","DTC","EUDT","FBI","FCEN","FAR","IMW","OFAC","OCC","OSFI","PEP","SDT","UNNT","BIS","WBIF"],"matches":[]},"fraud":null,"financial":null,"identity_questions":null},"related_data":{},"raw_responses":{"Lexis Nexis Instant ID":[{"response":{"Header":{"Status":0,"TransactionId":"0"},"Result":{"InputEcho":{"SSN":"123456789","SSNLast4":"6789","IPAddress":"192.168.0.1","Name":{"Last":"Nicholas","First":"Thomas"},"Address":{"StreetAddress1":"1717 E Test St","StreetAddress2":"APT 2L","City":"Richmond","State":"VA","Zip5":"23220"},"DOB":{"Year":1985,"Month":1,"Day":23},"Channel":null,"Passport":{"Number":"","Country":"","ExpirationDate":null,"MachineReadableLine1":"","MachineReadableLine2":""},"HomePhone":"+18042562188","OwnOrRent":null,"ApplicationDateTime":{"Day":3,"Year":2017,"Month":3,"Hour24":16,"Minute":17,"Second":24}},"UniqueId":"1567805191","NameAddressSSNSummary":12,"AdditionalScore1":0,"AdditionalScore2":0,"PhoneOfNameAddress":8043563199,"SSNInfo":{"Valid":"G","IssuedEndDate":{"Year":"1979","Month":"12"},"IssuedLocation":"VIRGINIA","IssuedStartDate":{"Year":"1977","Month":"01"}},"CurrentName":{"Last":"NICHOLAS","First":"THOMAS"},"ReversePhone":{"Name":{"Last":"NICHOLAS","First":"THOMAS"},"Address":{"City":"RICHMOND","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"300","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE APT 1","UnitDesignation":"APT"}},"VerifiedInput":{"DOB":{"Day":"XX","Year":"1986","Month":"04"},"SSN":"61252xxxx","Name":{"Last":"NICHOLAS","First":"THOMAS"},"Address":{"City":"RICHMOND","Zip4":"2186","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"3000","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE","UnitDesignation":"APT"},"HomePhone":"8043563199"},"ComprehensiveVerification":{"ComprehensiveVerificationIndex":50,"PotentialFollowupActions":{"FollowupAction":[{"RiskCode":"B","Description":"Verify name with Social (via SSN card, DL if applicable, paycheck stub, or other Government Issued ID)"},{"RiskCode":"C","Description":"Verify name with Address (via DL, utility bill, Directory Assistance, paycheck stub, or other Government Issued ID)"}]},"RiskIndicators":{"RiskIndicator":[{"RiskCode":"PA","Sequence":1,"Description":"Potential address discrepancy - the Input address may be previous address"},{"RiskCode":"SD","Sequence":2,"Description":"The input address state is different than LN best address on file"},{"RiskCode":"10","Sequence":3,"Description":"The input phone number is a mobile number"}]}},"NameAddressPhone":{"Summary":12},"AddressPOBox":false,"SSNFoundForLexID":true,"AddressCMRA":false,"DOBMatchLevel":8,"PassportValidated":false,"InstantIDVersion":"1","ChronologyHistories":{"ChronologyHistory":[{"Address":{"City":"RICHMOND","Zip4":"2186","Zip5":"23220","State":"VA","StreetName":"STUART","UnitNumber":"1","StreetNumber":"300","StreetSuffix":"AVE","StreetAddress1":"3000 STUART AVE APT 1","UnitDesignation":"APT"},"DateLastSeen":{"Year":"2015","Month":"07"},"DateFirstSeen":{"Year":"2007","Month":"09"},"IsBestAddress":true},{"Phone":"8043563199","Address":{"City":"FORT WASHINGTON","Zip4":"4851","Zip5":"20749","State":"MD","StreetAddress1":"PO BOX 44851"},"DateLastSeen":{"Year":"2013","Month":"07"},"DateFirstSeen":{"Year":"1999","Month":"02"}},{"Phone":"8043563199","Address":{"City":"FREDERICKSBURG","Zip4":"6495","Zip5":"22406","State":"VA","StreetAddress1":"606 ENGLAND POINTE DR"},"DateLastSeen":{"Year":"2013","Month":"07"},"DateFirstSeen":{"Year":"2000","Month":"05"}}]},"DOBVerified":true,"WatchLists":{"WatchList":[]}}}}]},"formatted_responses":{"Lexis Nexis Instant ID":{"matching":{"name":{"score":1,"matched":true},"address":{"score":1,"matched":true},"ssn":{"score":1,"matched":true},"dob":{"score":1,"matched":true},"phone":{"score":1,"matched":true}},"diligence":{"watchlists":{"lists":["BES","CFTC","DTC","EUDT","FBI","FCEN","FAR","IMW","OFAC","OCC","OSFI","PEP","SDT","UNNT","BIS","WBIF"],"matches":[]},"fraud":{"score":null,"flags":null},"financial":{"credit":null,"banking":null},"identity_questions":null},"data":{"identity_theft_risk":1,"risk_codes":["PA","SD","10"],"followup_codes":[],"address":{"po_box":false,"commercial_mail":false},"ssn":{"issuance_start_date":"1977-01-1","issuance_end_date":"1979-12-1","issuance_state":"VIRGINIA"},"reverse_phone":{"name_first":"THOMAS","name_last":"NICHOLAS","address_city":"RICHMOND","address_state":"VA","address_postal_code_last5":"23220"},"reverse_name_address":{"phone_number":8043563199},"verification":{"dob_day":true,"dob_month":true,"dob_year":true,"name_first_last":true,"name_first_address":true,"name_last_address":true,"name_first_phone":true,"name_last_phone":true,"name_first_ssn":true,"name_last_ssn":true,"address_phone":true,"address_ssn":true,"name_first_last_address":true,"name_first_last_phone":true,"name_first_last_ssn":true,"name_first_address_phone":true,"name_last_address_phone":true,"name_first_last_address_phone":true,"name_first_address_ssn":true,"name_last_address_ssn":true,"name_first_last_address_ssn":true}}}},"audit_archive":null}

data/lib/alloy/kyc.rb

@@ -0,0 +1,28 @@
+require "faraday"
+require "json"
+require "base64"
+require "ostruct"
+
+require "alloy/kyc/version"
+require "alloy/kyc/configuration"
+require "alloy/kyc/bearer_token"
+require "alloy/kyc/evaluation"
+require 'alloy/kyc/backends/remote'
+require 'alloy/kyc/backends/mock'
+
+module Alloy
+  module KYC
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def self.mock_mode!
+      self.configuration.backend = Alloy::KYC::Backends::Mock.new
+    end
+  end
+end

data/lib/alloy/kyc/backends/mock.rb

@@ -0,0 +1,90 @@
+module Alloy
+
+  module KYC
+
+    module Backends
+
+      class Mock
+
+        attr_accessor :bearer_token, :database
+
+        def initialize
+          @database = generate_fake_data
+          nil
+        end
+
+        def get_bearer_token
+          @bearer_token = BearerToken.new("access_token", Time.now + (60*60*24*365))
+        end
+
+        def requires_bearer_token?
+          bearer_token.nil? || bearer_token.expired?
+        end
+
+        def create_evaluation(params)
+          if !params[:document_ssn].nil? && params[:document_ssn] == "111223333"
+            wrap_in_struct(database[:create_evaluations][:requires_oow])
+          else
+            wrap_in_struct(database[:create_evaluations][:success])
+          end
+        end
+
+        def submit_oow_responses(path, responses)
+          if responses[:document_ssn] == "111223333"
+            wrap_in_struct(database[:submit_oow_responses][:requires_oow])
+          else
+            wrap_in_struct(database[:submit_oow_responses][:success])
+          end
+        end
+
+        def fork_evaluation(path)
+          wrap_in_struct(database[:fork_evaluation][:success])
+        end
+
+        private
+
+        def wrap_in_struct(hash)
+          json = hash.to_json
+          OpenStruct.new(raw_response: json, body: json)
+        end
+
+        def generate_fake_data
+          {
+            create_evaluations: {
+              success: fake_create_evaluations_response_success,
+              requires_oow: fake_create_evaluations_response_requires_oow
+            },
+            submit_oow_responses: {
+              success: fake_create_evaluations_response_success,
+              requires_oow: fake_create_evaluations_response_requires_oow
+            },
+            fork_evaluation: {
+              success: fake_fork_response_success
+            }
+          }
+        end
+
+        def fake_fork_response_success
+          load_mock_data("fake_fork_response_success.json")
+        end
+
+        def fake_create_evaluations_response_requires_oow
+          load_mock_data("fake_create_evaluations_response_requires_oow.json")
+        end
+
+        def fake_create_evaluations_response_success
+          load_mock_data("fake_create_evaluations_response_success.json")
+        end
+
+        def load_mock_data(filename)
+          # Would use Gem.datadir, but https://github.com/rubygems/rubygems/issues/1673
+          JSON.parse(File.read(Gem.loaded_specs['alloy-kyc'].full_gem_path + "/data/#{filename}"))
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/alloy/kyc/backends/remote.rb

@@ -0,0 +1,61 @@
+module Alloy
+  module KYC
+    module Backends
+      class Remote
+
+        attr_reader :bearer_token
+
+        def conn
+          @conn ||= Faraday.new(url: "#{Alloy::KYC.configuration.api_endpoint}")
+        end
+
+        def get_bearer_token
+          conn.basic_auth(Alloy::KYC.configuration.application_token, Alloy::KYC.configuration.application_secret)
+          response = conn.post("/oauth/bearer")
+          token_info = JSON.parse(response.body)
+          @bearer_token = BearerToken.new(token_info["access_token"], token_info["expires_in"])
+        end
+
+        def requires_bearer_token?
+          bearer_token.nil? || bearer_token.expired?
+        end
+
+        def set_auth_header
+          if requires_bearer_token?
+            conn.authorization("Bearer", get_bearer_token.token)
+          end
+        end
+
+        # domain methods
+        def create_evaluation(params)
+          post("/evaluations", params)
+        end
+
+        def submit_oow_responses(path, responses)
+          patch(path, responses)
+        end
+
+        def fork_evaluation(path)
+          post(path)
+        end
+
+        # http-level methods
+        def get(url, options={})
+          set_auth_header
+          conn.get(url, options)
+        end
+
+        def post(url, params={})
+          set_auth_header
+          conn.post(url, params)
+        end
+
+        def patch(url, params={})
+          set_auth_header
+          conn.patch(url, params)
+        end
+
+      end
+    end
+  end
+end

data/lib/alloy/kyc/bearer_token.rb

@@ -0,0 +1,16 @@
+module Alloy
+  module KYC
+    class BearerToken
+      attr_accessor :token, :expires_at
+
+      def initialize(access_token, expires_in)
+        @token = access_token
+        @expires_at = Time.now + expires_in
+      end
+
+      def expired?
+        Time.now > expires_at
+      end
+    end
+  end
+end

data/lib/alloy/kyc/configuration.rb

@@ -0,0 +1,17 @@
+module Alloy
+  module KYC
+    class Configuration
+      attr_accessor :application_token
+      attr_accessor :application_secret
+      attr_accessor :api_endpoint
+      attr_accessor :backend
+
+      def initialize
+        @application_token = "dpDD6z4olOSI7N4fMCsAlKjFa7reBYhu"
+        @application_secret = "oJm3niQX1Pdy4z675kefEIKBgFn9tQ45"
+        @api_endpoint = "https://sandbox.alloy.co/v1"
+        @backend = Alloy::KYC::Backends::Remote.new
+      end
+    end
+  end
+end

data/lib/alloy/kyc/evaluation.rb

@@ -0,0 +1,47 @@
+module Alloy
+  module KYC
+    class Evaluation < OpenStruct
+
+      def self.create(params)
+        response = Alloy::KYC.configuration.backend.create_evaluation(params)
+        new(JSON.parse(response.body))
+      end
+
+      def initialize(response)
+        super(response)
+        self.raw_response = response
+      end
+
+      def success?
+        summary["result"] == "success" && status_code != 206
+      end
+
+      def partial_success?
+        summary["result"] == "success" && status_code == 206
+      end
+
+      def requires_oow?
+        !!self.required
+      end
+
+      # responses should be in the format:
+      # {answers: [
+      #   {question_id: 1, answer_id: 2},
+      #   {question_id: 2, answer_id: 4},
+      #   ....
+      # ],
+      # name_first: "Charles",
+      # name_last: "Hearn"}
+      def submit_oow_responses(responses)
+        response = Alloy::KYC.configuration.backend.submit_oow_responses("/evaluations/#{self.evaluation_token}", responses)
+        self.class.new(JSON.parse(response.body))
+      end
+
+      def fork
+        response = Alloy::KYC.configuration.backend.fork_evaluation("/evaluations/#{self.evaluation_token}")
+        self.class.new(JSON.parse(response.body))
+      end
+
+    end
+  end
+end

data/lib/alloy/kyc/version.rb

@@ -0,0 +1,5 @@
+module Alloy
+  module KYC
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: alloy-kyc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doug Ramsay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to wrap the Alloy.co API
+email:
+- doug@qedinvestors.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alloy-kyc.gemspec
+- bin/console
+- bin/setup
+- data/fake_create_evaluations_response_requires_oow.json
+- data/fake_create_evaluations_response_success.json
+- data/fake_fork_response_success.json
+- lib/alloy/kyc.rb
+- lib/alloy/kyc/backends/mock.rb
+- lib/alloy/kyc/backends/remote.rb
+- lib/alloy/kyc/bearer_token.rb
+- lib/alloy/kyc/configuration.rb
+- lib/alloy/kyc/evaluation.rb
+- lib/alloy/kyc/version.rb
+homepage: https://github.com/qedinvestors/alloy-kyc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to wrap the Alloy.co API
+test_files: []