prepare release 3.0.0 (#293)

#293

* bump version to 3.0.0
* update docstrings
* housekeeping
* update gitignore to ignore quicksearches.json
* update i18n
* formatting with black

Author: SimonSAMPERE

.gitignore

@@ -117,7 +117,8 @@ test/fixtures
 
 # user settings
 _user/
-
+cache.json
+quicksearches.json
 
 *.pyc
 *.*~

i18n/isogeo.qph

@@ -221,17 +221,12 @@
     <target>Alerte</target>
 </phrase>
 <phrase>
-    <source>Proxy issue : 
-QGIS and your OS have different proxy set ups.</source>
-    <target>Problème de proxy :\nQGIS et votre ordinateur ont des configurations de proxy différentes.</target>
-</phrase>
-<phrase>
-    <source>Proxy issue : 
-You have a proxy set up on your OS but none in QGIS.
-Please set it up in &apos;Preferences/Options/Network&apos;.</source>
-    <target>Problème de proxy :
-Votre ordinateur utilise un proxy, mais il n&apos;est pas configuré
-dans QGIS (Menu &apos;Préférences/Options/Réseau).</target>
+    <source>Proxy issue: 
+You have a proxy set up on your OS {} but none in QGIS.
+ Please set it up in &apos;Preferences/Options/Network&apos; then close/reopen the plugin.</source>
+    <target>Erreur de proxy détectée :
+Un proxy est actif sur votre système {} mais pas dans QGIS.
+Vérifiez la configuration de QGIS (Préférénces/Options/Réseau) et de votre ordinateur, puis fermer et réouvrir le plugin.</target>
 </phrase>
 <phrase>
     <source>Error</source>
@@ -421,10 +416,6 @@ dans QGIS (Menu &apos;Préférences/Options/Réseau).</target>
     <source>Authentication file is valid. Asking for authorization to Isogeo&apos;s API.</source>
     <target>Le fichier d&apos;authentification est valide. Demande d&apos;autorisation envoyée à l&apos;API.</target>
 </phrase>
-<phrase>
-    <source>Redirecting code received. ID and SECRET could be invalid. Provide them again. If this error keeps happening, please report it in the bug tracker.</source>
-    <target>Les identifiant et mot de passe ne sont pas valides. Renseignez les une nouvelle fois. Si l&apos;erreur persiste, merci de la signaler dans le bug tracker.</target>
-</phrase>
 <phrase>
     <source>Proxy error found. Check your OS and QGIS proxy configuration.If this error keeps happening, please report it in the bug tracker.</source>
     <target>Erreur de proxy détectée. Vérifiez les configurations de QGIS et de votre ordinateur. Si l&apos;erreur persiste, merci de la signaler dans le bug tracker.</target>
@@ -445,6 +436,10 @@ dans QGIS (Menu &apos;Préférences/Options/Réseau).</target>
     <source>Request to Isogeo&apos;s API failed : please check your Internet connection and your proxy configuration. If this error keeps happening, please report it in the bug tracker.</source>
     <target>La requête à l&apos;API Isogeo a échoué. Vérifiez votre connexion Internet et votre configuration proxy. Si l&apos;erreur persiste, merci de la signaler dans le bug tracker.</target>
 </phrase>
+<phrase>
+    <source>ID and SECRET could be invalid. Provide them again. If this error keeps happening, please report it in the bug tracker.</source>
+    <target>Les paramètres d&apos;authentification (Client ID et Client Secret) semblent invalides.</target>
+</phrase>
 <phrase>
     <source>Credits</source>
     <target>Crédits</target>

i18n/isogeo_search_engine_en.ts

@@ -280,17 +280,17 @@
 <context>
     <name>IsogeoPlgTools</name>
     <message>
-        <location filename="../modules/tools.py" line="458"/>
+        <location filename="../modules/tools.py" line="461"/>
         <source>The &apos;{}&apos; QGIS style is not compatible with combobox. It has been changed. Please restart QGIS.</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/tools.py" line="368"/>
+        <location filename="../modules/tools.py" line="371"/>
         <source>Alert</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/tools.py" line="368"/>
+        <location filename="../modules/tools.py" line="371"/>
         <source>Proxy issue: 
 You have a proxy set up on your OS {} but none in QGIS.
  Please set it up in &apos;Preferences/Options/Network&apos; then close/reopen the plugin.</source>
@@ -366,52 +366,52 @@ You have a proxy set up on your OS {} but none in QGIS.
 <context>
     <name>ResultsManager</name>
     <message>
-        <location filename="../modules/results/display.py" line="162"/>
+        <location filename="../modules/results/display.py" line="167"/>
         <source>Point</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="165"/>
+        <location filename="../modules/results/display.py" line="170"/>
         <source>Polygon</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="168"/>
+        <location filename="../modules/results/display.py" line="173"/>
         <source>Line</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="171"/>
+        <location filename="../modules/results/display.py" line="176"/>
         <source>MultiPolygon</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="193"/>
+        <location filename="../modules/results/display.py" line="198"/>
         <source>Unknown geometry</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="187"/>
+        <location filename="../modules/results/display.py" line="192"/>
         <source>Raster</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="190"/>
+        <location filename="../modules/results/display.py" line="195"/>
         <source>Service</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="450"/>
+        <location filename="../modules/results/display.py" line="455"/>
         <source>Data file</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="446"/>
+        <location filename="../modules/results/display.py" line="451"/>
         <source>PostGIS table</source>
         <translation type="unfinished"></translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="398"/>
+        <location filename="../modules/results/display.py" line="403"/>
         <source>Can&apos;t be added</source>
         <translation type="unfinished"></translation>
     </message>

i18n/isogeo_search_engine_fr.qm

@@ -280,17 +280,17 @@
 <context>
     <name>IsogeoPlgTools</name>
     <message>
-        <location filename="../modules/tools.py" line="458"/>
+        <location filename="../modules/tools.py" line="461"/>
         <source>The &apos;{}&apos; QGIS style is not compatible with combobox. It has been changed. Please restart QGIS.</source>
         <translation>Le {} style de l&apos;interface n&apos;est pas compatible avec le sélecteur de mots-clés. Il a été changé. Merci de redémarrer QGIS.</translation>
     </message>
     <message>
-        <location filename="../modules/tools.py" line="368"/>
+        <location filename="../modules/tools.py" line="371"/>
         <source>Alert</source>
         <translation>Alerte</translation>
     </message>
     <message>
-        <location filename="../modules/tools.py" line="368"/>
+        <location filename="../modules/tools.py" line="371"/>
         <source>Proxy issue: 
 You have a proxy set up on your OS {} but none in QGIS.
  Please set it up in &apos;Preferences/Options/Network&apos; then close/reopen the plugin.</source>
@@ -368,52 +368,52 @@ Vérifiez la configuration de QGIS (Préférénces/Options/Réseau) et de votre
 <context>
     <name>ResultsManager</name>
     <message>
-        <location filename="../modules/results/display.py" line="162"/>
+        <location filename="../modules/results/display.py" line="167"/>
         <source>Point</source>
         <translation>Point</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="165"/>
+        <location filename="../modules/results/display.py" line="170"/>
         <source>Polygon</source>
         <translation>Polygone</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="168"/>
+        <location filename="../modules/results/display.py" line="173"/>
         <source>Line</source>
         <translation>Linéaire</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="171"/>
+        <location filename="../modules/results/display.py" line="176"/>
         <source>MultiPolygon</source>
         <translation>Multi-polygone</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="193"/>
+        <location filename="../modules/results/display.py" line="198"/>
         <source>Unknown geometry</source>
         <translation>Géométrie inconnue</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="187"/>
+        <location filename="../modules/results/display.py" line="192"/>
         <source>Raster</source>
         <translation>Raster</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="190"/>
+        <location filename="../modules/results/display.py" line="195"/>
         <source>Service</source>
         <translation>Service</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="450"/>
+        <location filename="../modules/results/display.py" line="455"/>
         <source>Data file</source>
         <translation>Donnée fichier</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="446"/>
+        <location filename="../modules/results/display.py" line="451"/>
         <source>PostGIS table</source>
         <translation>Table PostGIS</translation>
     </message>
     <message>
-        <location filename="../modules/results/display.py" line="398"/>
+        <location filename="../modules/results/display.py" line="403"/>
         <source>Can&apos;t be added</source>
         <translation>Non ajoutable</translation>
     </message>

i18n/isogeo_search_engine_fr.ts

@@ -11,7 +11,7 @@ name=Isogeo
 qgisMinimumVersion=3.4
 qgisMaximumVersion=3.99
 description=Isogeo search engine within QGIS
-version=2.0.0-beta4
+version=3.0.0
 author=Isogeo
 email=projects+qgis@isogeo.com
 
@@ -37,7 +37,7 @@ homepage=http://help.isogeo.com/qgis/
 category=Web
 icon=icon.png
 # experimental flag
-experimental=True
+experimental=False
 
 # deprecated flag (applies to the whole plugin, not just a single version)
 deprecated=False

metadata.txt

@@ -274,7 +274,7 @@ def credentials_update(self, credentials_source: str = "QSettings"):
             self.api_params["url_auth"] = creds.get("uri_auth")
             self.api_params["url_token"] = creds.get("uri_token")
             self.api_params["url_redirect"] = creds.get("uri_redirect")
-            # self.credentials_storer(store_location="QSettings")
+            self.credentials_storer(store_location="QSettings")
         else:
             pass
 
@@ -290,7 +290,6 @@ def display_auth_form(self):
         """
         self.informer = UserInformer(message_bar=self.msgbar, trad=self.tr)
         self.auth_sig.connect(self.informer.authentication_slot)
-        self.ask_shares.connect(self.informer.authentication_slot)
         self.ui_auth_form.chb_isogeo_editor.stateChanged.connect(
             lambda: qsettings.setValue(
                 "isogeo/user/editor",
@@ -326,7 +325,8 @@ def display_auth_form(self):
     def credentials_uploader(self):
         """Get file selected by the user and loads API credentials into plugin.
         If the selected is compliant, credentials are loaded from then it's
-        moved inside plugin/_auth subfolder.
+        moved inside plugin/_auth subfolder. auth_sig is emitted to inform the user
+        about indicated file's accessibility and format validity.
         """
         self.ui_auth_form.btn_browse_credentials.fileChanged.disconnect()
 
@@ -383,7 +383,7 @@ def credentials_uploader(self):
 
         # mave new credentials file to the _auth subfolder
         try:
-            selected_file.rename(dest_path) # using pathlib.Path (= os.rename)
+            selected_file.rename(dest_path)  # using pathlib.Path (= os.rename)
             logger.debug(
                 "Selected credentials file has been moved into plugin _auth subfolder"
             )

modules/api/auth.py

@@ -33,6 +33,7 @@ class ApiRequester(QgsNetworkAccessManager):
         - Request about application's shares
         - Request about ressources
         - Building request URLs
+        - Parsing API's answer tags
     """
 
     api_sig = pyqtSignal(str)
@@ -66,8 +67,8 @@ def __init__(self):
         self.currentUrl = str
 
     def setup_api_params(self, dict_params: dict):
-        """Store API parameters of the application (URLs and credentials)
-        in class attributes.
+        """Store API parameters of the application (URLs and credentials) in class 
+        attributes.
 
         :param dict dict_params: a dict containing API parameters provided
         by Authenticator().manage_api_initialization method.
@@ -83,8 +84,8 @@ def setup_api_params(self, dict_params: dict):
         self.send_request("token")
 
     def create_request(self, request_type: str):
-        """Creates a QNetworkRequest() with appropriate headers and URL
-        according to the 'request_type' parameter.
+        """Creates a QNetworkRequest() with appropriate headers and URL according to the
+        'request_type' parameter.
 
         :param str request_type: type of request to create. Options:
             - 'token'
@@ -131,8 +132,8 @@ def create_request(self, request_type: str):
         return request
 
     def send_request(self, request_type: str = "search"):
-        """ Sends a request to the Isogeo's API using QNetworkRequestManager.
-        That's the handle_reply method which get the API's response. See below.
+        """ Sends a request to the Isogeo's API using QNetworkRequestManager. That's the
+        handle_reply method which get the API's response. See below.
 
         :param str request_type: type of request to send. Options:
             - 'token'
@@ -154,23 +155,39 @@ def send_request(self, request_type: str = "search"):
         # get request for other
         else:
             req = self.get(request)
+        # since https://github.com/isogeo/isogeo-plugin-qgis/issues/288, the slot is
+        # connected to the request's signal and no more to QgsNetworkAccessManager's one
+        # because otherweise, the plugin doesn't work on QGIS 3.8.x
         req.finished.connect(partial(self.handle_reply, req))
         return
 
     def handle_reply(self, reply: QNetworkReply):
-        """Slot to QNetworkAccesManager.finished signal who handles the API's response to any type
-        of request : 'token', 'search', 'shares' or 'details'.
-
-        The request's type is identicated from the url of the request from which the answer comes.
-        Depending on the reply's content validity and the request's type, an appropriated signal
-        is emitted with different data's value.
-
-        - For token requests : the api_sig signal is emitted wathever the replys's content but
-        the mitted str's value depend on this content. A single slot is connected to this signal
-        and acts according to value of the string recieved (see isogeo.py : Isogeo.token_slot).
-        - For other requests : for each type of request there is a corresponding signal but the
-        reply's parsed content is emitted wathever the request's type. Each signal is connected to
-        an appropriate slot (see isogeo.py).
+        """Slot to QNetworkAccesManager.finished signal who handles the API's response
+        to any type of request: 'token', 'search', 'shares' or 'details'.
+
+        The request's type is identicated from the url of the request from which the
+        answer comes. Depending on the reply's content validity and the request's type,
+        an appropriated signal is emitted with different data's value.
+
+        - api_sig is emitted when a token request is handled or when there is a problem
+        with the API response. 2 slots are connected to api_sig:
+
+            - Isogeo.token_slot: it calls the necessary methods to initialize the plugin
+            when authentication is successful (when "ok" is emitted) and disables the
+            plugin when it's not (when other than "ok" str is emitted).
+
+            - UserInformer.request_slot: it displays to user the appropriated message
+            when a problem with the API response is detected (when other than "ok" str
+            is emitted) depending on the origin ofthe problem.
+
+        - search_sig is emitted when the API response to a search request is handled.
+        Isogeo.search_slot() is connected to this signal
+
+        - details_sig is emitted when the API response to a details request is handled.
+        MetadataDisplayer.show_complete_md() is connected to this signal
+
+        - shares_sig is emitted when the API response to a shares request is handled.
+        SharesParser.send_share_info() is connected to this signal
 
         :param QNetworkReply reply: Isogeo API response
         """