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

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

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.20.0 - 2025-04-28]
+
+### Changed
+
+- ExApps: `nc_py_api.ex_app.events_listener.EventsListener` was removed in favor of `nc_py_api.webhooks`. #348
+
+### Fixed
+
+- Method `download2stream` not working correctly when Nextcloud returns compressed content. #352 Thanks to @PatrickPromitzer for reporting this.
+
+## [0.19.2 - 2025-03-17]
+
+### Added
+
+- Optional `response_type` parameter of `nextcloud.ocs` method for calling OCS endpoints that return raw data. #341 Thanks to @janepie
+
 ## [0.19.1 - 2025-03-07]
 
 ### Fixed

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.19.1
+Version: 0.20.0
 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.19.1 → nc_py_api-0.20.0}/nc_py_api/_session.py

@@ -197,6 +197,7 @@ class NcSessionBasic(NcSessionBase, ABC):
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         files: dict | None = None,
         **kwargs,
@@ -215,6 +216,8 @@ class NcSessionBasic(NcSessionBase, ABC):
         if response.status_code == 204:  # NO_CONTENT
             return []
         response_data = loads(response.text)
+        if response_type == "json":
+            return response_data
         ocs_meta = response_data["ocs"]["meta"]
         if ocs_meta["status"] != "ok":
             if (
@@ -304,7 +307,7 @@ class NcSessionBasic(NcSessionBase, ABC):
         adapter = self.adapter_dav if dav else self.adapter
         with adapter.stream("GET", url_path, params=params, headers=kwargs.get("headers")) as response:
             check_error(response)
-            for data_chunk in response.iter_raw(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
+            for data_chunk in response.iter_bytes(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
                 fp.write(data_chunk)
 
 
@@ -319,6 +322,7 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         files: dict | None = None,
         **kwargs,
@@ -337,6 +341,8 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         if response.status_code == 204:  # NO_CONTENT
             return []
         response_data = loads(response.text)
+        if response_type == "json":
+            return response_data
         ocs_meta = response_data["ocs"]["meta"]
         if ocs_meta["status"] != "ok":
             if (
@@ -428,7 +434,7 @@ class AsyncNcSessionBasic(NcSessionBase, ABC):
         adapter = self.adapter_dav if dav else self.adapter
         async with adapter.stream("GET", url_path, params=params, headers=kwargs.get("headers")) as response:
             check_error(response)
-            async for data_chunk in response.aiter_raw(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
+            async for data_chunk in response.aiter_bytes(chunk_size=kwargs.get("chunk_size", 5 * 1024 * 1024)):
                 fp.write(data_chunk)
 
 

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

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

{nc_py_api-0.19.1 → nc_py_api-0.20.0}/nc_py_api/nextcloud.py

@@ -31,7 +31,6 @@ from .activity import _ActivityAPI, _AsyncActivityAPI
 from .apps import _AppsAPI, _AsyncAppsAPI
 from .calendar_api import _CalendarAPI
 from .ex_app.defs import LogLvl
-from .ex_app.events_listener import AsyncEventsListenerAPI, EventsListenerAPI
 from .ex_app.occ_commands import AsyncOccCommandsAPI, OccCommandsAPI
 from .ex_app.providers.providers import AsyncProvidersApi, ProvidersApi
 from .ex_app.ui.ui import AsyncUiApi, UiApi
@@ -137,11 +136,14 @@ class _NextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         **kwargs,
     ):
         """Performs OCS call and returns OCS response payload data."""
-        return self._session.ocs(method, path, content=content, json=json, params=params, **kwargs)
+        return self._session.ocs(
+            method, path, content=content, json=json, response_type=response_type, params=params, **kwargs
+        )
 
     def download_log(self, fp) -> None:
         """Downloads Nextcloud log file. Requires Admin privileges."""
@@ -238,11 +240,14 @@ class _AsyncNextcloudBasic(ABC):  # pylint: disable=too-many-instance-attributes
         *,
         content: bytes | str | typing.Iterable[bytes] | typing.AsyncIterable[bytes] | None = None,
         json: dict | list | None = None,
+        response_type: str | None = None,
         params: dict | None = None,
         **kwargs,
     ):
         """Performs OCS call and returns OCS response payload data."""
-        return await self._session.ocs(method, path, content=content, json=json, params=params, **kwargs)
+        return await self._session.ocs(
+            method, path, content=content, json=json, response_type=response_type, params=params, **kwargs
+        )
 
     async def download_log(self, fp) -> None:
         """Downloads Nextcloud log file. Requires Admin privileges."""
@@ -321,8 +326,6 @@ class NextcloudApp(_NextcloudBasic):
     ui: UiApi
     """Nextcloud UI API for ExApps"""
     providers: ProvidersApi
-    """API for registering providers for Nextcloud"""
-    events_listener: EventsListenerAPI
     """API for registering Events listeners for ExApps"""
     occ_commands: OccCommandsAPI
     """API for registering OCC command for ExApps"""
@@ -338,7 +341,6 @@ class NextcloudApp(_NextcloudBasic):
         self.preferences_ex = PreferencesExAPI(self._session)
         self.ui = UiApi(self._session)
         self.providers = ProvidersApi(self._session)
-        self.events_listener = EventsListenerAPI(self._session)
         self.occ_commands = OccCommandsAPI(self._session)
 
     @property
@@ -456,8 +458,6 @@ class AsyncNextcloudApp(_AsyncNextcloudBasic):
     ui: AsyncUiApi
     """Nextcloud UI API for ExApps"""
     providers: AsyncProvidersApi
-    """API for registering providers for Nextcloud"""
-    events_listener: AsyncEventsListenerAPI
     """API for registering Events listeners for ExApps"""
     occ_commands: AsyncOccCommandsAPI
     """API for registering OCC command for ExApps"""
@@ -473,7 +473,6 @@ class AsyncNextcloudApp(_AsyncNextcloudBasic):
         self.preferences_ex = AsyncPreferencesExAPI(self._session)
         self.ui = AsyncUiApi(self._session)
         self.providers = AsyncProvidersApi(self._session)
-        self.events_listener = AsyncEventsListenerAPI(self._session)
         self.occ_commands = AsyncOccCommandsAPI(self._session)
 
     @property

{nc_py_api-0.19.1 → nc_py_api-0.20.0}/nc_py_api/webhooks.py

@@ -2,6 +2,7 @@
 
 import dataclasses
 
+from ._exceptions import NextcloudExceptionNotFound
 from ._misc import clear_from_params_empty  # , require_capabilities
 from ._session import AppConfig, AsyncNcSessionBasic, NcSessionBasic
 
@@ -51,7 +52,7 @@ class WebhookInfo:
     @property
     def user_id_filter(self) -> str:
         """Currently unknown."""
-        return self._raw_data["userIdFilter"]
+        return "" if self._raw_data["userIdFilter"] is None else self._raw_data["userIdFilter"]
 
     @property
     def headers(self) -> dict:
@@ -84,8 +85,11 @@ class _WebhooksAPI:
         params = {"uri": uri_filter} if uri_filter else {}
         return [WebhookInfo(i) for i in self._session.ocs("GET", f"{self._ep_base}", params=params)]
 
-    def get_entry(self, webhook_id: int) -> WebhookInfo:
-        return WebhookInfo(self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+    def get_entry(self, webhook_id: int) -> WebhookInfo | None:
+        try:
+            return WebhookInfo(self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+        except NextcloudExceptionNotFound:
+            return None
 
     def register(
         self,
@@ -151,7 +155,7 @@ class _WebhooksAPI:
 class _AsyncWebhooksAPI:
     """The class provides the async application management API on the Nextcloud server."""
 
-    _ep_base: str = "/ocs/v1.php/webhooks"
+    _ep_base: str = "/ocs/v1.php/apps/webhook_listeners/api/v1/webhooks"
 
     def __init__(self, session: AsyncNcSessionBasic):
         self._session = session
@@ -160,8 +164,11 @@ class _AsyncWebhooksAPI:
         params = {"uri": uri_filter} if uri_filter else {}
         return [WebhookInfo(i) for i in await self._session.ocs("GET", f"{self._ep_base}", params=params)]
 
-    async def get_entry(self, webhook_id: int) -> WebhookInfo:
-        return WebhookInfo(await self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+    async def get_entry(self, webhook_id: int) -> WebhookInfo | None:
+        try:
+            return WebhookInfo(await self._session.ocs("GET", f"{self._ep_base}/{webhook_id}"))
+        except NextcloudExceptionNotFound:
+            return None
 
     async def register(
         self,

nc_py_api-0.19.1/nc_py_api/ex_app/events_listener.py

@@ -1,137 +0,0 @@
-"""Nextcloud API for registering Events listeners for ExApps."""
-
-import dataclasses
-
-from .._exceptions import NextcloudExceptionNotFound
-from .._misc import require_capabilities
-from .._session import AsyncNcSessionApp, NcSessionApp
-
-_EP_SUFFIX: str = "events_listener"
-
-
-@dataclasses.dataclass
-class EventsListener:
-    """EventsListener description."""
-
-    def __init__(self, raw_data: dict):
-        self._raw_data = raw_data
-
-    @property
-    def event_type(self) -> str:
-        """Main type of event, e.g. ``node_event``."""
-        return self._raw_data["event_type"]
-
-    @property
-    def event_subtypes(self) -> str:
-        """Subtypes for which fire event, e.g. ``NodeCreatedEvent``, ``NodeDeletedEvent``."""
-        return self._raw_data["event_subtypes"]
-
-    @property
-    def action_handler(self) -> str:
-        """Relative ExApp url which will be called by Nextcloud."""
-        return self._raw_data["action_handler"]
-
-    def __repr__(self):
-        return f"<{self.__class__.__name__} event_type={self.event_type}, handler={self.action_handler}>"
-
-
-class EventsListenerAPI:
-    """API for registering Events listeners, avalaible as **nc.events_handler.<method>**."""
-
-    def __init__(self, session: NcSessionApp):
-        self._session = session
-
-    def register(
-        self,
-        event_type: str,
-        callback_url: str,
-        event_subtypes: list[str] | None = None,
-    ) -> None:
-        """Registers or edits the events listener."""
-        if event_subtypes is None:
-            event_subtypes = []
-        require_capabilities("app_api", self._session.capabilities)
-        params = {
-            "eventType": event_type,
-            "actionHandler": callback_url,
-            "eventSubtypes": event_subtypes,
-        }
-        self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
-
-    def unregister(self, event_type: str, not_fail=True) -> None:
-        """Removes the events listener."""
-        require_capabilities("app_api", self._session.capabilities)
-        try:
-            self._session.ocs(
-                "DELETE",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                params={"eventType": event_type},
-            )
-        except NextcloudExceptionNotFound as e:
-            if not not_fail:
-                raise e from None
-
-    def get_entry(self, event_type: str) -> EventsListener | None:
-        """Get information about the event listener."""
-        require_capabilities("app_api", self._session.capabilities)
-        try:
-            return EventsListener(
-                self._session.ocs(
-                    "GET",
-                    f"{self._session.ae_url}/{_EP_SUFFIX}",
-                    params={"eventType": event_type},
-                )
-            )
-        except NextcloudExceptionNotFound:
-            return None
-
-
-class AsyncEventsListenerAPI:
-    """API for registering Events listeners, avalaible as **nc.events_handler.<method>**."""
-
-    def __init__(self, session: AsyncNcSessionApp):
-        self._session = session
-
-    async def register(
-        self,
-        event_type: str,
-        callback_url: str,
-        event_subtypes: list[str] | None = None,
-    ) -> None:
-        """Registers or edits the events listener."""
-        if event_subtypes is None:
-            event_subtypes = []
-        require_capabilities("app_api", await self._session.capabilities)
-        params = {
-            "eventType": event_type,
-            "actionHandler": callback_url,
-            "eventSubtypes": event_subtypes,
-        }
-        await self._session.ocs("POST", f"{self._session.ae_url}/{_EP_SUFFIX}", json=params)
-
-    async def unregister(self, event_type: str, not_fail=True) -> None:
-        """Removes the events listener."""
-        require_capabilities("app_api", await self._session.capabilities)
-        try:
-            await self._session.ocs(
-                "DELETE",
-                f"{self._session.ae_url}/{_EP_SUFFIX}",
-                params={"eventType": event_type},
-            )
-        except NextcloudExceptionNotFound as e:
-            if not not_fail:
-                raise e from None
-
-    async def get_entry(self, event_type: str) -> EventsListener | None:
-        """Get information about the event listener."""
-        require_capabilities("app_api", await self._session.capabilities)
-        try:
-            return EventsListener(
-                await self._session.ocs(
-                    "GET",
-                    f"{self._session.ae_url}/{_EP_SUFFIX}",
-                    params={"eventType": event_type},
-                )
-            )
-        except NextcloudExceptionNotFound:
-            return None