Regroup APIs + Notifications API (#59)

Related to this: nextcloud/app_api#25 Added Notification API + start grouping APIs --------- Signed-off-by: Alexander Piskun <[email protected]>
cloud-py-api · Aug 2, 2023 · ff10d39 · ff10d39
1 parent f149e52
commit ff10d39
Show file tree

Hide file tree

Showing 42 changed files with 896 additions and 589 deletions.
diff --git a/.github/workflows/analysis-coverage.yml b/.github/workflows/analysis-coverage.yml
@@ -452,6 +452,13 @@ jobs:
           repository: nextcloud/server
           ref: "master"
 
+      - name: Checkout Notifications
+        uses: actions/checkout@v3
+        with:
+          repository: nextcloud/notifications
+          ref: "master"
+          path: apps/notifications
+
       - name: Set up & run Nextcloud
         env:
           DB_PORT: 4444
@@ -463,6 +470,7 @@ jobs:
           ./occ config:system:set loglevel --value=0 --type=integer
           ./occ config:system:set debug --value=true --type=boolean
           ./occ config:system:set allow_local_remote_servers --value true
+          ./occ app:enable notifications
           php -S localhost:8080 &
 
       - name: Checkout NcPyApi
@@ -566,6 +574,13 @@ jobs:
           repository: nextcloud/server
           ref: "master"
 
+      - name: Checkout Notifications
+        uses: actions/checkout@v3
+        with:
+          repository: nextcloud/notifications
+          ref: "master"
+          path: apps/notifications
+
       - name: Set up & run Nextcloud
         env:
           DB_PORT: 4444
@@ -577,6 +592,7 @@ jobs:
           ./occ config:system:set loglevel --value=0 --type=integer
           ./occ config:system:set debug --value=true --type=boolean
           ./occ config:system:set allow_local_remote_servers --value true
+          ./occ app:enable notifications
           php -S localhost:8080 &
 
       - name: Checkout NcPyApi
@@ -648,6 +664,13 @@ jobs:
           repository: nextcloud/server
           ref: ${{ matrix.nextcloud }}
 
+      - name: Checkout Notifications
+        uses: actions/checkout@v3
+        with:
+          repository: nextcloud/notifications
+          ref: ${{ matrix.nextcloud }}
+          path: apps/notifications
+
       - name: Set up & run Nextcloud
         env:
           DB_PORT: 4444
@@ -659,6 +682,7 @@ jobs:
           ./occ config:system:set loglevel --value=0 --type=integer
           ./occ config:system:set debug --value=true --type=boolean
           ./occ config:system:set allow_local_remote_servers --value true
+          ./occ app:enable notifications
           php -S localhost:8080 &
 
       - name: Checkout NcPyApi

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.0.27 - 2023-08-0x]
+## [0.0.27 - 2023-08-03]
+
+### Added
+
+- `Notifications API`
 
 ### Changed
 
 - Switched to `hatching` as a build system, now correct install optional dependencies.
 - Renamed methods, attributes that was `shadowing a Python builtins`. Enabled additional `Ruff` linters checks.
+- Regroup APIs, now Users related stuff starts with `user`, file related stuff with `file`.
 
 ## [0.0.26 - 2023-07-29]
 

diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Python library that provides a robust and well-documented API that allows develo
  * Operations with Users and User Groups
  * User status
  * Weather status
- * ~~Nextcloud notifications support~~
+ * Notifications support
  * Shares support
  * ~~Talk support~~
 

diff --git a/docs/reference/Files.rst → docs/reference/Files/Files.rst b/docs/reference/Files.rst → docs/reference/Files/Files.rst
@@ -1,5 +1,3 @@
-.. py:currentmodule:: nc_py_api.files
-
 File System
 ===========
 
@@ -8,11 +6,11 @@ Refer to the **fs examples** to see how to use them nicely.
 
 All File APIs are designed to work relative to the current user.
 
-.. autoclass:: FsNodeInfo
+.. autoclass:: nc_py_api.files_defs.FsNodeInfo
     :members:
 
-.. autoclass:: FsNode
+.. autoclass:: nc_py_api.files_defs.FsNode
     :members:
 
-.. autoclass:: FilesAPI
+.. autoclass:: nc_py_api.files.FilesAPI
     :members:
diff --git a/docs/reference/Shares.rst → docs/reference/Files/Shares.rst b/docs/reference/Shares.rst → docs/reference/Files/Shares.rst
@@ -1,13 +1,11 @@
-.. py:currentmodule:: nc_py_api.files_sharing
-
 File Sharing
 ============
 
 The Shares API is universal for both modes and provides all the necessary methods for working with the Nextcloud Shares system.
 Refer to the **share examples** to see how to use them nicely.
 
-.. autoclass:: Share
+.. autoclass:: nc_py_api.files_defs.Share
     :members:
 
-.. autoclass:: FilesSharingAPI
+.. autoclass:: nc_py_api.files_sharing.FilesSharingAPI
     :members:
diff --git a/docs/reference/Files/index.rst b/docs/reference/Files/index.rst
@@ -0,0 +1,8 @@
+Files API
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   Files
+   Shares
diff --git a/docs/reference/Users.rst → docs/reference/Users/Users.rst b/docs/reference/Users.rst → docs/reference/Users/Users.rst
diff --git a/docs/reference/Users/UsersGroups.rst b/docs/reference/Users/UsersGroups.rst
@@ -0,0 +1,8 @@
+User Groups Management
+----------------------
+
+.. autoclass:: nc_py_api.users_groups.UserGroupsAPI
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.GroupDetails
+    :members:
diff --git a/docs/reference/Users/UsersStatus.rst b/docs/reference/Users/UsersStatus.rst
@@ -0,0 +1,17 @@
+User Status
+-----------
+
+.. autoclass:: nc_py_api.users_status.UserStatusAPI
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.CurrentUserStatus
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.UserStatus
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.PredefinedStatus
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.ClearAt
+    :members:
diff --git a/docs/reference/Users/WeatherStatus.rst b/docs/reference/Users/WeatherStatus.rst
@@ -0,0 +1,11 @@
+Weather Status
+--------------
+
+.. autoclass:: nc_py_api.users_weather.WeatherStatusAPI
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.WeatherLocation
+    :members:
+
+.. autoclass:: nc_py_api.users_defs.WeatherLocationMode
+    :members:
diff --git a/docs/reference/Users/index.rst b/docs/reference/Users/index.rst
@@ -0,0 +1,10 @@
+Users API
+=========
+
+.. toctree::
+   :maxdepth: 2
+
+   Users
+   UsersGroups
+   UsersStatus
+   WeatherStatus
diff --git a/docs/reference/UsersGroups.rst b/docs/reference/UsersGroups.rst
diff --git a/docs/reference/UsersStatus.rst b/docs/reference/UsersStatus.rst
diff --git a/docs/reference/WeatherStatus.rst b/docs/reference/WeatherStatus.rst
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -4,13 +4,9 @@ Reference
 .. toctree::
    :maxdepth: 2
 
-   Files
-   Shares
    Apps
-   Users
-   UsersGroups
-   UsersStatus
-   WeatherStatus
+   Files/index.rst
+   Users/index.rst
    Session
    Constants
    Exceptions
diff --git a/examples/to_gif/main.py b/examples/to_gif/main.py
@@ -97,4 +97,4 @@ def initialization():
     # environ["app_name"] = "test_app"
     # ---------
     urllib3.disable_warnings()
-    uvicorn.run("main:APP", host="0.0.0.0", port=9001, log_level='trace', reload=True)
+    uvicorn.run("main:APP", host="0.0.0.0", port=9001, log_level="trace", reload=True)
diff --git a/nc_py_api/__init__.py b/nc_py_api/__init__.py
@@ -1,10 +1,16 @@
 """Import all possible stuff that can be used."""
 
 from ._version import __version__
-from .constants import ApiScope, LogLvl, SharePermissions, ShareStatus, ShareType
+from .constants import ApiScope, LogLvl
 from .exceptions import NextcloudException, NextcloudExceptionNotFound, check_error
-from .files import FsNode, FsNodeInfo
-from .files_sharing import Share
+from .files_defs import (
+    FsNode,
+    FsNodeInfo,
+    Share,
+    SharePermissions,
+    ShareStatus,
+    ShareType,
+)
 from .integration_fastapi import (
     enable_heartbeat,
     nc_app,

diff --git a/nc_py_api/_session.py b/nc_py_api/_session.py
@@ -29,7 +29,7 @@
 
 
 class ServerVersion(TypedDict):
-    """Nextcloud version information"""
+    """Nextcloud version information."""
 
     major: int
     """Major version"""
@@ -79,7 +79,7 @@ def __init__(self, **kwargs):
 
 @dataclass
 class AppConfig(BasicConfig):
-    """Application configuration"""
+    """Application configuration."""
 
     ae_version: str
     """AppEcosystem version"""

diff --git a/nc_py_api/_version.py b/nc_py_api/_version.py
@@ -1,3 +1,3 @@
-""" Version of nc_py_api"""
+""" Version of nc_py_api."""
 
-__version__ = "0.0.27.dev0"
+__version__ = "0.0.27.dev2"
diff --git a/nc_py_api/apps.py b/nc_py_api/apps.py
@@ -10,7 +10,7 @@
 
 
 class ExAppInfo(TypedDict):
-    """Information about the External Application"""
+    """Information about the External Application."""
 
     id: str
     """`id` of the application"""

diff --git a/nc_py_api/constants.py b/nc_py_api/constants.py
@@ -1,11 +1,11 @@
-"""Common constants. Do not use them directly, all public ones are imported to __init__.py"""
+"""Common constants. Do not use them directly, all public ones are imported from __init__.py."""
 
-from enum import IntEnum, IntFlag
+from enum import IntEnum
 from typing import TypedDict
 
 
 class LogLvl(IntEnum):
-    """Log levels"""
+    """Log levels."""
 
     DEBUG = 0
     """Debug log level"""
@@ -23,7 +23,7 @@ class LogLvl(IntEnum):
 
 
 class ApiScope(IntEnum):
-    """Default API scopes"""
+    """Default API scopes."""
 
     SYSTEM = 2
     """Allows access to the System APIs."""
@@ -51,56 +51,3 @@ class OCSRespond(IntEnum):
     RESPOND_UNAUTHORISED = 997
     RESPOND_NOT_FOUND = 998
     RESPOND_UNKNOWN_ERROR = 999
-
-
-class SharePermissions(IntFlag):
-    """The share permissions to be set"""
-
-    PERMISSION_READ = 1
-    """Access to read"""
-    PERMISSION_UPDATE = 2
-    """Access to write"""
-    PERMISSION_CREATE = 4
-    """Access to create new objects in the share"""
-    PERMISSION_DELETE = 8
-    """Access to remove objects in the share"""
-    PERMISSION_SHARE = 16
-    """Access to re-share objects in the share"""
-
-
-class ShareType(IntEnum):
-    """Type of the object that will receive share"""
-
-    TYPE_USER = 0
-    """Share to the user"""
-    TYPE_GROUP = 1
-    """Share to the group"""
-    TYPE_LINK = 3
-    """Share by link"""
-    TYPE_EMAIL = 4
-    """Share by the email"""
-    TYPE_REMOTE = 6
-    """Share to the Federation"""
-    TYPE_CIRCLE = 7
-    """Share to the Nextcloud Circle"""
-    TYPE_GUEST = 8
-    """Share to `Guest`"""
-    TYPE_REMOTE_GROUP = 9
-    """Share to the Federation group"""
-    TYPE_ROOM = 10
-    """Share to the Talk room"""
-    TYPE_DECK = 11
-    """Share to the Nextcloud Deck"""
-    TYPE_SCIENCE_MESH = 15
-    """Share to the Reva instance(Science Mesh)"""
-
-
-class ShareStatus(IntEnum):
-    """Status of the share"""
-
-    STATUS_PENDING = 0
-    """The share waits for acceptance"""
-    STATUS_ACCEPTED = 1
-    """The share was for accepted"""
-    STATUS_REJECTED = 2
-    """The share was for rejected"""