Merge pull request #1 from bugout-dev/skeleton

Skeleton of API

Author: kompotkot

.gitignore

@@ -127,3 +127,13 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Pycharm
+.idea
+
+# VS Code
+.vscode/
+
+# Custom
+.secrets/
+.bugout/

README.md

@@ -1,2 +1,14 @@
 # bugout-python
-Python client library for Bugout
+Python client library for Bugout API
+
+```python
+from bugout.app import Bugout
+
+def main():
+    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

@@ -0,0 +1,17 @@
+"""
+Bugout Python API
+"""
+__author__ = "Bugout"
+__maintainer__ = __author__
+
+__email__ = "engineering@bugout.dev"
+__license__ = "MIT"
+__version__ = "0.0.1"
+
+__all__ = (
+    "__author__",
+    "__email__",
+    "__license__",
+    "__maintainer__",
+    "__version__",
+)

bugout/__main__.py

@@ -0,0 +1,65 @@
+import argparse
+import logging
+import textwrap
+
+from .app import Bugout
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+def user_get_handler(args: argparse.Namespace) -> None:
+    """
+    Handler for "users get" subcommand.
+    """
+    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:
+    bugout_description = textwrap.dedent(
+        """\
+        Bugout API: Tools for helping with Bugout API.
+        """
+    )
+    parser = argparse.ArgumentParser(prog="bugout", description=bugout_description)
+    parser.set_defaults(func=lambda _: parser.print_help())
+    subcommands = parser.add_subparsers(description="Journal commands")
+
+    parser.add_argument(
+        "--brood_url",
+        default="http://localhost",
+        help="Brood url",
+    )
+    parser.add_argument(
+        "--spire_url",
+        default="http://localhost",
+        help="Spire url",
+    )
+
+    # Users handlers
+    parser_users = subcommands.add_parser(
+        "user", description="Work with Bugout users API handlers"
+    )
+    parser_users.set_defaults(
+        func=lambda _: parser_users.print_help(), subparser="users"
+    )
+    subcommands_users = parser_users.add_subparsers(description="Users commands")
+
+    parser_user_get = subcommands_users.add_parser("get", description="Get user")
+    parser_user_get.set_defaults(subcommand="get")
+    parser_user_get.add_argument(
+        "-t",
+        "--token",
+        required=True,
+        help="User token",
+    )
+    parser_user_get.set_defaults(func=user_get_handler)
+
+    args = parser.parse_args()
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main()

bugout/app.py

@@ -0,0 +1,70 @@
+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, brood_api_url: Optional[str] = None, spire_api_url: Optional[str] = None
+    ) -> 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
+
+    @property
+    def spire_url(self):
+        return self.spire_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)
+
+    # User handlers
+    def get_user(self, token: str) -> data.BugoutUser:
+        return self.user.get_user(token)
+
+    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
+        )
+
+    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:
+        return self.user.revoke_token(token)
+
+    def update_token(
+        self,
+        token: str,
+        token_type: Optional[str] = None,
+        token_note: Optional[str] = None,
+    ) -> data.BugoutToken:
+        return self.user.update_token(token, token_type, token_note)
+
+    # Group handlers
+    def get_group(self, group_id: str, token: str) -> data.BugoutGroup:
+        return self.group.get_group(group_id, token)
+
+    # Journal handlers
+    def get_journal(self, journal_id: str, token: str) -> data.BugoutJournal:
+        return self.journal.get_journal(journal_id, token)

bugout/calls.py

@@ -0,0 +1,37 @@
+import logging
+from typing import Any, Dict, List, Optional, Tuple
+
+import requests
+
+from .data import Method
+
+logger = logging.getLogger(__name__)
+
+
+class InvalidUrlSpec(ValueError):
+    """
+    Raised when an invalid url is specified.
+    """
+
+
+class BugoutUnexpectedResponse(Exception):
+    """
+    Raised when Bugout server response is unexpected (e.g. unparseable).
+    """
+
+
+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

@@ -0,0 +1,53 @@
+from datetime import datetime
+from enum import Enum, unique
+from typing import Any, Dict, List, Optional, Tuple
+import uuid
+
+from pydantic import BaseModel
+
+
+@unique
+class Method(Enum):
+    delete = "delete"
+    get = "get"
+    post = "post"
+    put = "put"
+
+
+@unique
+class TokenType(Enum):
+    bugout = "bugout"
+    slack = "slack"
+    github = "github"
+
+
+class BugoutUser(BaseModel):
+    id: uuid.UUID
+    username: str
+    email: str
+    normalized_email: str
+    verified: bool
+    autogenerated: bool
+    created_at: datetime
+    updated_at: datetime
+
+
+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
+
+
+class BugoutToken(BaseModel):
+    id: uuid.UUID
+    token_type: Optional[str]
+    token_note: Optional[str]

bugout/group.py

@@ -0,0 +1,41 @@
+import logging
+from typing import Any, Dict, List, Optional, Tuple
+
+from .calls import make_request, InvalidUrlSpec
+from .data import BugoutGroup, Method
+
+logger = logging.getLogger(__name__)
+
+
+class GroupNotFound(Exception):
+    """
+    Raised on actions that involve group which are not present in the database.
+    """
+
+
+class Group:
+    """
+    Represent a group from Bugout.
+    """
+
+    def __init__(self, url: Optional[str] = None) -> None:
+        if url is None:
+            raise InvalidUrlSpec("Invalid brood url specified")
+        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_group(self, group_id: str, token: str) -> BugoutGroup:
+        get_group_path = f"groups/{group_id}"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        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,44 @@
+import logging
+from typing import Any, Dict, List, Optional, Tuple
+
+from .calls import make_request, InvalidUrlSpec
+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: Optional[str] = None) -> None:
+        if url is None:
+            raise InvalidUrlSpec("Invalid spire url specified")
+        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"),
+        )