checkr-rb 0.0.3a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a88aefc4b7d7f510d441047184fec40dc96dc12c
+  data.tar.gz: 29356d03792024cc24ee67e38457397281537897
+SHA512:
+  metadata.gz: 8e725c4b0d369c9fefbbdbc419023842a2efc3c6aa86bd02c5f2ddb4f5bd2115950b5033a43fdd0f2f02eb5f9920a7f2a8c5f47fb7c286b7fdc7cdc603e92dab
+  data.tar.gz: 5ac48fb5c4d0cb60a2edb2383eddf774eb2d9168e6f7430ee50670f0c9aa806d02af97c9f1524d4ef3f34bb8a7cfa6644b3c8d45a3dd333d3054d05bac76a887

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Checkr
+
+Ruby wrapper for checkr.io API (https://checkr.io/docs)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkr-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkr-rb
+
+## Usage
+
+**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::Candidate.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::Candidate.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 )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.ruby_opts << "-rubygems"
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/checkr.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkr'
+
+Gem::Specification.new do |spec|
+  spec.name          = "checkr-rb"
+  spec.version       = Checkr::VERSION
+  spec.authors       = ["Vijendra Rao"]
+  spec.email         = ["vijendrakarkala@gmail.com"]
+  spec.summary       = %q{checkr API Ruby wrapper}
+  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 = %w(lib)
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/checkr.rb

@@ -0,0 +1,37 @@
+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, :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
+
+    alias :config :configure
+
+    def auth
+       {:username => Checkr.api_key }
+    end
+  end
+
+  class Error < RuntimeError; end
+  class AuthenticationError < StandardError;  end
+  class UnexpectedError < StandardError;  end
+  class ParamsError < StandardError;  end
+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,57 @@
+module ExtendCore
+  def extend_if_nonexistant *methods
+    methods.each do |method_name|
+      if !self.method_defined? method_name
+        alias_method method_name, "checkr__#{method_name}".to_sym
+      end
+    end
+  end
+end
+
+class Hash
+  extend ExtendCore
+
+  def checkr__except_key(which)
+    self.tap{ |h| h.delete(which) }
+  end
+
+  extend_if_nonexistant :except_key
+end
+
+class Object
+  extend ExtendCore
+
+  #From rails/Object/try
+  def checkr__try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+
+  extend_if_nonexistant :try
+end
+
+class String
+  extend ExtendCore
+
+  def checkr__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 checkr__pluralize
+    #TODO this is wrong. But works for now
+    "#{self}s"
+  end
+
+  def checkr__tablelize
+    self.underscored_class_name.pluralize
+  end
+
+  extend_if_nonexistant :pluralize, :tablelize, :underscored_class_name
+end

data/lib/checkr/county_criminal_search.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class CountyCriminalSearch < 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