remotivelabs-cli 0.3.3__tar.gz → 0.3.5__tar.gz

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: remotivelabs-cli
-Version: 0.3.3
+Version: 0.3.5
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/cli/broker/signals.py

@@ -198,7 +198,7 @@ def namespaces(
 
 @app.command()
 def frame_distribution(
-    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    url: str = typer.Option(DEFAULT_GRPC_URL, help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
     namespace: str = typer.Option(..., help="Namespace"),
 ) -> None:

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/cli/settings/core.py

@@ -22,6 +22,10 @@ CONFIG_DIR_PATH = Path.home() / ".config" / "remotive"
 CLI_CONFIG_FILE_NAME = "config.json"
 CLI_INTERNAL_STATE_FILE_NAME = "app-state.json"
 
+TOKEN_ENV = "REMOTIVE_CLOUD_AUTH_TOKEN"
+# Deprecated in favour of name used in topology-cli
+DEPR_TOKEN_ENV = "REMOTIVE_CLOUD_ACCESS_TOKEN"
+
 
 class InvalidSettingsFilePathError(Exception):
     """Raised when trying to access an invalid settings file or file path"""
@@ -91,8 +95,15 @@ class Settings:
 
     def get_active_token(self) -> str | None:
         """
-        Get the token secret for the current active account
+        Get the token secret for the current active account or token specified by env variable
         """
+
+        token = os.environ[DEPR_TOKEN_ENV] if DEPR_TOKEN_ENV in os.environ else None
+        if not token:
+            token = os.environ[TOKEN_ENV] if TOKEN_ENV in os.environ else None
+        if token:
+            return token
+
         token_file = self.get_active_token_file()
         return token_file.token if token_file else None
 

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/cli/topology/cmd.py

@@ -5,10 +5,12 @@ import typer
 from cli.topology.start_trial import (
     MissingOrganizationError,
     NoActiveAccountError,
+    NoOrganizationOrPermissionError,
     NotAuthorizedError,
     NotAuthorizedToStartTrialError,
     NotSignedInError,
     SubscriptionExpiredError,
+    get_organization_and_account,
     start_trial,
 )
 from cli.typer import typer_utils
@@ -30,12 +32,34 @@ def start_trial_cmd(  # noqa: C901
 
     You can read more at https://docs.remotivelabs.com/docs/remotive-topology.
     """
+
     try:
-        subscription = start_trial(organization)
-        if subscription.type == "trial":
-            print_generic_message(f"topology trial active, expires {subscription.end_date}")
-        elif subscription.type == "paid":
-            print_generic_message(f"you already have a topology subscription, expires {subscription.end_date or 'Never'}")
+        (valid_organization, _) = get_organization_and_account(organization_uid=organization)
+        ok_to_start_trial = typer.confirm(
+            f"You are about to start trial of RemotiveTopology for {valid_organization.display_name}"
+            f" (uid={valid_organization.uid}), continue?",
+            default=True,
+        )
+        if not ok_to_start_trial:
+            return
+
+        (subscription, created) = start_trial(organization)
+
+        def print_start_trial_result() -> None:
+            assert subscription.type in ("trial", "paid"), f"Unexpected subscription type: {subscription.type}"
+            kind = None
+            status = None
+            if subscription.type == "trial":
+                status = "started now" if created else "is already active"
+                kind = "trial subscription"
+            elif subscription.type == "paid":
+                status = "started now" if created else "is already started"
+                kind = "subscription"
+
+            end_text = subscription.end_date or "Never"
+            print_generic_message(f"RemotiveTopology {kind} for {valid_organization.display_name} {status}, expires {end_text}")
+
+        print_start_trial_result()
 
     except NotSignedInError:
         print_generic_error(
@@ -46,7 +70,7 @@ def start_trial_cmd(  # noqa: C901
 
     except NoActiveAccountError:
         print_hint(
-            "You have not actived your account, please run [bold]remotive cloud auth activate[/bold] to choose an account"
+            "You have not activated your account, please run [bold]remotive cloud auth activate[/bold] to choose an account"
             "or [bold]remotive cloud auth login[/bold] to sign-in"
         )
         raise typer.Exit(3)
@@ -63,15 +87,25 @@ def start_trial_cmd(  # noqa: C901
         raise typer.Exit(5)
 
     except NotAuthorizedToStartTrialError as e:
-        print_generic_error(f"You are not allowed to start-trial topology in organization {e.organization}")
+        print_generic_error(f"You are not allowed to start-trial topology in organization {e.organization.display_name}.")
         raise typer.Exit(6)
 
     except SubscriptionExpiredError as e:
         if e.subscription.type == "trial":
-            print_generic_error(f"Your Topology trial expired {e.subscription.end_date}, please contact support@remotivelabs.com")
+            print_generic_error(
+                f"RemotiveTopology trial in {e.organization.display_name} expired"
+                f" {e.subscription.end_date}, please contact support@remotivelabs.com"
+            )
             raise typer.Exit(7)
 
-        print_generic_error(f"Your Topology subscription has expired {e.subscription.end_date}, please contact support@remotivelabs.com")
+        print_generic_error(
+            f"RemotiveTopology subscription in {e.organization.display_name} has expired"
+            f" {e.subscription.end_date}, please contact support@remotivelabs.com"
+        )
+        raise typer.Exit(7)
+
+    except NoOrganizationOrPermissionError as e:
+        print_generic_error(f"Organization id {e.organization} does not exist or you do not have permission to access it.")
         raise typer.Exit(7)
 
     except Exception as e:

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/cli/topology/start_trial.py

@@ -26,6 +26,14 @@ class NotAuthorizedError(Exception):
         self.account = account
 
 
+class NoOrganizationOrPermissionError(Exception):
+    """Raised when the user is trying to access an organization that it does not have access to or it does not exist"""
+
+    def __init__(self, account: Account, organization_uid: str):
+        self.account = account
+        self.organization = organization_uid
+
+
 class MissingOrganizationError(Exception):
     """Raised when the user has not specified an organization and no default organization is set"""
 
@@ -33,7 +41,7 @@ class MissingOrganizationError(Exception):
 class NotAuthorizedToStartTrialError(Exception):
     """Raised when the user is not authorized to start a topology trial"""
 
-    def __init__(self, account: Account, organization: str):
+    def __init__(self, account: Account, organization: Organization):
         self.account = account
         self.organization = organization
 
@@ -41,8 +49,15 @@ class NotAuthorizedToStartTrialError(Exception):
 class SubscriptionExpiredError(Exception):
     """Raised when the subscription has expired"""
 
-    def __init__(self, subscription: Subscription):
+    def __init__(self, subscription: Subscription, organization: Organization):
         self.subscription = subscription
+        self.organization = organization
+
+
+@dataclass
+class Organization:
+    uid: str
+    display_name: str
 
 
 @dataclass
@@ -67,12 +82,7 @@ class Subscription:
         )
 
 
-def start_trial(organization: str | None = None) -> Subscription:
-    """
-    Start a 30 day trial subscription for running RemotiveTopology.
-
-    # TODO: move authentication (and basic authorization) to a logged_in decorator
-    """
+def get_organization_and_account(organization_uid: str | None = None) -> tuple[Organization, Account]:
     active_account = settings.get_active_account()
     active_token_file = settings.get_active_token_file()
 
@@ -84,22 +94,41 @@ def start_trial(organization: str | None = None) -> Subscription:
     if not RestHelper.has_access("/api/whoami"):
         raise NotAuthorizedError(account=active_account)
 
-    valid_org = organization or active_account.default_organization
-    if not valid_org:
+    org_uid = organization_uid or active_account.default_organization
+    if not org_uid:
         raise MissingOrganizationError()
 
-    res = RestHelper.handle_get(f"/api/bu/{valid_org}/features/topology", return_response=True, allow_status_codes=[403, 404])
+    response = RestHelper.handle_get(f"/api/bu/{organization_uid}", return_response=True, allow_status_codes=[403, 404])
+    if response.status_code in (403, 404):
+        raise NoOrganizationOrPermissionError(account=active_account, organization_uid=org_uid)
+
+    display_name = response.json()["displayName"]
+
+    return Organization(uid=org_uid, display_name=display_name), active_account
+
+
+def start_trial(organization_uid: str | None = None) -> tuple[Subscription, bool]:
+    """
+    Start a 30 day trial subscription for running RemotiveTopology,
+    If a trial is already started in this organization, returns the existing trial instead.
+    Returns (subscription, created_now).
+    """
+
+    (organization, active_account) = get_organization_and_account(organization_uid)
+
+    res = RestHelper.handle_get(f"/api/bu/{organization.uid}/features/topology", return_response=True, allow_status_codes=[403, 404])
     if res.status_code == 403:
-        raise NotAuthorizedToStartTrialError(account=active_account, organization=valid_org)
+        raise NotAuthorizedToStartTrialError(account=active_account, organization=organization)
+
+    created_now = False
     if res.status_code == 404:
-        created = RestHelper.handle_post(f"/api/bu/{valid_org}/features/topology", return_response=True)
+        created = RestHelper.handle_post(f"/api/bu/{organization.uid}/features/topology", return_response=True)
         subscription = Subscription.from_dict(created.json())
+        created_now = True
     else:
-        # 200 OK means we already have a valid subscription
         subscription = Subscription.from_dict(res.json())
 
-    # check subscription validity
     if subscription.end_date < datetime.datetime.now().date():
-        raise SubscriptionExpiredError(subscription=subscription)
+        raise SubscriptionExpiredError(subscription=subscription, organization=organization)
 
-    return subscription
+    return subscription, created_now

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/cli/utils/rest_helper.py

@@ -85,6 +85,7 @@ class RestHelper:
         TODO: remove setting org, as we already set the default organization as env in remotive.py?
         TODO: don't sys.exit, raise error instead
         """
+
         if "REMOTIVE_CLOUD_ORGANIZATION" not in os.environ:
             active_account = settings.get_active_account()
             if active_account:
@@ -94,7 +95,8 @@ class RestHelper:
 
         token = access_token
         if not token:
-            token = os.environ.get("REMOTIVE_CLOUD_ACCESS_TOKEN", settings.get_active_token())
+            token = settings.get_active_token()
+
             if not token:
                 if quiet:
                     return

{remotivelabs_cli-0.3.3 → remotivelabs_cli-0.3.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.3.3"
+version = "0.3.5"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"