checkr-official 1.0.0

data/lib/checkr/api_list.rb

@@ -0,0 +1,78 @@
+module Checkr
+  class APIList < APIClass
+    include Enumerable
+
+    attribute :object
+    attribute :data
+    attr_accessor :api_list_klass
+
+    def [](k)
+      data[k]
+    end
+
+    def []=(k, v)
+      data[k]=v
+    end
+
+    def last
+      data.last
+    end
+
+    def length
+      data.length
+    end
+
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    def self.constructor(klass)
+      lambda do |json|
+        klass = Util.constantize(klass) unless klass.is_a?(Class)
+
+        instance = self.new
+        instance.api_list_klass = klass
+        instance.refresh_from(json)
+      end
+    end
+
+    def refresh_from(json)
+      self.object = "list"
+      self.data ||= []
+      self.json = Util.sorta_deep_clone(json)
+
+      if json.is_a?(Hash)
+        self.refresh_from_hash(json)
+      elsif json.is_a?(Array)
+        self.refresh_from_array(json)
+      else
+        self.clear_changed_attributes
+        self
+      end
+    end
+
+    def refresh_from_hash(json={})
+      klass = api_list_klass
+
+      json.each do |k, v|
+        if self.class.attribute_writer_names.include?(k.to_sym)
+          if k.to_sym == :data
+            self.send("#{k}=", v.map{ |i| klass.construct(i) })
+          else
+            self.send("#{k}=", v)
+          end
+        end
+      end
+      self
+    end
+
+    def refresh_from_array(array=[])
+      klass = api_list_klass
+      json = {
+        :object => "list",
+        :data => array
+      }
+      refresh_from_hash(json)
+    end
+  end
+end

data/lib/checkr/api_resource.rb

@@ -0,0 +1,18 @@
+module Checkr
+  class APIResource < APIClass
+    attribute :id
+    attribute :object
+    attribute :uri
+    attribute :created_at
+
+    api_instance_method :refresh, :get, :constructor => :self
+
+    def path(base=self.class.path)
+      unless id
+        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has an invalid ID: #{id.inspect}", 'id')
+      end
+      "#{base}/#{id}"
+    end
+
+  end
+end

data/lib/checkr/api_singleton.rb

@@ -0,0 +1,5 @@
+module Checkr
+  class APISingleton < APIClass
+    attribute :object
+  end
+end

data/lib/checkr/candidate.rb

@@ -0,0 +1,35 @@
+module Checkr
+  class Candidate < APIResource
+
+    attribute :first_name
+    attribute :middle_name
+    attribute :last_name
+    attribute :email
+    attribute :phone
+    attribute :zipcode
+    attribute :dob
+    attribute :ssn
+    attribute :driver_license_number
+    attribute :driver_license_state
+    attribute :previous_driver_license_number
+    attribute :previous_driver_license_state
+    attribute :copy_requested
+    attribute :custom_id
+    attribute :reports, :ReportList, :nested => true
+    attribute_writer_alias :report_ids, :reports
+    attribute :geos, APIList.constructor(:Geo)
+    attribute_writer_alias :geo_ids, :geos
+    attribute :adjudication
+    attribute :documents, :DocumentList, :nested => true, :default => {}
+
+    api_class_method :all, :get, :constructor => APIList.constructor(:Candidate)
+    api_class_method :create, :post
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/candidates"
+    end
+
+    APIClass.register_subclass(self, "candidate")
+  end
+end

data/lib/checkr/county_criminal_search.rb

@@ -0,0 +1,19 @@
+module Checkr
+  class CountyCriminalSearch < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :county
+    attribute :state
+    attribute :records
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/county_criminal_searches"
+    end
+
+    APIClass.register_subclass(self, "county_criminal_search")
+  end
+end

data/lib/checkr/document.rb

@@ -0,0 +1,13 @@
+module Checkr
+  class Document < APIResource
+
+    attribute :download_uri
+    attribute :filesize
+    attribute :filename
+    attribute :content_type
+
+    # Method #create and #all are all on the Candidate instance
+
+    APIClass.register_subclass(self, "document")
+  end
+end

data/lib/checkr/document_list.rb

@@ -0,0 +1,25 @@
+module Checkr
+  class DocumentList < APIList
+
+    attribute :next_href
+    attribute :previous_href
+    attribute :count
+    attr_accessor :parent
+
+    api_instance_method :all, :get
+    api_instance_method :create, :post, :constructor => :Document
+
+    def self.construct(json, parent=nil)
+      lambda = constructor(:Document)
+      instance = lambda.call(json)
+      instance.parent = parent if parent
+      instance.clear_changed_attributes
+      instance
+    end
+
+    def path
+      parent.path + "/documents"
+    end
+
+  end
+end

data/lib/checkr/errors/api_connection_error.rb

@@ -0,0 +1,4 @@
+module Checkr
+  class APIConnectionError < CheckrError
+  end
+end

data/lib/checkr/errors/api_error.rb

@@ -0,0 +1,10 @@
+module Checkr
+  class APIError < CheckrError
+
+    def self.generic(rcode, rbody)
+      self.new("Invalid response object from API: #{rbody.inspect} " +
+               "(HTTP response code was #{rcode})", rcode, rbody)
+    end
+
+  end
+end

data/lib/checkr/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Checkr
+  class AuthenticationError < CheckrError
+  end
+end

data/lib/checkr/errors/checkr_error.rb

@@ -0,0 +1,20 @@
+module Checkr
+  class CheckrError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/checkr/errors/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module Checkr
+  class InvalidRequestError < CheckrError
+    attr_accessor :param
+
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+end

data/lib/checkr/geo.rb

@@ -0,0 +1,19 @@
+module Checkr
+  class Geo < APIResource
+
+    attribute :name
+    attribute :state
+
+    api_class_method :all, :get, :constructor => APIList.constructor(:Geo)
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+    api_class_method :create, :post
+
+    api_instance_method :delete, :delete
+
+    def self.path
+      "/v1/geos"
+    end
+
+    APIClass.register_subclass(self, "geo")
+  end
+end

data/lib/checkr/motor_vehicle_report.rb

@@ -0,0 +1,31 @@
+module Checkr
+  class MotorVehicleReport < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :full_name
+    attribute :license_number
+    attribute :license_state
+    attribute :previous_license_number
+    attribute :previous_license_state
+    attribute :license_status
+    attribute :license_type
+    attribute :license_class
+    attribute :expiration_date
+    attribute :issued_date
+    attribute :first_issued_date
+    attribute :inferred_issued_date
+    attribute :restrictions
+    attribute :accidents
+    attribute :violations
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/motor_vehicle_reports"
+    end
+
+    APIClass.register_subclass(self, "motor_vehicle_report")
+  end
+end

data/lib/checkr/national_criminal_search.rb

@@ -0,0 +1,17 @@
+module Checkr
+  class NationalCriminalSearch < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :records
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/national_criminal_searches"
+    end
+
+    APIClass.register_subclass(self, "national_criminal_search")
+  end
+end

data/lib/checkr/report.rb

@@ -0,0 +1,43 @@
+module Checkr
+  class Report < APIResource
+
+    attribute :status
+    attribute :values
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :package
+    attribute :values
+    attribute :candidate, :Candidate
+    attribute_writer_alias :candidate_id, :candidate
+
+    attribute :ssn_trace, :SSNTrace
+    attribute_writer_alias :ssn_trace_id, :ssn_trace
+
+    attribute :sex_offender_search, :SexOffenderSearch
+    attribute_writer_alias :sex_offender_search_id, :sex_offender_search
+
+    attribute :national_criminal_search, :NationalCriminalSearch
+    attribute_writer_alias :national_criminal_search_id, :national_criminal_search
+
+    attribute :terrorist_watchlist_search, :TerroristWatchlistSearch
+    attribute_writer_alias :terrorist_watchlist_search_id, :terrorist_watchlist_search
+
+    attribute :county_criminal_searches, APIList.constructor(:CountyCriminalSearch)
+    attribute_writer_alias :county_criminal_search_ids, :county_criminal_searches
+
+    attribute :motor_vehicle_report, :MotorVehicleReport
+    attribute_writer_alias :motor_vehicle_report_id, :motor_vehicle_report
+
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+    api_class_method :create, :post
+
+    api_instance_method :save, :post, :default_params => :changed_attributes
+
+    def self.path
+      "/v1/reports"
+    end
+
+    APIClass.register_subclass(self, "report")
+  end
+end

data/lib/checkr/report_list.rb

@@ -0,0 +1,27 @@
+module Checkr
+  class ReportList < APIList
+
+    attr_accessor :parent
+
+    api_instance_method :create, :post, :constructor => :Report, :default_params => :create_defaults, :arguments => [:package]
+
+    def self.construct(json, parent=nil)
+      lambda = constructor(:Report)
+      instance = lambda.call(json)
+      instance.parent = parent if parent
+      instance.clear_changed_attributes
+      instance
+    end
+
+    def path
+      "/v1/reports"
+    end
+
+    def create_defaults
+      {
+        :candidate_id => parent.id
+      }
+    end
+
+  end
+end

data/lib/checkr/sex_offender_search.rb

@@ -0,0 +1,18 @@
+module Checkr
+  class SexOffenderSearch < APIResource
+
+    attribute :status
+    attribute :values
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :records
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/sex_offender_searches"
+    end
+
+    APIClass.register_subclass(self, "sex_offender_search")
+  end
+end

data/lib/checkr/ssn_trace.rb

@@ -0,0 +1,18 @@
+module Checkr
+  class SSNTrace < APIResource
+
+    attribute :status
+    attribute :completed_at
+    attribute :turnaround_time
+    attribute :ssn
+    attribute :addresses
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+
+    def self.path
+      "/v1/ssn_traces"
+    end
+
+    APIClass.register_subclass(self, "ssn_trace")
+  end
+end

data/lib/checkr/subscription.rb

@@ -0,0 +1,27 @@
+module Checkr
+  class Subscription < APIResource
+
+    attribute :status
+    attribute :values
+    attribute :canceled_at
+    attribute :package
+    attribute :values
+    attribute :interval_count
+    attribute :interval_unit
+    attribute :values
+    attribute :start_date
+    attribute :candidate, :Candidate
+    attribute_writer_alias :candidate_id, :candidate
+
+    api_class_method :retrieve, :get, ":path/:id", :arguments => [:id]
+    api_class_method :create, :post
+
+    api_instance_method :cancel, :delete
+
+    def self.path
+      "/v1/subscriptions"
+    end
+
+    APIClass.register_subclass(self, "subscription")
+  end
+end