checkr-official 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fd54e3b5798dd838beb31c43bc7b3a4da619cf2
-  data.tar.gz: bf941cf26a026ee573504678a247571a61001644
+  metadata.gz: 3e492068573125488bc43d5a3e849788959233e7
+  data.tar.gz: aede787f0b0dfe934d2407a8f3fffd9c114dfd04
 SHA512:
-  metadata.gz: 19fe187497cd058cdf766ed3f2ad6aefd9f8a3e2908946b36003648690925e430a939e8ad1f4308ad2c57bb7c91be78fad8fb8a2e525d5a80356bc8d646dcecc
-  data.tar.gz: 80ed601d77f401b45b0bb179874e2f1e8d9b235952639df7964bc0c237879e93b11c2b0cd135b2fb08b6a48adbb78b9c0069556dade90ca3fe0346a13aaa5e82
+  metadata.gz: bde325ad92092d6e50140acfc7e4114a34f34069e765a9c50c4c12d5a4018d7ca51e8fcf8a8bf2c7f077d1832c3d79198da0145c11fbe6431ea0b28d929d878c
+  data.tar.gz: f85ea6f213e030804e357652a0b7ef50c35efdac80ba14fc3508d91f4bcbb43b8e2485d1d5e28c0561b2f85d3e79323d78cc907d357e1a90f1f224d585981ce3

data/Changelog.md

@@ -0,0 +1,23 @@
+## 1.1.0 (2016-03-03)
+
+Features:
+
+  - Adds Candidate#save method (@squaresurf, #6)
+
+## 1.0.2 (2015-03-24)
+
+Fixes:
+
+  - Fixed a bug - #4 - with Util.constantize
+
+## 1.0.1 (2015-03-24)
+
+Features:
+
+  - Updated documents class to feel like other classes
+
+## 1.0 (2015-03-04)
+
+Features:
+
+  - Initial release

data/README.md

@@ -1,4 +1,4 @@
-# Checkr Ruby bindings ![Travis CI Status](https://travis-ci.org/checkr/checkr-ruby.svg?branch=master) [![Code Climate](https://codeclimate.com/github/checkr/checkr-ruby/badges/gpa.svg)](https://codeclimate.com/github/checkr/checkr-ruby)
+# Checkr Ruby bindings [![Build Status](https://travis-ci.org/checkr/checkr-ruby.svg?branch=master)](https://travis-ci.org/checkr/checkr-ruby) [![Code Climate](https://codeclimate.com/github/checkr/checkr-ruby/badges/gpa.svg)](https://codeclimate.com/github/checkr/checkr-ruby)
 
 
 ## Installation

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bump/tasks'
 require 'rake/testtask'
 require './tasks/api_test.rb'
 

data/checkr-official.gemspec

@@ -17,8 +17,9 @@ spec = Gem::Specification.new do |s|
 
   s.add_development_dependency('mocha', '~> 0.13.2')
   s.add_development_dependency('shoulda', '~> 3.4.0')
+  s.add_development_dependency('bump', '0.5.2')
+  s.add_development_dependency('rake', '10.4.2')
   s.add_development_dependency('test-unit')
-  s.add_development_dependency('rake')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/lib/checkr/candidate.rb

@@ -26,6 +26,8 @@ module Checkr
     api_class_method :create, :post
     api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
 
+    api_instance_method :save, :post, :default_params => :changed_attributes
+
     def self.path
       "/v1/candidates"
     end

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = File.open(File.expand_path("../../../VERSION", __FILE__)).read()
+  VERSION = '1.1.0'.freeze
 end

data/samples/candidate.md

@@ -139,6 +139,57 @@ candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
 ```
 
 
+## Update an existing Candidate
+
+### Definition
+
+```ruby
+candidate = Checkr::Candidate.retrieve({CANDIDATE_ID})
+candidate.copy_requested = {BOOL}
+candidate.save
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
+candidate.copy_requested = true
+candidate.save
+```
+
+### Example Response
+
+```ruby
+#<Checkr::Candidate:0x3fd909a22584 id=e44aa283528e6fde7d542194> JSON: {
+  "first_name": "John",
+  "middle_name": "Alfred",
+  "last_name": "Smith",
+  "email": "john.smith@gmail.com",
+  "phone": null,
+  "zipcode": "90401",
+  "dob": "1970-01-22",
+  "ssn": "XXX-XX-4645",
+  "driver_license_number": "F211165",
+  "driver_license_state": "CA",
+  "previous_driver_license_number": null,
+  "previous_driver_license_state": null,
+  "copy_requested": true,
+  "custom_id": null,
+  "reports": {"object":"list","data":[{"id":"4722c07dd9a10c3985ae432a"}, ...]},
+  "geos": {"object":"list","data":[]},
+  "adjudication": null,
+  "documents": {"object":"list","data":[]},
+  "id": "e44aa283528e6fde7d542194",
+  "object": "test_candidate",
+  "uri": "/v1/candidates/e44aa283528e6fde7d542194",
+  "created_at": "2014-06-17T05:55:47Z"
+}
+```
+
+
 ## List existing Candidates
 
 ### Definition

data/test/checkr/candidate_test.rb

@@ -41,6 +41,19 @@ module Checkr
         assert_equal(test_candidate[:email], candidate.email)
       end
 
+      should 'be updateable' do
+        candidate = Candidate.new(test_candidate)
+        candidate.copy_requested = true
+
+        @mock.expects(:post).once.with do |url, headers, params|
+          params == candidate.changed_attributes && url == "#{@candidate_url}/#{candidate.id}"
+        end.returns(test_response(test_candidate))
+
+        # This should update this instance with test_candidate since it was returned
+        candidate.save
+        assert_equal(test_candidate[:copy_requested], candidate.copy_requested)
+      end
+
       should 'include an empty documents list' do
         # TODO(joncalhoun): Implement this when test docs are available.
 

data/test/checkr/util_test.rb

@@ -1,6 +1,10 @@
 require File.expand_path('../../test_helper', __FILE__)
 
+class TestObj; end
+
 module Checkr
+  class TestObj; end
+
   class UtilTest < Test::Unit::TestCase
     should "symbolize_keys should convert keys to symbols" do
       start = {
@@ -46,5 +50,10 @@ module Checkr
 
       assert_equal(finish, Util.query_array(start))
     end
+
+    should 'scope the class in the Checkr namespace' do
+      assert_not_equal(::TestObj, Util.constantize(:TestObj))
+      assert_equal(Checkr::TestObj, Util.constantize(:TestObj))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkr-official
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jon Calhoun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -87,21 +87,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,11 +139,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
-- History.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/checkr-console
 - checkr-official.gemspec
 - gemfiles/default-with-activesupport.gemfile
@@ -216,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Checkr API

data/History.txt

@@ -1,12 +0,0 @@
-=== 1.0.2 2015-03-24
-* 1 minor enchancement:
-  * Fixed a bug with Util.constantize
-
-=== 1.0.1 2015-03-24
-* 1 minor enchancement:
-  * Updated documents class to feel like other classes.
-
-=== 1.0 2015-03-04
-
-* 1 major enhancement:
-  * Initial release

data/VERSION

@@ -1 +0,0 @@
-1.0.2