Updated structure in easiest way

Author: kompotkot

README.md

@@ -1,20 +1,14 @@
 # bugout-python
-Python client library for Bugout
+Python client library for Bugout API
 
 ```python
-from bugout.user import User
-from bugout.group import Group
 from bugout.app import Bugout
 
-bugout = Bugout(url="http://localhost", port="433")
-bugout_user = User(bugout)
-bugout_group = Group(bugout)
-
 def main():
-    print(bugout_user.get_user(token="<user token>"))
-    print(bugout_group.get_group(group_id="<group id>",token="<user token>"))
+    bugout = Bugout(brood_api_url="http://localhost:9001", spire_api_url="http://localhost:9002")
+    user = bugout.get_user("<user token id>")
+    group = bugout.get_group("<group id>", "<user token id>")
 
 if __name__ == "__main__":
     main()
-
-```
+```

bugout/__init__.py

@@ -4,7 +4,7 @@
 __author__ = "Bugout"
 __maintainer__ = __author__
 
-__email__ = "neeraj@bugout.dev"
+__email__ = "engineering@bugout.dev"
 __license__ = "MIT"
 __version__ = "0.0.1"
 

bugout/__main__.py

@@ -3,7 +3,6 @@
 import textwrap
 
 from .app import Bugout
-from .user import User
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
@@ -13,29 +12,9 @@ def user_get_handler(args: argparse.Namespace) -> None:
     """
     Handler for "users get" subcommand.
     """
-    bugout = Bugout(url=args.url, port=args.port)
-    user_obj = User(bugout)
-
-    result = user_obj.get_user(token=args.token)
-
-    print(result)
-
-
-def user_create_handler(args: argparse.Namespace) -> None:
-    """
-    Handler for "users create" subcommand.
-    """
-    bugout = Bugout(url=args.url, port=args.port)
-    user_obj = User(bugout)
-
-    result = user_obj.create_user(
-        username=args.username,
-        email=args.email,
-        password=args.password,
-        autogenerated_token=args.autogenerated_token,
-    )
-
-    print(result)
+    bugout = Bugout(brood_api_url=args.brood_url, spire_api_url=args.spire_url)
+    result = bugout.get_user(token=args.token)
+    print(result.json())
 
 
 def main() -> None:
@@ -49,19 +28,19 @@ def main() -> None:
     subcommands = parser.add_subparsers(description="Journal commands")
 
     parser.add_argument(
-        "--url",
-        default="localhost",
-        help="Dest url",
+        "--brood_url",
+        default="http://localhost:7474",
+        help="Brood url",
     )
     parser.add_argument(
-        "--port",
-        default="443",
-        help="Dest port",
+        "--spire_url",
+        default="http://localhost:7475",
+        help="Spire url",
     )
 
-    # Users handler
+    # Users handlers
     parser_users = subcommands.add_parser(
-        "users", description="Work with Bugout users API handlers"
+        "user", description="Work with Bugout users API handlers"
     )
     parser_users.set_defaults(
         func=lambda _: parser_users.print_help(), subparser="users"
@@ -78,35 +57,6 @@ def main() -> None:
     )
     parser_user_get.set_defaults(func=user_get_handler)
 
-    parser_user_create = subcommands_users.add_parser(
-        "create", description="Create user"
-    )
-    parser_user_create.set_defaults(subcommand="create")
-    parser_user_create.add_argument(
-        "-u",
-        "--username",
-        required=True,
-        help="Username",
-    )
-    parser_user_create.add_argument(
-        "-e",
-        "--email",
-        required=True,
-        help="Email",
-    )
-    parser_user_create.add_argument(
-        "-p",
-        "--password",
-        required=True,
-        help="Password",
-    )
-    parser_user_create.add_argument(
-        "-a",
-        "--autogenerated_token",
-        help="Token",
-    )
-    parser_user_create.set_defaults(func=user_create_handler)
-
     args = parser.parse_args()
     args.func(args)
 

bugout/app.py

@@ -1,15 +1,46 @@
-from .data import Method
-from .calls import ApiCalls
+from typing import Any, Dict, List, Optional, Tuple
+
+from . import data
+from . import calls
+from .group import Group
+from .journal import Journal
+from .user import User
 
 
 class Bugout:
-    def __init__(self, url, port) -> None:
-        self.url = url
-        self.port = port
+    def __init__(self, brood_api_url: str, spire_api_url: str) -> None:
+        self.brood_api_url = brood_api_url
+        self.spire_api_url = spire_api_url
+        self.user = User(self.brood_api_url)
+        self.group = Group(self.brood_api_url)
+        self.journal = Journal(self.spire_api_url)
+
+    @property
+    def brood_url(self):
+        return self.brood_api_url
+
+    def brood_ping(self) -> Dict[str, str]:
+        return calls.ping(self.brood_api_url)
+
+    def spire_ping(self) -> Dict[str, str]:
+        return calls.ping(self.spire_api_url)
+
+    def get_user(self, token: str) -> data.BugoutUser:
+        return self.user.get_user(token)
 
-    def _call(self, method: Method, path: str, **kwargs):
-        url = f"{self.url.rstrip('/')}:{self.port}/{path.rstrip('/')}"
+    def create_user(
+        self,
+        username: str,
+        email: str,
+        password: str,
+        autogenerated_token: str = None,
+    ) -> data.BugoutUser:
+        return self.user.create_user(
+            username, email, password, autogenerated_token=autogenerated_token
+        )
 
-        result = ApiCalls.make_request(method=method, url=url, **kwargs)
+    def get_group(self, group_id: str, token: str) -> data.BugoutGroup:
+        return self.group.get_group(group_id, token)
 
-        return result
+    def get_journal(self, journal_id: str, token: str) -> data.BugoutJournal:
+        return self.journal.get_journal(journal_id, token)

bugout/calls.py

@@ -14,21 +14,18 @@ class BugoutUnexpectedResponse(Exception):
     """
 
 
-class ApiCalls:
-    """
-    Handle REST API requests.
-    """
-
-    @staticmethod
-    def make_request(method: Method, url: str, **kwargs) -> Optional[Dict[str, Any]]:
-        response_body = None
-
-        try:
-            r = requests.request(method.value, url=url, **kwargs)
-            r.raise_for_status()
-            response_body = r.json()
-        except Exception as e:
-            logger.error(f"Exception {str(e)}")
-            raise
-
-        return response_body
+def make_request(method: Method, url: str, **kwargs) -> Any:
+    response_body = None
+    try:
+        r = requests.request(method.value, url=url, **kwargs)
+        r.raise_for_status()
+        response_body = r.json()
+    except Exception as e:
+        logger.error(f"Exception {str(e)}")
+        raise
+    return response_body
+
+
+def ping(url: str) -> Dict[str, Any]:
+    url = f"{url.rstrip('/')}/ping"
+    return make_request(Method.get, url)

bugout/data.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from enum import Enum, unique
 from typing import Any, Dict, List, Optional, Tuple
 import uuid
@@ -12,13 +13,27 @@ class Method(Enum):
     delete = "delete"
 
 
-class BroodUser(BaseModel):
+class BugoutUser(BaseModel):
     id: uuid.UUID
-    username: Optional[str]
-    email: Optional[str]
-    token: Optional[uuid.UUID]
+    username: str
+    email: str
+    normalized_email: str
+    verified: bool
+    autogenerated: bool
+    created_at: datetime
+    updated_at: datetime
 
 
-class BroodGroup(BaseModel):
+class BugoutGroup(BaseModel):
     id: uuid.UUID
     group_name: Optional[str]
+    autogenerated: bool
+
+
+class BugoutJournal(BaseModel):
+    id: uuid.UUID
+    bugout_user_id: uuid.UUID
+    holder_ids: List[uuid.UUID]
+    name: str
+    created_at: datetime
+    updated_at: datetime

bugout/group.py

@@ -1,8 +1,8 @@
 import logging
 from typing import Any, Dict, List, Optional, Tuple
 
-from .app import Bugout
-from .data import Method
+from .calls import make_request
+from .data import BugoutGroup, Method
 
 logger = logging.getLogger(__name__)
 
@@ -13,20 +13,27 @@ class GroupNotFound(Exception):
     """
 
 
-class Group(Bugout):
+class Group:
     """
     Represent a group from Bugout.
     """
 
-    def __init__(self, bugout: Bugout) -> None:
-        super().__init__(bugout.url, bugout.port)
+    def __init__(self, url) -> None:
+        self.url = url
 
-    def get_group(self, group_id: str, token: str) -> Optional[Dict[str, Any]]:
-        get_group_path = f"groups/{group_id}"
+    def _call(self, method: Method, path: str, **kwargs):
+        url = f"{self.url.rstrip('/')}/{path.rstrip('/')}"
+        result = make_request(method=method, url=url, **kwargs)
+        return result
 
+    def get_group(self, group_id: str, token: str) -> BugoutGroup:
+        get_group_path = f"groups/{group_id}"
         headers = {
             "Authorization": f"Bearer {token}",
         }
-
-        result = super()._call(method=Method.get, path=get_group_path, headers=headers)
-        return result
+        result = self._call(method=Method.get, path=get_group_path, headers=headers)
+        return BugoutGroup(
+            id=result.get("id"),
+            name=result.get("name"),
+            autogenerated=result.get("autogenerated"),
+        )

bugout/journal.py

@@ -0,0 +1,42 @@
+import logging
+from typing import Any, Dict, List, Optional, Tuple
+
+from .calls import make_request
+from .data import BugoutJournal, Method
+
+logger = logging.getLogger(__name__)
+
+
+class JournalNotFound(Exception):
+    """
+    Raised on actions that involve journal which are not present in the database.
+    """
+
+
+class Journal:
+    """
+    Represent a journal from Bugout.
+    """
+
+    def __init__(self, url) -> None:
+        self.url = url
+
+    def _call(self, method: Method, path: str, **kwargs):
+        url = f"{self.url.rstrip('/')}/{path.rstrip('/')}"
+        result = make_request(method=method, url=url, **kwargs)
+        return result
+
+    def get_journal(self, journal_id: str, token: str) -> BugoutJournal:
+        get_group_path = f"journals/{journal_id}"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        result = self._call(method=Method.get, path=get_group_path, headers=headers)
+        return BugoutJournal(
+            id=result.get("id"),
+            bugout_user_id=result.get("bugout_user_id"),
+            holder_ids=result.get("holder_ids"),
+            name=result.get("name"),
+            created_at=result.get("created_at"),
+            updated_at=result.get("updated_at"),
+        )