Merge pull request #14 from bugout-dev/internal-improvements

Internal improvements

Author: zomglings

.github/workflows/lint.yml

@@ -11,7 +11,7 @@ jobs:
         with:
           python-version: "3.8"
       - name: Install test requirements
-        run: pip install -r requirements.dev.txt
+        run: pip install -e .[dev]
       - name: Mypy type check
         run: mypy bugout/
       - name: Black syntax check

.github/workflows/locust.yml

@@ -25,26 +25,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip setuptools
           pip install bugout-locust
-      - name: Generate Locust summary
-        run: |
-          COMMENTS_URL=$(python -c 'import json; import os; event = os.environ.get("GITHUB_EVENT_PATH"); raw = open(event); inp_json = json.load(raw); print(inp_json.get("pull_request").get("_links").get("comments").get("href")); raw.close();')
-          INITIAL_REF=$(locust.github initial)
-          TERMINAL_REF=$(locust.github terminal)
-          REPO_URL=$(locust.github repo)
-          locust --format json $INITIAL_REF $TERMINAL_REF --github $REPO_URL --metadata "{\"comments_url\": \"${COMMENTS_URL}\", \"terminal_hash\": \"$TERMINAL_REF\"}" | tee summary
-      - name: Cleaning summary
-        id: clean_summary
-        run: |
-          summary=$(cat summary)
-          summary="${summary//'%'/'%25'}"
-          summary="${summary//$'\n'/'%0A'}"
-          summary="${summary//$'\r'/'%0D'}"
-          echo "::set-output name=summary::$summary"
-      - name: Upload locust results to Bugout
+      - name: Generate and send Locust summary
         env:
           BUGOUT_SECRET: ${{ secrets.BUGOUT_SECRET }}
         run: |
-          curl -k -X POST "https://spire.bugout.dev/github/summary" \
-            -H "Content-Type: application/json" \
-            -H "Authorization: Bearer $BUGOUT_SECRET" \
-            --data '${{ steps.clean_summary.outputs.summary }}'
+          locust.github publish

bugout/__init__.py

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

bugout/app.py

@@ -6,7 +6,7 @@
 from .group import Group
 from .journal import Journal
 from .user import User
-from .settings import REQUESTS_TIMEOUT
+from .settings import BUGOUT_BROOD_URL, BUGOUT_SPIRE_URL, REQUESTS_TIMEOUT
 
 
 class InvalidParameters(ValueError):
@@ -17,7 +17,9 @@ class InvalidParameters(ValueError):
 
 class Bugout:
     def __init__(
-        self, brood_api_url: Optional[str] = None, spire_api_url: Optional[str] = None
+        self,
+        brood_api_url: str = BUGOUT_BROOD_URL,
+        spire_api_url: str = BUGOUT_SPIRE_URL,
     ) -> None:
         self.brood_api_url = brood_api_url
         self.spire_api_url = spire_api_url
@@ -35,13 +37,9 @@ 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 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 ping(self.spire_api_url)
 
     # User handlers
@@ -50,15 +48,12 @@ def create_user(
         username: str,
         email: str,
         password: str,
-        autogenerated_token: str = 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,
-            autogenerated_token=autogenerated_token,
+            username=username, email=email, password=password, **kwargs
         )
 
     def get_user(
@@ -80,13 +75,11 @@ def find_user(
         self,
         username: str,
         token: Union[str, uuid.UUID] = None,
-        installation_token: str = None,
         timeout: float = REQUESTS_TIMEOUT,
+        **kwargs: Dict[str, Any],
     ) -> data.BugoutUser:
         self.user.timeout = timeout
-        return self.user.find_user(
-            username=username, token=token, installation_token=installation_token
-        )
+        return self.user.find_user(username=username, token=token, **kwargs)
 
     def confirm_email(
         self,
@@ -533,7 +526,7 @@ def search(
         token: Union[str, uuid.UUID],
         journal_id: Union[str, uuid.UUID],
         timeout: float = REQUESTS_TIMEOUT,
-        **queries: Dict[str, Any]
+        **queries: Dict[str, Any],
     ) -> data.BugoutSearchResults:
         self.journal.timeout = timeout
         return self.journal.search(token=token, journal_id=journal_id, **queries)

bugout/settings.py

@@ -1,5 +1,8 @@
 import os
 
+BUGOUT_BROOD_URL = "https://auth.bugout.dev"
+BUGOUT_SPIRE_URL = "https://spire.bugout.dev"
+
 REQUESTS_TIMEOUT = 5
 REQUESTS_TIMEOUT_RAW = os.environ.get("BUGOUT_TIMEOUT_SECONDS")
 try:

bugout/user.py

@@ -37,19 +37,17 @@ def create_user(
         username: str,
         email: str,
         password: str,
-        autogenerated_token: Optional[str] = None,
+        **kwargs: Dict[str, Any],
     ) -> BugoutUser:
         create_user_path = "user"
         data = {
             "username": username,
             "email": email,
             "password": password,
         }
-        headers = None
-        if autogenerated_token is not None:
-            headers = {
-                "x-bugout-installation-token": autogenerated_token,
-            }
+        headers = {}
+        if "headers" in kwargs.keys():
+            headers.update(kwargs["headers"])
         result = self._call(
             method=Method.post, path=create_user_path, headers=headers, data=data
         )
@@ -79,14 +77,14 @@ def find_user(
         self,
         username: str,
         token: Union[str, uuid.UUID] = None,
-        installation_token: str = None,
+        **kwargs: Dict[str, Any],
     ) -> BugoutUser:
         find_user_path = f"user/find?username={username}"
         headers = {}
         if token is not None:
             headers.update({"Authorization": f"Bearer {token}"})
-        if installation_token is not None:
-            headers.update({"x-bugout-installation-token": installation_token})
+        if "headers" in kwargs.keys():
+            headers.update(kwargs["headers"])
         result = self._call(method=Method.get, path=find_user_path, headers=headers)
         return BugoutUser(**result)
 

requirements.dev.txt

@@ -13,16 +13,6 @@
 with open("README.md") as ifp:
     long_description = ifp.read()
 
-
-def load_requirements(fname: str) -> list:
-    requirements = []
-    with open(fname, "r") as fp:
-        for req in parse_requirements(fp.read()):
-            extras = "[{}]".format(",".join(req.extras)) if req.extras else ""
-            requirements.append("{}{}{}".format(req.name, extras, req.specifier))
-    return requirements
-
-
 setup(
     name=MODULE_NAME,
     version=module.__version__,
@@ -49,7 +39,7 @@ def load_requirements(fname: str) -> list:
     packages=find_packages(),
     package_data={"bugout": ["py.typed"]},
     zip_safe=False,
-    install_requires=load_requirements("requirements.txt"),
-    extras_require={"dev": load_requirements("requirements.dev.txt")},
+    install_requires=["pydantic", "requests"],
+    extras_require={"dev": ["black", "mypy"]},
     entry_points={"console_scripts": ["{0} = {0}.__main__:main".format(MODULE_NAME)]},
 )