nc-py-api 0.20.0__tar.gz → 0.20.2__tar.gz

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.20.2 - 2025-05-28]
+
+### Added
+
+- ExApps(NC32+): field `sensitive` to the `SettingsField` class (Declarative Settings) and to the `PreferencesExAPI` class. #357
+
+## [0.20.1 - 2025-05-06]
+
+### Fixed
+
+- ExApps: `AppAPIAuthMiddleware`: correct handling of `disable_for` parameter. #357 Thanks to @BerengarWLehr
+
 ## [0.20.0 - 2025-04-28]
 
 ### Changed

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.20.0
+Version: 0.20.2
 Summary: Nextcloud Python Framework
 Project-URL: Changelog, https://github.com/cloud-py-api/nc_py_api/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://cloud-py-api.github.io/nc_py_api/

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/nc_py_api/_preferences_ex.py

@@ -61,6 +61,21 @@ class _BasicAppCfgPref:
             if not not_fail:
                 raise e from None
 
+    def set_value(self, key: str, value: str, sensitive: bool | None = None) -> None:
+        """Sets a value and if specified the sensitive flag for a key.
+
+        .. note:: A sensitive flag ensures key value are encrypted and truncated in Nextcloud logs.
+            Default for new records is ``False`` when sensitive is *unspecified*, if changes existing record and
+            sensitive is *unspecified* it will not change the existing `sensitive` flag.
+        """
+        if not key:
+            raise ValueError("`key` parameter can not be empty")
+        require_capabilities("app_api", self._session.capabilities)
+        params: dict = {"configKey": key, "configValue": value}
+        if sensitive is not None:
+            params["sensitive"] = sensitive
+        self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)
+
 
 class _AsyncBasicAppCfgPref:
     _url_suffix: str
@@ -104,72 +119,41 @@ class _AsyncBasicAppCfgPref:
             if not not_fail:
                 raise e from None
 
+    async def set_value(self, key: str, value: str, sensitive: bool | None = None) -> None:
+        """Sets a value and if specified the sensitive flag for a key.
+
+        .. note:: A sensitive flag ensures key value are encrypted and truncated in Nextcloud logs.
+            Default for new records is ``False`` when sensitive is *unspecified*, if changes existing record and
+            sensitive is *unspecified* it will not change the existing `sensitive` flag.
+        """
+        if not key:
+            raise ValueError("`key` parameter can not be empty")
+        require_capabilities("app_api", await self._session.capabilities)
+        params: dict = {"configKey": key, "configValue": value}
+        if sensitive is not None:
+            params["sensitive"] = sensitive
+        await self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)
+
 
 class PreferencesExAPI(_BasicAppCfgPref):
-    """User specific preferences API, avalaible as **nc.preferences_ex.<method>**."""
+    """User specific preferences API, available as **nc.preferences_ex.<method>**."""
 
     _url_suffix = "ex-app/preference"
 
-    def set_value(self, key: str, value: str) -> None:
-        """Sets a value for a key."""
-        if not key:
-            raise ValueError("`key` parameter can not be empty")
-        require_capabilities("app_api", self._session.capabilities)
-        params = {"configKey": key, "configValue": value}
-        self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)
-
 
 class AsyncPreferencesExAPI(_AsyncBasicAppCfgPref):
     """User specific preferences API."""
 
     _url_suffix = "ex-app/preference"
 
-    async def set_value(self, key: str, value: str) -> None:
-        """Sets a value for a key."""
-        if not key:
-            raise ValueError("`key` parameter can not be empty")
-        require_capabilities("app_api", await self._session.capabilities)
-        params = {"configKey": key, "configValue": value}
-        await self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)
-
 
 class AppConfigExAPI(_BasicAppCfgPref):
-    """Non-user(App) specific preferences API, avalaible as **nc.appconfig_ex.<method>**."""
+    """Non-user(App) specific preferences API, available as **nc.appconfig_ex.<method>**."""
 
     _url_suffix = "ex-app/config"
 
-    def set_value(self, key: str, value: str, sensitive: bool | None = None) -> None:
-        """Sets a value and if specified the sensitive flag for a key.
-
-        .. note:: A sensitive flag ensures key values are truncated in Nextcloud logs.
-            Default for new records is ``False`` when sensitive is *unspecified*, if changes existing record and
-            sensitive is *unspecified* it will not change the existing `sensitive` flag.
-        """
-        if not key:
-            raise ValueError("`key` parameter can not be empty")
-        require_capabilities("app_api", self._session.capabilities)
-        params: dict = {"configKey": key, "configValue": value}
-        if sensitive is not None:
-            params["sensitive"] = sensitive
-        self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)
-
 
 class AsyncAppConfigExAPI(_AsyncBasicAppCfgPref):
     """Non-user(App) specific preferences API."""
 
     _url_suffix = "ex-app/config"
-
-    async def set_value(self, key: str, value: str, sensitive: bool | None = None) -> None:
-        """Sets a value and if specified the sensitive flag for a key.
-
-        .. note:: A sensitive flag ensures key values are truncated in Nextcloud logs.
-            Default for new records is ``False`` when sensitive is *unspecified*, if changes existing record and
-            sensitive is *unspecified* it will not change the existing `sensitive` flag.
-        """
-        if not key:
-            raise ValueError("`key` parameter can not be empty")
-        require_capabilities("app_api", await self._session.capabilities)
-        params: dict = {"configKey": key, "configValue": value}
-        if sensitive is not None:
-            params["sensitive"] = sensitive
-        await self._session.ocs("POST", f"{self._session.ae_url}/{self._url_suffix}", json=params)

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.20.0"
+__version__ = "0.20.2"

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/nc_py_api/ex_app/integration_fastapi.py

@@ -247,7 +247,7 @@ class AppAPIAuthMiddleware:
 
         conn = HTTPConnection(scope)
         url_path = conn.url.path.lstrip("/")
-        if not fnmatch.filter(self._disable_for, url_path):
+        if not any(fnmatch.fnmatch(url_path, i) for i in self._disable_for):
             try:
                 scope["username"] = _request_sign_check(conn, AsyncNextcloudApp())
             except HTTPException as exc:

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/nc_py_api/ex_app/ui/settings.py

@@ -48,6 +48,7 @@ class SettingsField:
     description: str = ""
     placeholder: str = ""
     label: str = ""
+    sensitive: bool = False
     notify = False  # to be supported in future
 
     @classmethod
@@ -74,6 +75,7 @@ class SettingsField:
             "placeholder": self.placeholder,
             "label": self.label,
             "notify": self.notify,
+            "sensitive": self.sensitive,
         }
 
 

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/nc_py_api/files/_files.py

@@ -1,8 +1,10 @@
 """Helper functions for **FilesAPI** and **AsyncFilesAPI** classes."""
 
 import enum
+from datetime import datetime, timezone
 from io import BytesIO
 from json import dumps, loads
+from typing import Any
 from urllib.parse import unquote
 from xml.etree import ElementTree
 
@@ -69,6 +71,16 @@ def get_propfind_properties(capabilities: dict) -> list:
     return r
 
 
+def _dav_literal(val: Any) -> str:
+    """Return a string suitable for <d:literal>."""
+    if isinstance(val, datetime):
+        # make timezone-aware, force UTC, second precision
+        dt = val if val.tzinfo else val.replace(tzinfo=timezone.utc)
+        dt = dt.astimezone(timezone.utc).replace(microsecond=0)
+        return dt.isoformat().replace("+00:00", "Z")  # 2025-03-10T12:34:56Z
+    return str(val)
+
+
 def build_find_request(req: list, path: str | FsNode, user: str, capabilities: dict) -> ElementTree.Element:
     path = path.user_path if isinstance(path, FsNode) else path
     root = ElementTree.Element(
@@ -126,7 +138,7 @@ def build_search_req(xml_element_where, req: list) -> None:
         ElementTree.SubElement(_, SEARCH_PROPERTIES_MAP[req.pop(0)])
         _ = ElementTree.SubElement(_root, "d:literal")
         value = req.pop(0)
-        _.text = value if isinstance(value, str) else str(value)
+        _.text = _dav_literal(value)
 
     while len(req):
         where_part = req.pop(0)

{nc_py_api-0.20.0 → nc_py_api-0.20.2}/pyproject.toml

@@ -104,9 +104,6 @@ exclude = [
 
 [tool.black]
 line-length = 120
-target-versions = [
-  "py310",
-]
 preview = true
 
 [tool.ruff]