checkr-canada 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a0f958343edf3ee08da068b738327fac6b89b61
+  data.tar.gz: f8b8f3addf39dadd1333fa793c59a1312f45523f
+SHA512:
+  metadata.gz: 994a7ed50ae4c915be1175ce3123f3571cef20226f03eff96ae6cbe77fd18098e3b794de5da482b7186cebb256fab2d6e7ab2c3475564e9f3bdc554772c2547b
+  data.tar.gz: d6c200d385c955e416ff9027b561faffe34c5d0198edbca8130d66fb67ec1572b4843624702864fb8bf922a7e43d568798b9cac028cb5c6c45a2a4b0e5c9c177

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,76 @@
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - '*.gemspec'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
+
+Rails:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'lib/checkr/canada/entities/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/checkr/canada/entities/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'lib/checkr/canada/entities/**/*.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/checkr/canada/entities/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 palkan
+
+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,140 @@
+# Checkr Canada API Client
+
+[Checkr Canada](https://checkr-canada.api-docs.io/v1/overview) API client.
+
+Built on top of [evil-client](https://github.com/evilmartians/evil-client).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkr-canada'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkr-canada
+
+## Usage
+
+
+First, you should initialize a client using your API key:
+
+```ruby
+require 'checkr-canada'
+
+client = Checkr::Canada::Client.new('my-checkr-api-key')
+```
+
+Then you can make API requests:
+
+
+```ruby
+# ==== Candidates ==== #
+
+# Create a candidate
+client.candidates.create(
+  first_name: "Test",
+  last_name: "Candidate",
+  email: "testonboard@test.com",
+  phone: "000-000-0002",
+  birth_place: "Toronto",
+  dob: Date.new(2017, 3, 23), # accepts Data, Time and String objects
+  gender: "F"
+)
+
+#=> <Checkr::Canada::Entities::Candidate ...>
+
+
+# Get a candidate
+client.candidates.get("123123123")
+
+#=> <Checkr::Canada::Entities::Candidate ...>
+
+# List candidates
+result = client.candidates.all(page: 1, per_page: 10)
+result.count = 42
+result.data #=> [<Checkr::Canada::Entities::Candidate ...>, ...]
+
+
+# ==== Documents ==== #
+
+# Upload a document
+client.documents.upload(candidate_id: "123", url: "https://example.com/image.png", type: "identification")
+
+#=> <Checkr::Canada::Entities::Document ...>
+
+
+# ==== Addresses ==== #
+
+# Create an address for a candidate
+client.addresses.create(
+  candidate_id: "123",
+  street1: "Mission st",
+  street2: "4-2",
+  region: "BC",
+  city: "San Francisco",
+  postal_code: "BC341",
+  start_date: "2017-01-02"
+)
+
+#=> <Checkr::Canada::Entities::Address ...>
+
+
+# ==== Reports ==== #
+
+# Create a report
+client.reports.create(candidate_id: "123", package: "mvr")
+
+#=> <Checkr::Canada::Entities::Report ...>
+
+# Get a report
+client.report.get("123123123")
+
+#=> <Checkr::Canada::Entities::Report ...>
+
+# List reports
+result = client.reports.all(page: 1, per_page: 10)
+result.count = 42
+result.data #=> [<Checkr::Canada::Entities::Report ...>, ...]
+
+# ==== Criminal Records ==== #
+
+# Create a record
+client.criminal_records.create(candidate_id: 'ca1b9ca32fc52fd902a57487', offence: 'Killing Teddy Bear', sentence_date: Date.today, location: 'Moscow')
+
+#=> <Checkr::Canada::Entities::CriminalRecord ...>
+```
+
+### Exceptions
+
+Client uses `dry-types` and `evil-client` gems to validate params and response format. There can be the following exceptions:
+
+- `Dry::Types::ConstraintError` when provided data is invalid
+
+- `ArgumentError` when required params are missing
+
+- `Evil::Client::Operation::ResponseError` when API-level error occurs (e.g. authentication failure, resource not found, etc)
+
+- `Evil::Client::Operation::UnexpectedResponseError` when we fail to parse response.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/checkr-canada.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "checkr-canada"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/checkr-canada.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkr/canada/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "checkr-canada"
+  spec.version       = Checkr::Canada::VERSION
+  spec.authors       = ["palkan"]
+  spec.email         = ["dementiev.vm@gmail.com"]
+
+  spec.summary       = "Checkr Canada API client"
+  spec.description   = "Checkr Canda API client (https://checkr-canada.api-docs.io/v1/overview)"
+  spec.homepage      = "http://github.com/onboardiq/checkr-canada"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "dry-types", "~> 0.10.3"
+  spec.add_runtime_dependency "evil-client", "~> 0.3.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/lib/checkr-canada.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "checkr/canada"

data/lib/checkr/canada.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "checkr/canada/version"
+require "checkr/canada/client"
+
+module Checkr
+  module Canada # :nodoc:
+  end
+end

data/lib/checkr/canada/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "evil-client"
+require "base64"
+
+require_relative "types"
+require_relative "ext/stringify_json_patch"
+
+module Checkr
+  module Canada
+    # Checkr Canada API client
+    class Client
+      extend Evil::Client::DSL
+
+      path = File.expand_path("../entities/*.rb", __FILE__)
+      Dir[path].each { |file| require(file) }
+
+      settings do
+        param :api_key, Types::Strict::String
+        option :version, Types::Coercible::Int, default: proc { 1 }
+      end
+
+      base_url do |settings|
+        "https://api.checkr.com/ca/v#{settings.version}/"
+      end
+
+      operation do |settings|
+        security { basic_auth settings.api_key, '' }
+      end
+    end
+  end
+end
+
+Evil::Client::Middleware::StringifyJson.prepend StringifyJsonPatch

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    module Entities
+      class AddressForm < Evil::Struct
+        attribute :street1, Types::Strict::String
+        attribute :street2, Types::String, optional: true
+        attribute :region, Types::Province
+        attribute :city, Types::Strict::String
+        attribute :postal_code, Types::Strict::String
+        attribute :country, Types::Strict::String, default: proc { "CA" }
+        attribute :start_date, Types::Date
+      end
+
+      class Address < AddressForm
+        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_address do |_settings|
+        http_method :post
+
+        path { |candidate_id:, **| "candidates/#{candidate_id}/addresses" }
+
+        body format: "json", model: Entities::AddressForm
+
+        response :success, 201, format: :json, model: Entities::Address
+
+        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 :addresses do
+        def create(data)
+          operations[:create_address].call(data)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Checkr
+  module Canada
+    module Entities
+      class CandidateForm < Evil::Struct
+        attribute :first_name, Types::Strict::String
+        attribute :middle_name, Types::String, optional: true
+        attribute :last_name, Types::Strict::String
+        attribute :mother_maiden_name, Types::String, optional: true
+
+        attribute :email, Types::Email
+        attribute :dob, Types::Date
+        attribute :phone, Types::Strict::String
+        attribute :gender, Types::Gender, optional: true
+
+        attribute :birth_place, Types::String, optional: true
+        attribute :birth_country, Types::Strict::String, default: proc { 'CA' }
+
+        attribute :driver_license_province, Types::String, optional: true
+        attribute :driver_license_number, Types::String, optional: true
+
+        attribute :nationality, Types::String, optional: true
+        attribute :entry_date, Types::String, optional: true
+
+        attribute :custom_id, Types::String, optional: true
+      end
+
+      class Candidate < CandidateForm
+        attribute :id, Types::Strict::String
+        attribute :object, Types::Strict::String
+        attribute :uri, Types::Strict::String
+        attribute :created_at, Types::Json::DateTime
+        attribute :updated_at, Types::Json::DateTime, optional: true
+
+        attribute :address_ids, Types::Strict::Array.member(Types::Strict::String)
+      end
+    end
+
+    class Client
+      operation :list_candidates do |_settings|
+        http_method :get
+        path { "candidates" }
+
+        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::Candidate)
+        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_candidate do |_settings|
+        http_method :get
+        path { |id:, **| "candidates/#{id}" }
+
+        response :success, 200, format: :json, model: Entities::Candidate
+
+        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_candidate do |_settings|
+        http_method :post
+
+        path { "candidates" }
+
+        body format: "json", model: Entities::CandidateForm
+
+        response :success, 201, format: :json, model: Entities::Candidate
+
+        response :not_authorized, 401, format: :json, raise: true do
+          attribute :error
+        end
+      end
+
+      scope :candidates do
+        def all(**data)
+          operations[:list_candidates].call(**data)
+        end
+
+        def get(id, data = {})
+          operations[:get_candidate].call(data.merge(id: id))
+        end
+
+        def create(data)
+          operations[:create_candidate].call(data)
+        end
+      end
+    end
+  end
+end