sous-dossier "api"

[SimonSAMPERE]

Objectifs

Sortir l'interactions avec l'api Isogeo et la gestion de l'authentification de la classe principale Isogeo (isogeo.py).

Marche à suivre

Créer le sous-dossier api (dans le dossier modules) contenant deux modules se partageant les méthodes de l'actuelle IsogeoPlgApiManager (api.py) et récupérant des méthodes de **Isogeo** (isogeo.py`) :

• api/auth.py : Le rôle de ce module sera de gérer l'authentification à l'API Isogeo (affichage du formulaire, stockage et validation des credentials). Il contiendra la nouvelle classe Authenticator qui récupérera toutes les méthodes de l'actuelle IsogeoPlgApiManager (à l'exception de build_request_url()).

• api/request.py : Le rôle de ce module sera d'effectuer les requêtes à l'API Isogeo (demande de token, construction des URLs, requêtes sur les ressources). Il contiendra la classe ApiRequester qui sera dotée de la méthodes build_request_url() de l'actuelle IsogeoPlgApiManager en plus des méthodes create_request(), send_request() et handle_reply() qui remplaceront les actuelles api_auth_post_get_token(), api_auth_handle_token(), api_get_requests() et api_requests_handle_reply() de Isogeo (isogeo.py).

• api/shares.py : Ce module contiendra la classe SharesParser, son rôle sera de mettre en forme la réponse de l'API Isogeo à une requête sur les partages. Sa méthode send_share_info() construira une chaîne de caractères à partir de la réponse de l'API qui permettra d'informer l'utilisateur sur les partages alimentant son application. Cela permettre de sortir de la classe principale Isogeo une grande partie des lignes qui composent la méthode write_share_info. (voir Propriétés de l'application #215)

Organisation du code

ApiRequester sera utilisée dans modules/quick_search.py (#176) et isogeo.py. Les paramètres de connexion à l'API Isogeo (credentials et URL) seront passés de Authenticator à ApiRequester via la classe principale Isogeo. Il sera ainsi possible d'effectuer une demande de token (via ApiRequester) permettant d'une part de tester la validité de l'authentification (gérée pas Authenticator) et d'autre part d'effectuer des requête à l'API (via ApiRequester). SharesParser sera connecté au signal shares_sig émis par ApiRequester une fois que le contenu d'une réponse de l'API à une requête sur les partages est reçue validée et traitée. Ce signal passera le contenu traité de la réponse de l'API à la méthode send_share_info() de SharesParser qui mettra en forme les informations reçues dans une chaîne de caractères qui sera affichée dans l'interface du plugin par ce qu'il restera de la méthode write_share_info de Isogeo.