checkr-official 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/History.txt +4 -0
  3. data/README.md +12 -4
  4. data/VERSION +1 -1
  5. data/lib/checkr/api_class.rb +11 -6
  6. data/lib/checkr/document.rb +3 -0
  7. data/samples/candidate.md +195 -0
  8. data/samples/country_criminal_search.md +60 -0
  9. data/samples/document.md +109 -0
  10. data/samples/geo.md +150 -0
  11. data/samples/motor_vehicle_report.md +136 -0
  12. data/samples/national_criminal_search.md +56 -0
  13. data/samples/report.md +158 -0
  14. data/samples/sex_offender_search.md +58 -0
  15. data/samples/ssn_trace.md +136 -0
  16. data/samples/subscription.md +143 -0
  17. data/samples/terrorist_watchlist_search.md +118 -0
  18. data/test/checkr/document_list_test.rb +36 -0
  19. data/test/checkr/document_test.rb +9 -4
  20. data/test/checkr/report_test.rb +5 -0
  21. data/test/test_data.rb +1 -0
  22. metadata +14 -1
data/samples/sex_offender_search.md ADDED
@@ -0,0 +1,58 @@
1
+ # Sex Offender Search
2
+
3
+ ## The Sex Offender Search Object
4
+
5
+ ### Example Response
6
+
7
+ ```ruby
8
+ #<Checkr::SexOffenderSearch:0x3fd909b50028 id=539fd88c101897f7cd000008> JSON: {
9
+ "status": "pending",
10
+ "values": null,
11
+ "completed_at": null,
12
+ "turnaround_time": null,
13
+ "records": [
14
+
15
+ ],
16
+ "id": "539fd88c101897f7cd000008",
17
+ "object": "test_sex_offender_search",
18
+ "uri": "/v1/sex_offender_searches/539fd88c101897f7cd000008",
19
+ "created_at": "2014-06-17T05:56:28Z"
20
+ }
21
+ ```
22
+
23
+
24
+
25
+ ## Retrieve an existing Sex Offender Search
26
+
27
+ ### Definition
28
+
29
+ ```ruby
30
+ Checkr::SexOffenderSearch.retrieve({SEX_OFFENDER_SEARCH_ID})
31
+ ```
32
+
33
+ ### Example Request
34
+
35
+ ```ruby
36
+ require 'checkr' # Note the gem is named checkr-official
37
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
38
+
39
+ sex_offender_search = Checkr::SexOffenderSearch.retrieve("539fd88c101897f7cd000008")
40
+ ```
41
+
42
+ ### Example Response
43
+
44
+ ```ruby
45
+ #<Checkr::SexOffenderSearch:0x3fd909b50028 id=539fd88c101897f7cd000008> JSON: {
46
+ "status": "pending",
47
+ "values": null,
48
+ "completed_at": null,
49
+ "turnaround_time": null,
50
+ "records": [
51
+
52
+ ],
53
+ "id": "539fd88c101897f7cd000008",
54
+ "object": "test_sex_offender_search",
55
+ "uri": "/v1/sex_offender_searches/539fd88c101897f7cd000008",
56
+ "created_at": "2014-06-17T05:56:28Z"
57
+ }
58
+ ```
data/samples/ssn_trace.md ADDED
@@ -0,0 +1,136 @@
1
+ # SSN Trace
2
+
3
+ ## The SSN Trace Object
4
+
5
+ ### Example Response
6
+
7
+ ```ruby
8
+ #<Checkr::SSNTrace:0x3fd90a1ae654 id=539fd88c101897f7cd000001> JSON: {
9
+ "status": "pending",
10
+ "completed_at": null,
11
+ "turnaround_time": null,
12
+ "ssn": "XXX-XX-4645",
13
+ "addresses": [
14
+ {
15
+ "street": "92074 Kuvalis Alley",
16
+ "unit": "Apt. 419",
17
+ "city": "East Greysonview",
18
+ "state": "ID",
19
+ "zipcode": "91989-2898",
20
+ "county": "County Down",
21
+ "from_date": null,
22
+ "to_date": null
23
+ },
24
+ {
25
+ "street": "4527 Forest Flat",
26
+ "unit": "Apt. 390",
27
+ "city": "North Huntermouth",
28
+ "state": "FL",
29
+ "zipcode": "28804",
30
+ "county": "Shropshire",
31
+ "from_date": null,
32
+ "to_date": null
33
+ },
34
+ {
35
+ "street": "47674 Stroman Light",
36
+ "unit": "Suite 893",
37
+ "city": "Goyetteton",
38
+ "state": "MI",
39
+ "zipcode": "50845",
40
+ "county": "Lancashire",
41
+ "from_date": null,
42
+ "to_date": null
43
+ },
44
+ {
45
+ "street": "812 Kemmer Run",
46
+ "unit": "Apt. 590",
47
+ "city": "Crawfordview",
48
+ "state": "WI",
49
+ "zipcode": "08754",
50
+ "county": "West Midlands",
51
+ "from_date": null,
52
+ "to_date": null
53
+ }
54
+ ],
55
+ "id": "539fd88c101897f7cd000001",
56
+ "object": "test_ssn_trace",
57
+ "uri": "/v1/ssn_traces/539fd88c101897f7cd000001",
58
+ "created_at": "2014-06-17T05:56:28Z"
59
+ }
60
+ ```
61
+
62
+
63
+
64
+ ## Retrieve an existing SSN Trace
65
+
66
+ ### Definition
67
+
68
+ ```ruby
69
+ Checkr::SSNTrace.retrieve({SSN_TRADE_ID})
70
+ ```
71
+
72
+ ### Example Request
73
+
74
+ ```ruby
75
+ require 'checkr' # Note the gem is named checkr-official
76
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
77
+
78
+ ssn_trace = Checkr::SSNTrace.retrieve("539fd88c101897f7cd000001")
79
+ ```
80
+
81
+ ### Example Response
82
+
83
+ ```ruby
84
+ #<Checkr::SSNTrace:0x3fd90a1ae654 id=539fd88c101897f7cd000001> JSON: {
85
+ "status": "pending",
86
+ "completed_at": null,
87
+ "turnaround_time": null,
88
+ "ssn": "XXX-XX-4645",
89
+ "addresses": [
90
+ {
91
+ "street": "92074 Kuvalis Alley",
92
+ "unit": "Apt. 419",
93
+ "city": "East Greysonview",
94
+ "state": "ID",
95
+ "zipcode": "91989-2898",
96
+ "county": "County Down",
97
+ "from_date": null,
98
+ "to_date": null
99
+ },
100
+ {
101
+ "street": "4527 Forest Flat",
102
+ "unit": "Apt. 390",
103
+ "city": "North Huntermouth",
104
+ "state": "FL",
105
+ "zipcode": "28804",
106
+ "county": "Shropshire",
107
+ "from_date": null,
108
+ "to_date": null
109
+ },
110
+ {
111
+ "street": "47674 Stroman Light",
112
+ "unit": "Suite 893",
113
+ "city": "Goyetteton",
114
+ "state": "MI",
115
+ "zipcode": "50845",
116
+ "county": "Lancashire",
117
+ "from_date": null,
118
+ "to_date": null
119
+ },
120
+ {
121
+ "street": "812 Kemmer Run",
122
+ "unit": "Apt. 590",
123
+ "city": "Crawfordview",
124
+ "state": "WI",
125
+ "zipcode": "08754",
126
+ "county": "West Midlands",
127
+ "from_date": null,
128
+ "to_date": null
129
+ }
130
+ ],
131
+ "id": "539fd88c101897f7cd000001",
132
+ "object": "test_ssn_trace",
133
+ "uri": "/v1/ssn_traces/539fd88c101897f7cd000001",
134
+ "created_at": "2014-06-17T05:56:28Z"
135
+ }
136
+ ```
data/samples/subscription.md ADDED
@@ -0,0 +1,143 @@
1
+ # Subscription
2
+
3
+ ## The Subscription Object
4
+
5
+ ### Example Response
6
+
7
+ ```ruby
8
+ #<Checkr::Subscription:0x3fd909a8a1ac id=ef7972ff5ea65dcb47214143> JSON: {
9
+ "status": "active",
10
+ "values": null,
11
+ "canceled_at": null,
12
+ "package": "driver_plus",
13
+ "interval_count": 1,
14
+ "interval_unit": "month",
15
+ "start_date": "2017-02-10",
16
+ "candidate": {"documents":{"object":"list","data":[]},"id":"e44aa283528e6fde7d542194"},
17
+ "id": "ef7972ff5ea65dcb47214143",
18
+ "object": "test_subscription",
19
+ "uri": "/v1/subscriptions/ef7972ff5ea65dcb47214143",
20
+ "created_at": "2015-03-24T20:55:30Z"
21
+ }
22
+ ```
23
+
24
+
25
+
26
+ ## Create a new Subscription
27
+
28
+ ### Definition
29
+
30
+ ```ruby
31
+ Checkr::Subscription.create
32
+ ```
33
+
34
+ ### Example Request
35
+
36
+ ```ruby
37
+ require 'checkr' # Note the gem is named checkr-official
38
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
39
+
40
+ candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
41
+ subscription = Checkr::Subscription.create({
42
+ :package => "driver_plus",
43
+ :start_date => "2017-02-10",
44
+ :interval_unit => "month",
45
+ :interval_count => 1,
46
+ :candidate_id => candidate.id
47
+ })
48
+ ```
49
+
50
+ ### Example Response
51
+
52
+ ```ruby
53
+ #<Checkr::Subscription:0x3fd909a8a1ac id=ef7972ff5ea65dcb47214143> JSON: {
54
+ "status": "active",
55
+ "values": null,
56
+ "canceled_at": null,
57
+ "package": "driver_plus",
58
+ "interval_count": 1,
59
+ "interval_unit": "month",
60
+ "start_date": "2017-02-10",
61
+ "candidate": {"documents":{"object":"list","data":[]},"id":"e44aa283528e6fde7d542194"},
62
+ "id": "ef7972ff5ea65dcb47214143",
63
+ "object": "test_subscription",
64
+ "uri": "/v1/subscriptions/ef7972ff5ea65dcb47214143",
65
+ "created_at": "2015-03-24T20:55:30Z"
66
+ }
67
+ ```
68
+
69
+
70
+
71
+ ## Retrieve an existing Subscription
72
+
73
+ ### Definition
74
+
75
+ ```ruby
76
+ Checkr::Subscription.retrieve({SUBSCRIPTION_ID})
77
+ ```
78
+
79
+ ### Example Request
80
+
81
+ ```ruby
82
+ require 'checkr' # Note the gem is named checkr-official
83
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
84
+
85
+ subscription = Checkr::Subscription.retrieve("ef7972ff5ea65dcb47214143")
86
+ ```
87
+
88
+ ### Example Response
89
+
90
+ ```ruby
91
+ #<Checkr::Subscription:0x3fd90a1309ac id=ef7972ff5ea65dcb47214143> JSON: {
92
+ "status": "active",
93
+ "values": null,
94
+ "canceled_at": null,
95
+ "package": "driver_plus",
96
+ "interval_count": 1,
97
+ "interval_unit": "month",
98
+ "start_date": "2017-02-10",
99
+ "candidate": {"documents":{"object":"list","data":[]},"id":"e44aa283528e6fde7d542194"},
100
+ "id": "ef7972ff5ea65dcb47214143",
101
+ "object": "test_subscription",
102
+ "uri": "/v1/subscriptions/ef7972ff5ea65dcb47214143",
103
+ "created_at": "2015-03-24T20:55:30Z"
104
+ }
105
+ ```
106
+
107
+ ## Cancel an existing Subscription
108
+
109
+ ### Definition
110
+
111
+ ```ruby
112
+ subscription = Checkr::Subscription.retrieve({SUBSCRIPTION_ID})
113
+ subscription.cancel
114
+ ```
115
+
116
+ ### Example Request
117
+
118
+ ```ruby
119
+ require 'checkr' # Note the gem is named checkr-official
120
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
121
+
122
+ subscription = Checkr::Subscription.retrieve("ef7972ff5ea65dcb47214143")
123
+ subscription.cancel
124
+ ```
125
+
126
+ ### Example Response
127
+
128
+ ```ruby
129
+ #<Checkr::Subscription:0x3fd909a9c370 id=ef7972ff5ea65dcb47214143> JSON: {
130
+ "status": "inactive",
131
+ "values": null,
132
+ "canceled_at": "2015-03-24T20:57:43Z",
133
+ "package": "driver_plus",
134
+ "interval_count": 1,
135
+ "interval_unit": "month",
136
+ "start_date": "2017-02-10",
137
+ "candidate": {"documents":{"object":"list","data":[]},"id":"e44aa283528e6fde7d542194"},
138
+ "id": "ef7972ff5ea65dcb47214143",
139
+ "object": "test_subscription",
140
+ "uri": "/v1/subscriptions/ef7972ff5ea65dcb47214143",
141
+ "created_at": "2015-03-24T20:55:30Z"
142
+ }
143
+ ```
data/samples/terrorist_watchlist_search.md ADDED
@@ -0,0 +1,118 @@
1
+ # Terrorist Watchlist Search
2
+
3
+ ## The Terrorist Watchlist Search Object
4
+
5
+ ### Example Response
6
+
7
+ ```ruby
8
+ #<Checkr::TerroristWatchlistSearch:0x3fd909b9dc24 id=539fd88c101897f7cd000008> JSON: {
9
+ "status": "consider",
10
+ "completed_at": "2014-01-18T12:35:30Z",
11
+ "turnaround_time": 90,
12
+ "records": [
13
+ {
14
+ "case_number": "24323-DA",
15
+ "file_date": null,
16
+ "arresting_agency": "DEA Boston Division",
17
+ "court_jurisdiction": null,
18
+ "court_of_record": null,
19
+ "dob": "1970-01-22",
20
+ "full_name": "John Alfred Smith",
21
+ "additional_info": null,
22
+ "charges": [
23
+ {
24
+ "charge": "RICO murder",
25
+ "charge_type": null,
26
+ "charge_id": null,
27
+ "classification": "Felony",
28
+ "deposition": null,
29
+ "defendant": null,
30
+ "plaintiff": null,
31
+ "sentence": "Active Punishment Minimum: 10Y",
32
+ "disposition": "Guilty",
33
+ "notes": null,
34
+ "probation_status": null,
35
+ "offense_date": "2011-04-22",
36
+ "deposition_date": "2014-05-27",
37
+ "arrest_date": null,
38
+ "charge_date": null,
39
+ "sentence_date": null,
40
+ "disposition_date": "2011-06-02",
41
+ "additional_info": null
42
+ }
43
+ ]
44
+ }
45
+ ],
46
+ "id": "539fd88c101897f7cd000008",
47
+ "object": "terrorist_watchlist_search",
48
+ "uri": "/v1/terrorist_watchlist_searches/539fd88c101897f7cd000008",
49
+ "created_at": "2014-01-18T12:34:00Z"
50
+ }
51
+ ```
52
+
53
+
54
+
55
+ ## Retrieve an existing Terrorist Watchlist Search
56
+
57
+ ### Definition
58
+
59
+ ```ruby
60
+ Checkr::TerroristWatchlistSearch.retrieve({TERRORIST_WATCHLIST_SEARCH_ID})
61
+ ```
62
+
63
+ ### Example Request
64
+
65
+ ```ruby
66
+ require 'checkr' # Note the gem is named checkr-official
67
+ Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
68
+
69
+ tws = Checkr::TerroristWatchlistSearch.retrieve("539fd88c101897f7cd000008")
70
+ ```
71
+
72
+ ### Example Response
73
+
74
+ ```ruby
75
+ #<Checkr::TerroristWatchlistSearch:0x3fd909b9dc24 id=539fd88c101897f7cd000008> JSON: {
76
+ "status": "consider",
77
+ "completed_at": "2014-01-18T12:35:30Z",
78
+ "turnaround_time": 90,
79
+ "records": [
80
+ {
81
+ "case_number": "24323-DA",
82
+ "file_date": null,
83
+ "arresting_agency": "DEA Boston Division",
84
+ "court_jurisdiction": null,
85
+ "court_of_record": null,
86
+ "dob": "1970-01-22",
87
+ "full_name": "John Alfred Smith",
88
+ "additional_info": null,
89
+ "charges": [
90
+ {
91
+ "charge": "RICO murder",
92
+ "charge_type": null,
93
+ "charge_id": null,
94
+ "classification": "Felony",
95
+ "deposition": null,
96
+ "defendant": null,
97
+ "plaintiff": null,
98
+ "sentence": "Active Punishment Minimum: 10Y",
99
+ "disposition": "Guilty",
100
+ "notes": null,
101
+ "probation_status": null,
102
+ "offense_date": "2011-04-22",
103
+ "deposition_date": "2014-05-27",
104
+ "arrest_date": null,
105
+ "charge_date": null,
106
+ "sentence_date": null,
107
+ "disposition_date": "2011-06-02",
108
+ "additional_info": null
109
+ }
110
+ ]
111
+ }
112
+ ],
113
+ "id": "539fd88c101897f7cd000008",
114
+ "object": "terrorist_watchlist_search",
115
+ "uri": "/v1/terrorist_watchlist_searches/539fd88c101897f7cd000008",
116
+ "created_at": "2014-01-18T12:34:00Z"
117
+ }
118
+ ```