blueline_services 0.1.5

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    blueline_services (0.1.5)
+      activesupport
+      httparty
+      i18n
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.10)
+    coderay (1.0.5)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    i18n (0.5.0)
+    metaclass (0.0.1)
+    method_source (0.7.1)
+    mocha (0.10.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.2.0)
+    multi_xml (0.4.2)
+    nokogiri (1.5.0)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blueline_services!
+  mocha
+  pry
+  rake
+  shoulda

data/README.md

@@ -0,0 +1,66 @@
+# BluelineServices
+
+The blueline_services gem is a ruby gem used for submitted background check requests to 
+[Blueline Services](http://www.blueline-services.com/)
+
+Using this API requires that you have an existing account with Blueline Services,
+specifically a screening product, username, and password.
+
+Install
+--------
+
+```shell
+gem install blueline_services
+```
+or add the following line to Gemfile:
+
+```ruby
+gem 'blueline_services'
+```
+and run `bundle install` from your shell.
+
+Usage
+---------------------------
+
+To create a new background check and submit it.
+
+```ruby
+request = BluelineServices::Request.new do |r|
+  r.user_name = "XML_TST",
+  r.password = "ScROLL447breaK",
+  r.type = "TST Media",
+  r.reference_id = 112233,
+  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 = BluelineServices::Request.new(hash)
+
+# or initialize with nothing and build on the fly
+
+request = BluelineServices::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 # => BluelineServices::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/blueline_services -r blueline_services.rb"
+end

data/blueline_services.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "blueline_services/version"
+
+Gem::Specification.new do |s|
+  s.name        = "blueline_services"
+  s.version     = BluelineServices::VERSION
+  s.authors     = ["Jon Karna", "Ed Lebert"]
+  s.email       = ["jon.karna@tstmedia.com", "ed.lebert@tstmedia.com"]
+  s.homepage    = ""
+  s.summary     = %q{Submit background checks to Blueline Services}
+  s.description = %q{The blueline_services gem is a ruby gem used for
+                     submitting background check requests to Blueline Services}
+
+  s.rubyforge_project = "blueline_services"
+
+  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"
+  s.add_runtime_dependency "i18n"
+
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "mocha"
+end

data/lib/blueline_services.rb

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

data/lib/blueline_services/configuration.rb

@@ -0,0 +1,54 @@
+module BluelineServices
+  class Configuration
+
+    attr_accessor :user_name,
+                  :password,
+                  :postback_url,
+                  :postback_username,
+                  :postback_password
+
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # Public: Configure blueline services gem
+  #
+  # Examples
+  #   BluelineServices.configure do |config|
+  #     config.user_name         = "***"
+  #     config.password          = "***"
+  #     config.postback_url      = "http://127.0.0.1/listen.php"
+  #     config.postback_username = "user"
+  #     config.postback_password = "secret"
+  #   end
+  #
+  def self.configure
+    yield(configuration)
+  end
+
+  # Public: Configure blueline services gem with yaml file
+  #
+  # file - The name of the file to parse. (optional)
+  #        Defaults to "config/blueline.yml".
+  #
+  # Examples
+  #   BluelineServices.load_config("blueline.yml")
+  #
+  def self.load_config(file="config/blueline.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/blueline_services/dsl.rb

@@ -0,0 +1,30 @@
+module BluelineServices
+  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/blueline_services/person_name.rb

@@ -0,0 +1,29 @@
+module BluelineServices
+  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/blueline_services/request.rb

@@ -0,0 +1,155 @@
+module BluelineServices
+  class Request
+    include DSL
+    include HTTParty
+    base_uri "https://www.bluelinebackgrounds.com/send/interchange"
+
+    ADDITIONAL_ITEMS = [:postback_url, :postback_username,
+      :postback_password, :embed_credentials, :ordernotes,
+      :interface, :monthly_income, :monthly_rent]
+
+    # BackgroundCheck
+    attr_accessor :user_name,
+                  :password
+
+    # BackgroundSearchPackage
+    attr_accessor :action,
+                  :type,
+                  :reference_id
+
+    # PersonalData
+    attr_accessor :email_address,
+                  :telephone
+
+    # PersonName
+    attr_accessor :given_name,
+                  :middle_name,
+                  :family_name,
+                  :affix
+
+    # DemographicDetail
+    attr_accessor :government_id,
+                  :country_code,
+                  :issuing_authority,
+                  :date_of_birth,
+                  :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
+      @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.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 => country_code,
+                      :issuingAuthority => issuing_authority)
+              } # DemographicDetail
+              xml.PostalAddress {
+                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 submit
+      response = self.class.post("", :body => {:request => to_xml})
+      data = response.parsed_response
+      BluelineServices::Response.new(data)
+    end
+
+    private
+    def init_defaults
+      config = BluelineServices.configuration
+      @user_name = config.user_name
+      @password = config.password
+      @postback_url = config.postback_url
+      @postback_username = config.postback_username
+      @postback_password = config.postback_password
+      @action = "submit"
+      @screenings = []
+      @aliases = []
+    end
+
+    def yes_or_no(v)
+      !!v ? "yes" : "no"
+    end
+
+  end
+end