checkr-official 1.5.4 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 75c06d4b9b7ca0f7e10ea7dacda6b01391bf5f324f4d32a5824d253b06040b25
-  data.tar.gz: e585ca7f37af58ba98da2e1c4c04af6207d4a32a07130ea0ad06e7e2208bed67
+SHA1:
+  metadata.gz: 2bb95db1be17c9c05e0f7eb6d0b5c59aa55364d2
+  data.tar.gz: 325812ecf94da8c71d312ed9e69c68f6cb831cd0
 SHA512:
-  metadata.gz: d8f3a05d1d15e60cbb69f30a6b31335a1540f4d40a468abc8e3a986e11da5ede73bba7496e3c7724c1049d863d3af2bd75e0fd131d9ff987c468c18e31bf3fcf
-  data.tar.gz: aa1c480c462230f8f9b1865ea499ad7cfa460a0b163f6424938794cc56243e7b4faa0cbceef137c0a535e3e33ad6df670025d7e39ca8bce7bd4b907e85756e93
+  metadata.gz: e42cb13af6da89f838ba1266ed3bdd1676e65ee818b84f3083e9818ae8071e0ffb3f66f9fde795b5366c505772c6f9f3d2f71a48c592a8aa1f465d13b074094b
+  data.tar.gz: 2a99458a7b72b23f518923d5307333c63ca34c51b375c42ee9d11d14b6b6e419476fb47f9f04cc1c2a64d4cbca5b78d239a0add2f7d6afc8c3b9d5b39222e2e2

data/Changelog.md

@@ -1,3 +1,8 @@
+## 1.6 (2019-05-20)
+
+- Add State CriminalSearch
+- Add Employment Verification
+
 ## v1.5.4 (2018-12-10)
 
 - Add ability to pass api key to individual API method calls
@@ -20,8 +25,8 @@ Fixes:
 
 Features:
 
-- Add FederalCivilSearch
-- Add FederalCriminalSearch
+- Add Federal Civil Search
+- Add Federal Criminal Search
 
 ## v1.5.0 (2018-02-2)
 

data/lib/checkr.rb

@@ -23,6 +23,7 @@ require 'checkr/county_criminal_search'
 require 'checkr/document'
 require 'checkr/document_list'
 require 'checkr/education_verification'
+require 'checkr/employment_verification'
 require 'checkr/eviction_search'
 require 'checkr/federal_civil_search'
 require 'checkr/federal_criminal_search'
@@ -37,6 +38,7 @@ require 'checkr/report'
 require 'checkr/report_list'
 require 'checkr/sex_offender_search'
 require 'checkr/ssn_trace'
+require 'checkr/state_criminal_search'
 require 'checkr/subscription'
 require 'checkr/verification'
 require 'checkr/verification_list'

data/lib/checkr/employment_verification.rb

@@ -0,0 +1,18 @@
+module Checkr
+  class EmploymentVerification < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :records
+
+    api_class_method :retrieve, :get, ':path/:id', arguments: [:id]
+
+    def self.path
+      '/v1/employment_verifications'
+    end
+
+    APIClass.register_subclass(self, 'employment_verification')
+
+  end
+end

data/lib/checkr/report.rb

@@ -29,6 +29,9 @@ module Checkr
     attribute :county_criminal_searches, APIList.constructor(:CountyCriminalSearch)
     attribute_writer_alias :county_criminal_search_ids, :county_criminal_searches
 
+    attribute :state_criminal_searches, APIList.constructor(:StateCriminalSearch)
+    attribute_writer_alias :state_criminal_search_ids, :state_criminal_searches
+
     attribute :federal_criminal_search, :FederalCriminalSearch
     attribute_writer_alias :federal_criminal_search_ids, :federal_criminal_search
 
@@ -50,6 +53,9 @@ module Checkr
     attribute :education_verification, :EducationVerification
     attribute_writer_alias :education_verification_id, :education_verification
 
+    attribute :employment_verification, :EmploymentVerification
+    attribute_writer_alias :employment_verification_id, :employment_verification
+
     api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
     api_class_method :create, :post
 

data/lib/checkr/state_criminal_search.rb

@@ -0,0 +1,22 @@
+module Checkr
+  class StateCriminalSearch < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :state
+    attribute :records
+    attribute :filtered_by_positive_adjudication_records
+    attribute :estimated_completion_date
+    attribute :estimated_completion_time
+
+    api_class_method :retrieve, :get, ':path/:id', arguments: [:id]
+
+    def self.path
+      '/v1/state_criminal_searches'
+    end
+
+    APIClass.register_subclass(self, 'state_criminal_search')
+
+  end
+end

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = '1.5.4'.freeze
+  VERSION = '1.6'.freeze
 end

data/samples/state_criminal_search.md

@@ -0,0 +1,59 @@
+# State Criminal Search
+
+## The State Criminal Search Object
+
+### Example Response
+
+```ruby
+#<Checkr::StateCriminalSearch:0x3fd909bcd974 id=539fdcf335644a0ef4000001> JSON: {
+  "status": "pending",
+  "completed_at": "2019-05-14T19:43:32Z",
+  "turnaround_time": 455685,
+  "state": "CA",
+  "records": [],
+  "id": "539fdcf335644a0ef4000001",
+  "object": "test_state_criminal_search",
+  "uri": "/v1/state_criminal_searches/539fdcf335644a0ef4000001",
+  "created_at": "2014-06-17T06:15:47Z",
+  "estimated_completion_time": "2019-05-09T21:40:45Z",
+  "estimated_completion_date": "2019-05-10",
+  "filtered_by_positive_adjudication_records": []
+}
+```
+
+
+## Retrieve an existing State Criminal Search
+
+### Definition
+
+```ruby
+Checkr::StateCriminalSearch.retrieve({STATE_CRIMINAL_SEARCH_ID})
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+ccs = Checkr::StateCriminalSearch.retrieve("539fdcf335644a0ef4000001")
+```
+
+### Example Response
+
+```ruby
+#<Checkr::StateCriminalSearch:0x3fd909bcd974 id=539fdcf335644a0ef4000001> JSON: {
+  "status": "pending",
+  "completed_at": "2019-05-14T19:43:32Z",
+  "turnaround_time": 455685,
+  "state": "CA",
+  "records": [],
+  "id": "539fdcf335644a0ef4000001",
+  "object": "test_state_criminal_search",
+  "uri": "/v1/state_criminal_searches/539fdcf335644a0ef4000001",
+  "created_at": "2014-06-17T06:15:47Z",
+  "estimated_completion_time": "2019-05-09T21:40:45Z",
+  "estimated_completion_date": "2019-05-10",
+  "filtered_by_positive_adjudication_records": []
+}
+```

data/test/checkr/employment_verification_test.rb

@@ -0,0 +1,80 @@
+require File.expand_path('../test_helper', __dir__)
+
+module Checkr
+  class EmploymentVerificationTest < Test::Unit::TestCase
+
+    setup do
+      @employment_verification_url = "#{Checkr.api_base}/v1/employment_verifications"
+    end
+
+    context 'EmploymentVerification class' do
+      should 'be retrieveable' do
+        id = 'employment_verification_id'
+        @mock.expects(:get).once.with("#{@employment_verification_url}/#{id}", anything, anything)
+          .returns(test_response(test_employment_verification))
+        employment_verification = EmploymentVerification.retrieve(id)
+        assert(employment_verification.is_a?(EmploymentVerification))
+      end
+    end
+
+    context 'EmploymentVerification instance' do
+      should 'be refreshable' do
+        @mock.expects(:get).once
+          .with("#{@employment_verification_url}/#{test_employment_verification[:id]}",
+                anything, anything)
+          .returns(test_response(test_employment_verification))
+        employment_verification = EmploymentVerification.new(test_employment_verification[:id])
+        employment_verification.refresh
+        assert_equal(test_employment_verification[:status], employment_verification.status)
+      end
+    end
+
+    context 'Retrieved EmploymentVerification instance' do
+      setup do
+        @mock.expects(:get).once.returns(test_response(test_employment_verification))
+        @employment_verification = EmploymentVerification.retrieve('employment_verification_id')
+      end
+
+      should 'have the id attribute' do
+        assert_equal(test_employment_verification[:id], @employment_verification.id)
+      end
+
+      should 'have the object attribute' do
+        assert_equal(test_employment_verification[:object], @employment_verification.object)
+      end
+
+      should 'have the uri attribute' do
+        assert_equal(test_employment_verification[:uri], @employment_verification.uri)
+      end
+
+      should 'have the status attribute' do
+        assert_equal(test_employment_verification[:status], @employment_verification.status)
+      end
+
+      should 'have the created_at attribute' do
+        assert_equal(test_employment_verification[:created_at],
+                     @employment_verification.created_at)
+      end
+
+      should 'have the completed_at attribute' do
+        assert_equal(test_employment_verification[:completed_at],
+                     @employment_verification.completed_at)
+      end
+
+      should 'have the turnaround_time attribute' do
+        assert_equal(test_employment_verification[:turnaround_time],
+                     @employment_verification.turnaround_time)
+      end
+
+      should 'have the records attribute' do
+        assert_equal(test_employment_verification[:records], @employment_verification.records)
+      end
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(EmploymentVerification))
+      assert_equal(EmploymentVerification, APIClass.subclass_fetch('employment_verification'))
+    end
+
+  end
+end

data/test/checkr/state_criminal_search_test.rb

@@ -0,0 +1,82 @@
+require File.expand_path('../test_helper', __dir__)
+
+module Checkr
+  class StateCriminalSearchTest < Test::Unit::TestCase
+
+    setup do
+      @state_criminal_search_url = "#{Checkr.api_base}/v1/state_criminal_searches"
+    end
+
+    context 'StateCriminalSearch class' do
+      should 'be retrieveable' do
+        id = 'state_criminal_search_id'
+        @mock.expects(:get).once.with("#{@state_criminal_search_url}/#{id}", anything, anything)
+          .returns(test_response(test_state_criminal_search))
+        state_criminal_search = StateCriminalSearch.retrieve(id)
+        assert(state_criminal_search.is_a?(StateCriminalSearch))
+      end
+    end
+
+    context 'StateCriminalSearch instance' do
+      should 'be refreshable' do
+        @mock.expects(:get).once
+          .with("#{@state_criminal_search_url}/#{test_state_criminal_search[:id]}",
+                anything, anything)
+          .returns(test_response(test_state_criminal_search))
+        state_criminal_search = StateCriminalSearch.new(test_state_criminal_search[:id])
+        state_criminal_search.refresh
+        assert_equal(test_state_criminal_search[:status], state_criminal_search.status)
+      end
+    end
+
+    context 'Retrieved StateCriminalSearch instance' do
+      setup do
+        @mock.expects(:get).once.returns(test_response(test_state_criminal_search))
+        @state_criminal_search = StateCriminalSearch.retrieve('state_criminal_search_id')
+      end
+
+      should 'have the id attribute' do
+        assert_equal(test_state_criminal_search[:id], @state_criminal_search.id)
+      end
+
+      should 'have the object attribute' do
+        assert_equal(test_state_criminal_search[:object], @state_criminal_search.object)
+      end
+
+      should 'have the uri attribute' do
+        assert_equal(test_state_criminal_search[:uri], @state_criminal_search.uri)
+      end
+
+      should 'have the status attribute' do
+        assert_equal(test_state_criminal_search[:status], @state_criminal_search.status)
+      end
+
+      should 'have the created_at attribute' do
+        assert_equal(test_state_criminal_search[:created_at], @state_criminal_search.created_at)
+      end
+
+      should 'have the completed_at attribute' do
+        assert_equal(test_state_criminal_search[:completed_at], @state_criminal_search.completed_at)
+      end
+
+      should 'have the turnaround_time attribute' do
+        assert_equal(test_state_criminal_search[:turnaround_time],
+                     @state_criminal_search.turnaround_time)
+      end
+
+      should 'have the state attribute' do
+        assert_equal(test_state_criminal_search[:state], @state_criminal_search.state)
+      end
+
+      should 'have the records attribute' do
+        assert_equal(test_state_criminal_search[:records], @state_criminal_search.records)
+      end
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(StateCriminalSearch))
+      assert_equal(StateCriminalSearch, APIClass.subclass_fetch('state_criminal_search'))
+    end
+
+  end
+end

data/test/test_data.rb

@@ -380,6 +380,22 @@ module Checkr
              :disposition_date=>"2011-06-02"}]}]}
     end
 
+    def test_state_criminal_search
+      { id: "5cd4265fd46fcf0001c6b8f3",
+        object: "state_criminal_search",
+        uri: "/v1/state_criminal_searches/5cd4265fd46fcf0001c6b8f3",
+        status: "clear",
+        state: "NY",
+        created_at: "2019-05-09T13:08:47Z",
+        completed_at: "2019-05-14T19:43:32Z",
+        turnaround_time: 455685,
+        estimated_completion_time: "2019-05-09T21:40:45Z",
+        estimated_completion_date: "2019-05-10",
+        records: [],
+        filtered_by_positive_adjudication_records: []
+      }
+    end
+
     def test_invitation
       { id: '2c8447d8c35761ad8f70d9d3',
         status: 'pending',
@@ -530,6 +546,17 @@ module Checkr
        :records => []}
     end
 
+    def test_employment_verification
+      { id: "5cd42657682ee80028cece4c",
+        object: "employment_verification",
+        uri: "/v1/employment_verifications/5cd42657682ee80028cece4c",
+        status: "clear",
+        created_at: "2019-05-09T13:08:39Z",
+        completed_at: "2019-05-13T12:50:47Z",
+        turnaround_time: 344528,
+        records: [] }
+    end
+
     # Errors
     def test_api_error
       {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: '1.6'
 platform: ruby
 authors:
 - Checkr Engineering Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -151,6 +151,7 @@ files:
 - lib/checkr/document.rb
 - lib/checkr/document_list.rb
 - lib/checkr/education_verification.rb
+- lib/checkr/employment_verification.rb
 - lib/checkr/errors/api_connection_error.rb
 - lib/checkr/errors/api_error.rb
 - lib/checkr/errors/authentication_error.rb
@@ -171,6 +172,7 @@ files:
 - lib/checkr/screening.rb
 - lib/checkr/sex_offender_search.rb
 - lib/checkr/ssn_trace.rb
+- lib/checkr/state_criminal_search.rb
 - lib/checkr/subscription.rb
 - lib/checkr/util.rb
 - lib/checkr/verification.rb
@@ -178,7 +180,7 @@ files:
 - lib/checkr/version.rb
 - mclovin.jpg
 - samples/candidate.md
-- samples/country_criminal_search.md
+- samples/county_criminal_search.md
 - samples/document.md
 - samples/geo.md
 - samples/global_watchlist_search.md
@@ -188,6 +190,7 @@ files:
 - samples/report.md
 - samples/sex_offender_search.md
 - samples/ssn_trace.md
+- samples/state_criminal_search.md
 - samples/subscription.md
 - tasks/api_test.rb
 - test/checkr/api_class_test.rb
@@ -200,6 +203,7 @@ files:
 - test/checkr/document_list_test.rb
 - test/checkr/document_test.rb
 - test/checkr/education_verification_test.rb
+- test/checkr/employment_verification_test.rb
 - test/checkr/eviction_search_test.rb
 - test/checkr/federal_civil_search_test.rb
 - test/checkr/federal_criminal_search_test.rb
@@ -213,6 +217,7 @@ files:
 - test/checkr/report_test.rb
 - test/checkr/sex_offender_search_test.rb
 - test/checkr/ssn_trace_test.rb
+- test/checkr/state_criminal_search_test.rb
 - test/checkr/status_codes_test.rb
 - test/checkr/subscription_test.rb
 - test/checkr/util_test.rb
@@ -241,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API
@@ -256,6 +261,7 @@ test_files:
 - test/checkr/document_list_test.rb
 - test/checkr/document_test.rb
 - test/checkr/education_verification_test.rb
+- test/checkr/employment_verification_test.rb
 - test/checkr/eviction_search_test.rb
 - test/checkr/federal_civil_search_test.rb
 - test/checkr/federal_criminal_search_test.rb
@@ -269,6 +275,7 @@ test_files:
 - test/checkr/report_test.rb
 - test/checkr/sex_offender_search_test.rb
 - test/checkr/ssn_trace_test.rb
+- test/checkr/state_criminal_search_test.rb
 - test/checkr/status_codes_test.rb
 - test/checkr/subscription_test.rb
 - test/checkr/util_test.rb