remotivelabs-cli 0.0.25__py3-none-any.whl → 0.0.27__py3-none-any.whl

cli/cloud/brokers.py

@@ -1,49 +1,40 @@
+from __future__ import annotations
+
 import json
 import os
 import signal as os_signal
+from typing import Any, Union
 
+import requests
 import typer
 import websocket
-from rich.progress import Progress, SpinnerColumn, TextColumn
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
 
 @app.command("list", help="Lists brokers in project")
-def list(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_get(f"/api/project/{project}/brokers")
+def list(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:  # pylint: disable=W0622
+    Rest.handle_get(f"/api/project/{project}/brokers")
 
 
 @app.command("describe", help="Shows details about a specific broker")
-def describe(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_get(f"/api/project/{project}/brokers/{name}")
+def describe(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_get(f"/api/project/{project}/brokers/{name}")
 
 
 @app.command("delete", help="Stops and deletes a broker from project")
-def stop(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    with Progress(
-        SpinnerColumn(),
-        TextColumn("[progress.description]{task.description}"),
-        transient=True,
-    ) as progress:
-        progress.add_task(description=f"Deleting broker {name}...", total=None)
-        rest.handle_delete(f"/api/project/{project}/brokers/{name}")
+def stop(name: str, project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_delete(f"/api/project/{project}/brokers/{name}")
 
 
 @app.command(help="Deletes your personal broker from project")
-def delete_personal(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    with Progress(
-        SpinnerColumn(),
-        TextColumn("[progress.description]{task.description}"),
-        transient=True,
-    ) as progress:
-        progress.add_task(description="Deleting personal broker...", total=None)
-        rest.handle_delete(f"/api/project/{project}/brokers/personal")
+def delete_personal(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_delete(f"/api/project/{project}/brokers/personal")
 
 
-def do_start(name: str, project: str, api_key: str, tag: str, return_response: bool = False):
+def do_start(name: str, project: str, api_key: str, tag: str, return_response: bool = False) -> Union[requests.Response, None]:
     if tag == "":
         tag_to_use = None
     else:
@@ -53,7 +44,7 @@ def do_start(name: str, project: str, api_key: str, tag: str, return_response: b
         body = {"size": "S", "tag": tag_to_use}
     else:
         body = {"size": "S", "apiKey": api_key, "tag": tag_to_use}
-    return rest.handle_post(
+    return Rest.handle_post(
         f"/api/project/{project}/brokers/{name}",
         body=json.dumps(body),
         return_response=return_response,
@@ -68,7 +59,7 @@ def start(
     tag: str = typer.Option("", help="Optional specific tag/version"),
     silent: bool = typer.Option(False, help="Optional specific tag/version"),
     api_key: str = typer.Option("", help="Start with your own api-key"),
-):
+) -> None:
     # with Progress(
     #        SpinnerColumn(),
     #        TextColumn("[progress.description]{task.description}"),
@@ -84,7 +75,7 @@ def logs(
     tail: bool = typer.Option(False, help="Tail the broker log"),
     history_minutes: str = typer.Option(10, help="History in minutes minutes to fetch"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Exposes broker logs history or real-time tail of the broker.
 
@@ -92,30 +83,30 @@ def logs(
 
     """
 
-    def exit_on_ctrlc(sig, frame):
+    def exit_on_ctrlc(__sig: Any, __frame: Any) -> None:
         wsapp.close()
         os._exit(0)
 
     os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
 
-    def on_message(wsapp, message):
+    def on_message(__wsapp: Any, message: str) -> None:
         print(message)
 
-    def on_error(wsapp, err):
+    def on_error(wsapp: Any, err: str) -> None:  # pylint: disable=W0613
         print("EXAMPLE error encountered: ", err)
 
-    rest.ensure_auth_token()
+    Rest.ensure_auth_token()
     # This will work with both http -> ws and https -> wss
-    ws_url = rest.base_url.replace("http", "ws")
+    ws_url = Rest.get_base_url().replace("http", "ws")
 
     if tail:
         q = "?tail=yes"
-    elif history_minutes != 10:
+    elif history_minutes != "10":
         q = f"?history={history_minutes}"
     else:
         q = ""
 
     wsapp = websocket.WebSocketApp(
-        f"{ws_url}/api/project/{project}/brokers/{broker_name}/logs{q}", header=rest.headers, on_message=on_message, on_error=on_error
+        f"{ws_url}/api/project/{project}/brokers/{broker_name}/logs{q}", header=Rest.get_headers(), on_message=on_message, on_error=on_error
     )
     wsapp.run_forever()

cli/cloud/cloud_cli.py

@@ -1,9 +1,8 @@
-import json
-
 import typer
 
-from . import auth, brokers, configs, filestorage, projects, recordings, sample_recordings, service_accounts
-from . import rest_helper as rest
+from cli.cloud.rest_helper import RestHelper
+
+from . import auth, brokers, configs, filestorage, organisations, projects, recordings, sample_recordings, service_accounts
 
 app = typer.Typer()
 
@@ -11,22 +10,12 @@ app = typer.Typer()
 @app.command(help="List licenses for an organisation")
 def licenses(
     organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION"),
-    filter: str = typer.Option("all", help="all, valid, expired"),
-):
-    rest.handle_get(f"/api/bu/{organisation}/licenses", {"filter": filter})
-
-
-@app.command(help="List your available organisations")
-def organisations():
-    r = rest.handle_get("/api/home", return_response=True)
-    if r.status_code == 200:
-        j = list(map(lambda x: x["billableUnitUser"]["billableUnit"]["uid"], r.json()))
-        print(json.dumps(j))
-    else:
-        print(f"Got status code: {r.status_code}")
-        print(r.text)
+    filter_option: str = typer.Option("all", help="all, valid, expired"),
+) -> None:
+    RestHelper.handle_get(f"/api/bu/{organisation}/licenses", {"filter": filter_option})
 
 
+app.add_typer(organisations.app, name="organisations", help="Manage organisations")
 app.add_typer(projects.app, name="projects", help="Manage projects")
 app.add_typer(auth.app, name="auth")
 app.add_typer(brokers.app, name="brokers", help="Manage cloud broker lifecycle")

cli/cloud/configs.py

@@ -7,22 +7,28 @@ import requests
 import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
 
 @app.command("list")
-def list_signal_databases(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_get(f"/api/project/{project}/files/config")
+def list_signal_databases(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    """
+    List available signal databases in project
+    """
+    Rest.handle_get(f"/api/project/{project}/files/config")
 
 
 @app.command("delete")
 def delete(
     signal_db_file: str = typer.Argument("", help="Signal database file"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
-    rest.handle_delete(f"/api/project/{project}/files/config/{signal_db_file}")
+) -> None:
+    """
+    Deletes the specified signal database
+    """
+    Rest.handle_delete(f"/api/project/{project}/files/config/{signal_db_file}")
 
 
 @app.command()
@@ -38,35 +44,45 @@ def upload(
         help="Path to signal database file to upload",
     ),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Uploads signal database to project
     """
-    rest.upload_file(path=path, url=f"/api/project/{project}/files/config/{os.path.basename(path)}/uploadfile")
+    res = Rest.handle_put(url=f"/api/project/{project}/files/config/{os.path.basename(path)}/uploadfile", return_response=True)
+    if res is not None:
+        Rest.upload_file_with_signed_url(
+            path=path, url=res.text, upload_headers={"Content-Type": "application/octet-stream"}, progress_label=f"Uploading {path}..."
+        )
 
 
 @app.command()
 def download(
     signal_db_file: str = typer.Argument("", help="Signal database file"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
+    """
+    Downloads the specified signal database to disk
+    """
     with Progress(
         SpinnerColumn(),
         TextColumn("[progress.description]{task.description}"),
         transient=True,
     ) as progress:
-        rest.ensure_auth_token()
+        Rest.ensure_auth_token()
 
         progress.add_task(description=f"Downloading {signal_db_file}", total=None)
 
         # First request the download url from cloud. This is a public signed url that is valid
         # for a short period of time
         get_signed_url_resp = requests.get(
-            f"{rest.base_url}/api/project/{project}/files/config/{signal_db_file}/download", headers=rest.headers, allow_redirects=True
+            f"{Rest.get_base_url()}/api/project/{project}/files/config/{signal_db_file}/download",
+            headers=Rest.get_headers(),
+            allow_redirects=True,
+            timeout=60,
         )
         if get_signed_url_resp.status_code == 200:
             # Next download the actual file
-            download_resp = requests.get(url=get_signed_url_resp.text, stream=True)
+            download_resp = requests.get(url=get_signed_url_resp.text, stream=True, timeout=60)
             if download_resp.status_code == 200:
                 with open(signal_db_file, "wb") as out_file:
                     shutil.copyfileobj(download_resp.raw, out_file)
@@ -86,4 +102,5 @@ def download(
 # print(r.status_code)
 # print(r.text)
 
+# pylint: disable=C0301
 # curl -X PUT -H 'Content-Type: application/octet-stream' --upload-file docker-compose.yml 'https://storage.googleapis.com/beamylabs-fileuploads-dev/projects/beamyhack/recording/myrecording?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=recordings-upload-account%40beamycloud-dev.iam.gserviceaccount.com%2F20220729%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20220729T134012Z&X-Goog-Expires=3000&X-Goog-SignedHeaders=content-type%3Bhost&X-Goog-Signature=d1fa7639349d6453aebfce8814d6e5685af03952d07aa4e3cb0d44dba7cf5e572f684c8120dba17cbc7ea6a0ef5450542a3c745c65e04272b34265d0ddcf1b67e6f2b5bfa446264a62d77bd7faabf45ad6bd2aec5225f57004b0a31cfe0480cba063a3807d86346b1da99ecbae3f3e6da8f44f06396dfc1fdc6f89e475abdf969142cef6f369f03aff41000c8abb28aa82185246746fd6c16b6b381baa2d586382a3d3067b6376ddba2b55b2b6f9d942913a1cbfbc61491ba6a615d7d5a0d9a476c357431143e9cea1411dfad9f01b1e1176dc8c056cbf08cccfd401a55d63c19d038f3ab42b712abc48d759047ac07862c4fae937c341e19b568bb60a4e4086'

cli/cloud/filestorage.py

@@ -1,11 +1,12 @@
 import os.path
+import sys
 from pathlib import Path
 
 import typer
 
 from ..errors import ErrorPrinter
-from . import rest_helper as rest
 from . import resumable_upload as upload
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer(
     rich_markup_mode="rich",
@@ -22,7 +23,7 @@ Copy file from local to remote storage and vice versa, list and delete files.
 def list_files(
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
     prefix: str = typer.Argument(default="rcs://", help="Remote storage path"),
-):
+) -> None:
     """
     Listing remote files
 
@@ -40,9 +41,9 @@ def list_files(
         prefix = __check_rcs_path(prefix)
     else:
         ErrorPrinter.print_hint("Path must start with rcs://")
-        exit(1)
+        sys.exit(1)
 
-    rest.handle_get(
+    Rest.handle_get(
         f"/api/project/{project}/files/storage{prefix}",
     )
 
@@ -51,7 +52,7 @@ def list_files(
 def delete_file(
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
     path: str = typer.Argument(default=..., help="Remote storage path to file to delete"),
-):
+) -> None:
     """
     [red]Deletes[/red] a file from remote storage, this cannot be undone :fire:
 
@@ -61,19 +62,19 @@ def delete_file(
         prefix = __check_rcs_path(path)
     else:
         ErrorPrinter.print_hint("Path must start with rcs://")
-        exit(1)
+        sys.exit(1)
 
-    rest.handle_delete(
+    Rest.handle_delete(
         f"/api/project/{project}/files/storage{prefix}",
     )
 
 
 @app.command(name="cp")
-def copy_file(
+def copy_file(  # noqa: C901 # type: ignore[too-many-branches]  # pylint: disable=no-member
     source: str = typer.Argument(default=..., help="Remote or local path to source file"),
     dest: str = typer.Argument(default=..., help="Remote or local path to destination file"),
     project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT"),
-):
+) -> None:
     """
     Copies a file to or from remote storage
 
@@ -86,58 +87,69 @@ def copy_file(
 
     if not source.startswith("rcs://") and not dest.startswith("rcs://"):
         ErrorPrinter.print_hint("Source or destination path must be an rcs:// path")
-        exit(2)
+        sys.exit(2)
 
     if source.startswith("rcs://") and dest.startswith("rcs://"):
         ErrorPrinter.print_hint("Currently one of source and destination path must be a local path")
-        exit(2)
+        sys.exit(2)
 
     if source.startswith("rcs://"):
-        rcs_path = __check_rcs_path(source)
-        filename = source.rsplit("/", 1)[-1]
-        path = Path(dest)
-        if path.is_dir():
-            if not path.exists():
-                ErrorPrinter.print_generic_error("Destination directory does not exist")
-                exit(1)
-            else:
-                dest = os.path.join(path.absolute(), filename)
-
+        __copy_to_local(source=source, dest=dest, project=project)
+    else:
+        __copy_to_remote(source=source, dest=dest, project=project)
+
+
+def __copy_to_remote(source: str, dest: str, project: str) -> None:
+    path = Path(source)
+    if not path.exists():
+        ErrorPrinter.print_hint("Source file does not exist")
+        sys.exit(1)
+    filename = source.rsplit("/", 1)[-1]
+    rcs_path = __check_rcs_path(dest)
+    if rcs_path.endswith("/"):
+        rcs_path = rcs_path + filename
+    res = Rest.handle_post(f"/api/project/{project}/files/storage{rcs_path}", return_response=True)
+    if res is None:
+        return
+    json = res.json()
+    url = json["url"]
+    content_type = json["contentType"]
+    try:
+        upload.upload_signed_url(url, source, content_type)
+    except IsADirectoryError:
+        ErrorPrinter.print_hint(f"Supplied source file '{source}' is a directory but must be a file")
+
+
+def __copy_to_local(source: str, dest: str, project: str) -> None:
+    rcs_path = __check_rcs_path(source)
+    filename = source.rsplit("/", 1)[-1]
+    path = Path(dest)
+    if path.is_dir():
+        if not path.exists():
+            ErrorPrinter.print_generic_error("Destination directory does not exist")
+            sys.exit(1)
         else:
-            if not path.parent.is_dir() or not path.parent.exists():
-                ErrorPrinter.print_generic_error("Destination directory does not exist")
-                exit(1)
-        dest = Path(dest).absolute()
+            dest = os.path.join(path.absolute(), filename)
+
+    else:
+        if not path.parent.is_dir() or not path.parent.exists():
+            ErrorPrinter.print_generic_error("Destination directory does not exist")
+            sys.exit(1)
+    dest = str(Path(dest).absolute())
+
+    res = Rest.handle_get(
+        f"/api/project/{project}/files/storage{rcs_path}?download=true",
+        return_response=True,
+    )
+    if res is None:
+        return
 
-        res = rest.handle_get(
-            f"/api/project/{project}/files/storage{rcs_path}?download=true",
-            return_response=True,
-        )
+    Rest.download_file(save_file_name=dest, url=res.text)
 
-        rest.download_file(save_file_name=dest, url=res.text)
 
-    else:
-        path = Path(source)
-        if not path.exists():
-            ErrorPrinter.print_hint("Source file does not exist")
-            exit(1)
-        filename = source.rsplit("/", 1)[-1]
-        rcs_path = __check_rcs_path(dest)
-        if rcs_path.endswith("/"):
-            rcs_path = rcs_path + filename
-        res = rest.handle_post(f"/api/project/{project}/files/storage{rcs_path}", return_response=True)
-        json = res.json()
-        url = json["url"]
-        content_type = json["contentType"]
-        try:
-            upload.upload_signed_url(url, source, content_type)
-        except IsADirectoryError:
-            ErrorPrinter.print_hint(f"Supplied source file '{source}' is a directory but must be a file")
-
-
-def __check_rcs_path(path: str):
+def __check_rcs_path(path: str) -> str:
     rcs_path = path.replace("rcs://", "/")
     if rcs_path.startswith("/."):
         ErrorPrinter.print_hint("Invalid path")
-        exit(1)
+        sys.exit(1)
     return rcs_path

cli/cloud/organisations.py

@@ -0,0 +1,30 @@
+import json
+import sys
+
+import typer
+
+from cli.cloud.rest_helper import RestHelper
+
+app = typer.Typer()
+
+
+@app.command(name="list", help="List your available organisations")
+def list_orgs() -> None:
+    r = RestHelper.handle_get("/api/home", return_response=True)
+    if r is None:
+        return
+    if r.status_code == 200:
+        j = list(
+            map(
+                lambda x: {
+                    "uid": x["billableUnitUser"]["billableUnit"]["uid"],
+                    "displayName": x["billableUnitUser"]["billableUnit"]["displayName"],
+                },
+                r.json(),
+            )
+        )
+        print(json.dumps(j))
+    else:
+        print(f"Got status code: {r.status_code}")
+        print(r.text)
+        sys.exit(1)

cli/cloud/projects.py

@@ -2,14 +2,17 @@ import json
 
 import typer
 
-from . import rest_helper as rest
+from .rest_helper import RestHelper as Rest
 
 app = typer.Typer()
 
 
 @app.command(name="list", help="List your projects")
-def list_projects(organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION")):
-    r = rest.handle_get(url=f"/api/bu/{organisation}/me", return_response=True)
+def list_projects(organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION")) -> None:
+    r = Rest.handle_get(url=f"/api/bu/{organisation}/me", return_response=True)
+    if r is None:
+        return
+
     if r.status_code == 200:
         # extract the project uid parts
         projects = r.json()["projects"]
@@ -22,19 +25,19 @@ def list_projects(organisation: str = typer.Option(..., help="Organisation ID",
 
 @app.command(name="create")
 def create_project(
+    project_uid: str = typer.Argument(help="Project UID"),
     organisation: str = typer.Option(..., help="Organisation ID", envvar="REMOTIVE_CLOUD_ORGANISATION"),
-    project_uid: str = typer.Option(..., help="Project UID"),
     project_display_name: str = typer.Option(default="", help="Project display name"),
-):
+) -> None:
     create_project_req = {
         "uid": project_uid,
         "displayName": project_display_name if project_display_name != "" else project_uid,
         "description": "",
     }
 
-    rest.handle_post(url=f"/api/bu/{organisation}/project", body=json.dumps(create_project_req))
+    Rest.handle_post(url=f"/api/bu/{organisation}/project", body=json.dumps(create_project_req))
 
 
 @app.command(name="delete")
-def delete(project: str = typer.Option(..., help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")):
-    rest.handle_delete(url=f"/api/project/{project}")
+def delete(project: str = typer.Argument(help="Project ID", envvar="REMOTIVE_CLOUD_PROJECT")) -> None:
+    Rest.handle_delete(url=f"/api/project/{project}")