fixes for new AppEcosystem version (#84)

Signed-off-by: Alexander Piskun <[email protected]>

Author: bigcat88

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.31 - 2023-08-17]
+
+### Added
+
+- `FsNode` can be created from Nextcloud `UiActionFileInfo` reply.
+- Finished documentation.
+
 ## [0.0.30 - 2023-08-15]
 
 ### Added

examples/as_app/skeleton/Makefile

@@ -32,12 +32,14 @@ deploy:
 .PHONY: run28
 run28:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:unregister skeleton --silent || true
-	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register skeleton docker_dev -e --force-scopes
+	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register skeleton docker_dev -e --force-scopes \
+		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
 
 .PHONY: run27
 run27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_ecosystem_v2:app:unregister skeleton --silent || true
-	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register skeleton docker_dev -e --force-scopes
+	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register skeleton docker_dev -e --force-scopes \
+		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
 
 .PHONY: manual_register
 manual_register:

examples/as_app/skeleton/requirements.txt

@@ -1 +1 @@
-nc_py_api[app]
+nc_py_api[app]>=0.0.30

examples/as_app/to_gif/Makefile

@@ -15,7 +15,7 @@ help:
 	@echo "  run27             install ToGif for Nextcloud 27"
 	@echo "  "
 	@echo "  For development of this example use PyCharm run configurations. Development is always set for last Nextcloud."
-	@echo "  First run 'to_gif' and then 'make manual_register', after that you can use/debug/develop it and easy test."
+	@echo "  First run 'ToGif' and then 'make manual_register', after that you can use/debug/develop it and easy test."
 	@echo "  "
 	@echo "  manual_register   perform registration of running 'to_gif' into the 'manual_install' deploy daemon."
 
@@ -32,12 +32,14 @@ deploy:
 .PHONY: run28
 run28:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:unregister to_gif --silent || true
-	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register to_gif docker_dev -e --force-scopes
+	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register to_gif docker_dev -e --force-scopes \
+		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/to_gif/appinfo/info.xml
 
 .PHONY: run27
 run27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_ecosystem_v2:app:unregister to_gif --silent || true
-	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register to_gif docker_dev -e --force-scopes
+	docker exec master-nextcloud-1 sudo -u www-data php occ app_ecosystem_v2:app:register to_gif docker_dev -e --force-scopes \
+		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/to_gif/appinfo/info.xml
 
 .PHONY: manual_register
 manual_register:

examples/as_app/to_gif/requirements.txt

@@ -1,4 +1,4 @@
-nc_py_api[app]
+nc_py_api[app]>=0.0.30
 pygifsicle
 imageio
 opencv-python

examples/as_app/to_gif/src/main.py

@@ -18,6 +18,7 @@
     UiFileActionHandlerInfo,
     nc_app,
     run_app,
+    set_handlers,
 )
 
 APP = FastAPI()
@@ -88,10 +89,13 @@ def enabled_handler(enabled: bool, nc: NextcloudApp) -> str:
     return ""
 
 
+@APP.on_event("startup")
+def initialization():
+    set_handlers(APP, enabled_handler)
+
+
 if __name__ == "__main__":
     run_app(
-        APP,
-        enabled_handler,
         "main:APP",
         log_level="trace",
     )

nc_py_api/_version.py

@@ -1,3 +1,3 @@
 """Version of nc_py_api."""
 
-__version__ = "0.0.30"
+__version__ = "0.0.31.dev0"

nc_py_api/ex_app/uvicorn_fastapi.py

@@ -2,17 +2,23 @@
 import typing
 from os import environ
 
-from uvicorn import run
-from uvicorn.config import ASGIApplication
+try:
+    import uvicorn
+except ImportError as ex:
+    from .._deffered_error import DeferredError
+
+    uvicorn = DeferredError(ex)
 
 
 def run_app(
-    uvicorn_app: typing.Union["ASGIApplication", typing.Callable, str],
+    uvicorn_app: typing.Union[typing.Callable, str, typing.Any],
     *args,
     **kwargs,
 ) -> None:
     """Wrapper around Uvicorn's ``run`` function.
 
-    Accepts and passes all arguments to it, except for ``host`` and ``port`` which are taken from the environment.
+    :param uvicorn_app: "ASGIApplication", usually consists of the "name_of_file:FastAPI_class".
+    :param args: Any args to pass to **uvicorn.run**.
+    :param kwargs: Any **kwargs** to pass to **uvicorn.run**, except ``host`` and ``port``.
     """
-    run(uvicorn_app, *args, host=environ.get("APP_HOST", "127.0.0.1"), port=int(environ["APP_PORT"]), **kwargs)
+    uvicorn.run(uvicorn_app, *args, host=environ.get("APP_HOST", "127.0.0.1"), port=int(environ["APP_PORT"]), **kwargs)

tests/_install_only_enabled_handler.py

@@ -9,5 +9,10 @@ def enabled_handler(_enabled: bool, _nc: NextcloudApp) -> str:
     return ""
 
 
+@APP.on_event("startup")
+def initialization():
+    ex_app.set_handlers(APP, enabled_handler)
+
+
 if __name__ == "__main__":
-    ex_app.run_app(APP, enabled_handler, "_install_only_enabled_handler:APP", log_level="warning")
+    ex_app.run_app("_install_only_enabled_handler:APP", log_level="warning")

tests/nc_app_test.py

@@ -33,9 +33,9 @@ def test_app_cfg():
 def test_scope_allow_app_ecosystem_disabled():
     NC.apps.disable("app_ecosystem_v2")
     try:
-        assert NC_APP.scope_allowed(ApiScope.DAV)
+        assert NC_APP.scope_allowed(ApiScope.FILES)
         NC_APP.update_server_info()
-        assert not NC_APP.scope_allowed(ApiScope.DAV)
+        assert not NC_APP.scope_allowed(ApiScope.FILES)
     finally:
         NC.apps.enable("app_ecosystem_v2")
         NC_APP.update_server_info()