ssci_inc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df8f76de6d18ea79119204dc67e777553af6a989
+  data.tar.gz: ae34bd28ec63ec2ae9a83a0ce39c61cef50a604a
+SHA512:
+  metadata.gz: 47c824840d70d4a2a8372e83d530cd4b4627c1da2acc2382c81a95c16adbf120f7bdd69e0fa83fcea5b5e5299b2ff29b0a5a98ff088aefd23cbeea7668d26a5e
+  data.tar.gz: 5f8b1beddc9cf92735058638c64cdd39abc3147023707c64928124a316922b262c0ff6e40d29f4ab499841fec8382f4e579d4add252381d732848775c3d20489

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+.bundle
+pkg/*
+Gemfile.lock
+
+# Mac
+.DS_Store
+
+# NetBeans
+nbproject
+
+# Eclipse
+.project
+
+# Redcar
+.redcar
+
+# Rubinius
+*.rbc
+
+# Vim
+*.swp
+*.swo
+
+# RubyMine
+.idea

data/.octopolo.yml

@@ -0,0 +1,2 @@
+deploy_branch: master
+github_repo: sportngin/ssci_inc

data/.ruby-gemset

@@ -0,0 +1 @@
+ssci_inc

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -0,0 +1,22 @@
+sudo: false
+branches:
+  only:
+    - master
+
+notifications:
+  slack: sportngin:Yr24DXJUvIOegSPwKMG099D1
+
+after_script:
+  - uptime && vmstat -S M
+
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+cache: bundler
+
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,66 @@
+# SSCI Inc
+
+The ssci_inc gem is a ruby gem used for submitted background check requests to
+[SSCI](http://www.ssci2000.com/)
+
+Using this API requires that you have an existing account with SSCI.
+
+Install
+--------
+
+```shell
+gem install ssci_inc
+```
+or add the following line to Gemfile:
+
+```ruby
+gem 'ssci_inc'
+```
+and run `bundle install` from your shell.
+
+Usage
+---------------------------
+
+To create a new background check and submit it.
+
+```ruby
+request = SsciInc::Request.new do |r|
+  r.user_name = "XML_TST",
+  r.password = "ScROLL447breaK",
+  r.type = "TST Media",
+  r.reference_id = 112233,
+  r.reference = "ABC Company Inc.",
+  r.given_name = "HANK",
+  r.family_name = "MESS",
+  r.ssn = "333-22-1111",
+  r.date_of_birth = "1960-01-01",
+  r.postal_code = "60750",
+  r.region = "IL",
+  r.municipality = "FANTASY ISLAND",
+  r.address_line = 899,
+  r.street_name = "LINCOLN RD",
+  r.postback_url = "http://127.0.0.1/listen.php",
+  r.postback_username = "user",
+  r.postback_password = "secret",
+  r.use_defaults = true
+end
+
+# or initialize with a hash
+
+request = SsciInc::Request.new(hash)
+
+# or initialize with nothing and build on the fly
+
+request = SsciInc::Request.new
+request.user_name = "..."
+
+# and then add some screens
+
+request.criminal_county_screen do |screen|
+  screen.region "WA"
+  screen.county "KING"
+end
+
+request.submit # => SsciInc::Response
+```
+

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+task :test => ["test:units","test:integration"]
+
+namespace :test do
+
+  Rake::TestTask.new(:units) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    test.verbose = true
+  end
+
+  Rake::TestTask.new(:integration) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/integration/**/*_test.rb"]
+    test.verbose = true
+  end
+
+end
+
+task :console do
+  sh "pry -I lib/ssci_inc -r ssci_inc.rb"
+end

data/lib/ssci_inc/configuration.rb

@@ -0,0 +1,62 @@
+module SsciInc
+  class Configuration
+
+    attr_accessor :base_uri,
+                  :user_name,
+                  :password,
+                  :postback_url,
+                  :postback_username,
+                  :postback_password
+
+    def base_uri
+      @base_uri ||= 'http://localhost'
+    end
+
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # Public: Configure ssci inc gem
+  #
+  # Examples
+  #   SsciInc.configure do |config|
+  #       bg_create_uri: ********
+  #       bg_index_uri: ********
+  #       site_identifier: ********
+  #       account_code: ********
+  #       username: ********
+  #       password: ********
+  #       postback_username: ********
+  #       postback_password: ********
+  #   end
+  #
+  def self.configure
+    yield(configuration)
+  end
+
+  # Public: Configure ssci inc gem with yaml file
+  #
+  # file - The name of the file to parse. (optional)
+  #        Defaults to "config/ssci_inc.yml".
+  #
+  # Examples
+  #   SsciInc.load_config("ssci_inc.yml")
+  #
+  def self.load_config(file="config/ssci_inc.yml")
+    if File.exists?(file)
+      h = YAML::load(IO.read(file))
+      configure do |config|
+        h.each do |k,v|
+          config.send("#{k}=", v) if config.respond_to?("#{k}=")
+        end
+      end
+    end
+  end
+
+end

data/lib/ssci_inc/dsl.rb

@@ -0,0 +1,30 @@
+module SsciInc
+  module DSL
+
+    def screen(klass, h={}, &block)
+      s = klass.new(h)
+      yield s if block_given?
+      @screenings << s
+    end
+
+    %w[CivilCounty Credit CriminalCounty CriminalFederal CriminalSecurity
+       CriminalState PersonSearch].each do |class_name|
+      class_eval <<-eoruby, __FILE__, __LINE__ + 1
+        def #{class_name.underscore}_screen(*args, &block)
+          screen(Screening::#{class_name}, *args, &block)
+        end
+      eoruby
+    end
+
+    def alias(h={}, &block)
+      @aliases << person_name(h, &block)
+    end
+
+    def person_name(h={}, &block)
+      p = PersonName.new(h)
+      yield p if block_given?
+      p
+    end
+
+  end
+end

data/lib/ssci_inc/person_name.rb

@@ -0,0 +1,29 @@
+module SsciInc
+  class PersonName
+
+    attr_accessor :given_name,
+                  :middle_name,
+                  :family_name,
+                  :affix
+
+    def initialize(h={})
+      h.each {|k,v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+
+    def as_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.PersonName {
+          xml.GivenName given_name
+          xml.MiddleName middle_name
+          xml.FamilyName family_name
+          xml.Affix affix
+        }
+      end.parent.root
+    end
+
+    def to_xml
+      as_xml.to_xml
+    end
+
+  end
+end

data/lib/ssci_inc/request.rb

@@ -0,0 +1,196 @@
+module SsciInc
+  class Request
+    include DSL
+
+    ADDITIONAL_ITEMS = [:postback_url, :postback_username,
+      :postback_password, :embed_credentials, :ordernotes,
+      :interface, :monthly_income, :monthly_rent]
+
+    # BackgroundCheck
+    attr_accessor :config,
+                  :base_uri,
+                  :user_name,
+                  :password
+
+    # BackgroundSearchPackage
+    attr_accessor :action,
+                  :type,
+                  :reference_id,
+                  :reference
+
+    # PersonalData
+    attr_accessor :email_address,
+                  :telephone
+
+    # PersonName
+    attr_accessor :given_name,
+                  :middle_name,
+                  :family_name,
+                  :affix
+
+    # DemographicDetail
+    attr_accessor :government_id,
+                  :ssn_country_code,
+                  :issuing_authority,
+                  :date_of_birth
+
+    # PostalAddress
+    attr_accessor :country_code,
+                  :postal_code,
+                  :region,
+                  :municipality,
+                  :address_line,
+                  :street_name
+
+    # Screenings
+    attr_reader   :screenings
+    attr_accessor :use_defaults
+
+    # AdditionalItems
+    attr_accessor *ADDITIONAL_ITEMS
+
+    attr_reader :aliases
+
+    def initialize(h={})
+      init_defaults
+      h.each do |k,v|
+        send("#{k}=", v) if respond_to?("#{k}=")
+      end
+      yield self if block_given?
+    end
+
+    def additional_items
+      ADDITIONAL_ITEMS.inject({}) do |h,a|
+        v = send(a)
+        h[a] = send(a) unless v.nil?
+        h
+      end
+    end
+
+    def ssn=(new_ssn)
+      @government_id = new_ssn
+      @ssn_country_code = "US"
+      @issuing_authority = "SSN"
+    end
+
+    def name
+      person_name do |p|
+        p.given_name = given_name
+        p.middle_name = middle_name
+        p.family_name = family_name
+        p.affix = affix
+      end
+    end
+
+    def as_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.BackgroundCheck(:userId => user_name, :password => password) {
+          xml.BackgroundSearchPackage(:type => type, :action => action) {
+            xml.ReferenceId reference_id
+            xml.Reference reference
+            xml.PersonalData {
+              xml.EmailAddress email_address
+              xml.Telephone telephone
+              xml.parent << name.as_xml
+              if aliases.any?
+                xml.Aliases {
+                  aliases.each do |a|
+                    xml.parent << a.as_xml
+                  end
+                }
+              end
+              xml.DemographicDetail {
+                xml.GovernmentId(government_id,
+                      :countryCode => ssn_country_code,
+                      :issuingAuthority => issuing_authority)
+                xml.DateOfBirth date_of_birth
+              } # DemographicDetail
+              xml.PostalAddress {
+                xml.CountryCode country_code == "Canada" ? "CA" : "US"
+                xml.PostalCode postal_code
+                xml.Region region
+                xml.Municipality municipality
+                xml.DeliveryAddress {
+                  xml.AddressLine address_line
+                  xml.StreetName street_name
+                } # DeliveryAddress
+              } # PostalAddress
+            } # PersonalData
+            xml.Screenings(:useConfigurationDefaults => yes_or_no(use_defaults)) {
+              screenings.each do |s|
+                xml.parent << s.as_xml
+              end
+              additional_items.each do |k,v|
+                xml.AdditionalItems(:type => "x:#{k}") {
+                  xml.Text v
+                }
+              end
+            } # Screenings
+          } # BackgroundSearchPackage
+        } # BackgroundCheck
+      end
+    end
+
+    def to_xml
+      as_xml.to_xml
+    end
+
+    def request_options
+      {
+        body: { request: to_xml },
+        basic_auth: { username: user_name, password: password }
+      }
+    end
+
+    def build_request
+      HTTParty::Request.new(Net::HTTP::Post, base_uri, request_options)
+    end
+
+    def submit
+      response = build_request.perform
+      data = response.parsed_response
+      SsciInc::Response.new(data)
+    end
+
+    def config
+      @config || SsciInc.configuration
+    end
+
+    def base_uri
+      @base_uri || config.base_uri
+    end
+
+    def user_name
+      @user_name || config.user_name
+    end
+
+    def password
+      @password || config.password
+    end
+
+    def postback_url
+      @postback_url || config.postback_url
+    end
+
+    def postback_username
+      @postback_username || config.postback_username
+    end
+
+    def postback_password
+      @postback_password || config.postback_password
+    end
+
+    private
+
+    def init_defaults
+      @action = "submit"
+      @screenings = []
+      @aliases = []
+    end
+
+    def yes_or_no(v)
+      !!v ? "yes" : "no"
+    end
+
+  end
+end

data/lib/ssci_inc/response.rb

@@ -0,0 +1,44 @@
+module SsciInc
+  class Response
+
+    attr_reader :user_id, :password, :reference_id, :reference, :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)
+      @reference = document.at("//Reference").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/ssci_inc/screening/civil_county.rb

@@ -0,0 +1,17 @@
+module SsciInc
+  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/ssci_inc/screening/credit.rb

@@ -0,0 +1,16 @@
+module SsciInc
+  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/ssci_inc/screening/criminal_county.rb

@@ -0,0 +1,17 @@
+module SsciInc
+  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/ssci_inc/screening/criminal_federal.rb

@@ -0,0 +1,17 @@
+module SsciInc
+  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/ssci_inc/screening/criminal_security.rb

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

data/lib/ssci_inc/screening/criminal_state.rb

@@ -0,0 +1,16 @@
+module SsciInc
+  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/ssci_inc/screening/eviction.rb

@@ -0,0 +1,16 @@
+module SsciInc
+  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/ssci_inc/screening/model.rb

@@ -0,0 +1,27 @@
+module SsciInc
+  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/ssci_inc/screening/person_search.rb

@@ -0,0 +1,16 @@
+module SsciInc
+  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