passfort 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11120072e170612a1a224a7e5494a78401ac7c840b9efd54e43c104948f0c9fd
+  data.tar.gz: 035174f509a2106dd5ea314517ec24b503d6d22b30100c64c935f360b6860396
+SHA512:
+  metadata.gz: e5041f41f44de8502abe4b7d3c0b4d59570e5ad629b66c74b10980cad3333c4bb3ce19fbaeb050a3e4a9355caa394df365586c1f883a57746d6546470d290700
+  data.tar.gz: 94f245e7d800b9bfbf7ca0b40db72f5f37894bd56a8df125858c703cfcd742a00a324c50d28421fc3ccc60e09423ad9d198feae5d3d5b6bb2fef5595600b66a6

data/.circleci/config.yml

@@ -0,0 +1,17 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/passfort
+    docker:
+      - image: ruby:2.5
+    steps:
+      - checkout
+      - restore_cache:
+          key: gemfile-lock-{{ checksum "Gemfile.lock" }}
+      - run: bundle install --deployment
+      - save_cache:
+          key: gemfile-lock-{{ checksum "Gemfile.lock" }}
+          paths:
+            - "vendor/bundle"
+      - run: bundle exec rubocop
+      - run: bundle exec rspec --format RspecJunitFormatter

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  gc_ruboconfig: rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+Changelog
+=========
+
+Unreleased
+----------
+
+No changes.
+
+0.2.0
+-----
+
+- Convert resource attributes to a hash with indifferent access,
+  so that you can use symbol or string keys.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    passfort (0.2.0)
+      activesupport (~> 5.0)
+      excon (~> 0.60)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    excon (0.60.0)
+    gc_ruboconfig (2.3.4)
+      rubocop (~> 0.53.0)
+      rubocop-rspec (~> 1.24)
+    hashdiff (0.3.7)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.0.3)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.24.0)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gc_ruboconfig (~> 2.3)
+  passfort!
+  pry (~> 0.10)
+  rspec (~> 3.2)
+  rspec_junit_formatter (~> 0.3)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 GoCardless
+
+MIT License
+
+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,6 @@
+PassFort
+========
+
+[![CircleCI](https://circleci.com/gh/gocardless/passfort/tree/master.svg?style=svg)](https://circleci.com/gh/gocardless/passfort/tree/master)
+
+A Ruby client library for the [PassFort](https://passfort.com) API.

data/lib/passfort.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "passfort/version"
+require "passfort/errors"
+
+require "passfort/resource"
+require "passfort/endpoint"
+require "passfort/client"
+
+module Passfort
+  module CheckType
+    IDENTITY_CHECK = "IDENTITY_CHECK"
+    DOCUMENT_VERIFICATION = "DOCUMENT_VERIFICATION"
+    DOCUMENT_FETCH = "DOCUMENT_FETCH"
+    PEPS_SCREEN = "PEPS_SCREEN"
+    SANCTIONS_SCREEN = "SANCTIONS_SCREEN"
+    PEPS_AND_SANCTIONS_SCREEN = "PEPS_AND_SANCTIONS_SCREEN"
+    COMPANY_REGISTRY = "COMPANY_REGISTRY"
+    COMPANY_OWNERSHIP = "COMPANY_OWNERSHIP"
+    COMPANY_FILINGS = "COMPANY_FILINGS"
+    COMPANY_FILING_PURCHASE = "COMPANY_FILING_PURCHASE"
+    COMPANY_PEPS_AND_SANCTIONS_SCREEN = "COMPANY_PEPS_AND_SANCTIONS_SCREEN"
+  end
+
+  module EntityType
+    INDIVIDUAL = "INDIVIDUAL"
+    COMPANY = "COMPANY"
+  end
+
+  module Role
+    INDIVIDUAL_CUSTOMER = "INDIVIDUAL_CUSTOMER"
+    INDIVIDUAL_ASSOCIATED = "INDIVIDUAL_ASSOCIATED"
+    COMPANY_CUSTOMER = "COMPANY_CUSTOMER"
+  end
+end

data/lib/passfort/client.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "passfort/http"
+
+module Passfort
+  class Client
+    def initialize(api_key:)
+      @http = Passfort::Http.new(api_key)
+    end
+
+    def profiles
+      Endpoint::Profiles.new(@http)
+    end
+
+    def checks
+      Endpoint::Checks.new(@http)
+    end
+
+    def tasks
+      Endpoint::Tasks.new(@http)
+    end
+  end
+end

data/lib/passfort/endpoint.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "passfort/endpoint/profiles"
+require "passfort/endpoint/checks"
+require "passfort/endpoint/tasks"
+
+module Passfort
+  module Endpoint
+  end
+end

data/lib/passfort/endpoint/checks.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Endpoint
+    class Checks
+      def initialize(client)
+        @client = client
+      end
+
+      def create(profile_id:, check_type:)
+        response = @client.post(
+          "/profiles/#{profile_id}/checks",
+          body: { check_type: check_type },
+        )
+        Passfort::Resource::Check.new(response)
+      end
+    end
+  end
+end

data/lib/passfort/endpoint/profiles.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "passfort/resource/profile"
+
+module Passfort
+  module Endpoint
+    class Profiles
+      def initialize(client)
+        @client = client
+      end
+
+      def create(role:, collected_data: {})
+        profile = @client.post(
+          "/profiles",
+          body: { role: role, collected_data: collected_data },
+        )
+        ::Passfort::Resource::Profile.new(profile)
+      end
+
+      def find(id)
+        profile = @client.get("/profiles/#{id}")
+        ::Passfort::Resource::Profile.new(profile)
+      end
+
+      def collected_data(id)
+        collected_data = @client.get("/profiles/#{id}/collected_data")
+        resource_class(collected_data["entity_type"]).new(collected_data)
+      end
+
+      def update_collected_data(id, data)
+        collected_data = @client.post("/profiles/#{id}/collected_data", body: data)
+        resource_class(collected_data["entity_type"]).new(collected_data)
+      end
+
+      private
+
+      def resource_class(entity_type)
+        case entity_type
+        when Passfort::EntityType::COMPANY then ::Passfort::Resource::CompanyData
+        when Passfort::EntityType::INDIVIDUAL then ::Passfort::Resource::IndividualData
+        else raise ArgumentError, "Invalid entity type #{entity_type.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/passfort/endpoint/tasks.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Endpoint
+    class Tasks
+      def initialize(client)
+        @client = client
+      end
+
+      def find(profile_id:, task_id:)
+        response = @client.get("/profiles/#{profile_id}/tasks/#{task_id}")
+        Passfort::Resource::Task.new(response)
+      end
+    end
+  end
+end

data/lib/passfort/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "passfort/errors/api_error"
+require "passfort/errors/chargeable_limit_reached_error"
+require "passfort/errors/invalid_api_key_error"
+require "passfort/errors/invalid_input_data_error"
+require "passfort/errors/request_error"
+
+module Passfort
+  module Errors
+  end
+end

data/lib/passfort/errors/api_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    # Represents any response from the API which is not a 200 OK
+    class APIError < StandardError
+      attr_reader :response
+
+      def initialize(msg, response = nil)
+        super(msg)
+        @response = response
+      end
+    end
+  end
+end

data/lib/passfort/errors/chargeable_limit_reached_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    # Specific error class for when the chargeable limit has been reached
+    class ChargeableLimitReachedError < APIError
+      def initialize(response = nil)
+        super("Rate limit exceeded", response)
+      end
+    end
+  end
+end

data/lib/passfort/errors/invalid_api_key_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    # Specific error class for when an invalid API key is used to access the service
+    class InvalidAPIKeyError < APIError
+      def initialize(response = nil)
+        super("Invalid API key", response)
+      end
+    end
+  end
+end

data/lib/passfort/errors/invalid_input_data_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    # Specific error class for when an invalid input data is used to query the service
+    class InvalidInputDataError < APIError
+      def initialize(response = nil)
+        super("Invalid input data", response)
+      end
+    end
+  end
+end

data/lib/passfort/errors/request_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    # Specific error class for when an HTTP request error has occurred
+    class RequestError < APIError
+      def initialize(response)
+        super("Request API error - HTTP #{response.status}", response)
+      end
+    end
+  end
+end

data/lib/passfort/http.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "json"
+require "excon"
+
+module Passfort
+  class Http
+    DOMAIN = "https://api.passfort.com"
+    ROOT_PATH = "/4.0"
+
+    def initialize(api_key, connection: Excon.new(DOMAIN))
+      @api_key = api_key
+      @connection = connection
+    end
+
+    def get(path)
+      response = @connection.get(path: ROOT_PATH + path, headers: { apikey: @api_key })
+      body = JSON.parse(response.body)
+      handle_error(response, body)
+      body
+    end
+
+    def post(path, body:)
+      response = @connection.post(
+        path: ROOT_PATH + path,
+        body: body.to_json,
+        headers: { apikey: @api_key, "Content-Type" => "application/json" },
+      )
+      body = JSON.parse(response.body)
+      handle_error(response, body)
+      body
+    end
+
+    private
+
+    # error codes: https://passfort.com/developer/v4/data-reference/ErrorCodes
+    def handle_error(response, body)
+      unless [200, 201].include?(response.status)
+        raise Passfort::Errors::RequestError, response
+      end
+
+      errors = body["errors"].is_a?(Array) ? body["errors"] : [body["errors"]]
+
+      handle_response_error(errors[0], response) if errors.any?
+    end
+
+    def handle_response_error(error, response)
+      case error["code"]
+      when 201
+        raise Passfort::Errors::InvalidInputDataError, response
+      when 204
+        raise Passfort::Errors::InvalidAPIKeyError, response
+      when 104
+        raise Passfort::Errors::ChargeableLimitReachedError, response
+      else
+        raise Passfort::Errors::APIError.new("Unknown API error", response)
+      end
+    end
+  end
+end