workato-platform-cli 1.0.0rc5.dev5__py3-none-any.whl

workato_platform_cli/cli/utils/version_checker.py

@@ -0,0 +1,237 @@
+"""Version checking utilities for the Workato CLI."""
+
+import contextlib
+import json
+import os
+import ssl
+import threading
+import time
+import urllib.request
+
+from collections.abc import Callable
+from functools import wraps
+from pathlib import Path
+from typing import Any
+from urllib.parse import urlparse
+
+import asyncclick as click
+
+from workato_platform_cli.cli.utils.config import ConfigManager
+
+
+try:
+    from workato_platform_cli._version import __version__
+except ImportError:
+    # Fallback for development when not built with hatch
+    __version__ = "0.0.0+unknown"
+
+
+try:
+    from packaging import version
+
+    HAS_DEPENDENCIES = True
+except ImportError:
+    HAS_DEPENDENCIES = False
+
+
+PACKAGE_NAME = "workato-platform-cli"
+PYPI_API_URL = f"https://pypi.org/pypi/{PACKAGE_NAME}/json"
+CHECK_INTERVAL = 86400  # 24 hours in seconds
+REQUEST_TIMEOUT = 2  # seconds
+
+
+class VersionChecker:
+    """Handles version checking and update notifications."""
+
+    def __init__(self, config_manager: ConfigManager) -> None:
+        """Initialize version checker with config manager."""
+        self.config_manager = config_manager
+        self.cache_dir = Path.home() / ".cache" / "workato-platform-cli"
+        self.cache_file = self.cache_dir / "last_update_check"
+        self._ensure_cache_dir()
+
+    def _ensure_cache_dir(self) -> None:
+        """Ensure cache directory exists."""
+        self.cache_dir.mkdir(parents=True, exist_ok=True, mode=0o755)
+
+    def is_update_check_disabled(self) -> bool:
+        """Check if update checking is disabled."""
+        # Environment variable override
+        return os.getenv("WORKATO_DISABLE_UPDATE_CHECK", "").lower() in (
+            "1",
+            "true",
+            "yes",
+        )
+
+    def should_check_for_updates(self) -> bool:
+        """Check if it's time to check for updates."""
+        if self.is_update_check_disabled():
+            return False
+
+        if not HAS_DEPENDENCIES:
+            return False
+
+        if not self.cache_file.exists():
+            return True
+
+        try:
+            last_check = self.cache_file.stat().st_mtime
+            return time.time() - last_check > CHECK_INTERVAL
+        except OSError:
+            return True
+
+    def get_latest_version(self) -> str | None:
+        """Get the latest version from PyPI."""
+        if not HAS_DEPENDENCIES:
+            return None
+
+        try:
+            # Ensure only HTTPS scheme is allowed for security
+            if not PYPI_API_URL.startswith("https://"):
+                return None
+
+            parsed_url = urlparse(PYPI_API_URL)
+            if parsed_url.scheme != "https":
+                return None
+
+            # Create SSL context with TLS 1.2 minimum
+            ssl_context = ssl.create_default_context()
+            if hasattr(ssl, "TLSVersion"):  # Python 3.7+
+                ssl_context.minimum_version = ssl.TLSVersion.TLSv1_2
+            else:  # Fallback for older Python versions
+                ssl_context.options |= (
+                    ssl.OP_NO_SSLv2
+                    | ssl.OP_NO_SSLv3
+                    | ssl.OP_NO_TLSv1
+                    | ssl.OP_NO_TLSv1_1
+                )
+
+            request = urllib.request.Request(PYPI_API_URL)  # noqa: S310
+            # Secure: URL scheme validated above, HTTPS only, proper SSL context
+            with urllib.request.urlopen(  # noqa: S310
+                request, timeout=REQUEST_TIMEOUT, context=ssl_context
+            ) as response:
+                status_code = response.getcode()
+                if status_code != 200:
+                    return None
+                data = json.loads(response.read().decode())
+                version_str: str = data["info"]["version"]
+                return version_str
+        except (OSError, KeyError, ValueError, json.JSONDecodeError):
+            return None
+
+    def update_cache_timestamp(self) -> None:
+        """Update the last check timestamp."""
+        with contextlib.suppress(OSError):
+            self.cache_file.touch()
+
+    def check_for_updates(self, current_version: str) -> str | None:
+        """Check if a newer version is available."""
+        if not HAS_DEPENDENCIES:
+            return None
+
+        latest = self.get_latest_version()
+        if not latest:
+            return None
+
+        try:
+            if version.parse(latest) > version.parse(current_version):
+                return latest
+        except Exception:
+            click.echo("Failed to check for updates")
+
+        return None
+
+    def show_update_notification(self, latest_version: str) -> None:
+        """Show update notification to user."""
+        click.echo()
+        click.echo(f"💡 A new version of {PACKAGE_NAME} is available: {latest_version}")
+        click.echo(f"   Run 'pip install --upgrade {PACKAGE_NAME}' to update")
+        click.echo(
+            "   To disable these notifications: export WORKATO_DISABLE_UPDATE_CHECK=1"
+        )
+
+    def background_update_check(self, current_version: str) -> None:
+        """Perform update check in background (non-blocking)."""
+        if not self.should_check_for_updates():
+            return
+
+        try:
+            latest_version = self.check_for_updates(current_version)
+            if latest_version:
+                self.show_update_notification(latest_version)
+
+            # Always update timestamp after a check attempt
+            self.update_cache_timestamp()
+
+        except Exception:
+            # Never let update checking break the CLI
+            click.echo("Failed to check for updates")
+
+
+def check_updates_async(func: Callable) -> Callable:
+    """Decorator to add background update checking to CLI commands."""
+
+    @wraps(func)
+    async def async_wrapper(*args: Any, **kwargs: Any) -> Any:
+        # Import here to avoid circular imports
+        from workato_platform_cli.cli.containers import Container
+
+        try:
+            # Run main command first
+            result = await func(*args, **kwargs)
+
+            # Check updates in background (non-blocking)
+            config_manager = Container.config_manager()
+            version_checker = VersionChecker(config_manager)
+
+            if version_checker.should_check_for_updates():
+                thread = threading.Thread(
+                    target=version_checker.background_update_check,
+                    args=(__version__,),
+                    daemon=True,
+                )
+                thread.start()
+                thread.join(timeout=3)  # Don't wait too long
+
+            return result
+
+        except Exception:
+            # If anything goes wrong with update checking, just run the main command
+            return await func(*args, **kwargs)
+
+    @wraps(func)
+    def sync_wrapper(*args: Any, **kwargs: Any) -> Any:
+        # Import here to avoid circular imports
+        from workato_platform_cli.cli.containers import Container
+
+        try:
+            # Run main command first
+            result = func(*args, **kwargs)
+
+            # Check updates in background (non-blocking)
+            config_manager = Container.config_manager()
+            version_checker = VersionChecker(config_manager)
+
+            if version_checker.should_check_for_updates():
+                thread = threading.Thread(
+                    target=version_checker.background_update_check,
+                    args=(__version__,),
+                    daemon=True,
+                )
+                thread.start()
+                thread.join(timeout=3)  # Don't wait too long
+
+            return result
+
+        except Exception:
+            # If anything goes wrong with update checking, just run the main command
+            return func(*args, **kwargs)
+
+    # Return appropriate wrapper based on whether function is async
+    import asyncio
+
+    if asyncio.iscoroutinefunction(func):
+        return async_wrapper
+    else:
+        return sync_wrapper

workato_platform_cli/client/workato_api/__init__.py

@@ -0,0 +1,202 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Workato Platform API
+
+    Official Workato Platform API for managing recipes, connections, projects, and other automation resources.  ## Authentication All endpoints require a Bearer token in the Authorization header.  ## Base URL The base URL varies by region: - US: `https://www.workato.com` - EU: `https://app.eu.workato.com` - JP: `https://app.jp.workato.com` - SG: `https://app.sg.workato.com` - AU: `https://app.au.workato.com` - IL: `https://app.il.workato.com` - Trial: `https://app.trial.workato.com` 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "APIPlatformApi",
+    "ConnectionsApi",
+    "ConnectorsApi",
+    "DataTablesApi",
+    "ExportApi",
+    "FoldersApi",
+    "PackagesApi",
+    "ProjectsApi",
+    "PropertiesApi",
+    "RecipesApi",
+    "UsersApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "ApiClient",
+    "ApiClientApiCollectionsInner",
+    "ApiClientApiPoliciesInner",
+    "ApiClientCreateRequest",
+    "ApiClientListResponse",
+    "ApiClientResponse",
+    "ApiCollection",
+    "ApiCollectionCreateRequest",
+    "ApiEndpoint",
+    "ApiKey",
+    "ApiKeyCreateRequest",
+    "ApiKeyListResponse",
+    "ApiKeyResponse",
+    "Asset",
+    "AssetReference",
+    "Connection",
+    "ConnectionCreateRequest",
+    "ConnectionUpdateRequest",
+    "ConnectorAction",
+    "ConnectorVersion",
+    "CreateExportManifestRequest",
+    "CreateFolderRequest",
+    "CustomConnector",
+    "CustomConnectorCodeResponse",
+    "CustomConnectorCodeResponseData",
+    "CustomConnectorListResponse",
+    "DataTable",
+    "DataTableColumn",
+    "DataTableColumnRequest",
+    "DataTableCreateRequest",
+    "DataTableCreateResponse",
+    "DataTableListResponse",
+    "DataTableRelation",
+    "DeleteProject403Response",
+    "Error",
+    "ExportManifestRequest",
+    "ExportManifestResponse",
+    "ExportManifestResponseResult",
+    "Folder",
+    "FolderAssetsResponse",
+    "FolderAssetsResponseResult",
+    "FolderCreationResponse",
+    "ImportResults",
+    "OAuthUrlResponse",
+    "OAuthUrlResponseData",
+    "OpenApiSpec",
+    "PackageDetailsResponse",
+    "PackageDetailsResponseRecipeStatusInner",
+    "PackageResponse",
+    "PicklistRequest",
+    "PicklistResponse",
+    "PlatformConnector",
+    "PlatformConnectorListResponse",
+    "Project",
+    "Recipe",
+    "RecipeConfigInner",
+    "RecipeConnectionUpdateRequest",
+    "RecipeListResponse",
+    "RecipeStartResponse",
+    "RuntimeUserConnectionCreateRequest",
+    "RuntimeUserConnectionResponse",
+    "RuntimeUserConnectionResponseData",
+    "SuccessResponse",
+    "UpsertProjectPropertiesRequest",
+    "User",
+    "ValidationError",
+    "ValidationErrorErrorsValue",
+]
+
+# import apis into sdk package
+from workato_platform_cli.client.workato_api.api.api_platform_api import APIPlatformApi as APIPlatformApi
+from workato_platform_cli.client.workato_api.api.connections_api import ConnectionsApi as ConnectionsApi
+from workato_platform_cli.client.workato_api.api.connectors_api import ConnectorsApi as ConnectorsApi
+from workato_platform_cli.client.workato_api.api.data_tables_api import DataTablesApi as DataTablesApi
+from workato_platform_cli.client.workato_api.api.export_api import ExportApi as ExportApi
+from workato_platform_cli.client.workato_api.api.folders_api import FoldersApi as FoldersApi
+from workato_platform_cli.client.workato_api.api.packages_api import PackagesApi as PackagesApi
+from workato_platform_cli.client.workato_api.api.projects_api import ProjectsApi as ProjectsApi
+from workato_platform_cli.client.workato_api.api.properties_api import PropertiesApi as PropertiesApi
+from workato_platform_cli.client.workato_api.api.recipes_api import RecipesApi as RecipesApi
+from workato_platform_cli.client.workato_api.api.users_api import UsersApi as UsersApi
+
+# import ApiClient
+from workato_platform_cli.client.workato_api.api_response import ApiResponse as ApiResponse
+from workato_platform_cli.client.workato_api.api_client import ApiClient as ApiClient
+from workato_platform_cli.client.workato_api.configuration import Configuration as Configuration
+from workato_platform_cli.client.workato_api.exceptions import OpenApiException as OpenApiException
+from workato_platform_cli.client.workato_api.exceptions import ApiTypeError as ApiTypeError
+from workato_platform_cli.client.workato_api.exceptions import ApiValueError as ApiValueError
+from workato_platform_cli.client.workato_api.exceptions import ApiKeyError as ApiKeyError
+from workato_platform_cli.client.workato_api.exceptions import ApiAttributeError as ApiAttributeError
+from workato_platform_cli.client.workato_api.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from workato_platform_cli.client.workato_api.models.api_client import ApiClient as ApiClient
+from workato_platform_cli.client.workato_api.models.api_client_api_collections_inner import ApiClientApiCollectionsInner as ApiClientApiCollectionsInner
+from workato_platform_cli.client.workato_api.models.api_client_api_policies_inner import ApiClientApiPoliciesInner as ApiClientApiPoliciesInner
+from workato_platform_cli.client.workato_api.models.api_client_create_request import ApiClientCreateRequest as ApiClientCreateRequest
+from workato_platform_cli.client.workato_api.models.api_client_list_response import ApiClientListResponse as ApiClientListResponse
+from workato_platform_cli.client.workato_api.models.api_client_response import ApiClientResponse as ApiClientResponse
+from workato_platform_cli.client.workato_api.models.api_collection import ApiCollection as ApiCollection
+from workato_platform_cli.client.workato_api.models.api_collection_create_request import ApiCollectionCreateRequest as ApiCollectionCreateRequest
+from workato_platform_cli.client.workato_api.models.api_endpoint import ApiEndpoint as ApiEndpoint
+from workato_platform_cli.client.workato_api.models.api_key import ApiKey as ApiKey
+from workato_platform_cli.client.workato_api.models.api_key_create_request import ApiKeyCreateRequest as ApiKeyCreateRequest
+from workato_platform_cli.client.workato_api.models.api_key_list_response import ApiKeyListResponse as ApiKeyListResponse
+from workato_platform_cli.client.workato_api.models.api_key_response import ApiKeyResponse as ApiKeyResponse
+from workato_platform_cli.client.workato_api.models.asset import Asset as Asset
+from workato_platform_cli.client.workato_api.models.asset_reference import AssetReference as AssetReference
+from workato_platform_cli.client.workato_api.models.connection import Connection as Connection
+from workato_platform_cli.client.workato_api.models.connection_create_request import ConnectionCreateRequest as ConnectionCreateRequest
+from workato_platform_cli.client.workato_api.models.connection_update_request import ConnectionUpdateRequest as ConnectionUpdateRequest
+from workato_platform_cli.client.workato_api.models.connector_action import ConnectorAction as ConnectorAction
+from workato_platform_cli.client.workato_api.models.connector_version import ConnectorVersion as ConnectorVersion
+from workato_platform_cli.client.workato_api.models.create_export_manifest_request import CreateExportManifestRequest as CreateExportManifestRequest
+from workato_platform_cli.client.workato_api.models.create_folder_request import CreateFolderRequest as CreateFolderRequest
+from workato_platform_cli.client.workato_api.models.custom_connector import CustomConnector as CustomConnector
+from workato_platform_cli.client.workato_api.models.custom_connector_code_response import CustomConnectorCodeResponse as CustomConnectorCodeResponse
+from workato_platform_cli.client.workato_api.models.custom_connector_code_response_data import CustomConnectorCodeResponseData as CustomConnectorCodeResponseData
+from workato_platform_cli.client.workato_api.models.custom_connector_list_response import CustomConnectorListResponse as CustomConnectorListResponse
+from workato_platform_cli.client.workato_api.models.data_table import DataTable as DataTable
+from workato_platform_cli.client.workato_api.models.data_table_column import DataTableColumn as DataTableColumn
+from workato_platform_cli.client.workato_api.models.data_table_column_request import DataTableColumnRequest as DataTableColumnRequest
+from workato_platform_cli.client.workato_api.models.data_table_create_request import DataTableCreateRequest as DataTableCreateRequest
+from workato_platform_cli.client.workato_api.models.data_table_create_response import DataTableCreateResponse as DataTableCreateResponse
+from workato_platform_cli.client.workato_api.models.data_table_list_response import DataTableListResponse as DataTableListResponse
+from workato_platform_cli.client.workato_api.models.data_table_relation import DataTableRelation as DataTableRelation
+from workato_platform_cli.client.workato_api.models.delete_project403_response import DeleteProject403Response as DeleteProject403Response
+from workato_platform_cli.client.workato_api.models.error import Error as Error
+from workato_platform_cli.client.workato_api.models.export_manifest_request import ExportManifestRequest as ExportManifestRequest
+from workato_platform_cli.client.workato_api.models.export_manifest_response import ExportManifestResponse as ExportManifestResponse
+from workato_platform_cli.client.workato_api.models.export_manifest_response_result import ExportManifestResponseResult as ExportManifestResponseResult
+from workato_platform_cli.client.workato_api.models.folder import Folder as Folder
+from workato_platform_cli.client.workato_api.models.folder_assets_response import FolderAssetsResponse as FolderAssetsResponse
+from workato_platform_cli.client.workato_api.models.folder_assets_response_result import FolderAssetsResponseResult as FolderAssetsResponseResult
+from workato_platform_cli.client.workato_api.models.folder_creation_response import FolderCreationResponse as FolderCreationResponse
+from workato_platform_cli.client.workato_api.models.import_results import ImportResults as ImportResults
+from workato_platform_cli.client.workato_api.models.o_auth_url_response import OAuthUrlResponse as OAuthUrlResponse
+from workato_platform_cli.client.workato_api.models.o_auth_url_response_data import OAuthUrlResponseData as OAuthUrlResponseData
+from workato_platform_cli.client.workato_api.models.open_api_spec import OpenApiSpec as OpenApiSpec
+from workato_platform_cli.client.workato_api.models.package_details_response import PackageDetailsResponse as PackageDetailsResponse
+from workato_platform_cli.client.workato_api.models.package_details_response_recipe_status_inner import PackageDetailsResponseRecipeStatusInner as PackageDetailsResponseRecipeStatusInner
+from workato_platform_cli.client.workato_api.models.package_response import PackageResponse as PackageResponse
+from workato_platform_cli.client.workato_api.models.picklist_request import PicklistRequest as PicklistRequest
+from workato_platform_cli.client.workato_api.models.picklist_response import PicklistResponse as PicklistResponse
+from workato_platform_cli.client.workato_api.models.platform_connector import PlatformConnector as PlatformConnector
+from workato_platform_cli.client.workato_api.models.platform_connector_list_response import PlatformConnectorListResponse as PlatformConnectorListResponse
+from workato_platform_cli.client.workato_api.models.project import Project as Project
+from workato_platform_cli.client.workato_api.models.recipe import Recipe as Recipe
+from workato_platform_cli.client.workato_api.models.recipe_config_inner import RecipeConfigInner as RecipeConfigInner
+from workato_platform_cli.client.workato_api.models.recipe_connection_update_request import RecipeConnectionUpdateRequest as RecipeConnectionUpdateRequest
+from workato_platform_cli.client.workato_api.models.recipe_list_response import RecipeListResponse as RecipeListResponse
+from workato_platform_cli.client.workato_api.models.recipe_start_response import RecipeStartResponse as RecipeStartResponse
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_create_request import RuntimeUserConnectionCreateRequest as RuntimeUserConnectionCreateRequest
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_response import RuntimeUserConnectionResponse as RuntimeUserConnectionResponse
+from workato_platform_cli.client.workato_api.models.runtime_user_connection_response_data import RuntimeUserConnectionResponseData as RuntimeUserConnectionResponseData
+from workato_platform_cli.client.workato_api.models.success_response import SuccessResponse as SuccessResponse
+from workato_platform_cli.client.workato_api.models.upsert_project_properties_request import UpsertProjectPropertiesRequest as UpsertProjectPropertiesRequest
+from workato_platform_cli.client.workato_api.models.user import User as User
+from workato_platform_cli.client.workato_api.models.validation_error import ValidationError as ValidationError
+from workato_platform_cli.client.workato_api.models.validation_error_errors_value import ValidationErrorErrorsValue as ValidationErrorErrorsValue
+

workato_platform_cli/client/workato_api/api/__init__.py

@@ -0,0 +1,15 @@
+# flake8: noqa
+
+# import apis into api package
+from workato_platform_cli.client.workato_api.api.api_platform_api import APIPlatformApi
+from workato_platform_cli.client.workato_api.api.connections_api import ConnectionsApi
+from workato_platform_cli.client.workato_api.api.connectors_api import ConnectorsApi
+from workato_platform_cli.client.workato_api.api.data_tables_api import DataTablesApi
+from workato_platform_cli.client.workato_api.api.export_api import ExportApi
+from workato_platform_cli.client.workato_api.api.folders_api import FoldersApi
+from workato_platform_cli.client.workato_api.api.packages_api import PackagesApi
+from workato_platform_cli.client.workato_api.api.projects_api import ProjectsApi
+from workato_platform_cli.client.workato_api.api.properties_api import PropertiesApi
+from workato_platform_cli.client.workato_api.api.recipes_api import RecipesApi
+from workato_platform_cli.client.workato_api.api.users_api import UsersApi
+