ex_app API rework [ci skip]

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>

Author: bigcat88

nc_py_api/apps.py

@@ -1,17 +1,19 @@
 """Nextcloud API for working with applications."""
 
-from typing import Optional, TypedDict
+from dataclasses import dataclass
+from typing import Optional
 
 from ._session import NcSessionBasic
 from .misc import require_capabilities
 
 ENDPOINT = "/ocs/v1.php/cloud/apps"
 
 
-class ExAppInfo(TypedDict):
+@dataclass
+class ExAppInfo:
     """Information about the External Application."""
 
-    id: str
+    app_id: str
     """`ID` of the application"""
     name: str
     """Display name"""
@@ -24,6 +26,14 @@ class ExAppInfo(TypedDict):
     system: bool
     """Flag indicating if the application is a system application"""
 
+    def __init__(self, raw_data: dict):
+        self.app_id = raw_data["id"]
+        self.name = raw_data["name"]
+        self.version = raw_data["version"]
+        self.enabled = bool(raw_data["enabled"])
+        self.last_check_time = raw_data["last_check_time"]
+        self.system = raw_data["system"]
+
 
 class AppAPI:
     """The class provides the application management API on the Nextcloud server."""
@@ -78,12 +88,25 @@ def is_disabled(self, app_id: str) -> bool:
             raise ValueError("`app_id` parameter can not be empty")
         return app_id in self.get_list(enabled=False)
 
-    def ex_app_get_list(self) -> list[str]:
-        """Gets the list of the external applications IDs installed on the server."""
-        require_capabilities("app_ecosystem_v2", self._session.capabilities)
-        return self._session.ocs(method="GET", path=f"{self._session.ae_url}/ex-app/all", params={"extended": 0})
+    def ex_app_get_list(self, enabled: bool = False) -> list[ExAppInfo]:
+        """Gets information of the enabled external applications installed on the server.
 
-    def ex_app_get_info(self) -> list[ExAppInfo]:
-        """Gets information of the external applications installed on the server."""
+        :param enabled: Flag indicating whether to return only enabled applications or all applications.
+            Default = **False**.
+        """
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
-        return self._session.ocs(method="GET", path=f"{self._session.ae_url}/ex-app/all", params={"extended": 1})
+        url_param = "enabled" if enabled else "all"
+        r = self._session.ocs(method="GET", path=f"{self._session.ae_url}/ex-app/{url_param}")
+        return [ExAppInfo(i) for i in r]
+
+    def ex_app_is_enabled(self, app_id: str) -> bool:
+        """Returns ``True`` if specified external application is enabled."""
+        if not app_id:
+            raise ValueError("`app_id` parameter can not be empty")
+        return app_id in [i.app_id for i in self.ex_app_get_list(True)]
+
+    def ex_app_is_disabled(self, app_id: str) -> bool:
+        """Returns ``True`` if specified external application is disabled."""
+        if not app_id:
+            raise ValueError("`app_id` parameter can not be empty")
+        return app_id in [i.app_id for i in self.ex_app_get_list(True) if not i.enabled]

tests/apps_test.py

@@ -52,27 +52,33 @@ def test_invalid_param(nc):
         nc.apps.enable("")
     with pytest.raises(ValueError):
         nc.apps.disable("")
+    with pytest.raises(ValueError):
+        nc.apps.ex_app_is_enabled("")
+    with pytest.raises(ValueError):
+        nc.apps.ex_app_is_disabled("")
 
 
 @pytest.mark.parametrize("nc", NC_TO_TEST)
 def test_ex_app_get_list(nc):
     if "app_ecosystem_v2" not in nc.capabilities:
         pytest.skip("app_ecosystem_v2 is not installed.")
+    enabled_ex_apps = nc.apps.ex_app_get_list(enabled=True)
+    assert isinstance(enabled_ex_apps, list)
+    for i in enabled_ex_apps:
+        assert i.enabled is True
+        assert nc.apps.ex_app_is_enabled(i.app_id) is True
+        assert nc.apps.ex_app_is_disabled(i.app_id) is False
+    assert "nc_py_api" in [i.app_id for i in enabled_ex_apps]
     ex_apps = nc.apps.ex_app_get_list()
     assert isinstance(ex_apps, list)
-    assert isinstance(ex_apps[0], str)
-
-
-@pytest.mark.parametrize("nc", NC_TO_TEST)
-def test_ex_app_get_info(nc):
-    if "app_ecosystem_v2" not in nc.capabilities:
-        pytest.skip("app_ecosystem_v2 is not installed.")
-    ex_apps = nc.apps.ex_app_get_info()
-    assert isinstance(ex_apps, list)
-    nc_py_api = [i for i in ex_apps if i["id"] == "nc_py_api"][0]
-    assert nc_py_api["id"] == "nc_py_api"
-    assert isinstance(nc_py_api["name"], str)
-    assert isinstance(nc_py_api["version"], str)
-    assert nc_py_api["enabled"]
-    assert isinstance(nc_py_api["last_check_time"], int)
-    assert nc_py_api["system"]
+    assert "nc_py_api" in [i.app_id for i in ex_apps]
+    assert len(ex_apps) >= len(enabled_ex_apps)
+    for app in ex_apps:
+        assert isinstance(app.app_id, str)
+        assert isinstance(app.name, str)
+        assert isinstance(app.version, str)
+        assert isinstance(app.enabled, bool)
+        assert isinstance(app.last_check_time, int)
+        assert isinstance(app.system, bool)
+        if app.app_id == "nc_py_api":
+            assert app.system is True