feat: add method to create and store a shared access key for a specific case, and extend the constructor to allow the use of this key.

Author: rwiker

src/sumo/wrapper/_auth_provider.py

@@ -66,6 +66,11 @@ def get_authorization(self):
 
         return {"Authorization": "Bearer " + token}
 
+    def store_shared_access_key_for_case(self, case_uuid, token):
+        with open(get_token_path(self._resource_id + "+" + case_uuid,
+                                      ".sharedkey"), "w") as f:
+            f.write(token)
+
     pass
 
 
@@ -394,6 +399,7 @@ def get_auth_provider(
     access_token=None,
     refresh_token=None,
     devicecode=False,
+    case_uuid = None,
 ):
     if refresh_token:
         return AuthProviderRefreshToken(
@@ -403,6 +409,9 @@ def get_auth_provider(
     if access_token:
         return AuthProviderAccessToken(access_token)
     # ELSE
+    if case_uuid is not None and os.path.exists(get_token_path(resource_id + "+" + case_uuid, ".sharedkey")):
+        return AuthProviderSumoToken(resource_id + "+" + case_uuid)
+    # ELSE
     if os.path.exists(get_token_path(resource_id, ".sharedkey")):
         return AuthProviderSumoToken(resource_id)
     # ELSE

src/sumo/wrapper/sumo_client.py

@@ -33,6 +33,7 @@ def __init__(
         verbosity: str = "CRITICAL",
         retry_strategy=RetryStrategy(),
         timeout=DEFAULT_TIMEOUT,
+        case_uuid = None,
     ):
         """Initialize a new Sumo object
 
@@ -85,6 +86,7 @@ def __init__(
             refresh_token=refresh_token,
             access_token=access_token,
             devicecode=devicecode,
+            case_uuid = case_uuid,
         )
 
         if env == "localhost":
@@ -398,6 +400,22 @@ def getLogger(self, name):
             pass
         return logger
 
+    def create_shared_access_key_for_case(self, case_uuid):
+        """Creates and stores a shared access key that can be used to access
+        the case identified by *case_uuid*, in the current Sumo environment.
+
+        This shared access key can then be used by instantiating
+        SumoClient with the parameter case_uuid set accordingly.
+
+        Args:
+            case_uuid: the uuid for a case.
+
+        Side effects:
+            Creates a new file in ~/.sumo, named {app_id}+{case_uuid}
+        """
+        token = self.get(f"/objects('{case_uuid}')/make-shared-access-key").text
+        self.auth.store_shared_access_key_for_case(case_uuid, token)
+
     @raise_for_status_async
     async def get_async(self, path: str, params: dict = None):
         """Performs an async GET-request to the Sumo API.