checkr-official 1.6 → 1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bb95db1be17c9c05e0f7eb6d0b5c59aa55364d2
-  data.tar.gz: 325812ecf94da8c71d312ed9e69c68f6cb831cd0
+  metadata.gz: 419e5c8590cb5750264886e813b59c9ff657822c
+  data.tar.gz: 39e5119e18ee5fae44a5860e6a1047478fd02107
 SHA512:
-  metadata.gz: e42cb13af6da89f838ba1266ed3bdd1676e65ee818b84f3083e9818ae8071e0ffb3f66f9fde795b5366c505772c6f9f3d2f71a48c592a8aa1f465d13b074094b
-  data.tar.gz: 2a99458a7b72b23f518923d5307333c63ca34c51b375c42ee9d11d14b6b6e419476fb47f9f04cc1c2a64d4cbca5b78d239a0add2f7d6afc8c3b9d5b39222e2e2
+  metadata.gz: de81030f52a846f734c189af6e67b158345fc9e868e0e57e47b25feeb0e5972e268062048723790a73edddb3d139fff80428a892e9aa1a10e21f33ac70bc53fa
+  data.tar.gz: 48c1a067f7eb082670ff9d4ffcf036bc35c1f61bab9103b2a5b96c056f862ad6fbd6ed116af0f718644ad87d9f124460bcef098a06fa00db5aed5197300323e8

data/Changelog.md

@@ -1,6 +1,13 @@
+## 1.6.1 (2019-07-16)
+
+Features:
+
+- Add Adverse Action resource
+- Add Adverse Item resource
+
 ## 1.6 (2019-05-20)
 
-- Add State CriminalSearch
+- Add State Criminal Search
 - Add Employment Verification
 
 ## v1.5.4 (2018-12-10)

data/RELEASE.md

@@ -0,0 +1,20 @@
+# Releasing a new version of checkr-official
+
+## Release process
+
+1. Create a list of all the changes since the prior release
+    1. Compare the latest release to master using
+       https://github.com/checkr/checkr-ruby/compare/`${latest}`...master
+    1. Open the linked pull requests from all the `Merge pull request #...` commits
+    1. For all non-documentation PRs, copy title (including pull request number)
+       into markdown list items
+    1. Sort into logical buckets, like "New", "Improvement", "Fix"
+    1. Reorganize to put the pull request number at the end of the line with author in parenthesis
+1. Ensure there are no breaking changes, or if there are breaking changes you'll need to bump
+   the major version, following [SemVer](https://semver.org/)
+1. Update the version
+    1. Update the constant in `lib/checkr/version.rb`
+    1. Commit and push to your branch
+    1. Get it reviewed and merge to master
+1. Move to master branch and pull last version
+1. Run the `bin/release` script to cut a release

data/bin/release

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+# Usage: bin/release
+# Build the gem, tag master, push it to origin, and then release the package on RubyGems.
+
+set -e
+
+branch="$(git rev-parse --abbrev-ref HEAD)"
+[ "$branch" = "master" ] ||
+  (echo "You are not on master. First push your branch, get your PR reviewed, merge it on Github. "\
+    "Then locally move to master and pull last changes." && exit 1)
+
+version="$(gem build *.gemspec | grep Version: | awk '{print $2}')"
+[ -n "$version" ] || (echo "Version needs to be a number" && exit 1)
+
+echo $version
+git tag "v$version"
+git push origin "v$version"
+gem push *-${version}.gem

data/lib/checkr.rb

@@ -18,6 +18,9 @@ require 'checkr/api_list'
 require 'checkr/util'
 
 # Requires for classes
+require 'checkr/adverse_action'
+require 'checkr/adverse_item'
+require 'checkr/adverse_item_list'
 require 'checkr/candidate'
 require 'checkr/county_criminal_search'
 require 'checkr/document'

data/lib/checkr/adverse_action.rb

@@ -0,0 +1,23 @@
+module Checkr
+  class AdverseAction < APIResource
+    attribute :status
+    attribute :report_id
+    attribute :post_notice_scheduled_at
+    attribute :post_notice_ready_at
+    attribute :canceled_at
+    attribute :individualized_assessment_engaged
+    attribute :adverse_items, APIList.constructor(:AdverseItem)
+
+    api_class_method :create, :post, '/v1/reports/:report_id/adverse_actions'
+    api_class_method :retrieve, :get, ':path/:id', :arguments => [:id]
+    api_class_method :cancel, :delete, ':path/:id', :arguments => [:id]
+
+    api_instance_method :cancel, :delete
+
+    def self.path
+      '/v1/adverse_actions'
+    end
+
+    APIClass.register_subclass(self, 'adverse_action')
+  end
+end

data/lib/checkr/adverse_item.rb

@@ -0,0 +1,9 @@
+module Checkr
+  class AdverseItem < APIResource
+    attribute :text
+
+    api_class_method :all, :get, '/v1/reports/:report_id/adverse_items', :constructor => :AdverseItemList
+
+    APIClass.register_subclass(self, 'adverse_item')
+  end
+end

data/lib/checkr/adverse_item_list.rb

@@ -0,0 +1,24 @@
+module Checkr
+  class AdverseItemList < APIList
+
+    attribute :next_href
+    attribute :previous_href
+    attribute :count
+    attr_accessor :parent
+
+    api_instance_method :all, :get
+
+    def self.construct(json, parent=nil)
+      lambda = constructor(:AdverseItem)
+      instance = lambda.call(json)
+      instance.parent = parent if parent
+      instance.clear_changed_attributes
+      instance
+    end
+
+    def path
+      parent.path + '/adverse_items'
+    end
+
+  end
+end

data/lib/checkr/report.rb

@@ -11,6 +11,9 @@ module Checkr
     attribute :candidate, :Candidate
     attribute_writer_alias :candidate_id, :candidate
 
+    attribute :adverse_items, :AdverseItemList, :nested => true, :default => {}
+    attribute_writer_alias :adverse_item_ids, :adverse_items
+
     attribute :ssn_trace, :SSNTrace
     attribute_writer_alias :ssn_trace_id, :ssn_trace
 

data/lib/checkr/version.rb

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

data/test/checkr/adverse_action_test.rb

@@ -0,0 +1,91 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Checkr
+  class AdverseActionTest < Test::Unit::TestCase
+    setup do
+      @adverse_action_url = "#{Checkr.api_base}#{AdverseAction.path}"
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(AdverseAction))
+      assert_equal(AdverseAction, APIClass.subclass_fetch('adverse_action'))
+    end
+
+    context 'Constructed AdverseAction instance' do
+      setup do
+        @adverse_action = AdverseAction.construct(test_adverse_action)
+      end
+
+      [
+        :id,
+        :object,
+        :uri,
+        :created_at,
+        :status,
+        :report_id,
+        :post_notice_scheduled_at,
+        :post_notice_ready_at,
+        :canceled_at,
+        :individualized_assessment_engaged,
+      ].each do |attribute|
+        should "have the #{attribute.to_s} attribute" do
+          assert_equal(test_adverse_action[attribute], @adverse_action.public_send(attribute))
+        end
+      end
+    end
+
+    context '.create' do
+      setup do
+        @report = Report.construct(test_report)
+        @create_url = "#{Checkr.api_base}#{Report.path}/#{@report.id}/adverse_actions"
+      end
+
+      should 'creates an instance of AdverseAction' do
+        @mock.expects(:post).once.with(@create_url, anything, anything)
+            .returns(test_response(test_adverse_action))
+
+        adverse_action = AdverseAction.create({ :report_id => @report.id })
+
+        assert(adverse_action.is_a?(AdverseAction))
+        assert_equal(test_adverse_action[:id], adverse_action.id)
+      end
+    end
+
+    context '.retrieve' do
+      setup do
+        @id = test_adverse_action[:id]
+        @retrieve_url = "#{Checkr.api_base}#{AdverseAction.path}/#{@id}"
+      end
+
+      should 'fetches an instance of AdverseAction' do
+        @mock.expects(:get).once.with(@retrieve_url, anything, anything)
+          .returns(test_response(test_adverse_action))
+
+        adverse_action = AdverseAction.retrieve(@id)
+
+        assert(adverse_action.is_a?(AdverseAction))
+        assert_equal(@id, adverse_action.id)
+      end
+    end
+
+    context '#cancel/.cancel' do
+      setup do
+        @id = test_adverse_action[:id]
+        @cancel_url = "#{Checkr.api_base}#{AdverseAction.path}/#{@id}"
+      end
+
+      should 'cancels an instance of AdverseAction' do
+        @mock.expects(:delete).twice.with(@cancel_url, anything, anything)
+          .returns(test_response(test_adverse_action))
+
+        adverse_action = AdverseAction.cancel(@id)
+        assert(adverse_action.is_a?(AdverseAction))
+        assert_equal(@id, adverse_action.id)
+
+        adverse_action = AdverseAction.new(@id).cancel
+        assert(adverse_action.is_a?(AdverseAction))
+        assert_equal(@id, adverse_action.id)
+      end
+    end
+  end
+end

data/test/checkr/adverse_item_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Checkr
+  class AdverseItemTest < Test::Unit::TestCase
+    setup do
+      @report = Report.construct(test_report)
+      @adverse_item_url = "#{Checkr.api_base}#{@report.path}/adverse_items"
+    end
+
+    context 'Constructed AdverseItem instance' do
+      setup do
+        @adverse_item = AdverseItem.construct(test_adverse_item)
+      end
+
+      [
+        :id,
+        :object,
+        :uri,
+        :created_at,
+        :text,
+      ].each do |attribute|
+        should "have the #{attribute.to_s} attribute" do
+          assert_equal(test_adverse_item[attribute], @adverse_item.public_send(attribute))
+        end
+      end
+    end
+
+    context '.all' do
+      should 'return instances of AdverseItem' do
+        @mock.expects(:get).once.with do |url, params, opts|
+          url.start_with?(@adverse_item_url)
+        end.returns(test_response(test_adverse_item_list))
+
+        adverse_items = AdverseItem.all({ :report_id => @report.id })
+
+        assert(adverse_items.is_a?(AdverseItemList))
+        assert(adverse_items.length > 0)
+        adverse_items.each do |adverse_item|
+          assert(adverse_item.is_a?(AdverseItem))
+        end
+      end
+    end
+
+    should 'be registered' do
+      assert(APIClass.subclasses.include?(AdverseItem))
+      assert_equal(AdverseItem, APIClass.subclass_fetch('adverse_item'))
+    end
+  end
+end

data/test/test_data.rb

@@ -513,6 +513,7 @@ module Checkr
        :type=>"driver_license",
        :content_type=>"image/jpeg"}
     end
+
     def test_document_list
       {
         :object => 'list',
@@ -528,6 +529,7 @@ module Checkr
        :verification_url=>"http://verifications.checkr.com/db313e73383710d4fa2f18fd",
        :completed_at=>nil}
     end
+
     def test_verification_list
       {
         :object => 'list',
@@ -535,6 +537,46 @@ module Checkr
       }
     end
 
+    def test_adverse_item
+      {
+        :id => '71c0c2c79349c9f899bda22d3ccf60b7e0469266',
+        :object => 'adverse_item',
+        :text => 'License status: Suspended',
+      }
+    end
+
+    def test_adverse_item_list
+      {
+        :object => 'list',
+        :count => 2,
+        :data => [test_adverse_item, test_adverse_item],
+      }
+    end
+
+    def test_adverse_action
+      {
+        :id => '5d0af2cdfccff00034be49e9',
+        :object => 'adverse_action',
+        :uri => '/v1/adverse_actions/5d0af2cdfccff00034be49e9',
+        :created_at => '2019-06-20T02:43:25Z',
+        :status => 'pending',
+        :report_id => 'd36abda710bde8fd2c9d2587',
+        :post_notice_scheduled_at => '2019-06-27T02:43:25Z',
+        :post_notice_ready_at => '2019-06-27T02:43:25Z',
+        :canceled_at => nil,
+        :individualized_assessment_engaged => false,
+        :adverse_items => test_adverse_item_list,
+      }
+    end
+
+    def test_adverse_action_list
+      {
+        :object => 'list',
+        :count => 2,
+        :data => [test_adverse_action, test_adverse_action],
+      }
+    end
+
     def test_education_verification
       {:id => "5af5e030d24297006cce1e06",
        :object => "education_verification",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: '1.6'
+  version: '1.7'
 platform: ruby
 authors:
 - Checkr Engineering Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -128,6 +128,7 @@ email:
 - eng@checkr.com
 executables:
 - checkr-console
+- release
 extensions: []
 extra_rdoc_files: []
 files:
@@ -138,10 +139,15 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RELEASE.md
 - Rakefile
 - bin/checkr-console
+- bin/release
 - checkr-official.gemspec
 - lib/checkr.rb
+- lib/checkr/adverse_action.rb
+- lib/checkr/adverse_item.rb
+- lib/checkr/adverse_item_list.rb
 - lib/checkr/api_class.rb
 - lib/checkr/api_list.rb
 - lib/checkr/api_resource.rb
@@ -193,6 +199,8 @@ files:
 - samples/state_criminal_search.md
 - samples/subscription.md
 - tasks/api_test.rb
+- test/checkr/adverse_action_test.rb
+- test/checkr/adverse_item_test.rb
 - test/checkr/api_class_test.rb
 - test/checkr/api_list_test.rb
 - test/checkr/api_resource_test.rb
@@ -246,11 +254,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API
 test_files:
+- test/checkr/adverse_action_test.rb
+- test/checkr/adverse_item_test.rb
 - test/checkr/api_class_test.rb
 - test/checkr/api_list_test.rb
 - test/checkr/api_resource_test.rb