preparing next version (#39)

Adjustments to the last AppEcosystem update

---------

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

Author: bigcat88

.gitignore

@@ -92,3 +92,5 @@ share/python-wheels/
 *.egg
 MANIFEST
 converted/
+
+geckodriver.log

.pre-commit-config.yaml

@@ -18,7 +18,8 @@ repos:
         files: >-
             (?x)^(
                 nc_py_api/|
-                benchmarks/
+                benchmarks/|
+                tests/
             )
 
 -   repo: https://github.com/psf/black
@@ -28,7 +29,8 @@ repos:
         files: >-
             (?x)^(
                 nc_py_api/|
-                benchmarks/
+                benchmarks/|
+                tests/
             )
 
 -   repo: https://github.com/tox-dev/pyproject-fmt

CHANGELOG.md

@@ -2,7 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.0.24 - 2023-07-xx]
+## [0.0.25 - 2023-07-xx]
+
+### Changed
+
+- Updated documentation, description
+-
+
+## [0.0.24 - 2023-07-18]
 
 ### Added
 

nc_py_api/__init__.py

@@ -4,7 +4,7 @@
 
 from ._version import __version__
 from .constants import ApiScope, LogLvl
-from .exceptions import NextcloudException, check_error
+from .exceptions import NextcloudException, NextcloudExceptionNotFound, check_error
 from .files import FsNode, FsNodeInfo
 from .integration_fastapi import (
     enable_heartbeat,

nc_py_api/_session.py

@@ -19,7 +19,8 @@
 from xxhash import xxh64
 
 from . import options
-from .exceptions import NextcloudException, check_error
+from .constants import OCSRespond
+from .exceptions import NextcloudException, NextcloudExceptionNotFound, check_error
 
 
 class ServerVersion(TypedDict):
@@ -138,8 +139,6 @@ def _ocs(self, method: str, path_params: str, headers: dict, data: Optional[byte
             raise NextcloudException(408, info=info) from None
 
         check_error(response.status_code, info)
-        if not response.text:
-            raise ValueError(f"Response is empty. Status code: {response.status_code}")
         response_data = loads(response.text)
         ocs_meta = response_data["ocs"]["meta"]
         if ocs_meta["status"] != "ok":
@@ -149,6 +148,8 @@ def _ocs(self, method: str, path_params: str, headers: dict, data: Optional[byte
                         self.adapter.close()
                         self.init_adapter(restart=True)
                         return self._ocs(method, path_params, headers, data, **kwargs, nested_req=True)
+            if ocs_meta["statuscode"] in (404, OCSRespond.RESPOND_NOT_FOUND):
+                raise NextcloudExceptionNotFound(reason=ocs_meta["message"], info=info)
             raise NextcloudException(status_code=ocs_meta["statuscode"], reason=ocs_meta["message"], info=info)
         return response_data["ocs"]["data"]
 

nc_py_api/appconfig_preferences_ex.py

@@ -5,6 +5,7 @@
 
 from ._session import NcSessionBasic
 from .constants import APP_V2_BASIC_URL
+from .exceptions import NextcloudExceptionNotFound
 from .misc import require_capabilities
 
 
@@ -19,28 +20,50 @@ class BasicAppCfgPref:
     def __init__(self, session: NcSessionBasic):
         self._session = session
 
-    def get_value(self, key: str) -> Optional[str]:
+    def get_value(self, key: str, default=None) -> Optional[str]:
+        if not key:
+            raise ValueError("`key` parameter can not be empty")
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
-        r = self.get_values([key])
-        if r:
-            return r[0]["configvalue"]
-        return None
+        try:
+            r = self.get_values([key])
+            if r:
+                return r[0]["configvalue"]
+        except NextcloudExceptionNotFound:
+            pass
+        return default
 
     def get_values(self, keys: list[str]) -> list[AppCfgPrefRecord]:
+        if not keys:
+            return []
+        if not all(keys):
+            raise ValueError("`key` parameter can not be empty")
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
         data = {"configKeys": keys}
-        return self._session.ocs(method="POST", path=f"{APP_V2_BASIC_URL}/{self.url_suffix}/get-values", json=data)
+        try:
+            return self._session.ocs(method="POST", path=f"{APP_V2_BASIC_URL}/{self.url_suffix}/get-values", json=data)
+        except NextcloudExceptionNotFound:
+            return []
 
     def set(self, key: str, value: str) -> None:
+        if not key:
+            raise ValueError("`key` parameter can not be empty")
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
         params = {"configKey": key, "configValue": value}
         self._session.ocs(method="POST", path=f"{APP_V2_BASIC_URL}/{self.url_suffix}", json=params)
 
-    def delete(self, keys: Union[str, list[str]]) -> None:
-        require_capabilities("app_ecosystem_v2", self._session.capabilities)
+    def delete(self, keys: Union[str, list[str]], not_fail=True) -> None:
         if isinstance(keys, str):
             keys = [keys]
-        self._session.ocs(method="DELETE", path=f"{APP_V2_BASIC_URL}/{self.url_suffix}", json={"configKeys": keys})
+        if not keys:
+            return
+        if not all(keys):
+            raise ValueError("`key` parameter can not be empty")
+        require_capabilities("app_ecosystem_v2", self._session.capabilities)
+        try:
+            self._session.ocs(method="DELETE", path=f"{APP_V2_BASIC_URL}/{self.url_suffix}", json={"configKeys": keys})
+        except NextcloudExceptionNotFound as e:
+            if not not_fail:
+                raise e from None
 
 
 class PreferencesExAPI(BasicAppCfgPref):

nc_py_api/constants.py

@@ -12,7 +12,7 @@ class LogLvl(IntEnum):
     FATAL = 4
 
 
-APP_V2_BASIC_URL = "/ocs/v2.php/apps/app_ecosystem_v2/api/v1"
+APP_V2_BASIC_URL = "/ocs/v1.php/apps/app_ecosystem_v2/api/v1"
 
 
 class ApiScope(IntEnum):
@@ -27,3 +27,10 @@ class ApiScope(IntEnum):
 class ApiScopesStruct(TypedDict):
     required: list[int]
     optional: list[int]
+
+
+class OCSRespond(IntEnum):
+    RESPOND_SERVER_ERROR = 996
+    RESPOND_UNAUTHORISED = 997
+    RESPOND_NOT_FOUND = 998
+    RESPOND_UNKNOWN_ERROR = 999

nc_py_api/exceptions.py

@@ -20,6 +20,11 @@ def __str__(self):
         return f"[{self.status_code}]{reason}{info}"
 
 
+class NextcloudExceptionNotFound(NextcloudException):
+    def __init__(self, reason="Not found", info: str = ""):
+        super().__init__(404, reason=reason, info=info)
+
+
 def check_error(code: int, info: str = ""):
     if 996 <= code <= 999:
         if code == 996:

nc_py_api/preferences.py

@@ -5,7 +5,7 @@
 from ._session import NcSessionBasic
 from .misc import check_capabilities, require_capabilities
 
-ENDPOINT = "/ocs/v2.php/apps/provisioning_api/api/v1/config/users"
+ENDPOINT = "/ocs/v1.php/apps/provisioning_api/api/v1/config/users"
 
 
 class PreferencesAPI:

nc_py_api/ui_files_actions_menu.py

@@ -6,6 +6,7 @@
 
 from ._session import NcSessionApp
 from .constants import APP_V2_BASIC_URL
+from .exceptions import NextcloudExceptionNotFound
 from .misc import require_capabilities
 
 
@@ -28,7 +29,7 @@ class UiFilesActionsAPI:
     def __init__(self, session: NcSessionApp):
         self._session = session
 
-    def register(self, name: str, display_name: str, callback_url: str, **kwargs):
+    def register(self, name: str, display_name: str, callback_url: str, **kwargs) -> None:
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
         params = {
             "fileActionMenuParams": {
@@ -42,9 +43,13 @@ def register(self, name: str, display_name: str, callback_url: str, **kwargs):
                 "action_handler": callback_url,
             },
         }
-        return self._session.ocs(method="POST", path=f"{APP_V2_BASIC_URL}/{ENDPOINT_SUFFIX}", json=params)
+        self._session.ocs(method="POST", path=f"{APP_V2_BASIC_URL}/{ENDPOINT_SUFFIX}", json=params)
 
-    def unregister(self, name: str):
+    def unregister(self, name: str, not_fail=True) -> None:
         require_capabilities("app_ecosystem_v2", self._session.capabilities)
         params = {"fileActionMenuName": name}
-        return self._session.ocs(method="DELETE", path=f"{APP_V2_BASIC_URL}/{ENDPOINT_SUFFIX}", json=params)
+        try:
+            self._session.ocs(method="DELETE", path=f"{APP_V2_BASIC_URL}/{ENDPOINT_SUFFIX}", json=params)
+        except NextcloudExceptionNotFound as e:
+            if not not_fail:
+                raise e from None