lexis_nexis_api 1.0.4

data/doc/admin.wsdl

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<wsdl:definitions
+    targetNamespace="http://www.cpscreen.com/schemas"
+    xmlns:tns="http://www.cpscreen.com/schemas"
+    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+    xmlns="http://schemas.xmlsoap.org/wsdl/"
+    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+    xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <wsdl:types>
+    <xs:schema elementFormDefault="qualified" targetNamespace="http://www.cpscreen.com/schemas">
+      <xs:include schemaLocation="AdminRequest.xsd"/>
+      <xs:include schemaLocation="AdminResponse.xsd"/>
+    </xs:schema>
+  </wsdl:types>
+  <wsdl:message name="AdminRequestMessage">
+    <wsdl:part name="Message" element="tns:ChoicePointAdminRequest"/>
+  </wsdl:message>
+  <wsdl:message name="AdminResponseMessage">
+    <wsdl:part name="Message" element="tns:ChoicePointAdminResponse"/>
+  </wsdl:message>
+  <wsdl:portType name="AdminInterface">
+    <wsdl:operation name="ChangePasswords">
+      <wsdl:input message="tns:AdminRequestMessage"/>
+      <wsdl:output message="tns:AdminResponseMessage"/>
+    </wsdl:operation>
+    <wsdl:operation name="GetPackages">
+      <wsdl:input message="tns:AdminRequestMessage"/>
+      <wsdl:output message="tns:AdminResponseMessage"/>
+    </wsdl:operation>
+  </wsdl:portType>
+  <wsdl:binding name="AdminSoapHttpBinding" type="tns:AdminInterface">
+    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+    <wsdl:operation name="ChangePasswords">
+      <soap:operation soapAction="http://www.cpscreen.com/pub/xchange/admin/ChangePasswords"/>
+      <wsdl:input>
+        <soap:body use="literal"/>
+      </wsdl:input>
+      <wsdl:output>
+        <soap:body use="literal"/>
+      </wsdl:output>
+    </wsdl:operation>
+    <wsdl:operation name="GetPackages">
+      <soap:operation soapAction="http://www.cpscreen.com/pub/xchange/admin/GetPackages"/>
+      <wsdl:input>
+        <soap:body use="literal"/>
+      </wsdl:input>
+      <wsdl:output>
+        <soap:body use="literal"/>
+      </wsdl:output>
+    </wsdl:operation>
+  </wsdl:binding>
+  <wsdl:service name="AdminService">
+    <wsdl:port name="AdminEndpoint" binding="tns:AdminSoapHttpBinding">
+      <soap:address location="https://www.cpscreen.com/pub/xchange/admin"/>
+    </wsdl:port>
+  </wsdl:service>
+</wsdl:definitions>

data/lexis_nexis_api.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lexis_nexis_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lexis_nexis_api"
+  s.version     = LexisNexisApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeff Emminger"]
+  s.email       = ["jeff@7compass.com"]
+  s.homepage    = "http://github.com/7compass/lexis_nexis_api"
+  s.summary     = %q{Lexis Nexis Api gem}
+  s.description = %q{}
+
+  s.rubyforge_project = "lexis_nexis_api"
+
+  s.add_runtime_dependency("nokogiri")
+  s.add_runtime_dependency("net/http")
+  s.add_runtime_dependency("net/https")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.license = 'MIT'
+end

data/lib/lexis_nexis_api/background_check.rb

@@ -0,0 +1,309 @@
+
+require 'nokogiri'
+
+module LexisNexisApi
+
+  class BackgroundCheck
+    extend XmlHelper
+
+    # 
+    # PRI-FAM:
+    # PRI-FFM:
+    # PRI-FIM:
+    # PRINCRF:
+    # PRINCRP:
+    #   PersonalData/PersonName
+    #   PersonalData/PostalAddress
+    # 
+    # SSNV:
+    #   PersonalData/DemographicDetail
+    # 
+    # MVR:
+    #   PersonalData/Licenses
+    # 
+    
+    
+    # combos
+    #  2112 = Package 1 = PRI-FIM, PRINCRF, PRINCRP, SSNV
+    #  2113 = Package 2 = PRI-FAM, PRINCRP, SSNV
+    #  2114 = Package 3 = MVR, PRINCRP, SSNV
+    #
+    # ala carte
+    #  2116 = Package 5 = MVR only
+    #  2117 = Package 6 = PRINCRP
+    #  2168 = Package 7 = PRI-FFM, SSNV
+    #  2169 = Package 9 = PRI-FFM
+    #  2360 = Package 14 = PRI-FAM
+    #
+    #
+    #  2011-02-22:
+    #  Package 1 can logically be ordered with 5,9 & 14
+    #  Package 2 can logically be ordered with 5 & 9
+    #  Package 3 can logically be ordered with 9 & 14
+    #  Any combination of 5,6,7,9 & 14 could be ordered.
+    #
+    #
+    def self.for_package(package_id, options)
+      package_id = package_id.to_i
+      
+      background_check = self.new(options.merge(:package_id => package_id))
+
+      background_check.add_ssnv # required for one-step orders
+
+      background_check.add_name_and_address if [2112, 2113, 2114, 2116, 2117, 2168, 2169, 2360].include?(package_id)
+      background_check.add_mvr if [2114, 2116].include?(package_id)
+      
+      background_check
+    end
+
+    def initialize(options={})
+      @options = options
+      @xml = create_root
+      self
+    end
+
+    # 
+    #  <BackgroundCheck
+    #      xmlns="http://www.cpscreen.com/schemas"
+    #      userId="XCHANGE"
+    #      account="#{@account}"
+    #      password="#{@password}">
+    #    <BackgroundSearchPackage xmlns="">
+    #      <PackageInformation>
+    #        <PositionAppliedFor>Current InterVarsity Staff</PositionAppliedFor>
+    #        <PackageId>#{options[:package_id]}</PackageId>
+    #        <ClientReferences>
+    #          <ClientReference>Region: Graduate &amp; Faculty Ministry North Atlantic</ClientReference>
+    #          <ClientReference>Washington, DC</ClientReference>
+    #        </ClientReferences>
+    #        <OrderAccount>
+    #          <UserId></UserId>
+    #          <Account></Account>
+    #        </OrderAccount>
+    #      </PackageInformation>
+    #      <PersonalData>
+    #        <ContactMethod>
+    #          <InternetEmailAddress></InternetEmailAddress>
+    #        </ContactMethod>
+    #      </PersonalData>
+    #    </BackgroundSearchPackage>
+    #  </BackgroundCheck>
+    # 
+    def create_root
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.BackgroundCheck(
+          :xmlns => 'http://www.cpscreen.com/schemas',
+          :userId => 'XCHANGE',
+          :account => @options[:account],
+          :password => @options[:password]
+        ){
+          xml.BackgroundSearchPackage(:xmlns => ''){
+            xml.PackageInformation{
+              xml.PositionAppliedFor @options[:position_applied_for]
+              xml.PackageId @options[:package_id]
+              xml.ClientReferences{
+                xml.ClientReference @options[:client_reference1]
+                xml.ClientReference @options[:order_as_user_id]
+              }
+              xml.OrderAccount{
+                xml.UserId 'XCHANGE'
+                xml.Account "#{@options[:account]}#{@options[:order_as_account_suffix]}"
+              } if @options[:order_as_account_suffix]
+            }
+            xml.PersonalData{
+              xml.ContactMethod{
+                xml.InternetEmailAddress @options[:contact_email]
+              }
+            }
+          }
+        }
+      end
+
+      builder.to_xml
+    end
+
+    #
+    # Optional element:
+    # /BackgroundCheck/BackgroundSearchPackage/PersonalData/Licenses
+    #
+    # Contains 0*
+    # /BackgroundCheck/BackgroundSearchPackage/PersonalData/Licenses/License
+    #
+    # options should contain:
+    #   licenses:  an array of license info hashes
+    #
+    # license info hash:
+    #   :valid_from      datetime or string YYYY-MM-DD
+    #   :valid_to        datetime or string YYYY-MM-DD
+    #   :country_code    2 char ISO country code
+    #   :license_number  AN 1..20
+    #   :license_region  2 char State/Region
+    #
+    def add_mvr
+      builder = Nokogiri::XML::Builder.with(personal_data_node) do |xml|
+        xml.Licenses {
+          @options[:licenses].each do |hash|
+            xml.License(:validFrom => ymd(hash[:valid_from]), :validTo => ymd(hash[:valid_to])) {
+              xml.CountryCode(hash[:country_code])
+              xml.LicenseNumber(hash[:license_number])
+              xml.LicenseName 'mvr'
+              xml.LicenseDescription 'mvr'
+              xml.LicenseRegion hash[:license_region] # State
+            }
+          end
+        }
+      end
+
+      @xml = builder.to_xml
+    end
+
+    # 
+    # expects an array of :person_names in @options
+    # expects an array of :postal_addresses in @options
+    #
+    #  <PersonName type="subject|alias">
+    #    <GivenName>Kevin</GivenName>
+    #    <MiddleName>Fred</MiddleName>
+    #    <FamilyName>Test</FamilyName>
+    #  </PersonName>
+    #  <PostalAddress type="current|prior" validFrom="2009-01-01">
+    #    <Municipality>Madison</Municipality>
+    #    <Region>WI</Region>
+    #    <PostalCode>53711</PostalCode>
+    #    <CountryCode>US</CountryCode>
+    #    <DeliveryAddress>
+    #      <AddressLine>1234 Main Rd</AddressLine>
+    #    </DeliveryAddress>
+    #  </PostalAddress>
+    def add_name_and_address
+      builder = Nokogiri::XML::Builder.with(personal_data_node) do |xml|
+        @options[:person_names].each do |hash|
+          xml.PersonName(:type => hash[:type]){
+            xml.GivenName hash[:first_name]
+            xml.MiddleName hash[:middle_name]
+            xml.FamilyName hash[:last_name]
+          }
+        end if @options[:person_names]
+
+        @options[:postal_addresses].each do |hash|
+          xml.PostalAddress(:type => hash[:type], :validFrom => ymd(hash[:valid_from]), :validTo => ymd(hash[:valid_to])){
+            xml.Municipality hash[:municipality]
+            xml.Region hash[:region]
+            xml.PostalCode hash[:postal_code]
+            xml.CountryCode hash[:country_code]
+            xml.DeliveryAddress{
+              xml.AddressLine hash[:address1]
+              xml.AddressLine(hash[:address2]) if hash[:address2].present?
+            }
+          }
+        end if @options[:postal_addresses]
+      end
+
+      @xml = builder.to_xml
+    end
+
+    #  <DemographicDetail>
+    #    <GovernmentId issuingAuthority="SSN">123456789</GovernmentId>
+    #    <DateOfBirth>1950-01-01</DateOfBirth>
+    #  </DemographicDetail>
+    #
+    def add_ssnv
+      builder = Nokogiri::XML::Builder.with(personal_data_node) do |xml|
+        xml.DemographicDetail{
+          xml.GovernmentId(@options[:ssn], :issuingAuthority => 'SSN')
+          xml.DateOfBirth(ymd(@options[:date_of_birth]))
+        }
+      end
+
+      @xml = builder.to_xml
+    end
+
+    def to_xml
+      self.class.soap_wrapper(@xml)
+    end
+
+    protected
+
+    def doc
+      Nokogiri::XML(@xml)
+    end
+
+    def personal_data_node
+      doc.at('//xmlns:BackgroundCheck/BackgroundSearchPackage/PersonalData', 'xmlns' => 'http://www.cpscreen.com/schemas')
+    end
+
+    # expects a Time or DateTime
+    def ymd(date)
+      return date if date.is_a?(String)
+      date.strftime("%Y-%m-%d") if date
+    end
+
+    
+    module XML
+
+      SAMPLE_ORDER_RESPONSE = %Q{<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:cp="http://www.cpscreen.com/schemas"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soapenv:Body>
+    <BackgroundReports xmlns="http://www.cpscreen.com/schemas">
+      <BackgroundReportPackage type="report">
+        <ProviderReferenceId>WPS-6266154</ProviderReferenceId>
+        <PackageInformation>
+          <ClientReferences>
+            <ClientReference>Youth123456</ClientReference>
+            <ClientReference>CN=Youth Tester/O=Youth</ClientReference>
+          </ClientReferences>
+          <Quotebacks>
+            <Quoteback name="Youth-83SQ7J"/>
+          </Quotebacks>
+        </PackageInformation>
+        <PersonalData>
+          <PersonName type="subject">
+            <GivenName>Test</GivenName>
+            <FamilyName>Youth</FamilyName>
+          </PersonName>
+          <DemographicDetail>
+            <GovernmentId issuingAuthority="SSN">123456789</GovernmentId>
+            <DateOfBirth/>
+            <Gender>F</Gender>
+          </DemographicDetail>
+        </PersonalData>
+        <ScreeningStatus>
+          <OrderStatus>InProgress</OrderStatus>
+        </ScreeningStatus>
+        <ScreeningResults mediaType="html">
+          <InternetWebAddress>https://screentest.lexisnexis.com/pub/l/login/userLogin.do?referer=https://screentest.lexisnexis.com/pub/l/jsp/menu/orderViewingMenuFrameSet.jsp?key=123|ABCDEFG</InternetWebAddress>
+        </ScreeningResults>
+      </BackgroundReportPackage>
+    </BackgroundReports>
+  </soapenv:Body>
+</soapenv:Envelope>
+      }
+
+      SAMPLE_USER_LOCKED_RESPONSE = %q[<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:cp="http://www.cpscreen.com/schemas"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soapenv:Body>
+    <BackgroundReports xmlns="http://www.cpscreen.com/schemas">
+      <BackgroundReportPackage type="errors">
+        <ErrorReport>
+          <ErrorCode>210</ErrorCode>
+          <ErrorDescription>User is locked</ErrorDescription>
+        </ErrorReport>
+      </BackgroundReportPackage>
+    </BackgroundReports>
+  </soapenv:Body>
+</soapenv:Envelope>
+      ]
+  
+    end # module XML
+
+  end # class BackgroundCheck
+
+end

data/lib/lexis_nexis_api/password_change.rb

@@ -0,0 +1,65 @@
+
+require 'nokogiri'
+
+module LexisNexisApi
+
+  class PasswordChange
+    extend XmlHelper
+
+    #
+    # options:
+    #   :account
+    #   :password
+    #   :new_password
+    #
+    def initialize(account, password, new_password, subaccount=nil)
+      @account, @password, @new_password, @subaccount = account, password, new_password, subaccount
+      @xml = create_xml
+      self
+    end
+    
+    %q[
+<ChoicePointAdminRequest
+    xmlns="http://www.cpscreen.com/schemas"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://www.cpscreen.com/schemas AdminRequest.xsd"
+    userId="XCHANGE"
+    account="999999KLX"
+    password="XXXXXXXXX">
+
+  <ChangePassword>
+    <Account>999999KLX</Account>
+    <UserId>XCHANGE</UserId>
+    <Password>As@34Gsg!#</Password>
+    <NewPassword>the_new_password</NewPassword>
+  </ChangePassword>
+
+</ChoicePointAdminRequest>
+    ]
+    def create_xml
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.ChoicePointAdminRequest(
+          :xmlns => 'http://www.cpscreen.com/schemas',
+          :userId => 'XCHANGE',
+          :account =>  "#{@account}#{@subaccount}",
+          :password => @password
+        ){
+          xml.ChangePassword{
+            xml.Account     "#{@account}#{@subaccount}"
+            xml.UserId      'XCHANGE'
+            xml.Password    @password
+            xml.NewPassword @new_password
+          }
+        }
+      end
+      
+      builder.to_xml
+    end
+
+    def to_xml
+      self.class.soap_wrapper(@xml)
+    end
+
+  end
+
+end

data/lib/lexis_nexis_api/remote_actions.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+require 'net/https'
+
+module LexisNexisApi
+
+  module RemoteActions
+    
+    class Response
+      attr_accessor :status
+      attr_accessor :body
+      attr_accessor :raw_response
+      
+      def initialize(ret_val, resp)
+        self.status = ret_val
+        self.raw_response = resp
+        self.body = resp.body
+      end
+
+      def failure?
+        !success?
+      end
+
+      def success?
+        (self.body =~ %r{<Error(Report)?>}m).nil?
+      end
+      
+      def errors
+        error_code = self.body.match(%r{<ErrorCode>(.+)</ErrorCode>})[1] rescue '???'
+        error_description = self.body.match(%r{<ErrorDescription>(.+)</ErrorDescription>})[1] rescue '???'
+        {
+          :error_code => error_code,
+          :error_description => error_description
+        }
+      end
+    end
+
+    # for use in tests
+    # 
+    # options:
+    #   :ret_val    the Net::HTTP return value
+    #               pass true for Net::HTTPSuccess, Net::HTTPRedirection
+    #               pass false for all others
+    #   
+    #   :body       the body 'returned' by the supposed Net::HTTP request
+    #
+    class MockResponse < Response
+      def initialize(options={})
+        Struct.new('MockHttpResponse', :body) unless defined?(Struct::MockHttpResponse)
+        mock_http_response = Struct::MockHttpResponse.new(options[:body])
+        super(options[:ret_val], mock_http_response)
+      end
+    end
+    
+    class Request
+      attr_accessor :headers
+      attr_accessor :proxy
+      attr_accessor :proxy_port
+      attr_accessor :body
+      attr_accessor :http_process
+      attr_accessor :url
+
+      def initialize(options={})
+        default_options = {
+          :body       => nil,
+          :headers    => {'Content-Type' => 'application/xml', 'Accept' => 'application/xml'},
+          :proxy      => nil,
+          :proxy_port => nil,
+        }
+        default_options.merge!(options)
+        
+        self.proxy      = default_options[:proxy]
+        self.proxy_port = default_options[:proxy_port]
+        self.headers    = default_options[:headers]
+        self.body       = default_options[:body]
+        self.url        = default_options[:url]
+      end
+
+      def host_from_url
+        self.url.match(%r{(?:https?://)?([^/]+)})[1] rescue nil
+      end
+
+      def is_ssl?
+        !!(self.url =~ /^https:/i)
+      end
+
+      def port_from_url
+        return 443 if self.url =~ /^https:/i
+
+        if m = self.url.match(%r{(?:http://)[^:]+:(\d+)/?})
+          return m[1].to_i
+        else
+          80
+        end
+      end
+
+      def send_request
+        self.http_process = Net::HTTP.new( host_from_url, port_from_url, self.proxy, self.proxy_port )
+        self.http_process.use_ssl = is_ssl?
+
+        http_process.start
+        resp = http_process.post(self.url, self.body, self.headers)
+        ret_val = false
+        case resp
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          ret_val = true
+        else
+          ret_val = false
+        end
+        return LexisNexisApi::RemoteActions::Response.new(ret_val, resp)
+      end
+      
+    end
+
+  end
+  
+end

data/lib/lexis_nexis_api/version.rb

@@ -0,0 +1,3 @@
+module LexisNexisApi
+  VERSION = "1.0.4"
+end

data/lib/lexis_nexis_api/xml_helper.rb

@@ -0,0 +1,26 @@
+
+module LexisNexisApi
+
+  module XmlHelper
+
+    def soap_wrapper(xml)
+      %Q{<?xml version="1.0"?>
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+  #{strip_instruct(xml)}
+  </soapenv:Body>
+</soapenv:Envelope>
+      }
+    end
+
+    def strip_instruct(xml)
+      xml.gsub!(%r{<\?xml\s+version=['"]1.0['"]\s*\?>}, '')
+      xml
+    end
+
+  end
+
+end

data/lib/lexis_nexis_api/xml_samples.rb

@@ -0,0 +1,50 @@
+module LexisNexisApi
+
+  module XmlSamples
+
+    CHANGE_PASSWORD_COMPLETE_RESPONSE = %q[<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:cp="http://www.cpscreen.com/schemas"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soapenv:Body>
+    <ChoicePointAdminResponse xmlns="http://www.cpscreen.com/schemas">
+      <ChangePassword>
+        <Status>Complete</Status>
+        <Account>036483</Account>
+        <UserId>XCHANGE</UserId>
+        <Password>This should be right</Password>
+        <NewPassword>hC0^eL0@sK9@aN7^mV4#iT6(cM0!vG1(cH8#aO8@</NewPassword>
+      </ChangePassword>
+    </ChoicePointAdminResponse>
+  </soapenv:Body>
+</soapenv:Envelope>
+    ]
+
+    CHANGE_PASSWORD_FAIL_RESPONSE = %q[<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope
+    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:cp="http://www.cpscreen.com/schemas"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soapenv:Body>
+    <ChoicePointAdminResponse xmlns="http://www.cpscreen.com/schemas">
+      <ChangePassword>
+        <Status>Fail</Status>
+        <Account>036483</Account>
+        <UserId>XCHANGE</UserId>
+        <Password>This should be wrong</Password>
+        <NewPassword>hC0^eL0@sK9@aN7^mV4#iT6(cM0!vG1(cH8#aO8@</NewPassword>
+        <Error>
+          <ErrorCode>250</ErrorCode>
+          <ErrorDescription>Invalid old password</ErrorDescription>
+        </Error>
+      </ChangePassword>
+    </ChoicePointAdminResponse>
+  </soapenv:Body>
+</soapenv:Envelope>
+    ]
+
+  end
+end