Merge pull request #12 from terrestris/feat/list-of-applications

Feature: load list of applications of SHOGun instance via GraphQL

Author: ahennr

.gitignore

@@ -3,6 +3,7 @@ __pycache__/
 *.py[cod]
 *$py.class
 docker/qgis_plugins/*
+plugin_code/shogun_qgis_venv/
 
 # C extensions
 *.so

Dockerfile

@@ -1,7 +1,7 @@
 services:
     qgis:
       image: qgis/qgis:3.44
-      command: ["/bin/bash", "-c", "pip install debugpy; qgis /root/shogun_qgis_konfigurator.qgs"]
+      command: ["/bin/bash", "-c", "qgis /root/shogun_qgis_konfigurator.qgs"]
       environment:
         DISPLAY: "unix${DISPLAY}"
         RUN_IN_DOCKER: "1"

docker/docker-compose-dev.yml

@@ -22,6 +22,8 @@
  This script initializes the plugin, making it known to QGIS.
 """
 
+from qgis.core import QgsMessageLog
+
 
 # noinspection PyPep8Naming
 def classFactory(iface):  # pylint: disable=invalid-name
@@ -31,5 +33,10 @@ def classFactory(iface):  # pylint: disable=invalid-name
     :type iface: QgsInterface
     """
     #
+    import os
+
+    project_path = os.path.dirname(__file__)
+    QgsMessageLog.logMessage(f"Project path: {project_path}", "QgisShogunEditor")
+
     from .qgis_shogun_editor import QgisShogunEditor
     return QgisShogunEditor(iface)

plugin_code/__init__.py

@@ -0,0 +1,2 @@
+class GraphQLException(Exception):
+    pass

plugin_code/exception/GraphQLException.py

@@ -27,7 +27,7 @@ tags=python
 
 homepage=http://homepage
 category=Plugins
-icon=icon.png
+icon=shogun_logo.png
 # experimental flag
 experimental=True
 
@@ -37,7 +37,7 @@ deprecated=False
 # Since QGIS 3.8, a comma separated list of plugins to be installed
 # (or upgraded) can be specified.
 # Check the documentation for more information.
-# plugin_dependencies=
+plugin_dependencies=qpip
 
 Category of the plugin: Raster, Vector, Database or Web
 # category=

plugin_code/exception/__init__.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+from typing import Any, Dict, Optional
+
+from ..models.BaseEntity import BaseEntity
+
+
+@dataclass
+class Application(BaseEntity):
+    name: Optional[str] = None
+    state_only: Optional[bool] = None
+    client_config: Optional[Dict[str, Any]] = None
+    layer_tree: Optional[Dict[str, Any]] = None
+    layer_config: Optional[Dict[str, Any]] = None
+    tool_config: Optional[Dict[str, Any]] = None
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'Application':
+        base = super().from_dict(data)
+        return cls(
+            _id=base._id,
+            created=base.created,
+            modified=base.modified,
+            name=data.get('name'),
+            state_only=data.get('stateOnly'),
+            client_config=data.get('clientConfig'),
+            layer_tree=data.get('layerTree'),
+            layer_config=data.get('layerConfig'),
+            tool_config=data.get('toolConfig')
+        )

plugin_code/metadata.txt

@@ -0,0 +1,43 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, Optional
+
+
+class LayerType(Enum):
+    TILE_WMS = "TileWMS"
+    VECTOR_TILE = "VectorTile"
+    WFS = "WFS"
+    WMS = "WMS"
+    WMTS = "WMTS"
+    XYZ = "XYZ"
+
+
+class RevisionType(Enum):
+    INSERT = "INSERT"
+    UPDATE = "UPDATE"
+    DELETE = "DELETE"
+
+
+@dataclass
+class BaseEntity:
+    _id: Optional[int] = None
+    created: Optional[datetime] = None
+    modified: Optional[datetime] = None
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'BaseEntity':
+        return cls(
+            _id=data.get('id'),
+            created=cls._parse_datetime(data.get('created')),
+            modified=cls._parse_datetime(data.get('modified'))
+        )
+
+    @staticmethod
+    def _parse_datetime(date_str: Optional[str]) -> Optional[datetime]:
+        if not date_str:
+            return None
+        try:
+            return datetime.fromisoformat(date_str.replace('Z', '+00:00'))
+        except (ValueError, AttributeError):
+            return None

plugin_code/models/Application.py

@@ -0,0 +1,27 @@
+from dataclasses import dataclass
+from typing import Any, Dict, Optional
+
+from .BaseEntity import BaseEntity
+
+
+@dataclass
+class Layer(BaseEntity):
+    name: Optional[str] = None
+    client_config: Optional[Dict[str, Any]] = None
+    source_config: Optional[Dict[str, Any]] = None
+    features: Optional[Dict[str, Any]] = None
+    layerType: Optional[str] = None
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> 'Layer':
+        base = super().from_dict(data)
+        return cls(
+            _id=base._id,
+            created=base.created,
+            modified=base.modified,
+            name=data.get('name'),
+            client_config=data.get('clientConfig'),
+            source_config=data.get('sourceConfig'),
+            features=data.get('features'),
+            layerType=data.get('type')
+        )