Public assets interface

Problem:
Old design of public assets interface considered
sub-optimal.

Solution:
New design reflects current API for restricted assets substituting
a root class 'ArchivistPublic' which has no URL or auth parameters.
Public assets have been removed from the story runner.
Corrected some minor code in the assetsattachments endpoint.
Split testevents unittests into separate files for better
manageability.

Signed-off-by: Paul Hewlett <[email protected]>

Author: eccles

archivist/access_policies.py

@@ -25,13 +25,11 @@
 from logging import getLogger
 from copy import deepcopy
 
-# pylint:disable=unused-import      # To prevent cyclical import errors forward referencing is used
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist as type_helper
+from . import archivist as type_helper  # pylint:disable=unused-import
 
 from .assets import Asset
 from .constants import (
-    SEP,
     ACCESS_POLICIES_SUBPATH,
     ACCESS_POLICIES_LABEL,
     ASSETS_LABEL,
@@ -65,6 +63,8 @@ class _AccessPoliciesClient:
 
     def __init__(self, archivist: "type_helper.Archivist"):
         self._archivist = archivist
+        self._subpath = f"{archivist.root}/{ACCESS_POLICIES_SUBPATH}"
+        self._label = f"{self._subpath}/{ACCESS_POLICIES_LABEL}"
 
     def __str__(self) -> str:
         return f"AccessPoliciesClient({self._archivist.url})"
@@ -107,7 +107,7 @@ def create_from_data(self, data: Dict) -> AccessPolicy:
         """
         return AccessPolicy(
             **self._archivist.post(
-                f"{ACCESS_POLICIES_SUBPATH}/{ACCESS_POLICIES_LABEL}",
+                f"{self._subpath}/{ACCESS_POLICIES_LABEL}",
                 data,
             )
         )
@@ -124,12 +124,7 @@ def read(self, identity: str) -> AccessPolicy:
             :class:`AccessPolicy` instance
 
         """
-        return AccessPolicy(
-            **self._archivist.get(
-                ACCESS_POLICIES_SUBPATH,
-                identity,
-            )
-        )
+        return AccessPolicy(**self._archivist.get(f"{self._subpath}/{identity}"))
 
     def update(
         self,
@@ -154,8 +149,7 @@ def update(
         """
         return AccessPolicy(
             **self._archivist.patch(
-                ACCESS_POLICIES_SUBPATH,
-                identity,
+                f"{self._subpath}/{identity}",
                 self.__params(
                     props, filters=filters, access_permissions=access_permissions
                 ),
@@ -174,7 +168,7 @@ def delete(self, identity: str) -> Dict:
             :class:`AccessPolicy` instance - empty?
 
         """
-        return self._archivist.delete(ACCESS_POLICIES_SUBPATH, identity)
+        return self._archivist.delete(f"{self._subpath}/{identity}")
 
     def __params(
         self,
@@ -205,10 +199,7 @@ def count(self, *, display_name: Optional[str] = None) -> int:
 
         """
         params = {"display_name": display_name} if display_name is not None else None
-        return self._archivist.count(
-            f"{ACCESS_POLICIES_SUBPATH}/{ACCESS_POLICIES_LABEL}",
-            params=params,
-        )
+        return self._archivist.count(self._label, params=params)
 
     def list(
         self, *, page_size: Optional[int] = None, display_name: Optional[str] = None
@@ -229,7 +220,7 @@ def list(
         return (
             AccessPolicy(**a)
             for a in self._archivist.list(
-                f"{ACCESS_POLICIES_SUBPATH}/{ACCESS_POLICIES_LABEL}",
+                self._label,
                 ACCESS_POLICIES_LABEL,
                 page_size=page_size,
                 params=params,
@@ -250,7 +241,7 @@ def count_matching_assets(self, access_policy_id: str) -> int:
 
         """
         return self._archivist.count(
-            SEP.join((ACCESS_POLICIES_SUBPATH, access_policy_id, ASSETS_LABEL)),
+            f"{self._subpath}/{access_policy_id}/{ASSETS_LABEL}"
         )
 
     def list_matching_assets(
@@ -271,7 +262,7 @@ def list_matching_assets(
         return (
             Asset(**a)
             for a in self._archivist.list(
-                SEP.join((ACCESS_POLICIES_SUBPATH, access_policy_id, ASSETS_LABEL)),
+                f"{self._subpath}/{access_policy_id}/{ASSETS_LABEL}",
                 ASSETS_LABEL,
                 page_size=page_size,
             )
@@ -290,7 +281,7 @@ def count_matching_access_policies(self, asset_id: str) -> int:
 
         """
         return self._archivist.count(
-            SEP.join((ACCESS_POLICIES_SUBPATH, asset_id, ACCESS_POLICIES_LABEL)),
+            f"{self._subpath}/{asset_id}/{ACCESS_POLICIES_LABEL}"
         )
 
     def list_matching_access_policies(
@@ -311,7 +302,7 @@ def list_matching_access_policies(
         return (
             AccessPolicy(**a)
             for a in self._archivist.list(
-                SEP.join((ACCESS_POLICIES_SUBPATH, asset_id, ACCESS_POLICIES_LABEL)),
+                f"{self._subpath}/{asset_id}/{ACCESS_POLICIES_LABEL}",
                 ACCESS_POLICIES_LABEL,
                 page_size=page_size,
             )

archivist/appidp.py

@@ -24,17 +24,14 @@
 from logging import getLogger
 
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-# pylint:disable=unused-import      # To prevent cyclical import errors forward referencing is used
 # pylint:disable=too-few-public-methods
-from . import archivist as type_helper
+from . import archivist as type_helper  # pylint:disable=unused-import
 
 from .constants import (
     APPIDP_SUBPATH,
     APPIDP_LABEL,
     APPIDP_TOKEN,
 )
-from .dictmerge import _deepmerge
-from .type_aliases import NoneOnError
 
 LOGGER = getLogger(__name__)
 
@@ -56,6 +53,8 @@ class _AppIDPClient:
 
     def __init__(self, archivist: "type_helper.Archivist"):
         self._archivist = archivist
+        self._subpath = f"{archivist.root}/{APPIDP_SUBPATH}"
+        self._label = f"{self._subpath}/{APPIDP_LABEL}"
 
     def __str__(self) -> str:
         return f"AppIDPClient({self._archivist.url})"
@@ -73,7 +72,7 @@ def token(self, client_id: str, client_secret: str) -> AppIDP:
         """
         return AppIDP(
             **self._archivist.post(
-                f"{APPIDP_SUBPATH}/{APPIDP_LABEL}/{APPIDP_TOKEN}",
+                f"{self._label}/{APPIDP_TOKEN}",
                 {
                     "grant_type": "client_credentials",
                     "client_id": client_id,

archivist/applications.py

@@ -24,9 +24,8 @@
 from logging import getLogger
 from typing import Dict, Optional
 
-# pylint:disable=unused-import      # To prevent cyclical import errors forward referencing is used
 # pylint:disable=cyclic-import      # but pylint doesn't understand this feature
-from . import archivist as type_helper
+from . import archivist as type_helper  # pylint:disable=unused-import
 
 from .constants import (
     APPLICATIONS_SUBPATH,
@@ -56,6 +55,8 @@ class _ApplicationsClient:
 
     def __init__(self, archivist: "type_helper.Archivist"):
         self._archivist = archivist
+        self._subpath = f"{archivist.root}/{APPLICATIONS_SUBPATH}"
+        self._label = f"{self._subpath}/{APPLICATIONS_LABEL}"
 
     def __str__(self) -> str:
         return f"ApplicationsClient({self._archivist.url})"
@@ -94,12 +95,7 @@ def create_from_data(self, data: Dict) -> Application:
             :class:`Application` instance
 
         """
-        return Application(
-            **self._archivist.post(
-                f"{APPLICATIONS_SUBPATH}/{APPLICATIONS_LABEL}",
-                data,
-            )
-        )
+        return Application(**self._archivist.post(self._label, data))
 
     def read(self, identity: str) -> Application:
         """Read Application
@@ -113,12 +109,7 @@ def read(self, identity: str) -> Application:
             :class:`Application` instance
 
         """
-        return Application(
-            **self._archivist.get(
-                APPLICATIONS_SUBPATH,
-                identity,
-            )
-        )
+        return Application(**self._archivist.get(f"{self._subpath}/{identity}"))
 
     def update(
         self,
@@ -142,8 +133,7 @@ def update(
         """
         return Application(
             **self._archivist.patch(
-                APPLICATIONS_SUBPATH,
-                identity,
+                f"{self._subpath}/{identity}",
                 self.__params(
                     display_name=display_name,
                     custom_claims=custom_claims,
@@ -163,7 +153,7 @@ def delete(self, identity: str) -> Dict:
             :class:`Application` instance - empty?
 
         """
-        return self._archivist.delete(APPLICATIONS_SUBPATH, identity)
+        return self._archivist.delete(f"{self._subpath}/{identity}")
 
     def __params(
         self,
@@ -203,7 +193,7 @@ def list(
         return (
             Application(**a)
             for a in self._archivist.list(
-                f"{APPLICATIONS_SUBPATH}/{APPLICATIONS_LABEL}",
+                self._label,
                 APPLICATIONS_LABEL,
                 page_size=page_size,
                 params=self.__params(display_name=display_name),
@@ -225,8 +215,7 @@ def regenerate(self, identity: str) -> Application:
         LOGGER.debug("Regenerate %s", identity)
         return Application(
             **self._archivist.post(
-                f"{APPLICATIONS_SUBPATH}/{identity}",
+                f"{self._subpath}/{identity}:{APPLICATIONS_REGENERATE}",
                 None,
-                verb=APPLICATIONS_REGENERATE,
             )
         )