ssci_inc 0.1.0

data/lib/ssci_inc/version.rb

@@ -0,0 +1,3 @@
+module SsciInc
+  VERSION = '0.1.0'
+end

data/lib/ssci_inc.rb

@@ -0,0 +1,19 @@
+require 'active_support/all'
+require 'nokogiri'
+require 'httparty'
+
+require 'ssci_inc/configuration'
+require 'ssci_inc/dsl'
+require 'ssci_inc/person_name'
+require 'ssci_inc/request'
+require 'ssci_inc/response'
+
+require 'ssci_inc/screening/model'
+require 'ssci_inc/screening/civil_county'
+require 'ssci_inc/screening/credit'
+require 'ssci_inc/screening/criminal_county'
+require 'ssci_inc/screening/criminal_federal'
+require 'ssci_inc/screening/criminal_security'
+require 'ssci_inc/screening/criminal_state'
+require 'ssci_inc/screening/eviction'
+require 'ssci_inc/screening/person_search'

data/ssci_inc.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ssci_inc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ssci_inc"
+  s.version     = SsciInc::VERSION
+  s.authors     = ["Jon Karna", "Jon Alme"]
+  s.email       = ["jon.karna@sportsengine.com", "jonathan.alme@sportsengine.com"]
+  s.homepage    = ""
+  s.summary     = %q{Submit background checks to SSCI, Inc}
+  s.description = %q{The ssci_inc gem is a ruby gem used for
+                     submitting background check requests to SSCI}
+
+  s.rubyforge_project = "ssci_inc"
+
+  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.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "activesupport", ['> 3.0.0', '< 5.0']
+  s.add_runtime_dependency "i18n"
+
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "shoulda", "~> 3.0"
+  s.add_development_dependency "mocha", "~> 0.10"
+  s.add_development_dependency "test-unit"
+end

data/test/integration/initial_request_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module SsciInc
+  class InitialRequestTest < Test::Unit::TestCase
+
+    context "#submit" do
+      context "with no credentials" do
+        subject { Request.new(user_name: 'test') }
+
+        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,113 @@
+<?xml version="1.0"?>
+<BackgroundCheck password="" userId="">
+  <BackgroundSearchPackage action="submit" type="TST Media">
+    <ReferenceId>112233</ReferenceId>
+    <Reference>ABC Company Inc.</Reference>
+    <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>
+        <CountryCode>US</CountryCode>
+        <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,120 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'ssci_inc'
+
+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,
+    :reference => "ABC Company Inc.",
+    :given_name => "HANK",
+    :family_name => "MESS",
+    :ssn => "333-22-1111",
+    :date_of_birth => "1960-01-01",
+    :country_code => "US",
+    :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>
+        <Reference>ABC Company Inc.</Reference>
+        <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>
+        <Reference>ABC Company Inc.</Reference>
+        <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>
+        <Reference>ABC Company Inc.</Reference>
+        <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

data/test/unit/request_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+module SsciInc
+  class RequestTest < Test::Unit::TestCase
+    subject do
+      request = Request.new(TEST_HASH)
+      request.alias do |a|
+        a.given_name = "Steve"
+        a.family_name = "Jobs"
+      end
+      request.criminal_county_screen do |screen|
+        screen.region = "WA"
+        screen.county = "KING"
+      end
+      request
+    end
+
+    context "#as_xml" do
+      should "be correctly structured nokogiri builder object" do
+        root_node = subject.as_xml.parent
+
+        # this is seeing if there is an attribute "somewhere" inside
+        # the document that matches this name and value
+        assert_xml_attr_equal root_node, :user_name, :userId
+        assert_xml_attr_equal root_node, :password
+        assert_xml_attr_equal root_node, :type
+        assert_xml_attr_equal root_node, :action
+        assert_xml_attr_equal root_node, :ssn_country_code, :countryCode
+        assert_xml_attr_equal root_node, :issuing_authority, :issuingAuthority
+        assert_equal "yes", root_node.at("//@useConfigurationDefaults").value
+
+        assert_xml_text_equal root_node, :reference_id
+        assert_xml_text_equal root_node, :reference
+        assert_xml_text_equal root_node, :email_address
+        assert_xml_text_equal root_node, :telephone
+        assert_xml_text_equal root_node, :given_name
+        assert_xml_text_equal root_node, :middle_name
+        assert_xml_text_equal root_node, :family_name
+        assert_xml_text_equal root_node, :government_id
+        assert_xml_text_equal root_node, :date_of_birth
+        assert_xml_text_equal root_node, :country_code
+        assert_xml_text_equal root_node, :postal_code
+        assert_xml_text_equal root_node, :region
+        assert_xml_text_equal root_node, :municipality
+        assert_xml_text_equal root_node, :address_line
+        assert_xml_text_equal root_node, :street_name
+
+        item_nodes = root_node.xpath("//AdditionalItems")
+        subject.additional_items.each do |k,v|
+          next if v.nil?
+          attr_name = "x:#{k}"
+          item_node = item_nodes.at("[@type='#{attr_name}']")
+          assert_not_nil item_node
+          assert_equal v.to_s, item_node.at(".//Text").try(:text)
+        end
+
+        region = root_node.at("//Screening//Region").text
+        county = root_node.at("//Screening//County").text
+        assert_equal "WA", region
+        assert_equal "KING", county
+
+        alias_given_name = root_node.at("//Aliases//PersonName//GivenName").text
+        alias_family_name = root_node.at("//Aliases//PersonName//FamilyName").text
+        assert_equal "Steve", alias_given_name
+        assert_equal "Jobs", alias_family_name
+      end
+    end
+
+    context "#submit" do
+      should "send a post request and wrap the response" do
+        response = mock
+        request_xml = "request xml"
+        response_xml = "reponse_xml"
+        http_response = mock(:parsed_response => response_xml)
+        subject.expects(:to_xml).returns(request_xml)
+        HTTParty::Request.any_instance.stubs(perform: http_response)
+        Response.expects(:new).with(response_xml).returns(response)
+        assert_equal response, subject.submit
+      end
+    end
+
+    should_have_attr_accessor :config, :base_uri, :user_name, :password
+    should_have_attr_accessor :action, :type, :reference_id, :reference
+    should_have_attr_accessor :email_address, :telephone
+    should_have_attr_accessor :given_name, :middle_name, :family_name
+    should_have_attr_accessor :government_id, :ssn_country_code,
+      :issuing_authority, :date_of_birth, :country_code, :postal_code, :region,
+      :municipality, :address_line, :street_name
+    should_have_attr_accessor :use_defaults
+    should_have_attr_accessor *Request::ADDITIONAL_ITEMS
+
+  end
+end

data/test/unit/response_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+module SsciInc
+  class ResponseTest < Test::Unit::TestCase
+    subject { Response.new(TEST_ERROR_RESPONSE) }
+
+    should_have_attr_reader :user_id, :password, :reference_id,
+                            :reference, :order_id, :order_status
+    should_have_attr_reader :error_code, :error_description
+    should_have_attr_reader :result_status,
+                            :order_status_flag,
+                            :screening_results_type,
+                            :screening_results_media_type,
+                            :screening_results_result_type,
+                            :result_url
+    should_have_attr_reader :data
+
+    context "#new" do
+      context "error response" do
+        subject { Response.new(TEST_ERROR_RESPONSE) }
+
+        should "have populated error attributes" do
+          assert_equal "x:error", subject.order_status
+          assert_equal "4", subject.error_code
+          assert_equal "Invalid username and/or password.",
+                       subject.error_description
+
+          assert_equal "some_id_value", subject.reference_id
+          assert_equal "ABC Company Inc.", subject.reference
+        end
+      end
+
+      context "pending response" do
+        subject { Response.new(TEST_PENDING_RESPONSE) }
+
+        should "have populated order status"  do
+          assert_equal "x:pending", subject.order_status
+          assert_equal "12358", subject.order_id
+
+          assert_equal "some_id_value", subject.reference_id
+          assert_equal "ABC Company Inc.", subject.reference
+        end
+      end
+
+      context "callback response" do
+        subject { Response.new(TEST_CALLBACK_RESPONSE) }
+
+        should "have a result status and result info"  do
+          assert_equal "x:ready", subject.order_status
+          assert_equal "Pass", subject.result_status
+          assert_equal "FALSE", subject.order_status_flag
+          assert_equal "result", subject.screening_results_type
+          assert_equal "html", subject.screening_results_media_type
+          assert_equal "report", subject.screening_results_result_type
+          assert_equal "display.php", subject.result_url
+
+          assert_equal "username", subject.user_id
+          assert_equal "password", subject.password
+
+          assert_equal "12358", subject.order_id
+          assert_equal "some_id_value", subject.reference_id
+          assert_equal "ABC Company Inc.", subject.reference
+        end
+      end
+    end
+
+  end
+end

data/test/unit/screening/civil_county_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CivilCountyTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :region, :county
+      should_call_builder_with(:type => "civil", :qualifier => "county")
+
+    end
+  end
+end

data/test/unit/screening/credit_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CreditTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :score, :fraud, :vendor
+      should_call_builder_with(:type => "credit")
+
+    end
+  end
+end

data/test/unit/screening/criminal_county_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CriminalCountyTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :region, :county
+      should_call_builder_with(:type => "criminal", :qualifier => "county")
+
+    end
+  end
+end

data/test/unit/screening/criminal_federal_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CriminalFederalTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :region, :district
+      should_call_builder_with(:type => "criminal", :qualifier => "federal")
+
+    end
+  end
+end

data/test/unit/screening/criminal_security_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CriminalSecurityTest < Test::Unit::TestCase
+
+      should_call_builder_with(:type => "criminal", :qualifier => "security")
+
+    end
+  end
+end

data/test/unit/screening/criminal_state_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class CriminalStateTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :region
+      should_call_builder_with(:type => "criminal", :qualifier => "statewide")
+
+    end
+  end
+end

data/test/unit/screening/eviction_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class EvictionTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :region
+
+    end
+  end
+end

data/test/unit/screening/model_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class ScreenUsingModel
+  include SsciInc::Screening::Model
+
+  attr_accessor :a, :b, :c
+
+end
+
+module SsciInc
+  module Screening
+    class ModelTest < Test::Unit::TestCase
+      subject { ScreenUsingModel.new }
+
+      context "#to_xml" do
+        should "call as_xml and to_xml on that object" do
+          xml = "<a>woot</a>"
+          subject.expects(:as_xml).returns(mock(:to_xml => xml))
+          assert_equal xml, subject.to_xml
+        end
+      end
+
+      context "#builder" do
+        should "build a Screening xml node with supplied attributes" do
+          node = mock
+          attributes = {:a => "a"}
+          Nokogiri::XML::Builder.any_instance.expects(:Screening).
+                                              with(attributes)
+          Nokogiri::XML::Builder.any_instance.expects(:parent => mock(
+                                                        :root => node))
+          assert_equal node, subject.builder(attributes)
+        end
+      end
+
+    end
+  end
+end

data/test/unit/screening/person_search_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module SsciInc
+  module Screening
+    class PersonSearchTest < Test::Unit::TestCase
+
+      should_have_attr_accessor :vendor
+
+    end
+  end
+end