checkr-official 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e160c7bd357550623cb71709142c66b23920d645
-  data.tar.gz: 5be13eaea8677719e1932ae6fa0248cdbf3a3b33
+  metadata.gz: 3f6f8e7728235f664dd469823cba36fb43579c62
+  data.tar.gz: ce422753b6aa3970255925acd63e842289bad87d
 SHA512:
-  metadata.gz: d13cfed1b9ae41f54f219b3f9be54599917369dd78a0a8f4763b33b8c14a5fdc13aa375015a4156be82d929f1372f74fc304dab015779d23d36c671aed433e0d
-  data.tar.gz: 3d3fca9ae636b4eaed8fc06334d20f282be60aeecd3c0b3c5020ae220c05d02ea00fb0caec979aa402d08befcbed7ad6923339a81d72d727a6aed89661e761ef
+  metadata.gz: 00b977c5fda42d85f1ebcdeea088499c8ee462c74148d15639d953eea6e6e7ffc19ababc88c544dd1fcb72aab82c1de4460b707ca674360e2c74de681af51feb
+  data.tar.gz: b2795ecaf64392d8bf4c0e40bf79d2422d8f530bb484247ff9d876cbb394089a6bf408a5878af009e4871534b2699a8fb6b2df07ba4b0cd5c400119eb771ccd4

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  Include:
+    - 'config.ru'
+    - 'Rakefile'
+  Exclude:
+    - 'Gemfile'
+    - 'bin/**/*'
+    - 'data/**/*'
+    - 'db/schema.rb'
+    - 'vendor/**/*'
+  DisplayCopNames: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Max: 100
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/Changelog.md

@@ -1,3 +1,14 @@
+## 1.2.0 (2017-04-14)
+
+Features:
+
+ - Add Invitation
+
+Fixes:
+
+ - Add `document_ids` to Candidate
+ - Doc links
+
 ## 1.1.2 (2017-01-05)
 
 Fixes:
@@ -8,7 +19,7 @@ Fixes:
 
 Features:
 
-  - Add support for Candidate.no_middle_name flag (#8)
+  - Add support for `Candidate#no_middle_name` flag (#8)
   - Add Documents to Report (@sico, #12)
 
 ## 1.1.0 (2016-03-03)

data/lib/checkr.rb

@@ -1,5 +1,5 @@
 # Checkr Ruby bindings
-# API spec at https://checkr.com/docs/api
+# API spec at https://docs.checkr.com
 require 'cgi'
 require 'set'
 require 'openssl'
@@ -22,7 +22,10 @@ require 'checkr/candidate'
 require 'checkr/county_criminal_search'
 require 'checkr/document'
 require 'checkr/document_list'
+require 'checkr/eviction_search'
 require 'checkr/geo'
+require 'checkr/global_watchlist_search'
+require 'checkr/invitation'
 require 'checkr/motor_vehicle_report'
 require 'checkr/national_criminal_search'
 require 'checkr/report'
@@ -30,8 +33,6 @@ require 'checkr/report_list'
 require 'checkr/sex_offender_search'
 require 'checkr/ssn_trace'
 require 'checkr/subscription'
-require 'checkr/global_watchlist_search'
-require 'checkr/eviction_search'
 
 # Errors
 require 'checkr/errors/checkr_error'
@@ -151,14 +152,14 @@ module Checkr
       raise AuthenticationError.new('No API key provided. ' +
         'Set your API key using "Checkr.api_key = <API-KEY>". ' +
         'You can generate API keys from the Checkr web interface. ' +
-        'See https://checkr.com/docs#authentication for details, ' +
+        'See https://docs.checkr.com/#authentication for details, ' +
         'or email hello@checkr.com if you have any questions.')
     end
 
     if api_key =~ /\s/
       raise AuthenticationError.new('Your API key is invalid, as it contains ' +
         'whitespace. (HINT: You can double-check your API key from the ' +
-        'Checkr web interface. See https://checkr.com/docs#authentication for details, or ' +
+        'Checkr web interface. See https://docs.checkr.com/#authentication for details, or ' +
         'email hello@checkr.com if you have any questions.)')
     end
   end

data/lib/checkr/api_class.rb

@@ -250,7 +250,6 @@ module Checkr
 
         resp = Checkr.request(method, composed_path, arguments[:params], arguments[:opts])
 
-
         api_lambda_construct(resp, constructor, self)
       end
     end

data/lib/checkr/candidate.rb

@@ -21,6 +21,7 @@ module Checkr
     attribute :geos, APIList.constructor(:Geo)
     attribute_writer_alias :geo_ids, :geos
     attribute :documents, :DocumentList, :nested => true, :default => {}
+    attribute_writer_alias :document_ids, :documents
 
     api_class_method :all, :get, :constructor => APIList.constructor(:Candidate)
     api_class_method :create, :post

data/lib/checkr/invitation.rb

@@ -0,0 +1,28 @@
+module Checkr
+  class Invitation < APIResource
+
+    attribute :uri
+    attribute :invitation_url
+    attribute :status
+    attribute :created_at
+    attribute :expires_at
+    attribute :completed_at
+    attribute :deleted_at
+    attribute :package
+    attribute :candidate, :Candidate
+    attribute_writer_alias :candidate_id, :candidate
+
+    api_class_method :all, :get,
+                     constructor: APIList.constructor(:Invitation)
+    api_class_method :retrieve, :get, ':path/:id', arguments: [:id]
+    api_class_method :create, :post
+    api_class_method :cancel, :delete, ':path/:id', arguments: [:id]
+
+    def self.path
+      '/v1/invitations'
+    end
+
+    APIClass.register_subclass(self, 'invitation')
+
+  end
+end

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/test/checkr/candidate_test.rb

@@ -158,10 +158,15 @@ module Checkr
       end
 
       should 'have the documents attribute' do
-        assert(!@candidate.documents.any?)
+        assert(@candidate.documents.any?)
         assert(@candidate.documents.is_a?(DocumentList))
       end
 
+      should 'have the document_ids attribute' do
+        assert_equal(test_candidate[:document_ids], @candidate.documents.json)
+        assert(@candidate.documents.is_a?(APIList))
+      end
+
     end
 
     should 'be registered' do

data/test/checkr/invitation_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path('../../test_helper', __FILE__)
+require 'active_support'
+require 'active_support/core_ext/object/to_query'
+
+module Checkr
+  class InvitationTest < Test::Unit::TestCase
+
+    setup do
+      @inviation_url = "#{Checkr.api_base}/v1/invitations"
+    end
+
+    context 'Invitation class' do
+      should 'be listable' do
+        params = {
+          candidate_id: '2c8447d8c35761ad8f70d9d3',
+          package: 'mvr'
+        }
+        @mock.expects(:get).once.with("#{@inviation_url}?#{params.to_query}", anything, anything)
+          .returns(test_response([test_invitation]))
+        document = Checkr::Invitation.all(params)
+        assert(document.is_a?(APIList))
+        assert(document.data[0].id, test_invitation[:id])
+      end
+
+      should 'be retrieveable' do
+        id = 'invitation_id'
+        @mock.expects(:get).once.with("#{@inviation_url}/#{id}", anything, anything)
+          .returns(test_response(test_invitation))
+        invitation = Checkr::Invitation.retrieve(id)
+        assert(invitation.is_a?(Invitation))
+        assert(invitation.candidate.is_a?(Candidate))
+      end
+
+      should 'be createable' do
+        @mock.expects(:post).once.with(@inviation_url, anything, test_invitation)
+          .returns(test_response(test_invitation))
+        invitation = Checkr::Invitation.create(test_invitation)
+        assert(invitation.is_a?(Invitation))
+        assert_equal(test_invitation[:id], invitation.id)
+      end
+
+      should 'be cancelable' do
+        id = '2c8447d8c35761ad8f70d9d3'
+        @mock.expects(:delete).once.with("#{@inviation_url}/#{id}", anything, anything)
+          .returns(test_response(test_invitation))
+        invitation = Checkr::Invitation.cancel(test_invitation[:id])
+        assert(invitation.is_a?(Invitation))
+        assert_equal(test_invitation[:id], invitation.id)
+      end
+    end
+
+    context 'Retrieved Invitation instance' do
+      setup do
+        @mock.expects(:get).once.returns(test_response(test_invitation))
+        @invitation = Checkr::Invitation.retrieve('invitation_id')
+      end
+
+      should 'have the id attribute' do
+        assert_equal(test_invitation[:id], @invitation.id)
+      end
+
+      should 'have the status attribute' do
+        assert_equal(test_invitation[:status], @invitation.status)
+      end
+
+      should 'have the uri attribute' do
+        assert_equal(test_invitation[:uri], @invitation.uri)
+      end
+
+      should 'have the invitation_url attribute' do
+        assert_equal(test_invitation[:invitation_url], @invitation.invitation_url)
+      end
+
+      should 'have the completed_at attribute' do
+        assert_equal(test_invitation[:completed_at], @invitation.completed_at)
+      end
+
+      should 'have the deleted_at attribute' do
+        assert_equal(test_invitation[:deleted_at], @invitation.deleted_at)
+      end
+
+      should 'have the expires_at attribute' do
+        assert_equal(test_invitation[:expires_at], @invitation.expires_at)
+      end
+
+      should 'have the package attribute' do
+        assert_equal(test_invitation[:package], @invitation.package)
+      end
+
+      should 'have the object attribute' do
+        assert_equal(test_invitation[:object], @invitation.object)
+      end
+
+      should 'have the created_at attribute' do
+        assert_equal(test_invitation[:created_at], @invitation.created_at)
+      end
+
+      should 'have the candidate_id attribute' do
+        assert_equal(test_invitation[:candidate_id], @invitation.candidate.id)
+        assert(@invitation.candidate.is_a?(Candidate))
+      end
+    end
+
+  end
+end

data/test/test_data.rb

@@ -60,6 +60,8 @@ module Checkr
        :copy_requested=>false,
        :custom_id=>nil,
        :report_ids=>["532e71cfe88a1d4e8d00000d"],
+       :document_ids => ["4722c07dd9a10c3985ae432a"],
+       :invitation_ids => ["2c8447d8c35761ad8f70d9d3"],
        :geo_ids=>["79f943e212cce7de21c054a8", "7299c2c22ebb19abb0688a6c"]}
     end
 
@@ -292,6 +294,21 @@ module Checkr
              :disposition_date=>"2011-06-02"}]}]}
     end
 
+    def test_invitation
+      { id: '2c8447d8c35761ad8f70d9d3',
+        status: 'pending',
+        uri: '/v1/invitations/2c8447d8c35761ad8f70d9d3',
+        invitation_url: 'https://checkr.com/invitations/2c8447d8c35761ad8f70d9d3',
+        completed_at: nil,
+        deleted_at: nil,
+        expires_at: '2015-05-21T17:45:34Z',
+        package: 'mvr',
+        object: 'invitation',
+        created_at: '2015-05-14T17:45:34Z',
+        candidate_id: '0130da24eb04f6f13973b490'
+      }
+    end
+
     def test_motor_vehicle_report
       {:id=>"539fd88c101897f7cd000007",
        :object=>"motor_vehicle_report",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Jon Calhoun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -132,6 +132,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - Changelog.md
 - Gemfile
@@ -156,6 +158,7 @@ files:
 - lib/checkr/eviction_search.rb
 - lib/checkr/geo.rb
 - lib/checkr/global_watchlist_search.rb
+- lib/checkr/invitation.rb
 - lib/checkr/motor_vehicle_report.rb
 - lib/checkr/national_criminal_search.rb
 - lib/checkr/report.rb
@@ -171,6 +174,7 @@ files:
 - samples/document.md
 - samples/geo.md
 - samples/global_watchlist_search.md
+- samples/invitation.md
 - samples/motor_vehicle_report.md
 - samples/national_criminal_search.md
 - samples/report.md
@@ -190,6 +194,7 @@ files:
 - test/checkr/eviction_search_test.rb
 - test/checkr/geo_test.rb
 - test/checkr/global_watchlist_search.rb
+- test/checkr/invitation_test.rb
 - test/checkr/motor_vehicle_report_test.rb
 - test/checkr/national_criminal_search_test.rb
 - test/checkr/report_test.rb
@@ -220,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API
@@ -237,6 +242,7 @@ test_files:
 - test/checkr/eviction_search_test.rb
 - test/checkr/geo_test.rb
 - test/checkr/global_watchlist_search.rb
+- test/checkr/invitation_test.rb
 - test/checkr/motor_vehicle_report_test.rb
 - test/checkr/national_criminal_search_test.rb
 - test/checkr/report_test.rb