checkr-canada 0.1.0

data/spec/cases/criminal_records_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Criminal Records" do
+  let(:client) { Checkr::Canada::Client.new("test_api_key") }
+
+  describe "#create" do
+    let(:answer) do
+      File.read("./spec/fixtures/criminal_record.json")
+    end
+
+    let(:params) do
+      {
+        candidate_id: 'abc123xyz',
+        offence: "Pissing in the street",
+        sentence_date: Time.new(2001, 3, 21, 14, 0, 0),
+        location: "Moscow"
+      }
+    end
+
+    subject(:doc) { client.criminal_records.create(**params) }
+
+    before do
+      stub_request(:post, /candidates\/abc123xyz\/criminal_records/)
+        .to_return(
+          body: answer,
+          status: 201
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:post, "https://api.checkr.com/ca/v1/candidates/abc123xyz/criminal_records")
+      ).to have_been_made
+    end
+
+    it "returns a record", :aggregate_failures do
+      expect(doc.sentence_date).to eq "2001-03-21"
+      expect(doc.created_at).to be_a(DateTime)
+    end
+
+    it "raises when missing params" do
+      params.delete(:offence)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "raises when missing candidate_id" do
+      params.delete(:candidate_id)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/cases/document_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Documents" do
+  let(:client) { Checkr::Canada::Client.new("test_api_key") }
+
+  describe "#upload" do
+    let(:answer) do
+      File.read("./spec/fixtures/document.json")
+    end
+
+    let(:params) do
+      {
+        candidate_id: 'abc123xyz',
+        type: "identification",
+        url: "http://example.com/image.png",
+        filename: "test.png"
+      }
+    end
+
+    subject(:doc) { client.documents.upload(**params) }
+
+    before do
+      stub_request(:post, /candidates\/abc123xyz\/documents/)
+        .to_return(
+          body: answer,
+          status: 201
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:post, "https://api.checkr.com/ca/v1/candidates/abc123xyz/documents")
+      ).to have_been_made
+    end
+
+    it "returns a document", :aggregate_failures do
+      expect(doc.filename).to eq "test.png"
+      expect(doc.created_at).to be_a(DateTime)
+    end
+
+    it "raises when missing params" do
+      params.delete(:type)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "raises when unknown type" do
+      params[:type] = "image"
+
+      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/reports_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "Reports" 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.reports.all(**options) }
+
+    before do
+      stub_request(:get, /reports/)
+        .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/reports")
+          .with(query: { per_page: 1, page: 2 })
+        ).to have_been_made
+      end
+    end
+
+    context "with data" do
+      let(:answer) do
+        File.read("./spec/fixtures/reports.json")
+      end
+
+      it "builds report", :aggregate_failures do
+        expect(subject.data.size).to eq 1
+
+        report = subject.data.first
+
+        expect(report.package).to eq "criminal"
+        expect(report.created_at).to be_a(DateTime)
+        expect(report.created_at.to_date).to eq Date.new(2017, 5, 2)
+        expect(report.candidate_id).to eq "7f23225f47ee143389595481"
+      end
+    end
+  end
+
+  describe "#get" do
+    let(:answer) do
+      File.read("./spec/fixtures/report.json")
+    end
+
+    subject(:report) { client.reports.get('123abc') }
+
+    before do
+      stub_request(:get, /reports\/123/)
+        .to_return(
+          body: answer
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:get, "https://api.checkr.com/ca/v1/reports/123abc")
+      ).to have_been_made
+    end
+
+    it "builds report", :aggregate_failures do
+      expect(report.package).to eq "criminal"
+      expect(report.created_at).to be_a(DateTime)
+      expect(report.created_at.to_date).to eq Date.new(2017, 5, 2)
+      expect(report.candidate_id).to eq "7f23225f47ee143389595481"
+    end
+
+    context "not found" do
+      before do
+        stub_request(:get, /reports\/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/report.json")
+    end
+
+    let(:params) do
+      {
+        candidate_id: "abc123",
+        package: "criminal"
+      }
+    end
+
+    subject(:report) { client.reports.create(params) }
+
+    before do
+      stub_request(:post, /reports/)
+        .to_return(
+          body: answer,
+          status: 201
+        )
+    end
+
+    it "makes request" do
+      subject
+
+      expect(
+        a_request(:post, "https://api.checkr.com/ca/v1/candidates/abc123/reports")
+      ).to have_been_made
+    end
+
+    it "returns a report", :aggregate_failures do
+      expect(report.package).to eq "criminal"
+    end
+
+    it "raises when unknown package" do
+      params[:package] = "test"
+
+      expect { subject }.to raise_error(Dry::Types::ConstraintError)
+    end
+
+    it "raises when missing candidate_id" do
+      params.delete(:candidate_id)
+
+      expect { subject }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/checkr/canada/types_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Checkr::Canada::Types do
+  describe "Status" do
+    subject { described_class::Status }
+
+    it "accepts", :aggregate_failures do
+      expect(subject["clear"]).to eq "clear"
+      expect(subject["pending"]).to eq "pending"
+      expect(subject["consider"]).to eq "consider"
+      expect(subject["suspended"]).to eq "suspended"
+    end
+
+    it "rejects" do
+      expect { subject["foobar"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+
+  describe "Date" do
+    subject { described_class::Date }
+
+    it "accepts valid string" do
+      expect(subject["1989-07-01"]).to eq "1989-07-01"
+    end
+
+    it "accepts Date" do
+      expect(subject[Date.new(1988, 2, 12)]).to eq "1988-02-12"
+    end
+
+    it "accepts Time" do
+      expect(subject[Time.new(1990, 12, 31, 12, 0, 0)]).to eq "1990-12-31"
+    end
+
+    it "rejects invalid string" do
+      expect { subject["today"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+
+  describe "Gender" do
+    subject { described_class::Gender }
+
+    it "accepts", :aggregate_failures do
+      expect(subject["M"]).to eq "M"
+      expect(subject["F"]).to eq "F"
+    end
+
+    it "rejects" do
+      expect { subject["Any"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+
+  describe "Package" do
+    subject { described_class::Package }
+
+    it "accepts", :aggregate_failures do
+      expect(subject["mvr"]).to eq "mvr"
+      expect(subject["criminal"]).to eq "criminal"
+      expect(subject["criminal_mvr"]).to eq "criminal_mvr"
+    end
+
+    it "rejects" do
+      expect { subject["stupid"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+
+  describe "DocumentType" do
+    subject { described_class::DocumentType }
+
+    it "accepts", :aggregate_failures do
+      expect(subject["identification"]).to eq "identification"
+      expect(subject["consent"]).to eq "consent"
+    end
+
+    it "rejects" do
+      expect { subject["image"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+
+  describe "Province" do
+    subject { described_class::Province }
+
+    it "accepts", :aggregate_failures do
+      # rubocop: disable Style/WordArray
+      [
+        'AB',
+        'BC',
+        'MB',
+        'NB',
+        'NL',
+        'NT',
+        'NS',
+        'NU',
+        'ON',
+        'PE',
+        'QC',
+        'SK',
+        'YT'
+      ].each do |province|
+        expect(subject[province]).to eq province
+      end
+    end
+
+    it "rejects" do
+      expect { subject["New York"] }.to raise_error(Dry::Types::ConstraintError)
+    end
+  end
+end

data/spec/checkr/canada_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Checkr::Canada do
+  it "has a version number" do
+    expect(Checkr::Canada::VERSION).not_to be nil
+  end
+end

data/spec/fixtures/address.json

@@ -0,0 +1,14 @@
+{
+  "id": "123123zya",
+  "object": "address",
+  "uri": "/ca/v1/addresses/123123zya",
+  "created_at": "2017-03-23T03:02:52Z",
+  "updated_at": "2017-03-23T03:02:52Z",
+  "street1": "Mission st",
+  "street2": "4-2",
+  "city": "San Francisco",
+  "region": "BC",
+  "country": "CA",
+  "postal_code": "BC341",
+  "start_date": "2017-01-02"
+}

data/spec/fixtures/candidate.json

@@ -0,0 +1,24 @@
+{
+  "id": "ca1b9ca32fc52fd902a57487",
+  "custom_id": null,
+  "birth_country": "CA",
+  "birth_place": "Toronto",
+  "dob": "1975-03-19",
+  "driver_license_number": null,
+  "driver_license_province": null,
+  "email": "testonboard@test.com",
+  "entry_date": null,
+  "first_name": "Test",
+  "gender": "M",
+  "last_name": "Candidate",
+  "middle_name": "",
+  "mother_maiden_name": null,
+  "nationality": null,
+  "object": "test_candidate",
+  "phone": "000-000-0002",
+  "province": null,
+  "uri": "/ca/v1/candidates/ca1b9ca32fc52fd902a57487",
+  "created_at": "2017-03-23T03:02:52Z",
+  "address_ids": [],
+  "disclosed_criminal_record_ids": []
+}

data/spec/fixtures/candidates.json

@@ -0,0 +1,30 @@
+{
+  "object": "list",
+  "count": 1,
+  "data": [
+    {
+      "id": "ca1b9ca32fc52fd902a57487",
+      "custom_id": null,
+      "birth_country": "CA",
+      "birth_place": "Toronto",
+      "dob": "1975-03-19",
+      "driver_license_number": null,
+      "driver_license_province": null,
+      "email": "testonboard@test.com",
+      "entry_date": null,
+      "first_name": "Test",
+      "gender": "M",
+      "last_name": "Candidate",
+      "middle_name": "",
+      "mother_maiden_name": null,
+      "nationality": null,
+      "object": "test_candidate",
+      "phone": "000-000-0002",
+      "province": null,
+      "uri": "/ca/v1/candidates/ca1b9ca32fc52fd902a57487",
+      "created_at": "2017-03-23T03:02:52Z",
+      "address_ids": [],
+      "disclosed_criminal_record_ids": []
+    }
+  ]
+}