openownership / register-sources-psc

Register Sources PSC is designed for inclusion as a library for use with the People with significant control (PSC) data published by Companies House in the UK

Register Sources PSC

Register Sources PSC is a shared library for the OpenOwnership Register project. It is designed for use with the data published about People with Significant Control (PSC) published by Companies House in the UK.

The primary purposes of this library are:

• Providing typed objects for the JSON-line data. It makes use of the dry-types and dry-struct gems to specify the different object types allowed in the data returned.
• Persisting the PSC records using Elasticsearch. This functionality includes creating a mapping for indexing the possible fields observed as well as functions for storage and retrieval.

Installation

Install and boot Register.

Configure your environment using the example file:

cp .env.example .env

Testing

Run the tests:

docker compose run sources-psc test