Added and update all token handlers for user api

kompotkot · kompotkot · commit 492da4ea7e17 · 2020-12-25T15:14:46.000Z
diff --git a/.gitignore b/.gitignore
@@ -137,3 +137,4 @@ dmypy.json
 # Custom
 .secrets/
 .bugout/
+test/
diff --git a/bugout/app.py b/bugout/app.py
@@ -1,4 +1,5 @@
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple, Union
+import uuid
 
 from . import data
 from . import calls
@@ -7,6 +8,12 @@
 from .user import User
 
 
+class InvalidParameters(ValueError):
+    """
+    Raised when provided invalid parameters.
+    """
+
+
 class Bugout:
     def __init__(
         self, brood_api_url: Optional[str] = None, spire_api_url: Optional[str] = None
@@ -27,13 +34,17 @@ def spire_url(self):
         return self.spire_api_url
 
     def brood_ping(self) -> Dict[str, str]:
+        if self.brood_api_url is None:
+            raise InvalidParameters("Brood API url should be provided")
         return calls.ping(self.brood_api_url)
 
     def spire_ping(self) -> Dict[str, str]:
+        if self.spire_api_url is None:
+            raise InvalidParameters("Spire API url should be provided")
         return calls.ping(self.spire_api_url)
 
     # User handlers
-    def get_user(self, token: str) -> data.BugoutUser:
+    def get_user(self, token: uuid.UUID) -> data.BugoutUser:
         return self.user.get_user(token)
 
     def create_user(
@@ -47,24 +58,41 @@ def create_user(
             username, email, password, autogenerated_token=autogenerated_token
         )
 
+    # Token handlers
     def create_token(self, username: str, password: str) -> data.BugoutToken:
         return self.user.create_token(username, password)
 
-    def revoke_token(self, token: str) -> data.BugoutToken:
+    def revoke_token(self, token: uuid.UUID) -> data.BugoutToken:
         return self.user.revoke_token(token)
 
+    def revoke_token_by_id(self, token: uuid.UUID) -> data.BugoutToken:
+        return self.user.revoke_token_by_id(token)
+
     def update_token(
         self,
-        token: str,
-        token_type: Optional[str] = None,
+        token: uuid.UUID,
+        token_type: Optional[data.TokenType] = None,
         token_note: Optional[str] = None,
     ) -> data.BugoutToken:
         return self.user.update_token(token, token_type, token_note)
 
+    def get_token_types(self, token: uuid.UUID) -> List[str]:
+        return self.user.get_token_types(token)
+
+    def get_user_tokens(
+        self,
+        token: uuid.UUID,
+        active: Optional[bool] = None,
+        token_type: Optional[data.TokenType] = None,
+    ):
+        return self.user.get_user_tokens(token, active, token_type)
+
     # Group handlers
-    def get_group(self, group_id: str, token: str) -> data.BugoutGroup:
+    def get_group(self, group_id: uuid.UUID, token: uuid.UUID) -> data.BugoutGroup:
         return self.group.get_group(group_id, token)
 
     # Journal handlers
-    def get_journal(self, journal_id: str, token: str) -> data.BugoutJournal:
+    def get_journal(
+        self, journal_id: uuid.UUID, token: uuid.UUID
+    ) -> data.BugoutJournal:
         return self.journal.get_journal(journal_id, token)
diff --git a/bugout/data.py b/bugout/data.py
@@ -3,7 +3,7 @@
 from typing import Any, Dict, List, Optional, Tuple
 import uuid
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 @unique
@@ -22,7 +22,7 @@ class TokenType(Enum):
 
 
 class BugoutUser(BaseModel):
-    id: uuid.UUID
+    id: uuid.UUID = Field(alias="user_id")
     username: str
     email: str
     normalized_email: str
@@ -32,6 +32,22 @@ class BugoutUser(BaseModel):
     updated_at: datetime
 
 
+class BugoutToken(BaseModel):
+    id: uuid.UUID
+    user_id: uuid.UUID
+    active: bool
+    token_type: Optional[str]
+    note: Optional[str]
+    created_at: datetime
+    updated_at: datetime
+
+
+class BugoutUserTokens(BaseModel):
+    user_id: uuid.UUID
+    username: str
+    tokens: List[BugoutToken] = Field(alias="token")
+
+
 class BugoutGroup(BaseModel):
     id: uuid.UUID
     group_name: Optional[str]
@@ -45,9 +61,3 @@ class BugoutJournal(BaseModel):
     name: str
     created_at: datetime
     updated_at: datetime
-
-
-class BugoutToken(BaseModel):
-    id: uuid.UUID
-    token_type: Optional[str]
-    token_note: Optional[str]
diff --git a/bugout/group.py b/bugout/group.py
@@ -1,5 +1,6 @@
 import logging
 from typing import Any, Dict, List, Optional, Tuple
+import uuid
 
 from .calls import make_request, InvalidUrlSpec
 from .data import BugoutGroup, Method
@@ -28,7 +29,7 @@ def _call(self, method: Method, path: str, **kwargs):
         result = make_request(method=method, url=url, **kwargs)
         return result
 
-    def get_group(self, group_id: str, token: str) -> BugoutGroup:
+    def get_group(self, group_id: uuid.UUID, token: uuid.UUID) -> BugoutGroup:
         get_group_path = f"groups/{group_id}"
         headers = {
             "Authorization": f"Bearer {token}",
diff --git a/bugout/journal.py b/bugout/journal.py
@@ -1,5 +1,6 @@
 import logging
 from typing import Any, Dict, List, Optional, Tuple
+import uuid
 
 from .calls import make_request, InvalidUrlSpec
 from .data import BugoutJournal, Method
@@ -28,7 +29,7 @@ def _call(self, method: Method, path: str, **kwargs):
         result = make_request(method=method, url=url, **kwargs)
         return result
 
-    def get_journal(self, journal_id: str, token: str) -> BugoutJournal:
+    def get_journal(self, journal_id: uuid.UUID, token: uuid.UUID) -> BugoutJournal:
         get_group_path = f"journals/{journal_id}"
         headers = {
             "Authorization": f"Bearer {token}",
diff --git a/bugout/user.py b/bugout/user.py
@@ -1,8 +1,10 @@
+import json
 import logging
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple, Union
+import uuid
 
 from .calls import make_request, InvalidUrlSpec
-from .data import BugoutUser, BugoutToken, Method, TokenType
+from .data import Method, TokenType, BugoutUser, BugoutToken, BugoutUserTokens
 
 logger = logging.getLogger(__name__)
 
@@ -35,33 +37,14 @@ def _call(self, method: Method, path: str, **kwargs):
         result = make_request(method=method, url=url, **kwargs)
         return result
 
-    def _user_model_converter(self, user_object: Dict[str, Any]) -> BugoutUser:
-        return BugoutUser(
-            id=user_object.get("user_id"),
-            username=user_object.get("username"),
-            email=user_object.get("email"),
-            normalized_email=user_object.get("normalized_email"),
-            verified=user_object.get("verified"),
-            autogenerated=user_object.get("autogenerated"),
-            created_at=user_object.get("created_at"),
-            updated_at=user_object.get("updated_at"),
-        )
-
-    def get_user(self, token: str) -> Dict[str, Any]:
-        get_user_path = "user"
-        headers = {
-            "Authorization": f"Bearer {token}",
-        }
-        result = self._call(method=Method.get, path=get_user_path, headers=headers)
-        return self._user_model_converter(result)
-
+    # User module
     def create_user(
         self,
         username: str,
         email: str,
         password: str,
         autogenerated_token: Optional[str] = None,
-    ) -> Dict[str, Any]:
+    ) -> BugoutUser:
         create_user_path = "user"
         data = {
             "username": username,
@@ -76,50 +59,98 @@ def create_user(
         result = self._call(
             method=Method.post, path=create_user_path, headers=headers, data=data
         )
-        return self._user_model_converter(result)
+        return BugoutUser(**result)
 
+    def get_user(self, token: uuid.UUID) -> BugoutUser:
+        get_user_path = "user"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        result = self._call(method=Method.get, path=get_user_path, headers=headers)
+        return BugoutUser(**result)
+
+    # Token module
     def create_token(self, username: str, password: str) -> BugoutToken:
         create_token_path = "token"
         data = {
             "username": username,
             "password": password,
         }
         result = self._call(method=Method.post, path=create_token_path, data=data)
-        return BugoutToken(
-            id=result.get("access_token"),
-            token_type=result.get("token_type"),
-        )
+        return BugoutToken(**result)
 
-    def revoke_token(self, token: str) -> BugoutToken:
-        create_token_path = "token"
+    def revoke_token(self, token: uuid.UUID) -> BugoutToken:
+        revoke_token_path = "token"
         headers = {
             "Authorization": f"Bearer {token}",
         }
         result = self._call(
-            method=Method.delete, path=create_token_path, headers=headers
+            method=Method.delete, path=revoke_token_path, headers=headers
         )
-        return BugoutToken(id=result)
+        return result
+
+    def revoke_token_by_id(self, token: uuid.UUID) -> BugoutToken:
+        revoke_token_path = f"token/{token}"
+        result = self._call(method=Method.delete, path=revoke_token_path)
+        return result
 
     def update_token(
         self,
-        token: str,
-        token_type: Optional[str] = None,
+        token: uuid.UUID,
+        token_type: Optional[TokenType] = None,
         token_note: Optional[str] = None,
     ) -> BugoutToken:
-        create_token_path = "token"
+        update_token_path = "token"
 
-        data = {"access_token": token}
+        data: Dict[str, Any] = {"access_token": token}
         if token_type is None and token_note is None:
             raise TokenInvalidParameters(
                 "In order to update token, at least one of token_type, or token_note must be specified"
             )
-        if token_type not in TokenType.__members__:
-            raise TokenInvalidParameters("Incorrect token type provided")
+        if token_type is not None and token_type not in TokenType.__members__:
+            raise TokenInvalidParameters(
+                "Incorrect token type provided, check types at get_token_types()"
+            )
 
         if token_type is not None:
             data.update({"token_type": token_type})
         if token_note is not None:
             data.update({"token_note": token_note})
 
-        result = self._call(method=Method.put, path=create_token_path, data=data)
-        return BugoutToken(id=result, token_type=token_type, token_note=token_note)
+        result = self._call(method=Method.put, path=update_token_path, data=data)
+        return BugoutToken(**result)
+
+    def get_token_types(self, token: uuid.UUID) -> List[str]:
+        get_token_types_path = "token/types"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        result = self._call(
+            method=Method.get, path=get_token_types_path, headers=headers
+        )
+        return result
+
+    def get_user_tokens(
+        self,
+        token: uuid.UUID,
+        active: Optional[bool] = None,
+        token_type: Optional[TokenType] = None,
+    ):
+        get_user_tokens_path = "tokens"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        if token_type is not None and token_type not in TokenType.__members__:
+            raise TokenInvalidParameters(
+                "Incorrect token type provided, check types at get_token_types()"
+            )
+        if active is not None and token_type is None:
+            get_user_tokens_path += f"?active={active}"
+        elif active is None and token_type is not None:
+            get_user_tokens_path += f"?token_type={token_type}"
+        elif active is not None and token_type is not None:
+            get_user_tokens_path += f"?active={active}&token_type={token_type}"
+        result = self._call(
+            method=Method.get, path=get_user_tokens_path, headers=headers
+        )
+        return BugoutUserTokens(**result)
