Merge pull request #31 from bugout-dev/resource-improvements

User create handler with application_id and same for resources list

Author: kompotkot

bugout/__init__.py

@@ -7,7 +7,7 @@
 
 __email__ = "engineering@bugout.dev"
 __license__ = "MIT"
-__version__ = "0.1.13"
+__version__ = "0.1.14"
 
 __all__ = (
     "__author__",

bugout/app.py

@@ -11,12 +11,6 @@
 from .settings import BUGOUT_BROOD_URL, BUGOUT_SPIRE_URL, REQUESTS_TIMEOUT
 
 
-class InvalidParameters(ValueError):
-    """
-    Raised when provided invalid parameters.
-    """
-
-
 class Bugout:
     def __init__(
         self,
@@ -52,12 +46,17 @@ def create_user(
         username: str,
         email: str,
         password: str,
+        application_id: Optional[Union[str, uuid.UUID]] = None,
         timeout: float = REQUESTS_TIMEOUT,
         **kwargs: Dict[str, Any],
     ) -> data.BugoutUser:
         self.user.timeout = timeout
         return self.user.create_user(
-            username=username, email=email, password=password, **kwargs
+            username=username,
+            email=email,
+            password=password,
+            application_id=application_id,
+            **kwargs,
         )
 
     def get_user(
@@ -136,10 +135,16 @@ def delete_user(
 
     # Token handlers
     def create_token(
-        self, username: str, password: str, timeout: float = REQUESTS_TIMEOUT
+        self,
+        username: str,
+        password: str,
+        application_id: Optional[Union[str, uuid.UUID]] = None,
+        timeout: float = REQUESTS_TIMEOUT,
     ) -> data.BugoutToken:
         self.user.timeout = timeout
-        return self.user.create_token(username=username, password=password)
+        return self.user.create_token(
+            username=username, password=password, application_id=application_id
+        )
 
     def create_token_restricted(
         self,

bugout/calls.py

@@ -3,18 +3,7 @@
 import requests
 
 from .data import Method
-
-
-class InvalidUrlSpec(ValueError):
-    """
-    Raised when an invalid url is specified.
-    """
-
-
-class BugoutUnexpectedResponse(Exception):
-    """
-    Raised when Bugout server response is unexpected (e.g. unparseable).
-    """
+from .exceptions import BugoutResponseException, BugoutUnexpectedResponse
 
 
 def make_request(method: Method, url: str, **kwargs) -> Any:
@@ -23,8 +12,17 @@ def make_request(method: Method, url: str, **kwargs) -> Any:
         r = requests.request(method.value, url=url, **kwargs)
         r.raise_for_status()
         response_body = r.json()
+    except requests.exceptions.RequestException as e:
+        exception_detail = r.json()
+        raise BugoutResponseException(
+            "An exception occurred at Bugout API side",
+            status_code=r.status_code,
+            detail=exception_detail["detail"]
+            if exception_detail["detail"] is not None
+            else None,
+        )
     except Exception as e:
-        raise BugoutUnexpectedResponse(f"Exception {str(e)}")
+        raise BugoutUnexpectedResponse(f"{str(e)}")
     return response_body
 
 

bugout/data.py

@@ -45,6 +45,7 @@ class BugoutUser(BaseModel):
     normalized_email: Optional[str]
     verified: Optional[bool]
     autogenerated: Optional[bool]
+    application_id: Optional[uuid.UUID]
     created_at: Optional[datetime]
     updated_at: Optional[datetime]
 

bugout/exceptions.py

@@ -0,0 +1,43 @@
+from typing import Any, Optional
+
+
+class InvalidUrlSpec(ValueError):
+    """
+    Raised when an invalid url is specified.
+    """
+
+
+class BugoutUnexpectedResponse(Exception):
+    """
+    Raised when Bugout server response is unexpected (e.g. unparseable).
+    """
+
+
+class BugoutResponseException(Exception):
+    """
+    Raised when Bugout server response with error.
+    """
+
+    def __init__(
+        self,
+        message,
+        status_code: int,
+        detail: Optional[Any] = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        if detail is not None:
+            self.detail = detail
+
+
+class TokenInvalidParameters(ValueError):
+    """
+    Raised when operations are applied to a token but invalid parameters are provided with which to
+    specify that token.
+    """
+
+
+class GroupInvalidParameters(ValueError):
+    """
+    Raised when operations are applied to a group but invalid parameters are provided.
+    """

bugout/group.py

@@ -1,7 +1,7 @@
 from typing import Any, Dict, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec
+from .calls import make_request
 from .data import (
     Method,
     Role,
@@ -12,15 +12,10 @@
     BugoutApplication,
     BugoutApplications,
 )
+from .exceptions import InvalidUrlSpec, GroupInvalidParameters
 from .settings import REQUESTS_TIMEOUT
 
 
-class GroupInvalidParameters(ValueError):
-    """
-    Raised when operations are applied to a group but invalid parameters are provided.
-    """
-
-
 class Group:
     """
     Represent a group from Bugout.

bugout/humbug.py

@@ -1,8 +1,9 @@
-from typing import Any, Dict, Optional, Union
+from typing import Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec
-from .data import Method, Role, BugoutHumbugIntegrationsList
+from .calls import make_request
+from .data import Method, BugoutHumbugIntegrationsList
+from .exceptions import InvalidUrlSpec
 from .settings import REQUESTS_TIMEOUT
 
 

bugout/journal.py

@@ -1,7 +1,7 @@
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, List, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec
+from .calls import make_request
 from .data import (
     BugoutJournal,
     BugoutJournals,
@@ -18,6 +18,7 @@
     Method,
     JournalTypes,
 )
+from .exceptions import InvalidUrlSpec
 from .settings import REQUESTS_TIMEOUT
 
 

bugout/resource.py

@@ -1,17 +1,12 @@
 from typing import Any, Dict, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec
+from .calls import make_request
 from .data import Method, BugoutResource, BugoutResources
+from .exceptions import InvalidUrlSpec
 from .settings import REQUESTS_TIMEOUT
 
 
-class ResourceInvalidParameters(ValueError):
-    """
-    Raised when operations are applied to a resource but invalid parameters are provided.
-    """
-
-
 class Resource:
     """
     Represent a resources from Bugout.

bugout/user.py

@@ -1,18 +1,12 @@
 from typing import Any, Dict, List, Optional, Union
 import uuid
 
-from .calls import make_request, InvalidUrlSpec
+from .calls import make_request
 from .data import Method, TokenType, BugoutUser, BugoutToken, BugoutUserTokens
+from .exceptions import InvalidUrlSpec, TokenInvalidParameters
 from .settings import REQUESTS_TIMEOUT
 
 
-class TokenInvalidParameters(ValueError):
-    """
-    Raised when operations are applied to a token but invalid parameters are provided with which to
-    specify that token.
-    """
-
-
 class User:
     """
     Represent a user from Bugout.
@@ -37,13 +31,15 @@ def create_user(
         username: str,
         email: str,
         password: str,
+        application_id: Optional[Union[str, uuid.UUID]] = None,
         **kwargs: Dict[str, Any],
     ) -> BugoutUser:
         create_user_path = "user"
         data = {
             "username": username,
             "email": email,
             "password": password,
+            "application_id": application_id,
         }
         headers = {}
         if "headers" in kwargs.keys():
@@ -160,11 +156,17 @@ def delete_user(
         return BugoutUser(**result)
 
     # Token module
-    def create_token(self, username: str, password: str) -> BugoutToken:
+    def create_token(
+        self,
+        username: str,
+        password: str,
+        application_id: Optional[Union[str, uuid.UUID]] = None,
+    ) -> BugoutToken:
         create_token_path = "token"
         data = {
             "username": username,
             "password": password,
+            "application_id": application_id,
         }
         result = self._call(method=Method.post, path=create_token_path, data=data)
         return BugoutToken(**result)