tdierich/son-gtkrec repository overview

⁠SONATA⁠'s Gatekeeper Record Management micro-service

This is the folder of the Records Management micro-service. This micro-service is used by the Gatekeeper API⁠.

⁠Configuration

The configuration of the Gatekeeper's Record Management micro-service is done mostly by defining ENV variables in the Dockerfile⁠. These variables are:

• PORT: the port the micro-service is to provide it's services, currently 5000;
• REPOSITORIES_URL: the Repository URL, currently http://catalogues:4002/records;

Future work includes evolving the way we store these environment variables, as well as avoiding at least some of the repetition between this information and the one provided in the docker-compose.yml⁠.

⁠Usage

To use this application, we write

$ foreman start

Foreman⁠ is a ruby gem for managing applications based on a Procfile⁠.

⁠Implemented API

The implemented API of the Gatekeeper is the following:

• /services:
  • GET: provides a list of service records, available in the Repository;
  • /:uuid: provides the service record data with the given :uuid;
• /functions:
  • GET: provides a list of function records available in the Catalogue;
  • /:uuid: provides the function record data with the given :uuid;

Note 1: PUTand DELETEoperations are already supported by some of the micro-services, and will be described in the next version(s);

Note 2: all GEToperations support pagination, though this still needs some work. This pagination can be done by using the offset and limit parameters, like in:

$ curl <resource_url>?offset=0,limit=10

This command will result in a list of 10values (the limit) of the first page (offset zero). These are the default values used for those parameters.

⁠Tests

At the module level, we only do automated unit tests, using the RSpec framework (see the ./spec/folder). For the remaining tests please see the repositorie's README⁠ file.