lexis_nexis_instant_authenticate 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b871dd55a1db8c597285f39ab56e409c19bcb314
+  data.tar.gz: 1ee8d0a1a721c95441c78adf1c91b1d7a28390b5
+SHA512:
+  metadata.gz: d773310ab770467337a030369d6aaf54d26cc4e937adbe5251c63ffb96481db585c9de38b29a0c86378b4bc6a2637ee08b59d56352df3f40a273d7c8b88c3a64
+  data.tar.gz: d723ca536e5f4300634a496f1e446e19d4f9f26eb8a927088e256014abfd8c868a8d8295631f64d582b7677f94ab8961b51bb8332075734c6ead146506a03cd6

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,62 @@
+# LexisNexisInstantAuthenticate
+
+Generate & Score Instant Authenicate quizes using Lexis Nexis SOAP API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lexis_nexis_instant_authenticate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lexis_nexis_instant_authenticate
+
+## Usage
+
+###Create a client.
+```ruby
+@client = LexisNexisInstantAuthenticate::Client.new(username: ENV['LEXIS_UN'], password: ENV['LEXIS_PW'], flow: "LEXIS_FLOW", transaction_id: SecureRandom.uuid)
+```
+
+Options:
+ * `username:` Lexis Nexis supplied username. Typically, "#{account_id}/#{username}"
+ * `password:` Lexis Nexis supplied password.
+ * `flow:` Name of workflow.
+ * `transaction_id:` Optional GUID. This must be the same string between quiz creation & quiz scoring requests. If you do not pass one in on quiz creation, `SecureRandom.uuid` will be used and returned with the generated quiz. That same string must be sent when scoring quiz.
+
+###Generate a quiz.
+```ruby
+  response = @client.create_quiz({first_name: "Joe", middle_name: "L", last_name: "Smith", ssn: "123456789", dob: {day: "01", month: "01", year: "1950"}})
+  if response.success?
+    return response
+  else
+    return response.status
+  end
+```
+
+Response will have:
+* `response.questions`
+* `response.id`
+* `response.transaction_id`
+
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RepPro/lexis_nexis_instant_authenticate.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lexis_nexis_instant_authenticate"
+
+# 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

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/lexis_nexis_instant_authenticate.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lexis_nexis_instant_authenticate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lexis_nexis_instant_authenticate"
+  spec.version       = LexisNexisInstantAuthenticate::VERSION
+  spec.authors       = ["Christopher Ostrowski"]
+  spec.email         = ["chris@reppro.co"]
+
+  spec.summary       = %q{Ruby interface for using LexisNexis Instant Authenticate.}
+  spec.homepage      = "https://github.com/reppro/lexis_nexis_instant_authenticate"
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency 'savon', '~> 2.0'
+  spec.add_dependency 'gyoku'
+end

data/lib/lexis_nexis_instant_authenticate/akami_patch.rb

@@ -0,0 +1,27 @@
+#The unholiest of all...
+#This monkey patch exists because LN requires a cleartext password to be sent with digest auth.
+require 'akami'
+if Akami::VERSION == "1.3.1"
+  module Akami
+    class WSSE
+      def wsse_username_token
+        if digest?
+          token = security_hash :wsse, "UsernameToken",
+            "wsse:Username" => username,
+            "wsse:Nonce" => Base64.encode64(nonce).chomp,
+            "wsu:Created" => timestamp,
+            "wsse:Password" => password,
+            :attributes! => { "wsse:Password" => { "Type" => PASSWORD_TEXT_URI },  "wsse:Nonce" => { "EncodingType" => BASE64_URI } }
+          # clear the nonce after each use
+          @nonce = nil
+        else
+          token = security_hash :wsse, "UsernameToken",
+            "wsse:Username" => username,
+            "wsse:Password" => password,
+            :attributes! => { "wsse:Password" => { "Type" => PASSWORD_TEXT_URI } }
+        end
+        token
+      end
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/client.rb

@@ -0,0 +1,80 @@
+require 'savon'
+require_relative './akami_patch'
+require_relative './requests/base'
+require_relative './requests/create_quiz'
+require_relative './requests/score_quiz'
+require_relative './resources/base'
+require_relative './resources/quiz'
+require_relative './resources/score'
+
+module LexisNexisInstantAuthenticate
+  class Client
+    def initialize(options = {})
+      @options = options
+    end
+
+    def savon
+      @savon ||= Savon.client(wsdl: wsdl_location) do |config|
+        config.endpoint endpoint_location
+        config.env_namespace :soapenv
+        config.raise_errors @options[:production]
+        config.log !@options[:production]
+        config.namespace_identifier "ws"
+
+        config.wsse_auth(@options[:username], @options[:password], :digest)
+      end
+    end
+
+    def transaction_id
+      if @options[:transaction_id]
+        @options[:transaction_id]
+      else
+        @options[:transaction_id] = SecureRandom.uuid
+        @options[:transaction_id]
+      end
+    end
+
+    def create_quiz(person = {})
+      response = call_service(Services::CreateQuiz.new(self, person).to_s)
+      Resources::Quiz.new(self, response)
+    end
+
+    def score_quiz(id, responses)
+      response = call_service(Services::ScoreQuiz.new(self, id, responses).to_s)
+      puts response.hash
+      Resources::Score.new(self, response)
+    end
+
+    def flow
+      @options[:flow]
+    end
+
+    private
+    def build_request
+      savon.build_request(:invoke_identity_service)
+    end
+
+    def call_service(request_body, locals = {})
+      request = build_request
+      request.body = request_body
+      response = Savon::Response.new(HTTPI.post(request), savon.globals, locals)
+      response
+    end
+
+    def wsdl_location
+      if @options[:production]
+        "https://identitymanagement.lexisnexis.com/identity-proofing/services/identityProofingServiceWS/v2?wsdl"
+      else
+        "https://staging.identitymanagement.lexisnexis.com/identity-proofing/services/identityProofingServiceWS/v2?wsdl"
+      end
+    end
+
+    def endpoint_location
+      if @options[:production]
+      else
+        "https://staging.identitymanagement.lexisnexis.com/identity-proofing/services/identityProofingServiceWS/v2"
+      end
+    end
+  end
+end
+

data/lib/lexis_nexis_instant_authenticate/requests/base.rb

@@ -0,0 +1,53 @@
+require 'gyoku'
+
+module LexisNexisInstantAuthenticate
+  module Services
+    class Base
+      NAMESPACE = "ns".freeze
+
+      def header
+        Savon::Header.new(@client.savon.globals, {})
+      end
+
+      def to_s
+        %{
+          <soapenv:Envelope 
+             xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
+             xmlns:ws="http://ws.identityproofing.idm.risk.lexisnexis.com/" 
+             xmlns:ns="http://ns.lexisnexis.com/identity-proofing/1.0" 
+             xmlns:ns1="http://ns.lexisnexis.com/survey/1.0">
+              <soapenv:Header>
+                #{header}  
+              </soapenv:Header>
+             <soapenv:Body>
+                <ws:invokeIdentityService>
+                   <ns:identityProofingRequest ns:transactionID="#{@client.transaction_id}">
+                      <ns:workFlow>#{@client.flow}</ns:workFlow>
+                      #{to_xml}
+                   </ns:identityProofingRequest>
+                </ws:invokeIdentityService>
+             </soapenv:Body>
+          </soapenv:Envelope>
+        }
+      end
+
+      def to_xml
+        Gyoku.xml(request_body, key_converter: -> key { [NAMESPACE, key.camelize(:lower)].join(':') })
+      end
+
+      def request_body
+        {}
+      end
+
+      def nil_to_string(object)
+        case object
+        when Hash then object.each {|k,v| object[k] = "" if v.nil?}
+        else object = "" if object.nil?
+        end
+        return object
+      end
+
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/requests/create_quiz.rb

@@ -0,0 +1,60 @@
+module LexisNexisInstantAuthenticate
+  module Services
+    class CreateQuiz < Base
+      def initialize(client, person)
+        @person = {dob: {}, address: {}}.merge(person)
+        @client = client
+      end
+
+      def request_body
+        {
+          input_subject: {
+            person: {
+              name: nil_to_string(name),
+              date_of_birth: nil_to_string(date_of_birth),
+              age: nil_to_string(age),
+              gender: nil_to_string(gender),
+              ssn: nil_to_string(ssn),
+              address: nil_to_string(address)
+            }
+          }
+        }
+      end
+
+      private
+      def name
+        {prefix: "", first: @person[:first_name], middle: @person[:middle_name], last: @person[:last_name], suffix: ""}
+      end
+
+      def date_of_birth
+        {year: @person[:dob][:year], month: @person[:dob][:month], day: @person[:dob][:day]}
+      end
+
+      def age
+        @person[:age]
+      end
+
+      def gender
+        return "" unless @person[:gender].present?
+        return @person[:gender].capitalize[0] if @person[:gender].length > 1
+        return @person[:gender]
+      end
+
+      def ssn
+        @person[:ssn].present? && @person[:ssn].gsub(/\D/, "")
+      end
+
+      def address
+        {
+          street_address_1: @person[:address][:line_1],
+          street_address_2: @person[:address][:line_2],
+          city: @person[:address][:city],
+          state: @person[:address][:state],
+          zip5: @person[:address][:zip_code]
+        }
+      end
+
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/requests/score_quiz.rb

@@ -0,0 +1,32 @@
+module LexisNexisInstantAuthenticate
+  module Services
+    class ScoreQuiz < Base
+
+      def initialize(client, id, quiz_responses)
+        @quiz_id = id
+        @quiz_responses = quiz_responses
+        @client = client
+      end
+
+      def responses_to_hash
+        @quiz_responses.map do |resp| 
+          { 
+            "#{NAMESPACE}:questionId" => resp[:question_id],
+            "#{NAMESPACE}:choiceId" => resp[:choice_id]
+          }
+        end
+      end
+
+      def request_body
+        {
+          score_request: {
+            quiz_id: @quiz_id,
+            answer: responses_to_hash
+          }
+        }
+      end
+
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/resources/base.rb

@@ -0,0 +1,35 @@
+module LexisNexisInstantAuthenticate
+  module Resources
+    class Base
+      attr_reader :response
+      def initialize(client, response)
+        @client = client
+        @response = response
+      end
+
+      def transaction_id
+        @client.transaction_id
+      end
+
+      def proofing_response
+        @response.hash[:envelope][:body][:invoke_identity_service_response][:identity_proofing_response]
+      end
+
+      def success?
+        case status
+        when "IDENTITY_NOT_LOCATED", "UNABLE_TO_GENERATE" then false
+        else true
+        end
+      end
+
+      def status
+        proofing_response[:status]
+      end
+
+      def product_response
+        proofing_response[:product_response]
+      end
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/resources/quiz.rb

@@ -0,0 +1,14 @@
+module LexisNexisInstantAuthenticate
+  module Resources
+    class Quiz < Base
+      def questions
+        product_response[:questions][:question]
+      end
+
+      def id
+        product_response[:questions][:"@ns:quiz_id"]
+      end
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/resources/score.rb

@@ -0,0 +1,22 @@
+module LexisNexisInstantAuthenticate
+  module Resources
+    class Score < Base
+      def pass?
+        status != "FAIL"
+      end
+
+      def score
+        product_response[:quiz_score]
+      end
+
+      def quiz_id
+        product_response[:quiz_score][:"@ns:quiz_id"]
+      end
+
+      def lex_id
+        product_response[:"@ns:lex_id"]
+      end
+
+    end
+  end
+end

data/lib/lexis_nexis_instant_authenticate/version.rb

@@ -0,0 +1,3 @@
+module LexisNexisInstantAuthenticate
+  VERSION = "0.2.0"
+end

data/lib/lexis_nexis_instant_authenticate.rb

@@ -0,0 +1,6 @@
+require "lexis_nexis_instant_authenticate/version"
+require "lexis_nexis_instant_authenticate/client"
+
+module LexisNexisInstantAuthenticate
+  
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: lexis_nexis_instant_authenticate
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Christopher Ostrowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  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: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  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: 
+email:
+- chris@reppro.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lexis_nexis_instant_authenticate.gemspec
+- lib/lexis_nexis_instant_authenticate.rb
+- lib/lexis_nexis_instant_authenticate/akami_patch.rb
+- lib/lexis_nexis_instant_authenticate/client.rb
+- lib/lexis_nexis_instant_authenticate/requests/base.rb
+- lib/lexis_nexis_instant_authenticate/requests/create_quiz.rb
+- lib/lexis_nexis_instant_authenticate/requests/score_quiz.rb
+- lib/lexis_nexis_instant_authenticate/resources/base.rb
+- lib/lexis_nexis_instant_authenticate/resources/quiz.rb
+- lib/lexis_nexis_instant_authenticate/resources/score.rb
+- lib/lexis_nexis_instant_authenticate/version.rb
+homepage: https://github.com/reppro/lexis_nexis_instant_authenticate
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby interface for using LexisNexis Instant Authenticate.
+test_files: []