passfort 0.2.0

data/lib/passfort/resource.rb

@@ -0,0 +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

data/lib/passfort/resource/base.rb

@@ -0,0 +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

data/lib/passfort/resource/check.rb

@@ -0,0 +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

data/lib/passfort/resource/company_data.rb

@@ -0,0 +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

data/lib/passfort/resource/individual_data.rb

@@ -0,0 +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

data/lib/passfort/resource/profile.rb

@@ -0,0 +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

data/lib/passfort/resource/task.rb

@@ -0,0 +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

data/lib/passfort/version.rb

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

data/passfort.gemspec

@@ -0,0 +1,29 @@
+# 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

data/spec/fixtures/check.json

@@ -0,0 +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": []
+}

data/spec/fixtures/collected_data.json

@@ -0,0 +1,7 @@
+{
+    "entity_type": "COMPANY",
+    "metadata": {
+        "country_of_incorporation": "GBR",
+        "number": "09565115"
+    }
+}

data/spec/fixtures/company_ownership_check/check.json

@@ -0,0 +1,78 @@
+{
+    "check_type": "COMPANY_OWNERSHIP",
+    "errors": [],
+    "id": "30e4ea06-0519-11e8-000000000000",
+    "input_data": {
+        "entity_type": "COMPANY",
+        "metadata": {
+            "country_of_incorporation": "GBR",
+            "number": "09565115"
+        }
+    },
+    "output_data": {
+        "entity_type": "COMPANY",
+        "metadata": {},
+        "ownership_structure": {
+            "shareholders": [
+                {
+                    "entity_type": "INDIVIDUAL",
+                    "immediate_data": {
+                        "address_history": [],
+                        "entity_type": "INDIVIDUAL",
+                        "personal_details": {
+                            "name": {
+                                "family_name": "Gillies",
+                                "given_names": [
+                                    "Donald"
+                                ]
+                            }
+                        }
+                    },
+                    "provider_name": "DueDil",
+                    "resolver_id": "322d0f54-0519-11e8-914c-000000000000",
+                    "shareholdings": [
+                        {
+                            "amount": 100,
+                            "currency": "GBP",
+                            "percentage": 50,
+                            "share_class": "Ordinary"
+                        }
+                    ],
+                    "total_percentage": 50
+                },
+                {
+                    "entity_type": "INDIVIDUAL",
+                    "immediate_data": {
+                        "address_history": [],
+                        "entity_type": "INDIVIDUAL",
+                        "personal_details": {
+                            "name": {
+                                "family_name": "Irish",
+                                "given_names": [
+                                    "Henry"
+                                ]
+                            }
+                        }
+                    },
+                    "provider_name": "DueDil",
+                    "resolver_id": "322d1f9e-0519-11e8-b046-000000000000",
+                    "shareholdings": [
+                        {
+                            "amount": 100,
+                            "currency": "GBP",
+                            "percentage": 50,
+                            "share_class": "Ordinary"
+                        }
+                    ],
+                    "total_percentage": 50
+                }
+            ]
+        }
+    },
+    "performed_on": "2018-01-29 17:24:01",
+    "result": "Pass",
+    "state": "COMPLETE",
+    "task_ids": [
+        "b845e7f4-f9e8-11e7-a4d1-000000000000"
+    ]
+}

data/spec/fixtures/company_ownership_check/collected_data.json

@@ -0,0 +1,7 @@
+{
+    "entity_type": "COMPANY",
+    "metadata": {
+        "country_of_incorporation": "GBR",
+        "number": "09565115"
+    }
+}

data/spec/fixtures/company_ownership_check/collected_data_update_request.json

@@ -0,0 +1,63 @@
+{
+    "entity_type": "COMPANY",
+    "metadata": {
+        "country_of_incorporation": "GBR",
+        "number": "09565115"
+    },
+    "ownership_structure": {
+        "shareholders": [
+            {
+                "entity_type": "INDIVIDUAL",
+                "immediate_data": {
+                    "address_history": [],
+                    "entity_type": "INDIVIDUAL",
+                    "personal_details": {
+                        "name": {
+                            "family_name": "Gillies",
+                            "given_names": [
+                                "Donald"
+                            ]
+                        }
+                    }
+                },
+                "provider_name": "DueDil",
+                "resolver_id": "322d0f54-0519-11e8-914c-000000000000",
+                "shareholdings": [
+                    {
+                        "amount": 100,
+                        "currency": "GBP",
+                        "percentage": 50,
+                        "share_class": "Ordinary"
+                    }
+                ],
+                "total_percentage": 50
+            },
+            {
+                "entity_type": "INDIVIDUAL",
+                "immediate_data": {
+                    "address_history": [],
+                    "entity_type": "INDIVIDUAL",
+                    "personal_details": {
+                        "name": {
+                            "family_name": "Irish",
+                            "given_names": [
+                                "Henry"
+                            ]
+                        }
+                    }
+                },
+                "provider_name": "DueDil",
+                "resolver_id": "322d1f9e-0519-11e8-b046-000000000000",
+                "shareholdings": [
+                    {
+                        "amount": 100,
+                        "currency": "GBP",
+                        "percentage": 50,
+                        "share_class": "Ordinary"
+                    }
+                ],
+                "total_percentage": 50
+            }
+        ]
+    }
+}

data/spec/fixtures/company_ownership_check/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": []
+}