Add method for GET /api/cloud_user (#19)

Adds a method for an API that allows clients to get information on the currently logged-in cloud user. The server returns a 404 when a user is not logged in, but this method returns None in this case instead.

Co-authored-by: ignormies <bryce.beagle@aotu.ai>

Author: velovix

brainframe/api/bf_errors.py

@@ -308,6 +308,11 @@ class UnauthorizedTokensError(BaseAPIError):
     """The provided tokens do not correctly authorize a BrainFrame Cloud user"""
 
 
+@_server_origin_error()
+class CloudUserNotFoundError(BaseAPIError):
+    """No cloud user is logged in"""
+
+
 class ServerNotReadyError(BaseAPIError):
     """The client was able to communicate with the server, but the server had
     not completed startup or was in an invalid state"""

brainframe/api/stub.py

@@ -22,7 +22,8 @@ class BrainFrameAPI(stubs.AlertStubMixin,
                     stubs.PremisesStubMixin,
                     stubs.UserStubMixin,
                     stubs.LicenseStubMixIn,
-                    stubs.CloudTokensStubMixin):
+                    stubs.CloudTokensStubMixin,
+                    stubs.CloudUsersStubMixIn):
     """Provides access to BrainFrame API endpoints."""
 
     def __init__(self, server_url=None, credentials: Tuple[str, str] = None):

brainframe/api/stubs/__init__.py

@@ -13,4 +13,5 @@
 from .users import UserStubMixin
 from .licenses import LicenseStubMixIn
 from .cloud_tokens import CloudTokensStubMixin
+from .cloud_users import CloudUsersStubMixIn
 from .base_stub import BaseStub

brainframe/api/stubs/cloud_users.py

@@ -0,0 +1,23 @@
+from typing import Optional
+
+from brainframe.api.bf_codecs import CloudUserInfo
+from brainframe.api.bf_errors import CloudUserNotFoundError
+
+from .base_stub import BaseStub, DEFAULT_TIMEOUT
+
+
+class CloudUsersStubMixIn(BaseStub):
+    def get_current_cloud_user(self, timeout=DEFAULT_TIMEOUT) \
+            -> Optional[CloudUserInfo]:
+        """Gets information on the cloud user that's currently logged in.
+
+        :param timeout: The timeout to use for this request
+        :return: Information on the cloud user, or None if no user is logged in
+        """
+        req = f"/api/cloud_user"
+        try:
+            data, _ = self._get_json(req, timeout=timeout)
+        except CloudUserNotFoundError:
+            return None
+        else:
+            return CloudUserInfo.from_dict(data)