Kaleidos file bundling job creation service

Service to create file-bundling jobs for a set of files relating to a Kaleidos-specific entity.

Rationale

Why not use the files/archive-endpoint that the file-bundling-service provides to create these bundling jobs?
Some of Kaleidos' agendas consist of a large amount of documents (> 1K). On request, the file-bundling service will first verify if there doesn't yet exist a job that produced the exact archive we want. For this many files, this process takes a while and as a result, the HTTP request can time out. This service implements endoints custom to the Kaleidos data-model to create file-bundling jobs for all files relating to a specific entity.
The created jobs will subsequently be picked up and run by the file-bundling-service.

Configuration snippets

docker-compose

file-bundling-job-creation:
  image: kanselarij/file-bundling-job-creation-service

Dispatcher

get "/agendas/:id/agendaitems/documents/files/archive", @any do
  Proxy.forward conn, [], "http://file-bundling-job-creation/agendas/" <> id <> "/agendaitems/documents/files/archive"
end

Authorization

Users of this service should have :read, :write and :read-for-write access to following rdf types

"http://www.w3.org/ns/prov#Collection"
"http://vocab.deri.ie/cogs#Job"
"http://mu.semte.ch/vocabularies/ext/FileBundlingJob"

Also read access to the entities grouping the documents (agenda for example ) and the documents themselves is required.

Resources

See file-bundling-service' README.

REST API

POST /agendas/:agenda_id/agendaitems/documents/files/archive

Request the creation of an archive of all files related to agenda :agenda_id. An optional query parameter is allowed, mandateeIds, which is a comma-separated string containing the ids of mandatees whose documents we want to fetch. When mandateeIds is provided all document linked to an agendaitem which are linked to the listed mandatees will be bundled, as well as all documents linked to an agendaitem with no linked mandatees. If mandateeIds is not provided all documents of the agenda will be bundled.

Response

201 Created

On successful creation of a job.

{
  "data": {
    "type": "file-bundling-jobs",
    "id": "5f680870-5984-11ea-98be-11315490e00b",
    "attributes": {
      "uri": "http://mu.semte.ch/services/file-bundling-service/file-bundling-jobs/5f680870-5984-11ea-98be-11315490e00b",
      "status": "http://vocab.deri.ie/cogs#Running",
      "created": "2020-02-27T17:12:45.943Z"
    }
  }
}

200 OK

When serving an already-existing job. Response payload similar to above.