checkr-official 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 204fa32aac332586ff0659b1c1ab5713b1cc79bf
-  data.tar.gz: e74b3546eb997df8a6e2e05698652f517bc24060
+  metadata.gz: 2ccafdc7b87f315c5f14d9c79f8d12cbc701e810
+  data.tar.gz: e7c5657e8b647000b5affea8d230f9d1108ead92
 SHA512:
-  metadata.gz: f3e1c06a138a2506b738f4d3b8195450a869c819eb6ac2c8546855f9c31747195d8f969ac1d2d7fef7b9499294c7306535d6901cc73595ccd68cd75cb04f99d6
-  data.tar.gz: 3cde6c929301904aadd2f5f53a07f6236eb0826213e926d9691ce8ccb571afa7cc3ab5e204edfbf03b868269aa71265c2e88b71e73709d8df5954d3243e7c9be
+  metadata.gz: b8e4424123de74f5be964464c0d2bbed9e01036ae1ab35327da5e42a371910c25057f78564e566ab1d86e7e593b723d18fb710c45e88b7ad7aca2748d9ae8577
+  data.tar.gz: 848abe2c0c6f2989bd9e6b0ecdc62a94630c9bc772e203159ac2696497e77eaac5927cf56c970efd2ba71d7e7b546c5427617fa6f53319bd58792a111b86924a

data/History.txt

@@ -1,3 +1,7 @@
+=== 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:

data/README.md

@@ -1,4 +1,4 @@
-# Checkr Ruby bindings ![Travis CI Status](https://travis-ci.org/checkr/checkr-ruby.svg?branch=master)
+# 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)
 
 
 ## Installation
@@ -7,16 +7,24 @@ You don't need this source code unless you want to modify the gem. If
 you just want to use the Checkr Ruby bindings, you should run:
 
 ```bash
-gem install checkr
+gem install checkr-official
 ```
 
 If you want to build the gem from source:
 
 ```bash
-gem build checkr.gemspec
+gem build checkr-official.gemspec
 ```
 
 
+If you want to include the gem in IRB you will need to require `checkr`. This naming will hopefully be cleared up if we are given ownership of the `checkr` gem on rubygems.
+
+```ruby
+require 'checkr'
+```
+
+
+
 ## Requirements
 
 * Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load
@@ -40,7 +48,7 @@ rubygems source in your Gemfile, as any gems fetched over http could potentially
 source 'https://rubygems.org'
 
 gem 'rails'
-gem 'checkr'
+gem 'checkr-official'
 ```
 
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/checkr/api_class.rb

@@ -157,11 +157,15 @@ module Checkr
 
     def inspect
       id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
-      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(json)
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(attributes)
+    end
+
+    def to_s(*args)
+      JSON.pretty_generate(non_nil_attributes)
     end
 
     def to_json(*a)
-      JSON.generate(json)
+      JSON.generate(non_nil_attributes)
     end
 
 
@@ -240,7 +244,7 @@ module Checkr
 
         validate_args(arg_names, *args)
         arguments = compose_arguments(method, arg_names, *args)
-        composed_path = compose_api_path(path, arguments)
+        composed_path = compose_api_path(path, arguments, arguments[:params])
         unused_args = determine_unused_args(path, arg_names, arguments)
         arguments[:params] = compose_params(arguments[:params], unused_args, default_params)
 
@@ -336,7 +340,7 @@ module Checkr
       self.class.compose_arguments(method, arg_names, *args)
     end
 
-    def self.compose_api_path(path, arguments, this=self)
+    def self.compose_api_path(path, arguments, params={}, this=self)
       # Setup the path using the following attribute order:
       #   1. Args passed in
       #   2. Args on this
@@ -347,6 +351,7 @@ module Checkr
         matches = ret.scan(/:([^\/]*)/).flatten.map(&:to_sym)
         matches.each do |match|
           value = arguments[match]
+          value ||= params[match] || params[match.to_s]
           begin
             value ||= this.send(match)
           rescue NoMethodError
@@ -369,8 +374,8 @@ module Checkr
       end
       ret
     end
-    def compose_api_path(path, arguments)
-      self.class.compose_api_path(path, arguments, self)
+    def compose_api_path(path, arguments, params={})
+      self.class.compose_api_path(path, arguments, params, self)
     end
 
     def self.determine_unused_args(path, arg_names, arguments, this=self)

data/lib/checkr/document.rb

@@ -6,6 +6,9 @@ module Checkr
     attribute :filename
     attribute :content_type
 
+    api_class_method :all, :get, "/v1/candidates/:candidate_id/documents", :constructor => :DocumentList
+    api_class_method :create, :post, "/v1/candidates/:candidate_id/documents"
+
     # Method #create and #all are all on the Candidate instance
 
     APIClass.register_subclass(self, "document")

data/samples/candidate.md

@@ -0,0 +1,195 @@
+# Candidate
+
+## The Candidate Object
+
+### 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": false,
+  "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"
+}
+```
+
+
+
+## Create a new Candidate
+
+### Definition
+
+```ruby
+Checkr::Candidate.create
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidate = Checkr::Candidate.create({
+  :first_name => "John",
+  :middle_name => "Alfred",
+  :last_name => "Smith",
+  :email => "john.smith@gmail.com",
+  :phone => "5555555555",
+  :zipcode => "90401",
+  :dob => "1970-01-22",
+  :ssn => "543-43-4645",
+  :driver_license_number => "F211165",
+  :driver_license_state => "CA"
+})
+```
+
+### Example Response
+
+```ruby
+#<Checkr::Candidate:0x3fd909a14cb8 id=25a317218b8c3254cec8ccfb> JSON: {
+  "first_name": "John",
+  "middle_name": "Alfred",
+  "last_name": "Smith",
+  "email": "john.smith@gmail.com",
+  "phone": "5555555555",
+  "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": false,
+  "custom_id": null,
+  "reports": {"object":"list","data":[]},
+  "geos": {"object":"list","data":[]},
+  "adjudication": null,
+  "documents": {"object":"list","data":[]},
+  "id": "25a317218b8c3254cec8ccfb",
+  "object": "test_candidate",
+  "uri": "/v1/candidates/25a317218b8c3254cec8ccfb",
+  "created_at": "2015-03-24T20:44:26Z"
+}
+```
+
+
+
+## Retrieve an existing Candidate
+
+### Definition
+
+```ruby
+Checkr::Candidate.retrieve({CANDIDATE_ID})
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
+```
+
+### 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": false,
+  "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
+
+```ruby
+Checkr::Candidate.all
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidates = Checkr::Candidate.all({
+  :created_after => "2015-03-23"
+})
+```
+
+### Example Response
+
+```ruby
+#<Checkr::APIList:0x3ffc490506b0> JSON: {
+  "object": "list",
+  "data": [
+    #<Checkr::Candidate:0x3ff176151ca4 id=6be8ba695388837cb74bcc50> JSON: {
+      "first_name": "John",
+      "last_name": "Smith",
+      "email": "john@smith.org",
+      "phone": "5555555555",
+      "dob": "1970-01-22",
+      "ssn": "XXX-XX-6789",
+      "copy_requested": false,
+      "reports": {
+        "object": "list",
+        "data": []
+      },
+      "geos": {
+        "object": "list",
+        "data": []
+      },
+      "documents": {
+        "object": "list",
+        "data": []
+      },
+      "id": "6be8ba695388837cb74bcc50",
+      "object": "test_candidate",
+      "uri": "/v1/candidates/6be8ba695388837cb74bcc50",
+      "created_at": "2015-03-23T11:24:18Z"
+    },
+    ...
+  ]
+}
+```

data/samples/country_criminal_search.md

@@ -0,0 +1,60 @@
+# County Criminal Search
+
+## The County Criminal Search Object
+
+### Example Response
+
+```ruby
+#<Checkr::CountyCriminalSearch:0x3fd909bcd974 id=539fdcf335644a0ef4000001> JSON: {
+  "status": "pending",
+  "completed_at": null,
+  "turnaround_time": null,
+  "county": "San Francisco",
+  "state": "CA",
+  "records": [
+
+  ],
+  "id": "539fdcf335644a0ef4000001",
+  "object": "test_county_criminal_search",
+  "uri": "/v1/county_criminal_searches/539fdcf335644a0ef4000001",
+  "created_at": "2014-06-17T06:15:47Z"
+}
+```
+
+
+
+## Retrieve an existing County Criminal Search
+
+### Definition
+
+```ruby
+Checkr::CountyCriminalSearch.retrieve({COUNTY_CRIMINAL_SEARCH_ID})
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+ccs = Checkr::CountyCriminalSearch.retrieve("539fdcf335644a0ef4000001")
+```
+
+### Example Response
+
+```ruby
+#<Checkr::CountyCriminalSearch:0x3fd909bcd974 id=539fdcf335644a0ef4000001> JSON: {
+  "status": "pending",
+  "completed_at": null,
+  "turnaround_time": null,
+  "county": "San Francisco",
+  "state": "CA",
+  "records": [
+
+  ],
+  "id": "539fdcf335644a0ef4000001",
+  "object": "test_county_criminal_search",
+  "uri": "/v1/county_criminal_searches/539fdcf335644a0ef4000001",
+  "created_at": "2014-06-17T06:15:47Z"
+}
+```

data/samples/document.md

@@ -0,0 +1,109 @@
+# Document
+
+## The Document Object
+
+### Example Response
+
+```ruby
+#<Checkr::Document:0x3fd90aa3e10c id=e9293aac1d008123627c398f> JSON: {
+  "download_uri": "https://checkr-documents.s3.amazonaws.com/candidates/e44aa283528e6fde7d542194/1427231857_mclovin.jpg?AWSAccessKeyId=AKIAJVBH7HZTOFURSXYQ&Expires=1427235458&Signature=7LPgGkve9SPnaMqozkV9%2BlL6luw%3D",
+  "filesize": 37291,
+  "filename": "1427231857_mclovin.jpg",
+  "content_type": "image/jpeg",
+  "id": "e9293aac1d008123627c398f",
+  "object": "document",
+  "uri": null,
+  "created_at": "2015-03-24T21:17:38Z"
+}
+```
+
+
+
+## Create a new Document
+
+### Definition
+
+```ruby
+candidate = Checkr::Candidate.retrieve({CANDIDATE_ID})
+candidate.documents.create
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
+document = Checkr::Document.create({
+  :candidate_id => candidate.id,
+  :type => "driver_license",
+  :file => File.open("./mclovin.jpg")
+})
+```
+
+### Example Response
+
+```ruby
+#<Checkr::Document:0x3fd90aa3e10c id=e9293aac1d008123627c398f> JSON: {
+  "download_uri": "https://checkr-documents.s3.amazonaws.com/candidates/e44aa283528e6fde7d542194/1427231857_mclovin.jpg?AWSAccessKeyId=AKIAJVBH7HZTOFURSXYQ&Expires=1427235458&Signature=7LPgGkve9SPnaMqozkV9%2BlL6luw%3D",
+  "filesize": 37291,
+  "filename": "1427231857_mclovin.jpg",
+  "content_type": "image/jpeg",
+  "id": "e9293aac1d008123627c398f",
+  "object": "document",
+  "uri": null,
+  "created_at": "2015-03-24T21:17:38Z"
+}
+```
+
+
+
+
+
+## List a Candidate's Documents
+
+### Definition
+
+```ruby
+candidate = Checkr::Candidate.retrieve({CANDIDATE_ID})
+Checkr::Document.all({
+  :candidate => candidate.id
+})
+```
+
+### Example Request
+
+```ruby
+require 'checkr' # Note the gem is named checkr-official
+Checkr.api_key = "83ebeabdec09f6670863766f792ead24d61fe3f9"
+
+candidate = Checkr::Candidate.retrieve("e44aa283528e6fde7d542194")
+documents = Checkr::Document.all({
+  :candidate_id => candidate.id
+})
+```
+
+### Example Response
+
+```ruby
+ #<Checkr::DocumentList:0x3fd90a9bb93c> JSON: {
+  "next_href": null,
+  "previous_href": null,
+  "count": 4,
+  "object": "list",
+  "data": [
+    #<Checkr::Document:0x3fd909fa1320 id=a89c96f8ae80b961900ca8a3> JSON: {
+	  "download_uri": "https://checkr-documents.s3.amazonaws.com/candidates/e44aa283528e6fde7d542194/1423684869_test.jpg?AWSAccessKeyId=AKIAJVBH7HZTOFURSXYQ&Expires=1427236003&Signature=kOYFewxbFn1%2FstvXEX1Y0V51sHY%3D",
+	  "filesize": 8576,
+	  "filename": "1423684869_test.jpg",
+	  "content_type": "image/jpeg",
+	  "id": "a89c96f8ae80b961900ca8a3",
+	  "object": "document",
+	  "uri": null,
+	  "created_at": "2015-02-11T20:01:10Z"
+	},
+	...
+  ]
+}
+```