passfort 0.2.0

data/spec/fixtures/profile.json

@@ -0,0 +1,128 @@
+{
+    "applications": [
+        {
+            "approval_blockers": [
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_VERIFY_IDENTITY"
+                },
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_IDENTIFY_AUTHORIZED_PERSONS"
+                },
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_IDENTIFY_OFFICERS"
+                },
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_IDENTIFY_BENEFICIAL_OWNERS"
+                },
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_ASSESS_SANCTIONS_EXPOSURE"
+                },
+                {
+                    "blocker_type": "INCOMPLETE_TASK",
+                    "task_type": "COMPANY_REVIEW_FILINGS"
+                }
+            ],
+            "history": [
+                {
+                    "date": "2018-01-15 11:39:17",
+                    "status": "APPLIED"
+                }
+            ],
+            "id": "b83a64ec-f9e8-11e7-82a7-000000000000",
+            "product": {
+                "id": "eb299330-f63a-11e7-bc01-000000000000",
+                "name": "Mortgage"
+            },
+            "status": "APPLIED"
+        }
+    ],
+    "category": "APPLICANT",
+    "checks": [],
+    "collected_data": {
+        "entity_type": "COMPANY",
+        "metadata": {
+            "country_of_incorporation": "GBR",
+            "number": "09565115"
+        }
+    },
+    "collection_steps": [],
+    "display_name": "PassFort Limited",
+    "document_images": [],
+    "events": [],
+    "has_associates": false,
+    "has_collection_steps": false,
+    "id": "b82b0434-f9e8-11e7-8397-000000000000",
+    "linked_to": [],
+    "risk": {},
+    "role": "COMPANY_CUSTOMER",
+    "status": "NORMAL",
+    "tags": [],
+    "task_progress": {
+        "completed_count": 0,
+        "total_count": 6
+    },
+    "task_types": [
+        "COMPANY_VERIFY_IDENTITY",
+        "COMPANY_IDENTIFY_AUTHORIZED_PERSONS",
+        "COMPANY_IDENTIFY_OFFICERS",
+        "COMPANY_IDENTIFY_BENEFICIAL_OWNERS",
+        "COMPANY_ASSESS_SANCTIONS_EXPOSURE",
+        "COMPANY_REVIEW_FILINGS"
+    ],
+    "tasks": [
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b83e2d7e-f9e8-11e7-8229-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_VERIFY_IDENTITY"
+        },
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b841b73e-f9e8-11e7-b17f-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_IDENTIFY_AUTHORIZED_PERSONS"
+        },
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b843d282-f9e8-11e7-b539-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_IDENTIFY_OFFICERS"
+        },
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b845e7f4-f9e8-11e7-a4d1-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_IDENTIFY_BENEFICIAL_OWNERS"
+        },
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b8485a78-f9e8-11e7-86ee-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_ASSESS_SANCTIONS_EXPOSURE"
+        },
+        {
+            "check_ids": [],
+            "creation_date": "2018-01-15 11:39:17",
+            "id": "b84ad2de-f9e8-11e7-806b-000000000000",
+            "is_complete": false,
+            "is_expired": false,
+            "type": "COMPANY_REVIEW_FILINGS"
+        }
+    ],
+    "unresolved_event_types": []
+}

data/spec/fixtures/task.json

@@ -0,0 +1,6 @@
+{
+    "type": "INDIVIDUAL_VERIFY_ADDRESS",
+    "check_ids": [],
+    "id": "33cdc540-61e0-11e7-b07b-acbc32b67d7b",
+    "is_complete": false
+}

data/spec/integration/company_ownership_check_spec.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+# https://www.passfort.com/developer/recipes/running-a-company-ownership-check
+# rubocop:disable RSpec/DescribeClass
+# rubocop:disable RSpec/ExampleLength
+RSpec.describe "running a company ownership check" do
+  let(:api_key) { "api_key" }
+  let(:client) { Passfort::Client.new(api_key: api_key) }
+
+  let(:profile_fixture) { load_fixture("company_ownership_check/profile.json") }
+  let(:check_fixture) { load_fixture("company_ownership_check/check.json") }
+  let(:collected_data_fixture) do
+    load_fixture("company_ownership_check/collected_data.json")
+  end
+  let(:collected_data_update_fixture) do
+    load_fixture("company_ownership_check/collected_data_update_request.json")
+  end
+
+  let(:profile_id) { JSON.parse(profile_fixture)["id"] }
+  let(:create_profile_args) do
+    {
+      role: Passfort::Role::COMPANY_CUSTOMER,
+      collected_data: {
+        entity_type: Passfort::EntityType::COMPANY,
+        metadata: {
+          country_of_incorporation: "GBR",
+          number: "09565115",
+        },
+      },
+    }
+  end
+
+  before do
+    stub_request(:post, %r{/profiles\z}).
+      with(body: create_profile_args).
+      to_return(status: 201, body: profile_fixture)
+    stub_request(:post, %r{/profiles/#{profile_id}/checks\z}).
+      with(body: { check_type: "COMPANY_OWNERSHIP" }).
+      to_return(status: 201, body: check_fixture)
+    stub_request(:get, %r{/profiles/#{profile_id}/collected_data\z}).
+      to_return(
+        status: 200,
+        body: collected_data_fixture,
+      )
+    stub_request(:post, %r{/profiles/#{profile_id}/collected_data\z}).
+      with(body: JSON.parse(collected_data_update_fixture)).
+      to_return(
+        status: 200,
+        body: collected_data_fixture,
+      )
+  end
+
+  it "succeeds" do
+    profile = client.profiles.create(create_profile_args)
+
+    expect(profile.id).to eq(profile_id)
+
+    check = client.checks.create(profile_id: profile.id, check_type: "COMPANY_OWNERSHIP")
+
+    shareholders = check.output_data[:ownership_structure][:shareholders]
+    beneficial_owners = shareholders.select { |sh| sh[:total_percentage] >= 25 }
+
+    collected_data = client.profiles.collected_data(profile.id).to_h
+
+    collected_data[:ownership_structure] ||= {}
+    collected_data[:ownership_structure][:shareholders] = beneficial_owners
+
+    client.profiles.update_collected_data(profile.id, collected_data)
+  end
+end
+# rubocop:enable RSpec/DescribeClass
+# rubocop:enable RSpec/ExampleLength

data/spec/passfort/endpoint/checks_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Endpoint::Checks do
+  let(:endpoint) { described_class.new(Passfort::Http.new("api_key")) }
+
+  describe "#create" do
+    subject { endpoint.create(profile_id: profile_id, check_type: check_type) }
+
+    let(:profile_id) { "a_profile_id" }
+    let(:check_type) { "a_check_type" }
+
+    before do
+      stub_request(:post, %r{/profiles/#{profile_id}/checks\z}).
+        with(body: { check_type: check_type }).
+        to_return(status: 200, body: load_fixture("check.json"))
+    end
+
+    it { is_expected.to have_attributes(id: "6c1d594a-496e-11e7-911e-acbc32b67d7b") }
+  end
+end

data/spec/passfort/endpoint/profiles_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Endpoint::Profiles do
+  let(:profiles) { described_class.new(client) }
+
+  let(:client) { instance_double(Passfort::Http) }
+
+  let(:profile_fixture) { JSON.parse(load_fixture("profile.json")) }
+  let(:collected_data_fixture) { JSON.parse(load_fixture("collected_data.json")) }
+
+  describe "#create" do
+    subject { profiles.create(role: role, collected_data: collected_data) }
+
+    let(:role) { Passfort::Role::COMPANY_CUSTOMER }
+    let(:collected_data) { {} }
+
+    before do
+      allow(client).
+        to receive(:post).
+        with("/profiles", body: { role: role, collected_data: collected_data }).
+        and_return(profile_fixture)
+    end
+
+    it { is_expected.to have_attributes(id: profile_fixture["id"]) }
+  end
+
+  describe "#find" do
+    subject { profiles.find(id) }
+
+    let(:id) { profile_fixture["id"] }
+
+    before do
+      allow(client).to receive(:get).with("/profiles/#{id}").and_return(profile_fixture)
+    end
+
+    it { is_expected.to have_attributes(id: id) }
+  end
+
+  describe "#collected_data" do
+    subject { profiles.collected_data(id) }
+
+    let(:id) { profile_fixture["id"] }
+
+    before do
+      allow(client).
+        to receive(:get).
+        with("/profiles/#{id}/collected_data").
+        and_return(collected_data_fixture)
+    end
+
+    it { is_expected.to have_attributes(entity_type: Passfort::EntityType::COMPANY) }
+    it { is_expected.to be_a(Passfort::Resource::CompanyData) }
+  end
+
+  describe "#update_collected_data" do
+    subject { profiles.update_collected_data(id, data) }
+
+    let(:id) { profile_fixture["id"] }
+    let(:data) do
+      collected_data_fixture.merge(metadata: { country_of_incorporation: "FR" })
+    end
+
+    before do
+      allow(client).
+        to receive(:post).
+        with("/profiles/#{id}/collected_data", body: data).
+        and_return(data)
+    end
+
+    it do
+      is_expected.to have_attributes(
+        entity_type: Passfort::EntityType::COMPANY,
+        metadata: { country_of_incorporation: "FR" },
+      )
+    end
+  end
+end

data/spec/passfort/endpoint/tasks_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Endpoint::Tasks do
+  let(:endpoint) { described_class.new(Passfort::Http.new("api_key")) }
+
+  describe "#find" do
+    subject { endpoint.find(profile_id: profile_id, task_id: task_id) }
+
+    let(:profile_id) { "a_profile_id" }
+    let(:task_id) { "a_task_id" }
+
+    before do
+      stub_request(:get, %r{/profiles/#{profile_id}/tasks/#{task_id}\z}).
+        to_return(status: 200, body: load_fixture("task.json"))
+    end
+
+    it { is_expected.to have_attributes(id: "33cdc540-61e0-11e7-b07b-acbc32b67d7b") }
+  end
+end

data/spec/passfort/http_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Passfort::Http do
+  let(:http) { described_class.new("api_key") }
+  let(:path) { "a/path" }
+
+  shared_examples "an API call that handles all errors" do
+    let(:api_path) { Passfort::Http::DOMAIN + Passfort::Http::ROOT_PATH + path }
+    let(:status) { 200 }
+    let(:error_code) { 0 }
+    let(:body) { { errors: { code: error_code } }.to_json }
+
+    before { stub_request(method, api_path). to_return(status: status, body: body) }
+
+    context "when returning a request error" do
+      let(:status) { 404 }
+      let(:error_class) { Passfort::Errors::RequestError }
+
+      it "raises a specific APIError" do
+        is_expected.to raise_error(instance_of(error_class))
+      end
+    end
+
+    context "when returning an invalid API Key error" do
+      let(:error_code) { 204 }
+      let(:error_class) { Passfort::Errors::InvalidAPIKeyError }
+
+      it "raises a specific APIError" do
+        is_expected.to raise_error(instance_of(error_class))
+      end
+    end
+
+    context "when returning an invalid input data error" do
+      let(:error_code) { 201 }
+      let(:error_class) { Passfort::Errors::InvalidInputDataError }
+
+      it "raises a specific APIError" do
+        is_expected.to raise_error(instance_of(error_class))
+      end
+    end
+
+    context "when returning a chargeable limit reached error" do
+      let(:error_code) { 104 }
+      let(:error_class) { Passfort::Errors::ChargeableLimitReachedError }
+
+      it "raises a specific APIError" do
+        is_expected.to raise_error(instance_of(error_class))
+      end
+    end
+
+    context "when returning an unknown API error" do
+      let(:error_code) { 203 }
+      let(:error_class) { Passfort::Errors::APIError }
+
+      it "raises a specific APIError" do
+        is_expected.to raise_error(instance_of(error_class))
+      end
+    end
+
+    context "when returning a successful result" do
+      let(:result) { subject.call }
+
+      before do
+        stub_request(method, api_path).
+          to_return(status: status, body: load_fixture("check.json"))
+      end
+
+      it "includes the id response" do
+        expect(result).to include("id" => "6c1d594a-496e-11e7-911e-acbc32b67d7b")
+      end
+    end
+  end
+
+  describe "#get" do
+    subject { -> { http.get(path) } }
+
+    let(:method) { :get }
+
+    it_behaves_like "an API call that handles all errors"
+  end
+
+  describe "#post" do
+    subject { -> { http.post(path, body: {}) } }
+
+    let(:method) { :post }
+
+    it_behaves_like "an API call that handles all errors"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "passfort"
+require "pry"
+require "webmock/rspec"
+
+def load_fixture(path)
+  File.read(File.join(__dir__, "fixtures", path))
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: passfort
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- GoCardless
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: gc_ruboconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- developers@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENCE.txt
+- README.md
+- lib/passfort.rb
+- lib/passfort/client.rb
+- lib/passfort/endpoint.rb
+- lib/passfort/endpoint/checks.rb
+- lib/passfort/endpoint/profiles.rb
+- lib/passfort/endpoint/tasks.rb
+- lib/passfort/errors.rb
+- lib/passfort/errors/api_error.rb
+- lib/passfort/errors/chargeable_limit_reached_error.rb
+- lib/passfort/errors/invalid_api_key_error.rb
+- lib/passfort/errors/invalid_input_data_error.rb
+- lib/passfort/errors/request_error.rb
+- lib/passfort/http.rb
+- lib/passfort/resource.rb
+- lib/passfort/resource/base.rb
+- lib/passfort/resource/check.rb
+- lib/passfort/resource/company_data.rb
+- lib/passfort/resource/individual_data.rb
+- lib/passfort/resource/profile.rb
+- lib/passfort/resource/task.rb
+- lib/passfort/version.rb
+- passfort.gemspec
+- spec/fixtures/check.json
+- spec/fixtures/collected_data.json
+- spec/fixtures/company_ownership_check/check.json
+- spec/fixtures/company_ownership_check/collected_data.json
+- spec/fixtures/company_ownership_check/collected_data_update_request.json
+- spec/fixtures/company_ownership_check/profile.json
+- spec/fixtures/profile.json
+- spec/fixtures/task.json
+- spec/integration/company_ownership_check_spec.rb
+- spec/passfort/endpoint/checks_spec.rb
+- spec/passfort/endpoint/profiles_spec.rb
+- spec/passfort/endpoint/tasks_spec.rb
+- spec/passfort/http_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/passfort
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Client for the PassFort API
+test_files:
+- spec/fixtures/check.json
+- spec/fixtures/collected_data.json
+- spec/fixtures/company_ownership_check/check.json
+- spec/fixtures/company_ownership_check/collected_data.json
+- spec/fixtures/company_ownership_check/collected_data_update_request.json
+- spec/fixtures/company_ownership_check/profile.json
+- spec/fixtures/profile.json
+- spec/fixtures/task.json
+- spec/integration/company_ownership_check_spec.rb
+- spec/passfort/endpoint/checks_spec.rb
+- spec/passfort/endpoint/profiles_spec.rb
+- spec/passfort/endpoint/tasks_spec.rb
+- spec/passfort/http_spec.rb
+- spec/spec_helper.rb