cpan-testers / cpantesters-api

An API in to data held by CPAN Testers: Test reports and CPAN uploads
Other
4 stars 4 forks source link

Create a Metabase backwards-compatibility shim API #3

Closed preaction closed 7 years ago

preaction commented 7 years ago

While we transition away from the Metabase project to a simpler way of storing raw reports, we will need a backwards-compatible way for existing clients to still submit reports. This API should write directly to the local CPAN Testers cache of the Metabase for the time being, until we figure out that simpler way of storing raw reports.

This shim API should function as a Metabase::Gateway by mimicking the REST API provided by Metabase::Web.

It must be able to:

When a report is submitted directly to the local cache, it will have a GUID, but not an ID (which gets added when the report is parsed into the cpanstats table by CPAN::Testers::Data::Generator). In order for this new shim API to work, we will need to alter CPAN::Testers::Data::Generator by:

This is the main API to submitting reports, so it is important that it is as robust as possible. All care should be taken that it does not go down, and it should be tested thoroughly before being put into production.

preaction commented 7 years ago

This work is started on the metabase-api branch. The initial metabase shim API for submitting new reports is complete, but must be tested against live clients.

preaction commented 7 years ago

We also need to create a basic web page that indicates what this site is and that users should use different APIs for this...

preaction commented 7 years ago

This is done enough for a public beta at http://metabase-beta.cpantesters.org. Any future problems in testing will be resolved in individual tickets.