siade

SIADE : Système d'Information des API de l'État

API pour API Entreprise et API Particulier

Requirements

• ruby 4.0.1
• postgresql >= 9
• redis-server >= 5
• gnugpg and gpgme (installed with script below)

Install

./bin/install.sh

Pour seed la base:

./bin/seeds.sh

Tests

Par défaut:

rspec

Avec le coverage:

COVERAGE=true rspec

Si vous rencontrez des problèmes de matching sur les cassettes VCR, vous pouvez obtenir plus de logs de la manière suivante:

DEBUG_VCR=true rspec

Avertissements sur les cas de tests

Il n'est pas possible de mettre de données personnelles dans les tests, soit le fournisseur de données a un environnement de test soit il faut utiliser webmock et non VCR.

Code Coverage

Celui-ci est automatiquement généré à chaque push, et est publié sur gitlab pages pour la branche develop.

Pour générer un code coverage en local:

COVERAGE=true bundle exec rspec

Documentation

La documentation se trouve dans le dossier docs/.

Notamment pour l'édition du swagger, voir le fichier docs/development/edition_swagger.md