nc-py-api 0.19.2__py3-none-any.whl → 0.20.0__py3-none-any.whl

nc_py_api/_session.py

@@ -307,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)
 
 
@@ -434,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/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.19.2"
+__version__ = "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
@@ -327,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"""
@@ -344,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
@@ -462,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"""
@@ -479,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/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.2.dist-info → nc_py_api-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nc-py-api
-Version: 0.19.2
+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.2.dist-info → nc_py_api-0.20.0.dist-info}/RECORD

@@ -4,15 +4,15 @@ nc_py_api/_exceptions.py,sha256=7vbUECaLmD7RJBCU27t4fuP6NmQK6r4508u_gS4szhI,2298
 nc_py_api/_misc.py,sha256=dUzCP9VmyhtICTsn1aexlFAYUioBm40k6Zh-YE5WwCY,3333
 nc_py_api/_preferences.py,sha256=OtovFZuGHnHYKjdDjSnUappO795tW8Oxj7qVaejHWpQ,2479
 nc_py_api/_preferences_ex.py,sha256=tThj6U0ZZMaBZ-jUkjrbaI0xDnafWsBowQKsC6gjOQs,7179
-nc_py_api/_session.py,sha256=jqvZ-HJOV7f1PJr1tWPGcYGLKqhxLhfr0zMzNYtSGnU,20660
+nc_py_api/_session.py,sha256=8CjrT0ZDTg8cugRkukxUHGA_O7UsiwleawZ_KyEI6n0,20664
 nc_py_api/_talk_api.py,sha256=0Uo7OduYniuuX3UQPb468RyGJJ-PWBCgJ5HoPuz5Qa0,51068
 nc_py_api/_theming.py,sha256=hTr3nuOemSuRFZaPy9iXNmBM7rDgQHECH43tHMWGqEY,1870
-nc_py_api/_version.py,sha256=IfQ3_oR_eCaAPVpP4i7ZXXZ5f_ghVyuoae34M2rFTW8,52
+nc_py_api/_version.py,sha256=ffWaRZShROhs5-fFhItPP3NQvF3fj57SDMn-qKh0UEo,52
 nc_py_api/activity.py,sha256=t9VDSnnaXRNOvALqOSGCeXSQZ-426pCOMSfQ96JHys4,9574
 nc_py_api/apps.py,sha256=Us2y2lszdxXlD8t6kxwd5_Nrrmazc0EvZXIH9O-ol80,9315
 nc_py_api/calendar_api.py,sha256=-T6CJ8cRbJZTLtxSEDWuuYpD29DMJGCTfLONmtxZV9w,1445
 nc_py_api/loginflow_v2.py,sha256=UjkK3gMouzNrIS7BFhjbmB_9m4fP2UY5sfpmvJ2EXWk,5760
-nc_py_api/nextcloud.py,sha256=4Z_2wKkvyNxbrFkEUi-EABzxG31jW4YsszwT9Xdz0hI,23195
+nc_py_api/nextcloud.py,sha256=C3lnns8Dx34wXsOoN4vwOc0Sm5rA8CgH4UtxNNKFyKc,22793
 nc_py_api/notes.py,sha256=ljO3TOe-Qg0bJ0mlFQwjg--Pxmj-XFknoLbcbJmII0A,15106
 nc_py_api/notifications.py,sha256=WgzV21TuLOhLk-UEjhBSbMsIi2isa5MmAx6cbe0pc2Y,9187
 nc_py_api/options.py,sha256=ZKJqVLhWVwJ6YxAKzGWlPXJhd1vg9GluyFzr-jX4Jp0,2038
@@ -22,10 +22,9 @@ nc_py_api/user_status.py,sha256=I101nwYS8X1WvC8AnLa2f3qJUCPDPHrbq-ke0h1VT4E,1328
 nc_py_api/users.py,sha256=SQG8Agplaxy7XJgguK-rxV-azpc-QdktbDmLmQtJkXo,15476
 nc_py_api/users_groups.py,sha256=IPxw-Ks5NjCm6r8_HC9xmf3IYptH00ulITbp5iazhAo,6289
 nc_py_api/weather_status.py,sha256=wAkjuJPjxc0Rxe4za0BzfwB0XeUmkCXoisJtTH3-qdQ,7582
-nc_py_api/webhooks.py,sha256=14nAMy-tnOvmRnJbo42zUHyjX-z6kc9OMDUVKzNmplY,7769
+nc_py_api/webhooks.py,sha256=BGHRtankgbUkcqBRJTFShjRLpaVoFNcjLsrVitoNziM,8083
 nc_py_api/ex_app/__init__.py,sha256=6Lwid4bBXOSrZf_ocf5m8qkkO1OgYxG0GTs4q6Nw72o,691
 nc_py_api/ex_app/defs.py,sha256=FaQInH3jLugKxDUqpwrXdkMT-lBxmoqWmXJXc11fa6A,727
-nc_py_api/ex_app/events_listener.py,sha256=pgQ4hSQV39NuP9F9IDWxo0Qle6oG15-Ol2FlItnIBGY,4682
 nc_py_api/ex_app/integration_fastapi.py,sha256=a3mhbBFrv_IaRqaYfKa26duiufZL-hSDFqcPDr59Vts,11041
 nc_py_api/ex_app/logger.py,sha256=nAHLObuPvl3UBLrlqZulgoxxVaAJ661iP4F6bTW-V-Y,1475
 nc_py_api/ex_app/misc.py,sha256=c7B0uE8isaIi4SQbxURGUuWjZaaXiLg3Ov6cqvRYplE,2298
@@ -46,8 +45,8 @@ nc_py_api/files/_files.py,sha256=l1oGcXIKmuhlNthXkwL8qbINQgiMJ9wmFega9IP-wNk,138
 nc_py_api/files/files.py,sha256=7x4hfnVa2y1R5bxK9f8cdggi1gPnpUYnsBj0e4p-4qc,24926
 nc_py_api/files/files_async.py,sha256=nyDeWiGx_8CHuVrNThSgfZy0l-WlC4El-TzJONo0TsM,25773
 nc_py_api/files/sharing.py,sha256=VRZCl-TYK6dbu9rUHPs3_jcVozu1EO8bLGZwoRpiLsU,14439
-nc_py_api-0.19.2.dist-info/METADATA,sha256=Kh7LhFby1VbKb5JouSSHVJfw9LL4PZDyV6z42k01hic,8055
-nc_py_api-0.19.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nc_py_api-0.19.2.dist-info/licenses/AUTHORS,sha256=B2Q9q9XH3PAxJp0V3GiKQc1l0z7vtGDpDHqda-ISWKM,616
-nc_py_api-0.19.2.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
-nc_py_api-0.19.2.dist-info/RECORD,,
+nc_py_api-0.20.0.dist-info/METADATA,sha256=80t-MmU4I6iXrIIpzf4ruf4PXZwns2WY7hCfpB6yy80,8055
+nc_py_api-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nc_py_api-0.20.0.dist-info/licenses/AUTHORS,sha256=B2Q9q9XH3PAxJp0V3GiKQc1l0z7vtGDpDHqda-ISWKM,616
+nc_py_api-0.20.0.dist-info/licenses/LICENSE.txt,sha256=OLEMh401fAumGHfRSna365MLIfnjdTcdOHZ6QOzMjkg,1551
+nc_py_api-0.20.0.dist-info/RECORD,,

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