Class: SsciInc::Request

Inherits:
Object
  • Object
show all
Includes:
DSL
Defined in:
lib/ssci_inc/request.rb

Constant Summary collapse

COURT_TYPES = 
{
    bankruptcy: "Bankruptcy",
    federal: "Federal",
    felony: "Felony",
    felony_misdemeanor: "Felony Misdemeanor",
    lower_civil: "Lower Civil",
    property_search: "Property Search",
    upper_civil: "Upper Civil",
    upper_lower_civil: "Upper and Lower Civil"
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DSL

#alias, #person_name, #screen

Constructor Details

#initialize(h = {}) ⇒ Request

Returns a new instance of Request.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/ssci_inc/request.rb', line 62

def initialize(h={})
  init_defaults
  h.each do |k,v|
    send("#{k}=", v) if respond_to?("#{k}=")
  end

  county =

  yield self if block_given?
end

Instance Attribute Details

#action ⇒ Object

BackgroundSearchPackage



24
25
26
 
# File 'lib/ssci_inc/request.rb', line 24

def action
  @action
end

#address_line ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def address_line
  @address_line
end

#affix ⇒ Object

PersonName



34
35
36
 
# File 'lib/ssci_inc/request.rb', line 34

def affix
  @affix
end

#aliases ⇒ Object (readonly)

Returns the value of attribute aliases.



60
61
62
 
# File 'lib/ssci_inc/request.rb', line 60

def aliases
  @aliases
end

#base_uri ⇒ Object

BackgroundCheck



18
19
20
 
# File 'lib/ssci_inc/request.rb', line 18

def base_uri
  @base_uri
end

#config ⇒ Object

BackgroundCheck



18
19
20
 
# File 'lib/ssci_inc/request.rb', line 18

def config
  @config
end

#country_code ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def country_code
  @country_code
end

#county ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def county
  @county
end

#date_of_birth ⇒ Object

DemographicDetail



40
41
42
 
# File 'lib/ssci_inc/request.rb', line 40

def date_of_birth
  @date_of_birth
end

#district ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def district
  @district
end

#email_address ⇒ Object

PersonalData



30
31
32
 
# File 'lib/ssci_inc/request.rb', line 30

def email_address
  @email_address
end

#extra_identifier ⇒ Object

ExtraIdentifier



54
55
56
 
# File 'lib/ssci_inc/request.rb', line 54

def extra_identifier
  @extra_identifier
end

#family_name ⇒ Object

PersonName



34
35
36
 
# File 'lib/ssci_inc/request.rb', line 34

def family_name
  @family_name
end

#given_name ⇒ Object

PersonName



34
35
36
 
# File 'lib/ssci_inc/request.rb', line 34

def given_name
  @given_name
end

#middle_name ⇒ Object

PersonName



34
35
36
 
# File 'lib/ssci_inc/request.rb', line 34

def middle_name
  @middle_name
end

#municipality ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def municipality
  @municipality
end

#password ⇒ Object

BackgroundCheck



18
19
20
 
# File 'lib/ssci_inc/request.rb', line 18

def password
  @password
end

#postal_code ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def postal_code
  @postal_code
end

#reference ⇒ Object

BackgroundSearchPackage



24
25
26
 
# File 'lib/ssci_inc/request.rb', line 24

def reference
  @reference
end

#reference_id ⇒ Object

BackgroundSearchPackage



24
25
26
 
# File 'lib/ssci_inc/request.rb', line 24

def reference_id
  @reference_id
end

#region ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def region
  @region
end

#screenings ⇒ Object (readonly)

Screenings



57
58
59
 
# File 'lib/ssci_inc/request.rb', line 57

def screenings
  @screenings
end

#ssn ⇒ Object

DemographicDetail



40
41
42
 
# File 'lib/ssci_inc/request.rb', line 40

def ssn
  @ssn
end

#street_name ⇒ Object

PostalAddress



44
45
46
 
# File 'lib/ssci_inc/request.rb', line 44

def street_name
  @street_name
end

#telephone ⇒ Object

PersonalData



30
31
32
 
# File 'lib/ssci_inc/request.rb', line 30

def telephone
  @telephone
end

#type ⇒ Object

BackgroundSearchPackage



24
25
26
 
# File 'lib/ssci_inc/request.rb', line 24

def type
  @type
end

#use_defaults ⇒ Object

Returns the value of attribute use_defaults.



58
59
60
 
# File 'lib/ssci_inc/request.rb', line 58

def use_defaults
  @use_defaults
end

#user_name ⇒ Object

BackgroundCheck



18
19
20
 
# File 'lib/ssci_inc/request.rb', line 18

def user_name
  @user_name
end

Instance Method Details

#account_code ⇒ Object 



163
164
165
 
# File 'lib/ssci_inc/request.rb', line 163

def 
  @account_code || config.
end

#as_xml ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ssci_inc/request.rb', line 73

def as_xml
  Nokogiri::XML::Builder.new do |xml|
    xml.BackgroundCheck(:userId => user_name, :password => password) {
      xml.BatchData {
        xml.DestSiteIdentifier "SOUTHEASTERN"
        xml.SourceSiteIdentifier site_identifier
        xml.AcctCode 
        xml.BatchID 1
        xml.RecordCount 1
      }
      xml.BackgroundSearchPackage {
        xml.PersonalData {
          xml.PersonName {
            xml.GivenName given_name
            xml.MiddleName middle_name if middle_name.present?
            xml.FamilyName family_name
            xml.Affix affix if affix.present?
          }
          if aliases.any?
            xml.AliasNames {
              aliases.each do |a|
                xml.parent << a.as_xml
              end
            }
          end
          xml.DemographicDetail {
            xml.Ssn ssn
            xml.DateOfBirth date_of_birth
          } # DemographicDetail
          xml.AddressSummary {
            xml.CountryCode country_code == "Canada" ? "CA" : "US"
            xml.PostalCode postal_code
            xml.Region region
            xml.Municipality municipality
            xml.AddressLine street_name
          } # AddressSummary
          xml.RequestIdData {
            xml.ReferenceID reference_id
          }
          xml.SpecialRequestInfo {
            xml.ApplicantPhone telephone
            xml.ApplicantEmail email_address
            xml.ExtraIdentifier extra_identifier
          }
        } # PersonalData
        xml.Screenings {
          init_default_screenings if use_defaults
          @screenings.each do |s|
            xml.parent << s.as_xml
          end
        } # Screenings
      } # BackgroundSearchPackage
    } # BackgroundCheck
  end
end

#build_request ⇒ Object 



141
142
143
 
# File 'lib/ssci_inc/request.rb', line 141

def build_request
  HTTParty::Request.new(Net::HTTP::Post, base_uri, request_options)
end

#init_default_screenings ⇒ Object 



189
190
191
192
 
# File 'lib/ssci_inc/request.rb', line 189

def init_default_screenings
  @screenings = [Screening::Social.new,
                 Screening::Other.new(qualifier: 'US Crim / Sex Offender Search')]
end

#request_options ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/ssci_inc/request.rb', line 133

def request_options
  {
    body: to_xml,
    basic_auth: { username: user_name, password: password },
    headers: { "Content-Type" => "text/xml"}
  }
end

#site_identifier ⇒ Object 



159
160
161
 
# File 'lib/ssci_inc/request.rb', line 159

def site_identifier
  @site_identifier || config.site_identifier
end

#submit ⇒ Object 



145
146
147
148
149
 
# File 'lib/ssci_inc/request.rb', line 145

def submit
  response = build_request.perform
  data = response.parsed_response
  SsciInc::Response.new(data)
end

#to_xml ⇒ Object 



129
130
131
 
# File 'lib/ssci_inc/request.rb', line 129

def to_xml
  as_xml.to_xml
end