factory

Author: DD-Arras

.docker/Dockerfile

@@ -4,8 +4,8 @@
 ARG registry=docker.io
 FROM ${registry}/library/composer:latest AS vendor
 
-RUN mkdir -p /opt/validator-api
-WORKDIR /opt/validator-api
+RUN mkdir -p /opt/validator-publi
+WORKDIR /opt/validator-publi
 COPY composer.json .
 RUN composer install --no-scripts --prefer-dist --ignore-platform-req=ext-pcntl
 
@@ -119,27 +119,27 @@ RUN mkdir -p /opt/ign-validator \
  && echo "validator-cli.jar version : $(java -jar /opt/ign-validator/validator-cli.jar version)"
 
 #----------------------------------------------------------------------
-# Install validator-api
+# Install validator-publi
 #----------------------------------------------------------------------
-COPY . /opt/validator-api
-WORKDIR /opt/validator-api
-COPY --from=vendor /opt/validator-api/vendor vendor
+COPY . /opt/validator-publi
+WORKDIR /opt/validator-publi
+COPY --from=vendor /opt/validator-publi/vendor vendor
 
 #----------------------------------------------------------------------
 # Prepare data storage
-# (Note that /opt/validator-api/var/data is shared between containers)
+# (Note that /opt/validator-publi/var/data is shared between containers)
 #----------------------------------------------------------------------
-RUN mkdir -p /opt/validator-api/var/data/validations \
- && chown -R www-data:www-data /opt/validator-api/var
+RUN mkdir -p /opt/validator-publi/var/data/validations \
+ && chown -R www-data:www-data /opt/validator-publi/var
 
 # ensure ogr2ogr can write in $HOME/.gdal ...
-ENV HOME=/opt/validator-api/var
+ENV HOME=/opt/validator-publi/var
 
-VOLUME /opt/validator-api/var/data
+VOLUME /opt/validator-publi/var/data
 
 USER www-data
 
 ENV APP_ENV=prod
 
 EXPOSE 8000
-CMD ["/opt/validator-api/.docker/application.sh"]
+CMD ["/opt/validator-publi/.docker/application.sh"]

.docker/apache-vhost.conf

@@ -1,8 +1,8 @@
 # config/vhost.conf
 <VirtualHost *:8000>
-	DocumentRoot /opt/validator-api/public
+	DocumentRoot /opt/validator-publi/public
 
-    <Directory "/opt/validator-api/public">
+    <Directory "/opt/validator-publi/public">
         Options -Indexes +FollowSymLinks +MultiViews
         AllowOverride All
 

CONTRIBUTING.md

@@ -4,14 +4,14 @@ Merci d'envisager nous aider sur ce projet. Tout type de contribution est bienve
 
 ## Contributions autres que du code
 
-N'hésitez pas à formuler toute proposition de nouvelle fonctionnalité, signalement d'anomalie ou même question dans une [nouvelle issue](https://github.com/IGNF/validator-api/issues/new/choose).
+N'hésitez pas à formuler toute proposition de nouvelle fonctionnalité, signalement d'anomalie ou même question dans une [nouvelle issue](https://github.com/IGNF/validator-publi/issues/new/choose).
 
-Vous pouvez également parcourir les [issues existantes](https://github.com/IGNF/validator-api/issues) pour voir si le sujet n'a pas déjà été abordé et apporter des informations complémentaires ou proposer des pistes de solutions.
+Vous pouvez également parcourir les [issues existantes](https://github.com/IGNF/validator-publi/issues) pour voir si le sujet n'a pas déjà été abordé et apporter des informations complémentaires ou proposer des pistes de solutions.
 
 Enfin si vous pensez avoir cerné quelle partie du validateur est concernée par votre contribution, vous pouvez créer l'issue dans le dépôt qui est le plus approprié parmi :
 
 * [IGNF/validator](https://github.com/IGNF/validator) : le moteur de validation en Java
-* [IGNF/validator-api](https://github.com/IGNF/validator-api) : la surcouche API REST en PHP (le présent dépôt)
+* [IGNF/validator-api](https://github.com/IGNF/validator-api) : la surcouche API REST en PHP
 * [IGNF/validator-api-client](https://github.com/IGNF/validator-api-client/) : l'interface graphique du démonstrateur
 
 ## Modifier le code ou la documentation
@@ -34,7 +34,7 @@ Exemple :
 
 ## Livraison d'une nouvelle version
 
-* Consulter le [numéro de la dernière version](https://github.com/IGNF/validator-api/tags).
+* Consulter le [numéro de la dernière version](https://github.com/IGNF/validator-publi/tags).
 * Renseigner la future version dans [docs/specs/validator-api.yml](docs/specs/validator-api.yml) (ex : `info.version: 0.3.0`)
 * Créer et pousser un tag (ex : `v0.3.0`)
-* Créer une release à partir du tag (voir https://github.com/IGNF/validator-api/tags)
+* Créer une release à partir du tag (voir https://github.com/IGNF/validator-publi/tags)

README.md

@@ -1,8 +1,8 @@
-# validator-api
+# validator-publi
 
-[![PHP CI](https://github.com/IGNF/validator-api/actions/workflows/php-ci.yml/badge.svg)](https://github.com/IGNF/validator-api/actions/workflows/php-ci.yml) [![Coverage Status](https://coveralls.io/repos/github/IGNF/validator-api/badge.svg?branch=master)](https://coveralls.io/github/IGNF/validator-api?branch=master) [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
+[![PHP CI](https://github.com/IGNF/validator-publi/actions/workflows/php-ci.yml/badge.svg)](https://github.com/IGNF/validator-publi/actions/workflows/php-ci.yml) [![Coverage Status](https://coveralls.io/repos/github/IGNF/validator-publi/badge.svg?branch=master)](https://coveralls.io/github/IGNF/validator-publi?branch=master) [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
 
-Cette API permet d'appeler [IGNF/validator](https://github.com/IGNF/validator), outil permettant de valider et de normaliser les données présentes dans une arborescence de fichiers. [En savoir plus](https://github.com/IGNF/validator).
+Ce service permet l'utilisation de [IGNF/validator](https://github.com/IGNF/validator) pour des utilisateurs externes à l'IGN, outil permettant de valider et de normaliser les données présentes dans une arborescence de fichiers. [En savoir plus](https://github.com/IGNF/validator).
 
 ## Documentation utilisateur
 

composer.json

@@ -1,6 +1,6 @@
 {
-  "name": "ignf/validator-api",
-  "description": "APIsation of Validator, a tool that allows to validate and normalize datasets according to a file mapping and a FeatureCatalog.",
+  "name": "ignf/validator-publi",
+  "description": "Service providing Validator, a tool that allows to validate and normalize datasets according to a file mapping and a FeatureCatalog.",
   "type": "project",
   "license": "AGPL-3.0-or-later",
   "require": {

docker-compose.yml

@@ -1,8 +1,8 @@
 services:
 
-  # validator-api service
-  api:
-    image: ignf/validator-api:master-dev
+  # validator-publi service
+  publi:
+    image: ignf/validator-publi:master-dev
     build:
       context: .
       dockerfile: .docker/Dockerfile
@@ -28,16 +28,16 @@ services:
     networks:
       - validator
     volumes:
-      - api-data:/opt/validator-api/var/data
+      - publi-data:/opt/validator-publi/var/data
     ports:
       # local exposure when traefik is not available
       - "8000:8000"
     depends_on:
       - database
     labels:
       - "traefik.enable=true"
-      - "traefik.http.routers.validator-api.rule=Host(`validator-api-v1.${HOST_HOSTNAME}`)"
-      - "traefik.http.services.validator-api-service.loadbalancer.server.port=8000"
+      - "traefik.http.routers.validator-publi.rule=Host(`validator-api-v1.${HOST_HOSTNAME}`)"
+      - "traefik.http.services.validator-publi-service.loadbalancer.server.port=8000"
     restart: unless-stopped
 
   database:
@@ -85,16 +85,16 @@ services:
     networks:
       - validator
     volumes:
-      - api-data:/opt/validator-api/var/data
+      - publi-data:/opt/validator-publi/var/data
     depends_on:
-      - api
+      - publi
     restart: unless-stopped
 
 networks:
   validator:
 
 volumes:
   # validations files
-  api-data:
+  publi-data:
   # postgresql files (docker volume create db-data)
   db-data:

docs/developer-guide.md

@@ -6,8 +6,8 @@
 
 ## Liens utiles
 
-* Dépôt GitHub : [https://github.com/IGNF/validator-api](https://github.com/IGNF/validator-api)
-* Intégration continue avec [GitHub actions](https://github.com/IGNF/validator-api/actions) configurée via le dossier [.github/workflows](https://github.com/IGNF/validator-api/tree/master/.github/workflows)
+* Dépôt GitHub : [https://github.com/IGNF/validator-api](https://github.com/IGNF/validator-publi)
+* Intégration continue avec [GitHub actions](https://github.com/IGNF/validator-publi/actions) configurée via le dossier [.github/workflows](https://github.com/IGNF/validator-publi/tree/master/.github/workflows)
 
 ## Données des tests
 

docs/developer-guide/docker.md

@@ -16,16 +16,16 @@
 
 Le paramétrage de l'application est réalisé via des variables d'environnements. Voir [.env](../../.env) servant de modèle.
 
-Le script [.docker/application.sh](../../.docker/application.sh) comporte des options spécifiques au démarrage de l'API :
+Le script [.docker/application.sh](../../.docker/application.sh) comporte des options spécifiques au démarrage du service :
 
 * `DB_CREATE` à définir à 0 ou 1 pour créer automatiquement la base de données
 * `DB_UPGRADE` à définir à 0 ou 1 pour mettre à jour automatiquement la structure
 
 ## Construction et démarrage de l'application
 
 ```bash
-git clone https://github.com/IGNF/validator-api.git
-cd validator-api
+git clone https://github.com/IGNF/validator-publi.git
+cd validator-publi
 # Construction de l'image docker
 docker compose build
 # Démarrage de la stack de développement

docs/developer-guide/php-classic.md

@@ -18,8 +18,8 @@
 * Cloner le dépôt et installez les dépendances PHP :
 
 ```bash
-git clone https://github.com/IGNF/validator-api.git
-cd validator-api
+git clone https://github.com/IGNF/validator-publi.git
+cd validator-publi
 composer install
 ```
 
@@ -57,7 +57,7 @@ L'application est consultable à l'adresse http://localhost:8000
 Dans `.env.test`, ajoutez la ligne suivante :
 
 ```
-DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@localhost:5432/validator_api_test?serverVersion=15&charset=utf8
+DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@localhost:5432/validator_publi_test?serverVersion=15&charset=utf8
 ```
 
 > [Comment configurer la variable DATABASE_URL (documentation Symfony)](https://symfony.com/doc/4.4/doctrine.html#configuring-the-database)

docs/developer-guide/sonarqube.md

@@ -12,7 +12,7 @@ Un fichier de configuration du projet Sonarqube à la racine du projet : [sonar-
 * Exécuter `sonar-scanner` :
 
 ```bash
-cd validator-api
+cd validator-publi
 # lancer l'analyse de code
 sonar-scanner
 ```