checkr 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94dc77398f872d24692f8ddee3906b1b3fdeef09
-  data.tar.gz: 84ea6f36e708a2cb40deb03c919d233cf9e69ed3
+  metadata.gz: cac7f51aa90e16e28b2a21ca48b7317ab897ce23
+  data.tar.gz: 198a3b605c9a344093adcd510528902cc0325871
 SHA512:
-  metadata.gz: 44cf1beec1d4e082f0965f34157e4cc6ef9dbf672f7f68a7e7e0ed6f6cd21ff05f1fd664d94b4b56b0c86c9d7e7a43f484988455539251c0083b3f60734c14af
-  data.tar.gz: a22f6dbfb4c9cd56a2671da69e9928ad6771b2c07ee7998eb2d016e7743e1f997d98d8f6878cdaf9d4affd0f864f503348e0b53854b8675b6cde5ed6a1ac8e39
+  metadata.gz: deb8e18304ddf84b96606bb17b1d9ed6250bf3ecb4b2739529207e3655019bba9bd8e5cf3bca7ed7f7be62a747c071dede3b72bc72801e586c18e48b0ccd8b99
+  data.tar.gz: ccd3ffb562cf1e7c5ef5b0b163f9887e8af6e01f254a552280a40a269eda42d5cfd61c6d7494081feb904159b959e6ea7cd19883ba855bba5e5ddd25a9bab402

data/README.md

@@ -1,13 +1,13 @@
 # Checkr
 
-TODO: Write a gem description
+Ruby wrapper for checkr.io API (https://checkr.io/docs)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'checkr'
+gem 'checkr', git: 'https://github.com/vijendra/checkr.git'
 ```
 
 And then execute:
@@ -20,8 +20,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+**Configure authentication keys**
 
+  ```Ruby
+  Checkr.configure do |c|
+    c.api_key   = "83ebeabdec09f6670863766f792ead24d61fe3f9" #Test token from checkr api document
+  end
+  ```
+  
+**Create subaccount**
+
+  ```Ruby
+  subaccount = Checkr::Subaccount.create(:name => 'Checkr', :entity_name => 'My Company', :tax_id => 'XXXXX', :representative_title => 'CEO', :representative_name => 'John Smith', :representative_email => 'john.smith@company.org', :phone => '3101111111',
+:incorporation_date => '2010-02-02', :incorporation_type => 'llc', :incorporation_state => 'DE', 'address[street]' => '3230 3rd street', 'address[city]' => 'San Francisco', 
+ 'address[state]' => 'CA', 'address[zipcode]'=> '94110')
+ 
+  #Subaccount attributes
+  subaccount_id = subaccount.id 
+  ```
+
+**Create candidate for subaccount**
+
+  ```Ruby
+  candidate = Checkr::Subaccount.create(:subaccount_id => '8168372aac5a952b90eb9acb', :first_name => 'John', :last_name => 'Smith', :dob => '1970-01-22', :ssn => '111-11-2000', :phone => '5555555555', :email => 'john@smith.org')
+ 
+  #candidate attributes
+  candidate_id = candidate.id 
+  ```
+
+**Create candidate**
+
+  ```Ruby
+  candidate = Checkr::Subaccount.create(:first_name => 'John', :last_name => 'Smith', :dob => '1970-01-22', :ssn => '111-11-2000', :phone => '5555555555', :email => 'john@smith.org')
+ 
+  #candidate attributes
+  candidate_id = candidate.id 
+  ```    
+ 
+**Find candidate**
+
+  ```Ruby
+  candidate = Checkr::Candidate.find('e44aa283528e6fde7d542194')
+  candidate.id #Returns checkr id of the candidate
+  candidate.first_name #Returns first_name of the candidate
+  ```
+
+**Get all reports belongs to candidate, if exists**
+
+  ```Ruby
+  candidate = Checkr::Subaccount.find('e44aa283528e6fde7d542194')
+  candidate.reports #Returns array of Checkr::Report objects
+  ```
+**Create report**
+
+  ```Ruby
+  report = Checkr::Report.create(:package => 'driver_plus', :candidate_id => 'e44aa283528e6fde7d542194')
+  report.id #Returns the checkr id of the created report
+  ```
+
+**Find report**
+
+  ```Ruby
+  report = Checkr::Report.find("5878551b3ee1eacae5a2c558")
+  report.id #Returns the checkr id of the created report
+  report.status #Returns the status of the report
+  ```
+**Find individual reports**
+
+  ```Ruby
+  report = Checkr::MotorVehicleReport.find("5878551b3ee1eacae5a2c558")
+  report = Checkr::CountryCriminalSearch.find("5878551b3ee1eacae5a2c558")
+  report = Checkr::NationalCriminalSearch.find("5878551b3ee1eacae5a2c558")
+  report = Checkr::SexOffenderSearch.find("5878551b3ee1eacae5a2c558")
+  report = Checkr::SsnTrace.find("5878551b3ee1eacae5a2c558")
+  report = Checkr::TerroristWatchlistSearch.find("5878551b3ee1eacae5a2c558") 
+  
+  report.status #Returns the status of the report
+  report.records #Returns array of ReportRecord objects, if report has records
+  report.records.first.charges #Returns array of ReportCharge objects, if report has charges  
+  report.accidents #In case of motor vehicle report
+  report.voilations #In case of motor vehicle report
+  ```
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/checkr/fork )

data/checkr.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'checkr/version'
+require 'checkr'
 
 Gem::Specification.new do |spec|
   spec.name          = "checkr"
@@ -9,26 +9,21 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Vijendra Rao"]
   spec.email         = ["vijendrakarkala@gmail.com"]
   spec.summary       = %q{checkr API Ruby wrapper}
-  spec.description   = %q{Automated background screenings and driving records}
-  spec.homepage      = ""
+  spec.description   = %q{checkr.io API wrapper: Automated background screenings and driving records}
+  spec.homepage      = "https://github.com/vijendra/checkr"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = Dir["README.md","Gemfile","Rakefile", "test/*", "lib/**/*"]
+  #spec.require_paths = Dir["README.md","Gemfile","Rakefile", "test/*", "lib/**/*"]
+  spec.require_paths = %w(lib)
   
   spec.add_dependency "httparty"
-  spec.add_dependency "active_attr"
-  spec.add_dependency "multi_json"
-  spec.add_dependency "hashie"
   
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "guard"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "faker"
-  spec.add_development_dependency "shoulda-matchers"
   spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/checkr.rb

@@ -1,15 +1,25 @@
+require "checkr/base"
 require "checkr/version"
 require "checkr/core_ext"
 require "checkr/candidate"
 require "checkr/subaccount"
 require "checkr/report"
+require "checkr/motor_vehicle_report"
+require "checkr/sex_offender search"
+require "checkr/ssn_trace"
+require "checkr/terrorist_watchlist_search"
+require "checkr/national_criminal_search"
+require "checkr/county_criminal_search"
+require "checkr/report_charge"
+require "checkr/report_record"
 
 module Checkr
   class << self
-    attr_accessor :api_key, :test
+    attr_accessor :api_key, :api_version
  
     def configure
       yield self
+      api_version = 'v1' if api_version.nil? || api_version.empty?
       raise Checkr::Error.new(':api_key cannot be blank') if api_key.nil? || api_key.empty?
     end
     

data/lib/checkr/base.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+require 'ostruct'
+
+module Checkr
+  class Base < OpenStruct
+    include HTTParty
+    base_uri "https://api.checkr.io/v1"
+ 
+    def self.construct(params)
+      new(params)
+    end
+    
+    private
+  
+    def self.handle_response(response)
+      case response.code.to_i
+ 	    when 200...300 then self.construct(response.parsed_response)
+      when 401 then raise Checkr::AuthenticationError, "#{response.body}: Verify your api token." 
+ 	    else
+ 	      raise Checkr::UnexpectedError, response.body
+ 	    end
+ 	  end
+  end
+end

data/lib/checkr/candidate.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+module Checkr
+  class Candidate < Checkr::Base
+ 
+    def self.create(params={})
+      if valid?(params)
+        uri = "/subaccounts/#{params[:subaccount_id]}" unless params[:subaccount_id].nil?
+        uri = "#{uri}/candidates"
+        response = self.post(uri, :body => params, :basic_auth => Checkr.auth )
+        handle_response(response)
+      end  
+    end
+   
+    def self.find(id)
+      response = self.get("/candidates/#{id}?include=reports", :basic_auth => {:username => Checkr.api_key } )
+      handle_response(response)
+    end
+ 
+    def self.construct(params)
+      reports = params["reports"]
+ 	    candidate = self.new(params.except_key('reports'))
+ 	    candidate.reports = []
+ 	    unless reports.nil? || reports.empty?
+ 	      reports.each do |report_attributes|
+ 	        candidate.reports << Checkr::Report.new(report_attributes)
+ 	      end
+ 	    end
+ 	      
+ 	    return candidate 
+    end
+    
+    protected
+ 
+    def self.valid?(params)
+      return true #TODO implement validation
+    end
+ 
+  end
+end

data/lib/checkr/core_ext.rb

@@ -0,0 +1,35 @@
+class Hash
+  def except_key(which)
+    self.tap{ |h| h.delete(which) }
+  end
+end
+
+class Object
+  #From rails/Object/try
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+end  
+
+class String
+  def underscored_class_name
+    self.split("::")[1].
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+  
+  def pluralize
+    #TODO this is wrong. But works for now
+    "#{self}s"
+  end
+  
+  def tablelize
+    self.underscored_class_name.pluralize
+  end
+end

data/lib/checkr/county_criminal_search.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class CountryCriminalSearch < Checkr::Report
+    
+  end
+end

data/lib/checkr/motor_vehicle_report.rb

@@ -0,0 +1,25 @@
+module Checkr
+  class MotorVehicleReport < Checkr::Report
+    def self.construct(params)
+      accidents = params["accidents"]
+      violations = params["violations"]
+      report = self.new(params.except_key('accidents').except_key('violations'))
+      
+ 	    report.accidents = []
+ 	    unless accidents.nil? || accidents.empty?
+ 	      accidents.each do |accident_attributes|
+ 	        report.accidents << Checkr::ReportRecord.construct(accident_attributes)
+ 	      end
+ 	    end
+ 	    
+ 	    report.violations = []
+ 	    unless violations.nil? || violations.empty?
+ 	      violations.each do |violation_attributes|
+ 	        report.violations << Checkr::ReportRecord.construct(violation_attributes)
+ 	      end
+ 	    end
+ 	      
+ 	    return report 
+    end
+  end
+end

data/lib/checkr/national_criminal_search.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class NationalCriminalSearch < Checkr::Report
+    
+  end
+end

data/lib/checkr/report.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+module Checkr
+  class Report < Checkr::Base
+    def self.create(params={})
+      if valid?(params)
+        response = self.post("/#{self.to_s.tablelize}", :body => params, :basic_auth => Checkr.auth )
+        handle_response(response)
+      end  
+    end
+   
+    def self.find(id)
+      response = self.get("/#{self.to_s.tablelize}/#{id}", :basic_auth => Checkr.auth )
+      handle_response(response)
+    end
+    
+    def self.construct(params)
+      records = params["records"]
+ 	    report = self.new(params.except_key('records'))
+ 	    report.records = []
+ 	    unless records.nil? || records.empty?
+ 	      records.each do |record_attributes|
+ 	        report.records << Checkr::ReportRecord.construct(record_attributes)
+ 	      end
+ 	    end
+ 	      
+ 	    return report 
+    end
+    
+    protected
+ 
+    def self.valid?(params)
+      return true #TODO implement validation
+    end
+  end
+end

data/lib/checkr/report_charge.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+module Checkr
+  class ReportCharge < Checkr::Base
+    
+  end
+end

data/lib/checkr/report_record.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+module Checkr
+  class ReportRecord < Checkr::Base
+    def self.construct(params)
+      charges = params["charges"]
+ 	    record = self.new(params.except_key('charges'))
+ 	    record.charges = []
+ 	    unless charges.nil? || charges.empty?
+ 	      charges.each do |charge_attributes|
+ 	        record.charges << Checkr::ReportCharge.construct(record_attributes)
+ 	      end
+ 	    end
+ 	      
+ 	    return record 
+    end
+  end
+end

data/lib/checkr/sex_offender search.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class SexOffenderSearch < Checkr::Report
+    
+  end
+end

data/lib/checkr/ssn_trace.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class SsnTrace < Checkr::Report
+    
+  end
+end

data/lib/checkr/subaccount.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+module Checkr
+  class Subaccount < Checkr::Base
+ 
+    def self.create(params={})
+      if valid?(params)
+        response = self.post("/subaccounts", :body => params, :basic_auth => Checkr.auth )
+        handle_response(response)
+      end  
+    end
+   
+    protected
+ 
+    def self.valid?(params)
+      true #TODO implement validation
+    end
+ 
+  end
+end

data/lib/checkr/terrorist_watchlist_search.rb

@@ -0,0 +1,6 @@
+module Checkr
+  class TerroristWatchlistSearch < Checkr::Report
+    
+  end
+end
+

data/lib/checkr/version.rb

@@ -1,3 +1,3 @@
 module Checkr
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/test/cassettes/test_0001_should_create_candidate.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://83ebeabdec09f6670863766f792ead24d61fe3f9:@api.checkr.io/v1/candidates
+    body:
+      encoding: UTF-8
+      string: first_name=John&last_name=Smith&dob=1970-01-22&ssn=111-11-2000&phone=5555555555&email=john%40smith.org
+    headers: {}
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Date:
+      - Sun, 12 Oct 2014 16:07:25 GMT
+      Status:
+      - 201 Created
+      Strict-Transport-Security:
+      - max-age=31536000
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '375'
+      X-Content-Type-Options:
+      - nosniff
+      Set-Cookie:
+      - checkr.production=BAh7CEkiD3Nlc3Npb25faWQGOgZFVEkiRTg5ZjVlZmE4ODBmODU0Mzk0ZWJk%0AOTIxNzAwZWI4MDJkN2YzMjAyMzdiMDliOGVmMjYxY2MzZDY2MjFjZmVhMmEG%0AOwBGSSIJY3NyZgY7AEZJIiUxYzg4MGI1NzQ4MGYyNzAzYjFmNTNhZTI2M2E0%0AZDg5MwY7AEZJIg10cmFja2luZwY7AEZ7B0kiFEhUVFBfVVNFUl9BR0VOVAY7%0AAFRJIi1kYTM5YTNlZTVlNmI0YjBkMzI1NWJmZWY5NTYwMTg5MGFmZDgwNzA5%0ABjsARkkiGUhUVFBfQUNDRVBUX0xBTkdVQUdFBjsAVEkiLWRhMzlhM2VlNWU2%0AYjRiMGQzMjU1YmZlZjk1NjAxODkwYWZkODA3MDkGOwBG%0A--f84a5c0327e8d8d8fb706f9410e08e0330caae86;
+        path=/; HttpOnly; secure
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"75c62b8845bee2df0752b009","object":"test_candidate","uri":"/v1/candidates/75c62b8845bee2df0752b009","created_at":"2014-10-12T16:07:25Z","first_name":"John","last_name":"Smith","middle_name":null,"dob":"1970-01-22","ssn":"XXX-XX-2000","email":"john@smith.org","zipcode":null,"phone":"5555555555","driver_license_state":null,"driver_license_number":null,"report_ids":[]}'
+    http_version: 
+  recorded_at: Sun, 12 Oct 2014 16:07:25 GMT
+recorded_with: VCR 2.9.3