blueline_services 0.1.5

data/lib/blueline_services/response.rb

@@ -0,0 +1,43 @@
+module BluelineServices
+  class Response
+
+    attr_reader :user_id, :password, :reference_id, :order_id, :order_status
+    attr_reader :result_status
+
+    # ErrorReport
+    attr_reader :error_code, :error_description
+
+    # postback
+    attr_reader :result_status,
+                :order_status_flag,
+                :screening_results_type,
+                :screening_results_media_type,
+                :screening_results_result_type,
+                :result_url
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      document = Nokogiri::XML.parse(data)
+      @user_id = document.at("//@userId").try(:value)
+      @password = document.at("//@password").try(:value)
+      @reference_id = document.at("//ReferenceId").try(:text)
+      @order_id = document.at("//OrderId").try(:text)
+      @order_status = document.at("//OrderStatus").try(:text)
+
+      # errors
+      @error_code = document.at("//ErrorCode").try(:text)
+      @error_description = document.at("//ErrorDescription").try(:text)
+
+      # completed postback response
+      @result_status = document.at("//ResultStatus").try(:text)
+      @order_status_flag = document.at("//OrderStatus//@flag").try(:value)
+      @screening_results_type = document.at("//ScreeningResults//@type").try(:value)
+      @screening_results_media_type = document.at("//ScreeningResults//@mediaType").try(:value)
+      @screening_results_result_type = document.at("//ScreeningResults//@resultType").try(:value)
+      @result_url = document.at("//InternetWebAddress").try(:text)
+    end
+
+  end
+end

data/lib/blueline_services/screening/civil_county.rb

@@ -0,0 +1,17 @@
+module BluelineServices
+  module Screening
+    class CivilCounty
+      include Screening::Model
+
+      attr_accessor :region, :county
+
+      def as_xml
+        builder(:type => "civil", :qualifier => "county") do |xml|
+          xml.Region region unless region.nil?
+          xml.County county unless county.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/credit.rb

@@ -0,0 +1,16 @@
+module BluelineServices
+  module Screening
+    class Credit
+      include Screening::Model
+
+      attr_accessor :score, :fraud, :vendor
+
+      def as_xml
+        builder(:type => "credit") do |xml|
+          xml.Vendor(vendor, :score => score, :fraud => fraud)
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/criminal_county.rb

@@ -0,0 +1,17 @@
+module BluelineServices
+  module Screening
+    class CriminalCounty
+      include Screening::Model
+
+      attr_accessor :region, :county
+
+      def as_xml
+        builder(:type => "criminal", :qualifier => "county") do |xml|
+          xml.Region region unless region.nil?
+          xml.County county unless county.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/criminal_federal.rb

@@ -0,0 +1,17 @@
+module BluelineServices
+  module Screening
+    class CriminalFederal
+      include Screening::Model
+
+      attr_accessor :region, :district
+
+      def as_xml
+        builder(:type => "criminal", :qualifier => "federal") do |xml|
+          xml.Region region unless region.nil?
+          xml.District district unless district.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/criminal_security.rb

@@ -0,0 +1,12 @@
+module BluelineServices
+  module Screening
+    class CriminalSecurity
+      include Screening::Model
+
+      def as_xml
+        builder(:type => "criminal", :qualifier => "security")
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/criminal_state.rb

@@ -0,0 +1,16 @@
+module BluelineServices
+  module Screening
+    class CriminalState
+      include Screening::Model
+
+      attr_accessor :region
+
+      def as_xml
+        builder(:type => "criminal", :qualifier => "statewide") do |xml|
+          xml.Region region unless region.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/eviction.rb

@@ -0,0 +1,16 @@
+module BluelineServices
+  module Screening
+    class Eviction
+      include Screening::Model
+
+      attr_accessor :region
+
+      def as_xml
+        builder(:type => "eviction", :qualifier => "statewide") do |xml|
+          xml.Region region unless region.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/model.rb

@@ -0,0 +1,27 @@
+module BluelineServices
+  module Screening
+    module Model
+
+      def initialize(h={})
+        h.each {|k,v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+      def builder(attributes={})
+        Nokogiri::XML::Builder.new do |xml|
+          xml.send("Screening", attributes) {
+            yield xml if block_given?
+          }
+        end.parent.root
+      end
+
+      def as_xml
+        raise NotImplementedError
+      end
+
+      def to_xml
+        as_xml.to_xml
+      end
+
+    end
+  end
+end

data/lib/blueline_services/screening/person_search.rb

@@ -0,0 +1,16 @@
+module BluelineServices
+  module Screening
+    class PersonSearch
+      include Screening::Model
+
+      attr_accessor :vendor
+
+      def as_xml
+        builder(:type => "personsearch") do |xml|
+          xml.Vendor vendor unless vendor.nil?
+        end
+      end
+
+    end
+  end
+end

data/lib/blueline_services/version.rb

@@ -0,0 +1,3 @@
+module BluelineServices
+  VERSION = "0.1.5"
+end

data/test/integration/initial_request_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module BluelineServices
+  class InitialRequestTest < Test::Unit::TestCase
+
+    context "#submit" do
+      context "with no credentials" do
+        subject { Request.new }
+
+        should "get an error response" do
+          response = subject.submit
+          assert_equal "x:error", response.order_status
+          assert_equal "120", response.error_code
+          assert_equal "Invalid login transaction. Bad credentials.",
+                       response.error_description
+        end
+      end
+    end
+
+  end
+end

data/test/test-updated.xml

@@ -0,0 +1,111 @@
+<?xml version="1.0"?>
+<BackgroundCheck password="" userId="">
+  <BackgroundSearchPackage action="submit" type="TST Media">
+    <ReferenceId>112233</ReferenceId>
+    <PersonalData>
+      <EmailAddresss></EmailAddresss>
+      <Telephone></Telephone>
+      <PersonName>
+        <GivenName>HANK</GivenName>
+        <MiddleName></MiddleName>
+        <FamilyName>MESS</FamilyName>
+      </PersonName>
+      <DemographicDetail>
+        <GovernmentId countryCode="US" issuingAuthority="SSN">333-22-1111</GovernmentId>
+      </DemographicDetail>
+      <PostalAddress>
+        <PostalCode>60750</PostalCode>
+        <Region>IL</Region>
+        <Municipality>FANTASY ISLAND</Municipality>
+        <DeliveryAddress>
+          <AddressLine>899</AddressLine>
+          <StreetName>LINCOLN RD</StreetName>
+        </DeliveryAddress>
+      </PostalAddress>
+    </PersonalData>
+    <Screenings useConfigurationDefaults="no">
+      <!-- Person Search / SSN verification -->
+      <Screening type="personsearch">
+      </Screening>
+      <!-- County Criminal -->
+      <Screening type="criminal" qualifier="county">
+      </Screening>
+      <!-- Federal Criminal -->
+      <Screening type="criminal" qualifier="federal">
+      </Screening>
+      <!-- Instant Nationwide DB check -->
+      <Screening type="criminal" qualifier="national">
+      </Screening>
+      <!-- Manual Statewide Criminal -->
+      <Screening type="criminal" qualifier="statewide">
+      </Screening>
+      <!-- Employment Verification -->
+      <Screening type="employment" verify="yes">
+        <OrganizationName>Burger Shack</OrganizationName>
+        <Title>Fry Cook</Title>
+        <StartDate>2005-05-05</StartDate>
+        <EndDate>2005-06-16</EndDate>
+        <Compensation>6.50/hr</Compensation>
+        <ContactInfo>
+          <PersonName>
+            <FormattedName>Susan Boss</FormattedName>
+          </PersonName>
+          <Telephone>801-123-4567</Telephone>
+          <Fax>801-999-9999</Fax>
+          <EmailAddress>susan@example.com</EmailAddress>
+          <PostalAddress>
+            <PostalCode>84020</PostalCode>
+            <Region>UT</Region>
+            <Municipality>Draper</Municipality>
+            <DeliveryAddress>
+              <AddressLine>1192</AddressLine>
+              <StreetName>Draper Parkway #401</StreetName>
+            </DeliveryAddress>
+          </PostalAddress>
+        </ContactInfo>
+      </Screening>
+      <!-- Education Verification -->
+      <Screening type="education">
+        <Region>UT</Region>
+        <EducationHistory>
+          <SchoolOrInstitution schoolType="university">
+            <SchoolName>UNIVERSITY OF UTAH</SchoolName>
+            <LocationSummary>
+              <Municipality>SALT LAKE CITY</Municipality>
+              <Region>UT</Region>
+            </LocationSummary>
+            <Degree degreeType="bachelors">
+              <DegreeName>COMMUNICATIONS</DegreeName>
+            </Degree>
+            <DatesOfAttendance>
+              <StartDate>
+                <StringDate>2002-09 TO 2006-01</StringDate>
+              </StartDate>
+            </DatesOfAttendance>
+          </SchoolOrInstitution>
+        </EducationHistory>
+      </Screening>
+      <!-- Instant Driving Records -->
+      <Screening type="license" qualifier="imvPersonal">
+        <Region>UT</Region>
+        <SearchLicense>
+          <License>
+            <LicenseNumber>123456789</LicenseNumber>
+            <LicensingAgency>UT</LicensingAgency>
+            <LicenseName>mvPersonal</LicenseName>
+          </License>
+        </SearchLicense>
+      </Screening>
+
+      <AdditionalItems type="x:postback_username">
+        <Text>user</Text>
+      </AdditionalItems>
+      <AdditionalItems type="x:postback_password">
+        <Text>secret</Text>
+      </AdditionalItems>
+      <AdditionalItems type="x:postback_url">
+        <Text>http://127.0.0.1/listen.php</Text>
+      </AdditionalItems>
+    </Screenings>
+  </BackgroundSearchPackage>
+</BackgroundCheck>

data/test/test_helper.rb

@@ -0,0 +1,115 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'blueline_services'
+
+class Test::Unit::TestCase
+
+  def self.should_have_attr_accessor(*args)
+    should "have attr_accessor for #{args.inspect}" do
+      args.each do |a|
+        assert_respond_to subject, a
+        assert_respond_to subject, "#{a}="
+      end
+    end
+  end
+
+  def self.should_have_attr_reader(*args)
+    should "have attr_reader for #{args.inspect}" do
+      args.each do |a|
+        assert_respond_to subject, a
+      end
+    end
+  end
+
+  def self.should_call_builder_with(*args)
+    should "should set type and qualifier attributes" do
+      node = mock
+      subject.expects(:builder).
+              with(*args).
+              returns(node)
+      assert_equal node, subject.as_xml
+    end
+  end
+
+  def assert_xml_attr_equal(node, method_name, attribute_name=method_name)
+    assert_equal subject.send(method_name).to_s,
+                 node.at("//@#{attribute_name}").value
+  end
+
+  def assert_xml_text_equal(node, method_name, attribute_name=method_name.to_s.camelize)
+    expected = subject.send(method_name).to_s
+    actual = node.at("//#{attribute_name}").try(:text).to_s
+    #puts "for #{method_name}, assert_equal #{expected}, #{actual}"
+    assert_equal expected, actual
+  end
+
+  TEST_HASH = {
+    :user_name => "username",
+    :password => "password",
+    :type => "My Package",
+    :reference_id => 112233,
+    :given_name => "HANK",
+    :family_name => "MESS",
+    :ssn => "333-22-1111",
+    :date_of_birth => "1960-01-01",
+    :postal_code => "60750",
+    :region => "IL",
+    :municipality => "FANTASY ISLAND",
+    :address_line => 899,
+    :street_name => "LINCOLN RD",
+    :postback_url => "http://127.0.0.1/listen.php",
+    :postback_username => "user",
+    :postback_password => "secret",
+    :use_defaults => true
+  }
+
+  TEST_ERROR_RESPONSE = %Q{
+    <BackgroundReports>
+      <BackgroundReportPackage>
+        <ReferenceId>some_id_value</ReferenceId>
+        <ScreeningStatus>
+          <OrderStatus>x:error</OrderStatus>
+        </ScreeningStatus>
+        <ErrorReport>
+          <ErrorCode>4</ErrorCode>
+          <ErrorDescription>Invalid username and/or password.</ErrorDescription>
+        </ErrorReport>
+      </BackgroundReportPackage>
+    </BackgroundReports>
+  }
+
+  TEST_PENDING_RESPONSE = %Q{
+    <BackgroundReports>
+      <BackgroundReportPackage>
+        <ReferenceId>some_id_value</ReferenceId>
+        <OrderId>12358</OrderId>
+        <ScreeningStatus>
+          <OrderStatus>x:pending</OrderStatus>
+        </ScreeningStatus>
+      </BackgroundReportPackage>
+    </BackgroundReports>
+  }
+
+  TEST_CALLBACK_RESPONSE = %Q{
+    <BackgroundReports userId="username" password="password">
+      <BackgroundReportPackage>
+        <ReferenceId>some_id_value</ReferenceId>
+        <OrderId>12358</OrderId>
+        <ScreeningStatus>
+          <OrderStatus flag="FALSE">x:ready</OrderStatus>
+          <ResultStatus>Pass</ResultStatus>
+        </ScreeningStatus>
+        <Screenings>
+          <Screening>
+            <ScreeningResults type="result" mediaType="html" resultType="report">
+              <InternetWebAddress>display.php</InternetWebAddress>
+            </ScreeningResults>
+          </Screening>
+        </Screenings>
+      </BackgroundReportPackage>
+    </BackgroundReports>
+  }
+
+end