passfort 0.2.3 → 0.3.0

data/lib/passfort/errors/unparseable_response_error.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-module Passfort
-  module Errors
-    class UnparseableResponseError < APIError
-      def initialize(*args)
-        super("Unparseable response body", *args)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Passfort
+  module Errors
+    class UnparseableResponseError < APIError
+      def initialize(*args)
+        super("Unparseable response body", *args)
+      end
+    end
+  end
+end

data/lib/passfort/http.rb

@@ -1,65 +1,89 @@
-# 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
-    rescue JSON::ParserError
-      raise Passfort::Errors::UnparseableResponseError.new([], response)
-    rescue Excon::Errors::Timeout
-      raise Passfort::Errors::TimeoutError
-    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
-    rescue JSON::ParserError
-      raise Passfort::Errors::UnparseableResponseError.new([], response)
-    rescue Excon::Errors::Timeout
-      raise Passfort::Errors::TimeoutError
-    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.new([], response)
-      end
-
-      errors = body["errors"].is_a?(Array) ? body["errors"] : [body["errors"]]
-
-      handle_response_error(errors, response) if errors.any?
-    end
-
-    def handle_response_error(errors, response)
-      error_class = case errors[0]["code"]
-                    when 201 then Passfort::Errors::InvalidInputDataError
-                    when 204 then Passfort::Errors::InvalidAPIKeyError
-                    when 104 then Passfort::Errors::ChargeableLimitReachedError
-                    else Passfort::Errors::UnknownApiError
-                    end
-      raise error_class.new(errors, response)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "active_support/notifications"
+require "excon"
+require "json"
+
+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)
+      execute(
+        -> {
+          @connection.get(
+            path: ROOT_PATH + path,
+            headers: { apikey: @api_key },
+          )
+        },
+        :get,
+        path: path,
+      )
+    end
+
+    def post(path, body:)
+      execute(
+        -> {
+          @connection.post(
+            path: ROOT_PATH + path,
+            body: body.to_json,
+            headers: { apikey: @api_key, "Content-Type" => "application/json" },
+          )
+        },
+        :post,
+        path: path,
+        body: body,
+      )
+    end
+
+    private
+
+    def execute(get_response, method, payload)
+      started = Time.now
+      response = get_response.call
+      payload[:response] = response.body
+      body = JSON.parse(response.body)
+      handle_error(response, body)
+      body
+    rescue JSON::ParserError => raw_error
+      payload[:error] = raw_error
+      raise Passfort::Errors::UnparseableResponseError.new([], response)
+    rescue Excon::Errors::Timeout => raw_error
+      payload[:error] = raw_error
+      raise Passfort::Errors::TimeoutError
+    ensure
+      publish("passfort.#{method}", started, Time.now, SecureRandom.hex(10), payload)
+    end
+
+    # 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.new([], response)
+      end
+
+      errors = body["errors"].is_a?(Array) ? body["errors"] : [body["errors"]]
+
+      handle_response_error(errors, response) if errors.any?
+    end
+
+    def handle_response_error(errors, response)
+      error_class = case errors[0]["code"]
+                    when 201 then Passfort::Errors::InvalidInputDataError
+                    when 204 then Passfort::Errors::InvalidAPIKeyError
+                    when 104 then Passfort::Errors::ChargeableLimitReachedError
+                    else Passfort::Errors::UnknownApiError
+                    end
+      raise error_class.new(errors, response)
+    end
+
+    def publish(*args)
+      ActiveSupport::Notifications.publish(*args)
+    end
+  end
+end

data/lib/passfort/resource.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-
-require "passfort/resource/base"
-require "passfort/resource/profile"
-require "passfort/resource/company_data"
-require "passfort/resource/task"
-require "passfort/resource/check"
-
-module Passfort
-  module Resource
-  end
-end
+# frozen_string_literal: true
+
+require "passfort/resource/base"
+require "passfort/resource/profile"
+require "passfort/resource/company_data"
+require "passfort/resource/task"
+require "passfort/resource/check"
+
+module Passfort
+  module Resource
+  end
+end

data/lib/passfort/resource/base.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require "active_support/core_ext/hash"
-
-module Passfort
-  module Resource
-    class Base
-      def self.attributes(*keys)
-        keys.each { |key| define_method(key) { @attributes[key] } }
-      end
-
-      def initialize(attributes)
-        @attributes = attributes.with_indifferent_access
-      end
-
-      def to_h
-        @attributes
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash"
+
+module Passfort
+  module Resource
+    class Base
+      def self.attributes(*keys)
+        keys.each { |key| define_method(key) { @attributes[key] } }
+      end
+
+      def initialize(attributes)
+        @attributes = attributes.with_indifferent_access
+      end
+
+      def to_h
+        @attributes
+      end
+    end
+  end
+end

data/lib/passfort/resource/check.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: true
-
-module Passfort
-  module Resource
-    class Check < Base
-      attributes :id, :check_type, :state, :input_data, :output_data, :result,
-                 :performed_on, :errors, :task_ids, :instructed_externally
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Passfort
+  module Resource
+    class Check < Base
+      attributes :id, :check_type, :state, :input_data, :output_data, :result,
+                 :performed_on, :errors, :task_ids, :instructed_externally
+    end
+  end
+end

data/lib/passfort/resource/company_data.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-module Passfort
-  module Resource
-    class CompanyData < Base
-      attributes :entity_type, :metadata, :authorized_persons,
-                 :unauthorized_persons, :ownership_structure, :officers,
-                 :filings, :customer_ref, :external_refs
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Passfort
+  module Resource
+    class CompanyData < Base
+      attributes :entity_type, :metadata, :authorized_persons,
+                 :unauthorized_persons, :ownership_structure, :officers,
+                 :filings, :customer_ref, :external_refs
+    end
+  end
+end

data/lib/passfort/resource/individual_data.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-module Passfort
-  module Resource
-    class IndividualData < Base
-      attributes :entity_type, :personal_details, :address_history,
-                 :contact_details, :phone_number, :email, :ip_location,
-                 :documents
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Passfort
+  module Resource
+    class IndividualData < Base
+      attributes :entity_type, :personal_details, :address_history,
+                 :contact_details, :phone_number, :email, :ip_location,
+                 :documents
+    end
+  end
+end

data/lib/passfort/resource/profile.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-require "passfort/resource/task"
-
-module Passfort
-  module Resource
-    class Profile < Base
-      attributes :id, :role, :collected_data, :verified_data, :checks,
-                 :collection_steps, :display_name, :applications, :task_types,
-                 :tasks, :events, :category, :status, :document_images, :tags,
-                 :risk, :unresolved_event_types, :task_progress,
-                 :has_associates, :has_collection_steps
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "passfort/resource/task"
+
+module Passfort
+  module Resource
+    class Profile < Base
+      attributes :id, :role, :collected_data, :verified_data, :checks,
+                 :collection_steps, :display_name, :applications, :task_types,
+                 :tasks, :events, :category, :status, :document_images, :tags,
+                 :risk, :unresolved_event_types, :task_progress,
+                 :has_associates, :has_collection_steps
+    end
+  end
+end

data/lib/passfort/resource/task.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-
-module Passfort
-  module Resource
-    class Task < Base
-      attributes :id, :type, :is_complete, :is_expired, :check_ids
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Passfort
+  module Resource
+    class Task < Base
+      attributes :id, :type, :is_complete, :is_expired, :check_ids
+    end
+  end
+end

data/lib/passfort/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Passfort
-  VERSION = "0.2.3"
-end
+# frozen_string_literal: true
+
+module Passfort
+  VERSION = "0.3.0"
+end

data/passfort.gemspec

@@ -1,29 +1,30 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "passfort/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "passfort"
-  spec.version = Passfort::VERSION
-  spec.summary = "Client for the PassFort API"
-  spec.authors = %w[GoCardless]
-  spec.homepage = "https://github.com/gocardless/passfort"
-  spec.email = %w[developers@gocardless.com]
-  spec.license = "MIT"
-
-  spec.files = `git ls-files -z`.split("\x0")
-  spec.test_files = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport", "~> 5.0"
-  spec.add_dependency "excon", "~> 0.60"
-
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.3"
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
-  spec.add_development_dependency "webmock", "~> 3.3"
-end
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "passfort/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "passfort"
+  spec.version = Passfort::VERSION
+  spec.summary = "Client for the PassFort API"
+  spec.authors = %w[GoCardless]
+  spec.homepage = "https://github.com/gocardless/passfort"
+  spec.email = %w[developers@gocardless.com]
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.0"
+  spec.add_dependency "excon", "~> 0.60"
+
+  spec.add_development_dependency "gc_ruboconfig", "~> 2.3"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
+  spec.add_development_dependency "timecop", "~> 0.8"
+  spec.add_development_dependency "webmock", "~> 3.3"
+end

data/spec/fixtures/check.json

@@ -1,67 +1,67 @@
-{
-    "check_type": "IDENTITY_CHECK",
-    "errors": [],
-    "id": "6c1d594a-496e-11e7-911e-acbc32b67d7b",
-    "input_data": {
-        "address_history": [
-            {
-                "address": {
-                    "country": "Southend-on-Sea",
-                    "locality": "Southend-on-Sea",
-                    "postal_code": "1",
-                    "postal_town": "Leigh-on-Sea",
-                    "route": "The Fairway",
-                    "state_province": "England",
-                    "street_number": "106",
-                    "type": "STRUCTURED"
-                },
-                "end_date": "2017-05",
-                "start_date": "2017-01"
-            }
-        ],
-        "entity_type": "INDIVIDUAL",
-        "personal_details": {
-            "dob": "1987-01-01",
-            "name": {
-                "family_name": "Smith",
-                "given_names": [
-                    "Thomas"
-                ]
-            }
-        }
-    },
-    "output_data": {
-        "credit_ref": {
-            "exact": {
-                "count": 8,
-                "match": true
-            },
-            "exact_dob": {
-                "count": 8,
-                "match": true
-            },
-            "partial": {
-                "count": 8,
-                "match": true
-            }
-        },
-        "db_matches": {
-            "electoral_exact": {
-                "count": 1,
-                "match": true
-            },
-            "electoral_exact_dob": {
-                "count": 0,
-                "match": false
-            },
-            "electoral_partial": {
-                "count": 1,
-                "match": true
-            }
-        },
-        "entity_type": "INDIVIDUAL"
-    },
-    "result": "2+2",
-    "state": "COMPLETE",
-    "task_ids": []
-}
+{
+    "check_type": "IDENTITY_CHECK",
+    "errors": [],
+    "id": "6c1d594a-496e-11e7-911e-acbc32b67d7b",
+    "input_data": {
+        "address_history": [
+            {
+                "address": {
+                    "country": "Southend-on-Sea",
+                    "locality": "Southend-on-Sea",
+                    "postal_code": "1",
+                    "postal_town": "Leigh-on-Sea",
+                    "route": "The Fairway",
+                    "state_province": "England",
+                    "street_number": "106",
+                    "type": "STRUCTURED"
+                },
+                "end_date": "2017-05",
+                "start_date": "2017-01"
+            }
+        ],
+        "entity_type": "INDIVIDUAL",
+        "personal_details": {
+            "dob": "1987-01-01",
+            "name": {
+                "family_name": "Smith",
+                "given_names": [
+                    "Thomas"
+                ]
+            }
+        }
+    },
+    "output_data": {
+        "credit_ref": {
+            "exact": {
+                "count": 8,
+                "match": true
+            },
+            "exact_dob": {
+                "count": 8,
+                "match": true
+            },
+            "partial": {
+                "count": 8,
+                "match": true
+            }
+        },
+        "db_matches": {
+            "electoral_exact": {
+                "count": 1,
+                "match": true
+            },
+            "electoral_exact_dob": {
+                "count": 0,
+                "match": false
+            },
+            "electoral_partial": {
+                "count": 1,
+                "match": true
+            }
+        },
+        "entity_type": "INDIVIDUAL"
+    },
+    "result": "2+2",
+    "state": "COMPLETE",
+    "task_ids": []
+}