checkr-canada 0.1.0

data/lib/checkr/canada/entities/criminal_record.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    module Entities
+      class CriminalRecordForm < Evil::Struct
+        attribute :offence, Types::Strict::String
+        attribute :location, Types::Strict::String
+        attribute :sentence_date, Types::Date
+      end
+
+      class CriminalRecord < CriminalRecordForm
+        attribute :id, Types::Strict::String
+        attribute :object, Types::String, optional: true
+        attribute :uri, Types::Strict::String
+        attribute :created_at, Types::Json::DateTime
+        attribute :updated_at, Types::Json::DateTime, optional: true
+      end
+    end
+
+    class Client
+      operation :create_criminal_record do |_settings|
+        http_method :post
+
+        path do |candidate_id:, **|
+          "candidates/#{candidate_id}/criminal_records"
+        end
+
+        body format: "json", model: Entities::CriminalRecordForm
+
+        response :success, 201, format: :json, model: Entities::CriminalRecord
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+
+        response :invalid, 400, format: :json, raise: true do
+          attribute :error
+        end
+      end
+
+      scope :criminal_records do
+        def create(data)
+          operations[:create_criminal_record].call(data)
+        end
+      end
+    end
+  end
+end

data/lib/checkr/canada/entities/document.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    module Entities
+      class Document < Evil::Struct
+        attribute :id, Types::Strict::String
+        attribute :object, Types::String, optional: true
+        attribute :filename, Types::String, optional: true
+        attribute :uri, Types::Strict::String
+        attribute :download_uri, Types::Strict::String
+        attribute :created_at, Types::Json::DateTime
+        attribute :content_type, Types::String, optional: true
+        attribute :filesize, Types::Int, optional: true
+      end
+    end
+
+    class Client
+      operation :upload_document do |_settings|
+        http_method :post
+
+        path { |candidate_id:, **| "candidates/#{candidate_id}/documents" }
+
+        body format: "json" do
+          attribute :type, Types::DocumentType
+          attribute :url, Types::Strict::String
+          attribute :filename, Types::Strict::String, optional: true
+        end
+
+        response :success, 201, format: :json, model: Entities::Document
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+
+        response :invalid, 400, format: :json, raise: true do
+          attribute :error
+        end
+      end
+
+      scope :documents do
+        def upload(data)
+          operations[:upload_document].call(data)
+        end
+      end
+    end
+  end
+end

data/lib/checkr/canada/entities/report.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    module Entities
+      class Report < Evil::Struct
+        attribute :id, Types::Strict::String
+        attribute :object, Types::Strict::String
+        attribute :uri, Types::Strict::String
+        attribute :package, Types::Package
+        attribute :status, Types::Status
+        attribute :adjudication, Types::String, optional: true
+        attribute :created_at, Types::Json::DateTime
+        attribute :completed_at, Types::Json::DateTime
+        attribute :turnaround_time, Types::Int, optional: true
+        attribute :account_id, Types::Strict::String, optional: true
+        attribute :candidate_id, Types::Strict::String, optional: true
+        attribute :motor_vehicle_report_id, Types::String, optional: true
+        attribute :national_criminal_search_id, Types::String, optional: true
+        attribute :criminal_record_ids, Types::Array.member(Types::Strict::String), optional: true
+        attribute :document_ids, Types::Array.member(Types::Strict::String), optional: true
+      end
+    end
+
+    class Client
+      operation :list_reports do |_settings|
+        http_method :get
+        path { "reports" }
+
+        query do
+          attributes optional: true do
+            attribute :page
+            attribute :per_page
+          end
+        end
+
+        response :success, 200, format: :json do
+          attribute :object, Types::Strict::String
+          attribute :next_href, Types::String, optional: true
+          attribute :previous_href, Types::String, optional: true
+          attribute :count, Types::Strict::Int
+          attribute :data, Types::Coercible::Array.member(Entities::Report)
+        end
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+
+        response :not_found, 404, format: :json, raise: true do
+          attribute :error
+        end
+      end
+
+      operation :get_report do |_settings|
+        http_method :get
+        path { |id:, **| "reports/#{id}" }
+
+        response :success, 200, format: :json, model: Entities::Report
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+
+        response :not_found, 404, format: :json, raise: true do
+          attribute :message, as: :error
+        end
+      end
+
+      operation :create_report do |_settings|
+        http_method :post
+
+        path { |candidate_id:, **| "candidates/#{candidate_id}/reports" }
+
+        body format: "json" do
+          attribute :package, Types::Package
+        end
+
+        response :success, 201, format: :json, model: Entities::Report
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+
+        response :invalid, 400, format: :json, raise: true do
+          attribute :error
+        end
+      end
+
+      scope :reports do
+        def all(**data)
+          operations[:list_reports].call(**data)
+        end
+
+        def get(id, data = {})
+          operations[:get_report].call(data.merge(id: id))
+        end
+
+        def create(data)
+          operations[:create_report].call(data)
+        end
+      end
+    end
+  end
+end

data/lib/checkr/canada/ext/stringify_json_patch.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Fix setting body to '{}' when it is blank
+module StringifyJsonPatch
+  def build(env)
+    return env unless env[:format] == "json"
+    new_env = super
+    new_env.delete(:body_string) if env[:body].nil? || env[:body].empty?
+    new_env
+  end
+end

data/lib/checkr/canada/types.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "dry-types"
+
+module Checkr
+  module Canada
+    PROVINCE_CODES = %w[
+      AB
+      BC
+      MB
+      NB
+      NL
+      NT
+      NS
+      NU
+      ON
+      PE
+      QC
+      SK
+      YT
+    ].freeze
+
+    # Dry types + custom types
+    module Types
+      include Dry::Types.module
+
+      Status = Strict::String.enum(
+        'pending', 'clear', 'consider', 'suspended'
+      )
+
+      Package = Strict::String.enum(
+        'mvr', 'criminal', 'criminal_mvr'
+      )
+
+      DocumentType = Strict::String.enum(
+        'identification', 'consent'
+      )
+
+      Province = Strict::String.enum(*PROVINCE_CODES)
+
+      Gender = Strict::String.enum('M', 'F')
+      Email = Strict::String
+
+      Date = Strict::String
+             .constrained(format: /\A\d{4}-\d{2}-\d{2}\z/)
+             .constructor do |value|
+               begin
+                 date = value.to_date if value.respond_to? :to_date
+                 date ||= ::Date.parse(value.to_s)
+                 date.strftime "%Y-%m-%d"
+               rescue
+                 raise Dry::Types::ConstraintError.new(
+                   "#{value.inspect} cannot be coerced to date",
+                   value
+                 )
+               end
+             end
+    end
+  end
+end

data/lib/checkr/canada/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    VERSION = "0.1.0"
+  end
+end

data/spec/cases/addresses_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Addresses" do
+  let(:client) { Checkr::Canada::Client.new("test_api_key") }
+
+  describe "#create" do
+    let(:answer) do
+      File.read("./spec/fixtures/address.json")
+    end
+
+    let(:params) do
+      {
+        candidate_id: 'abc123xyz',
+        street1: "Mission st",
+        street2: "4-2",
+        region: "BC",
+        city: "San Francisco",
+        postal_code: "BC341",
+        start_date: "2017-01-02"
+      }
+    end
+
+    subject(:doc) { client.addresses.create(**params) }
+
+    before do
+      stub_request(:post, /candidates\/abc123xyz\/addresses/)
+        .to_return(
+          body: answer,
+          status: 201
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:post, "https://api.checkr.com/ca/v1/candidates/abc123xyz/addresses")
+      ).to have_been_made
+    end
+
+    it "returns an address", :aggregate_failures do
+      expect(doc.country).to eq "CA"
+      expect(doc.created_at).to be_a(DateTime)
+    end
+
+    it "raises when missing params" do
+      params.delete(:region)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "raises when unknown region" do
+      params[:region] = "Arizona"
+
+      expect { subject }.to raise_error(TypeError)
+    end
+
+    it "raises when missing candidate_id" do
+      params.delete(:candidate_id)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/cases/authentication_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Authentication" do
+  let(:client) { Checkr::Canada::Client.new("test_api_key") }
+  subject { client.reports.all }
+
+  context "successful" do
+    before do
+      stub_request(:get, "https://api.checkr.com/ca/v1/reports").to_return(
+        body: { data: [], object: "list", count: 0 }.to_json
+      )
+    end
+
+    it "build basic auth from api_key" do
+      subject
+
+      expect(
+        a_request(:get, "https://api.checkr.com/ca/v1/reports")
+          .with(basic_auth: ["test_api_key", ""])
+      ).to have_been_made
+    end
+  end
+
+  context "failed" do
+    before do
+      stub_request(:get, "https://api.checkr.com/ca/v1/reports").to_return(
+        body: { error: 'Not authorized' }.to_json, status: 401
+      )
+    end
+
+    it "raises error" do
+      expect { subject }.to raise_error(Evil::Client::Operation::ResponseError)
+
+      expect(
+        a_request(:get, "https://api.checkr.com/ca/v1/reports")
+          .with(basic_auth: ["test_api_key", ""])
+      ).to have_been_made
+    end
+  end
+end

data/spec/cases/candidates_spec.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Candidates" do
+  let(:client) { Checkr::Canada::Client.new("test_api_key") }
+
+  describe "#all" do
+    let(:answer) { { data: [], object: "list", count: 0 }.to_json }
+    let(:options) { {} }
+
+    subject { client.candidates.all(**options) }
+
+    before do
+      stub_request(:get, /candidates/)
+        .to_return(
+          body: answer
+        )
+    end
+
+    it "builds response", :aggregate_failures do
+      expect(subject.count).to eq 0
+      expect(subject.object).to eq 'list'
+      expect(subject.next_href).to be_nil
+      expect(subject.previous_href).to be_nil
+      expect(subject.data.size).to eq 0
+    end
+
+    context "with params" do
+      let(:options) { { per_page: 1, page: 2, foo: "bar" } }
+
+      it "recognizes only valid params" do
+        subject
+
+        expect(
+          a_request(:get, "https://api.checkr.com/ca/v1/candidates")
+          .with(query: { per_page: 1, page: 2 })
+        ).to have_been_made
+      end
+    end
+
+    context "with data" do
+      let(:answer) do
+        File.read("./spec/fixtures/candidates.json")
+      end
+
+      it "builds candidate", :aggregate_failures do
+        expect(subject.data.size).to eq 1
+
+        candidate = subject.data.first
+
+        expect(candidate.dob).to eq "1975-03-19"
+        expect(candidate.created_at).to be_a(DateTime)
+        expect(candidate.created_at.to_date).to eq Date.new(2017, 3, 23)
+      end
+    end
+  end
+
+  describe "#get" do
+    let(:answer) do
+      File.read("./spec/fixtures/candidate.json")
+    end
+
+    subject(:candidate) { client.candidates.get('123abc') }
+
+    before do
+      stub_request(:get, /candidates\/123/)
+        .to_return(
+          body: answer
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:get, "https://api.checkr.com/ca/v1/candidates/123abc")
+      ).to have_been_made
+    end
+
+    it "builds candidate", :aggregate_failures do
+      expect(candidate.dob).to eq "1975-03-19"
+      expect(candidate.created_at).to be_a(DateTime)
+      expect(candidate.created_at.to_date).to eq Date.new(2017, 3, 23)
+    end
+
+    context "not found" do
+      before do
+        stub_request(:get, /candidates\/123/)
+          .to_return(
+            body: { message: 'Not found' }.to_json,
+            status: 404
+          )
+      end
+
+      it "raises error" do
+        expect { subject }.to raise_error(Evil::Client::Operation::ResponseError)
+      end
+    end
+  end
+
+  describe "#create" do
+    let(:answer) do
+      File.read("./spec/fixtures/candidate.json")
+    end
+
+    let(:params) do
+      {
+        first_name: "Test",
+        last_name: "Candidate",
+        email: "testonboard@test.com",
+        phone: "000-000-0002",
+        birth_place: "Toronto",
+        dob: Date.new(2017, 3, 23),
+        gender: "F"
+      }
+    end
+
+    subject(:candidate) { client.candidates.create(params) }
+
+    before do
+      stub_request(:post, /candidates/)
+        .to_return(
+          body: answer,
+          status: 201
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:post, "https://api.checkr.com/ca/v1/candidates")
+      ).to have_been_made
+    end
+
+    it "returns a candidate", :aggregate_failures do
+      expect(candidate.first_name).to eq "Test"
+      expect(candidate.last_name).to eq "Candidate"
+    end
+
+    it "raises when missing params" do
+      params.delete(:first_name)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+  end
+end