pg_frapi

Une collection de fonctions postgresql natives qui définissent un mappage et permettent d'interroger une séléction d'API mises à disposition par les diverses administrations françaises. Ce projet est encore en gestation et n'est pas encore stable. Nous avons cependant fait le choix de le dévelloper de manière totalement ouverte dans l'esprit de la loi sur la modernisation numérique.

Etat d'avancement

Le projet est actuelement en phase Alpha, le code est publié pour avis, la licence reste encore à définir. Les fonctions adresse_search() et adresse_reverse() sont cependant d'ors est déjà fonctionelles, un rapprochement avec adresse.gouv.fr et en cours pour voir si ce project respecte l'esprit et les capacité techniques de leur API. L'installation n'a pour l'instant été testée que sous Ubuntu 14.04 et PostgreSQL 9.5.

L'extension doit être maniée avec précaution puisqu'aucun diagnostic de sécurité n'as été établi et que la dépendance PLSH n'est pas qualifié de 'safe' par son auteur (un accès à la ligne de commande via une injection SQL est possible en théorie).

Objectifs

Version 0.1

• Proposer une implémentation simple pour l'API adresse.gouv.fr
  • Définir les paramètres d'entrée de manière à pouvoir utiliser tous les paramètres de l'API via des fonctions PG
  • Possibilité de récupérer un JSON brut ou un des lignes composites PG définie pour les résultats
  • Fourniture d'une fonction de conversion entre le JSON brut et le type composite
• Implémenter un système de build suffisant pour assembler les différents fichiers SQL
• Choix d'une politique de tags, de versionnement et d'utilisation des branches adéquat pour les dévelopements futurs
• Choix d'une licence FOSS pour le projet
• Proposer une implémentation simple pour l'API ign -->déplacé vers version 0.2

Version 0.2

• Ajout de tests et d'integration continue (Travis CI)
• Evaluer la possibilité de remplacer pl/sh par pl/python pour les appels http://
• Commenter le code de l'API adresse.gouv.fr
• Rédiger une page de documentation utilisateur pour l'API adresse.gouv.fr
• Rédiger une page de documentation pour le systeme de build
• Proposer une implémentation simple pour l'API geonym
• Stabiliser la syntaxe et la signature des différentes fonctions
• Amélioration du système de build pour générer des scripts d'update

Versions suivantes

• Proposer une implémentation simple pour l'API ign

Prérequis

L'extension PostGis est requise puisque le type géométrie est utilisé en retour de fonction.

L'extension PL/SH est actuellement requise puisqu'elle sert actuellement de passerelle pour acceder aux API.

Enfin les paquets suivant peuvent s'avérer nécessaire pour compiller plsh et sont donc aussi requis: build-essential postgresql-server-dev-X.X (remplacer par votre numéro de version de PostgreSQL)

(Sur une suggestion de Christian Quest il sera necessaire d'evaluer s'il ne serait pas opportun de basculer vers l'extension pgsql-http)

Installation rapide (Testée sur Ubuntu 14.04)

1. Installer et configurer les prérequis (postgres, postgis, plsh)
2. Cloner le repo
3. Dans le shell executer make install
4. Dans l'interface SQL executer CREATE EXTENSION frapi; inside your DB

Test rapide post-installation

• API adresse.gouv.fr
  Dans l'interface SQL executer SELECT * FROM frapi.adresse_search('8 bd du port'); cela devrait retourner des lignes postgresql calquées sur la structure de donnée de l'API décrite ici

Dévellopement

A partir de la première version tagée 0.1 la branch master sert exclusivement à publier les releases. Pour une version donnée c'est le script SQL correspondant qui sera installé par défaut par PGXS.

Dans la branche "develop" la version par défaut est la version 'dev' non numérotée. Le script d'instalation corespondant est inscrit dans le .gitignore il faut donc compiler ce fichier avant d'installer la version dev. Pour ce faire executer make build dans le répertoire.