gl-connectors-cli 0.1.0__tar.gz

gl_connectors_cli-0.1.0/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: gl-connectors-cli
+Version: 0.1.0
+Author-email: GL Connectors Team <bosa-eng@gdplabs.id>
+Requires-Python: <3.14,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: pydantic<3.0.0,>=2.11.7
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.1; extra == "dev"
+Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
+Requires-Dist: ruff>=0.12.7; extra == "dev"
+Requires-Dist: mypy>=1.17.0; extra == "dev"
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Requires-Dist: pip-tools>=7.0.0; extra == "dev"
+
+# GL Connectors CLI
+
+A command-line interface for managing GL Connectors integrations and authentication.
+
+## Prerequisites
+
+<details>
+<summary>Prerequisites details</summary>
+
+1. **Python v3.11 or above** (to run `python`)
+
+   - Using Conda (recommended):
+     You can use [Miniconda](https://docs.anaconda.com/miniconda/install) to install and manage Python versions.
+
+2. **Connector access** (contact your administrator for credentials)
+</details>
+
+## Installation
+
+Install the CLI using:
+
+```bash
+pip install gl-connectors-cli
+```
+
+## Quick Start
+
+Get up and create your first integration using GL Connectors CLI:
+
+1. **Login**:
+
+   ```bash
+   glcon auth login
+   # Make sure you have access to GL Connectors playground environment.
+   # You will be prompted to enter:
+
+   # Client API Key: sk-client-...
+   # Username (User Identifier): your user identifier
+   # User Secret: sk-user-...
+   ```
+
+2. **View Available Integrations**:
+
+   ```bash
+   glcon integrations
+   ```
+
+   You should have 0 integration(s) count for each connector listed.
+
+3. **Add Your First Integration**:
+
+   ```bash
+   glcon integrations add github
+   ```
+
+   You should see the following message:
+
+   ```
+   ✓ OAuth flow initiated for github!
+   Please visit the following URL to complete the integration:
+   https://github.com/login/oauth/authorize?client_id=...
+   ```
+
+   Open the URL in your browser and follow the OAuth flow.
+
+4. **Check your GitHub accounts**:
+
+   After you have completed the OAuth flow, you can check your GitHub accounts.
+
+   ```bash
+   glcon integrations show github
+   ```
+
+   Voila! You should see your GitHub accounts listed, as shown below:
+
+   ```
+   Integrations for github
+   =======================
+   ℹ Found 1 integration(s)
+
+   User Identifier | Status
+   ------------------------------------
+   | your-github-username | ✓ Selected
+   ```
+
+That's it! You're now ready to manage your GL Connectors' integrations.
+
+## Command Reference
+
+### Authentication Commands
+
+| Command             | Description                          | Options           |
+| ------------------- | ------------------------------------ | ----------------- |
+| `glcon auth login`  | Authenticate with client credentials | `--api-url <url>` |
+| `glcon auth status` | Check current authentication status  | -                 |
+| `glcon auth logout` | Clear stored credentials             | -                 |
+
+**Login prompts**:
+
+- **Client API Key**: Your client API key (input hidden)
+- **Username**: Your user identifier
+- **User Secret**: Your user secret (input hidden)
+
+**Configuration Options**:
+
+- `--api-url`: Custom Connector URL (for development purposes)
+
+### Integration Commands
+
+| Command                                              | Description                                | Parameter(s)                                                       |
+| ---------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------ |
+| `glcon integrations`                                 | List all connectors and integration counts | -                                                                  |
+| `glcon integrations list`                            | Same as above (explicit)                   | -                                                                  |
+| `glcon integrations add <connector>`                 | Add new integration via OAuth flow         | `<connector>`: github, google, etc.                                |
+| `glcon integrations show <connector>`                | Show all accounts for a connector          | `<connector>`: github, google, etc.                                |
+| `glcon integrations show <connector> <identifier>`   | Show specific integration details          | `<connector>`: github, google, etc. `<identifier>`: email/username |
+| `glcon integrations remove <connector> <identifier>` | Remove specific integration                | `<connector>`: github, google, etc. `<identifier>`: email/username |
+| `glcon integrations select <connector> <identifier>` | Set integration as primary                 | `<connector>`: github, google, etc. `<identifier>`: email/username |
+
+**Examples**:
+
+```bash
+glcon integrations                           # List all connectors
+glcon integrations add github                # Add GitHub integration
+glcon integrations show google               # Show all Google accounts
+glcon integrations show google user@gmail.com  # Show specific account details
+glcon integrations remove github username    # Remove GitHub integration
+glcon integrations select google user@gmail.com # Set as primary Google account
+```
+
+### User Commands
+
+| Command                           | Description               | Parameter(s)                   |
+| --------------------------------- | ------------------------- | ------------------------------ |
+| `glcon users create <identifier>` | Create a new user account | `<identifier>`: email/username |
+
+**Example**:
+
+```bash
+glcon users create john.doe@example.com
+```
+
+**Important**: Save the user secret securely! It's only shown once.
+
+## Configuration
+
+The CLI stores configuration in `~/.connector/config.json`. This file contains:
+
+- Authentication session (client key, user token, API URL)
+- Session expiration information
+
+The API URL is only configurable during authentication using the `--api-url` flag.
+
+## Getting Help
+
+Get help for any command:
+
+```bash
+glcon --help                    # Main help
+glcon auth --help              # Authentication commands help
+glcon integrations --help      # Integration commands help
+glcon users --help             # User management commands help
+```
+
+## Available Connectors
+
+The available connectors depend on your Connector configuration. Common connectors include:
+
+- **github**: GitHub API integration
+- **google**: Google services integration
+- **google_drive**: Google Drive integration
+- **google_docs**: Google Docs integration
+- **google_mail**: Google Mail integration
+
+## Contributing
+
+We welcome contributions! Please see our documentation:
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development setup, workflow, and code review guidelines
+- **[constitution.md](constitution.md)** - Code generation standards
+
+## License
+
+This project is maintained by the GL Connectors Team.

gl_connectors_cli-0.1.0/README.md

@@ -0,0 +1,184 @@
+# GL Connectors CLI
+
+A command-line interface for managing GL Connectors integrations and authentication.
+
+## Prerequisites
+
+<details>
+<summary>Prerequisites details</summary>
+
+1. **Python v3.11 or above** (to run `python`)
+
+   - Using Conda (recommended):
+     You can use [Miniconda](https://docs.anaconda.com/miniconda/install) to install and manage Python versions.
+
+2. **Connector access** (contact your administrator for credentials)
+</details>
+
+## Installation
+
+Install the CLI using:
+
+```bash
+pip install gl-connectors-cli
+```
+
+## Quick Start
+
+Get up and create your first integration using GL Connectors CLI:
+
+1. **Login**:
+
+   ```bash
+   glcon auth login
+   # Make sure you have access to GL Connectors playground environment.
+   # You will be prompted to enter:
+
+   # Client API Key: sk-client-...
+   # Username (User Identifier): your user identifier
+   # User Secret: sk-user-...
+   ```
+
+2. **View Available Integrations**:
+
+   ```bash
+   glcon integrations
+   ```
+
+   You should have 0 integration(s) count for each connector listed.
+
+3. **Add Your First Integration**:
+
+   ```bash
+   glcon integrations add github
+   ```
+
+   You should see the following message:
+
+   ```
+   ✓ OAuth flow initiated for github!
+   Please visit the following URL to complete the integration:
+   https://github.com/login/oauth/authorize?client_id=...
+   ```
+
+   Open the URL in your browser and follow the OAuth flow.
+
+4. **Check your GitHub accounts**:
+
+   After you have completed the OAuth flow, you can check your GitHub accounts.
+
+   ```bash
+   glcon integrations show github
+   ```
+
+   Voila! You should see your GitHub accounts listed, as shown below:
+
+   ```
+   Integrations for github
+   =======================
+   ℹ Found 1 integration(s)
+
+   User Identifier | Status
+   ------------------------------------
+   | your-github-username | ✓ Selected
+   ```
+
+That's it! You're now ready to manage your GL Connectors' integrations.
+
+## Command Reference
+
+### Authentication Commands
+
+| Command             | Description                          | Options           |
+| ------------------- | ------------------------------------ | ----------------- |
+| `glcon auth login`  | Authenticate with client credentials | `--api-url <url>` |
+| `glcon auth status` | Check current authentication status  | -                 |
+| `glcon auth logout` | Clear stored credentials             | -                 |
+
+**Login prompts**:
+
+- **Client API Key**: Your client API key (input hidden)
+- **Username**: Your user identifier
+- **User Secret**: Your user secret (input hidden)
+
+**Configuration Options**:
+
+- `--api-url`: Custom Connector URL (for development purposes)
+
+### Integration Commands
+
+| Command                                              | Description                                | Parameter(s)                                                       |
+| ---------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------ |
+| `glcon integrations`                                 | List all connectors and integration counts | -                                                                  |
+| `glcon integrations list`                            | Same as above (explicit)                   | -                                                                  |
+| `glcon integrations add <connector>`                 | Add new integration via OAuth flow         | `<connector>`: github, google, etc.                                |
+| `glcon integrations show <connector>`                | Show all accounts for a connector          | `<connector>`: github, google, etc.                                |
+| `glcon integrations show <connector> <identifier>`   | Show specific integration details          | `<connector>`: github, google, etc. `<identifier>`: email/username |
+| `glcon integrations remove <connector> <identifier>` | Remove specific integration                | `<connector>`: github, google, etc. `<identifier>`: email/username |
+| `glcon integrations select <connector> <identifier>` | Set integration as primary                 | `<connector>`: github, google, etc. `<identifier>`: email/username |
+
+**Examples**:
+
+```bash
+glcon integrations                           # List all connectors
+glcon integrations add github                # Add GitHub integration
+glcon integrations show google               # Show all Google accounts
+glcon integrations show google user@gmail.com  # Show specific account details
+glcon integrations remove github username    # Remove GitHub integration
+glcon integrations select google user@gmail.com # Set as primary Google account
+```
+
+### User Commands
+
+| Command                           | Description               | Parameter(s)                   |
+| --------------------------------- | ------------------------- | ------------------------------ |
+| `glcon users create <identifier>` | Create a new user account | `<identifier>`: email/username |
+
+**Example**:
+
+```bash
+glcon users create john.doe@example.com
+```
+
+**Important**: Save the user secret securely! It's only shown once.
+
+## Configuration
+
+The CLI stores configuration in `~/.connector/config.json`. This file contains:
+
+- Authentication session (client key, user token, API URL)
+- Session expiration information
+
+The API URL is only configurable during authentication using the `--api-url` flag.
+
+## Getting Help
+
+Get help for any command:
+
+```bash
+glcon --help                    # Main help
+glcon auth --help              # Authentication commands help
+glcon integrations --help      # Integration commands help
+glcon users --help             # User management commands help
+```
+
+## Available Connectors
+
+The available connectors depend on your Connector configuration. Common connectors include:
+
+- **github**: GitHub API integration
+- **google**: Google services integration
+- **google_drive**: Google Drive integration
+- **google_docs**: Google Docs integration
+- **google_mail**: Google Mail integration
+
+## Contributing
+
+We welcome contributions! Please see our documentation:
+
+- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Development setup, workflow, and code review guidelines
+- **[constitution.md](constitution.md)** - Code generation standards
+
+## License
+
+This project is maintained by the GL Connectors Team.

gl_connectors_cli-0.1.0/gl_connectors_cli/__init__.py

@@ -0,0 +1,5 @@
+"""GL Connectors CLI module for managing integrations and authentication."""
+
+from gl_connectors_cli.main import main
+
+__all__ = ["main"]

gl_connectors_cli-0.1.0/gl_connectors_cli/__main__.py

@@ -0,0 +1,12 @@
+"""CLI entry point.
+
+Authors:
+    GL Connectors Team
+"""
+
+import sys
+
+from gl_connectors_cli.main import main
+
+if __name__ == "__main__":
+    sys.exit(main())

gl_connectors_cli-0.1.0/gl_connectors_cli/api/__init__.py

@@ -0,0 +1,19 @@
+"""GL Connectors CLI API clients.
+
+Author:
+    I Gusti Ngurah Gana Untaran (i.gusti.n.g.untaran@gdplabs.id)
+"""
+
+from gl_connectors_cli.api.auth import AuthAPIClient
+from gl_connectors_cli.api.integrations import IntegrationsAPIClient
+from gl_connectors_cli.api.models import IntegrationDetail, Token, User
+from gl_connectors_cli.api.users import UsersAPIClient
+
+__all__ = [
+    "AuthAPIClient",
+    "UsersAPIClient",
+    "IntegrationsAPIClient",
+    "User",
+    "Token",
+    "IntegrationDetail",
+]

gl_connectors_cli-0.1.0/gl_connectors_cli/api/auth.py

@@ -0,0 +1,47 @@
+"""Authentication API client for GL Connectors CLI.
+
+Author:
+    I Gusti Ngurah Gana Untaran (i.gusti.n.g.untaran@gdplabs.id)
+"""
+
+from gl_connectors_cli.api.base import BaseAPIClient
+from gl_connectors_cli.api.models import Token
+from gl_connectors_cli.constants import API_KEY_HEADER, HTTP_POST
+from gl_connectors_cli.utils import CLIError
+
+
+class AuthAPIClient(BaseAPIClient):
+    """Authentication API client."""
+
+    def authenticate_user(self, client_key: str, identifier: str, secret: str) -> Token:
+        """Authenticate user and get JWT token.
+
+        Args:
+            client_key: Client API key
+            identifier: User identifier
+            secret: User secret
+
+        Returns:
+            Authentication token information
+
+        Raises:
+            CLIError: If authentication fails
+
+        """
+        headers = {
+            API_KEY_HEADER: client_key,
+        }
+
+        data = {"identifier": identifier, "secret": secret}
+
+        try:
+            response = self._make_request(HTTP_POST, "/clients/oauth-token", headers=headers, data=data)
+            token_data = response.get("data", None)
+
+            if not token_data:
+                raise CLIError("Authentication error. Please check your credentials and try again.")
+
+            return Token(**token_data)
+
+        except Exception as e:
+            raise CLIError(str(e)) from e

gl_connectors_cli-0.1.0/gl_connectors_cli/api/base.py

@@ -0,0 +1,86 @@
+"""Base API client for GL Connectors CLI.
+
+Author:
+    I Gusti Ngurah Gana Untaran (i.gusti.n.g.untaran@gdplabs.id)
+"""
+
+import json
+from typing import Any, Dict, Optional
+
+import requests
+
+from gl_connectors_cli.constants import HTTP_DELETE, HTTP_GET, HTTP_POST, HTTP_PUT
+from gl_connectors_cli.utils import CLIError
+
+
+class BaseAPIClient:
+    """Base API client with shared request functionality."""
+
+    def __init__(self, base_url: str):
+        """Initialize base API client.
+
+        Args:
+            base_url: Connector base URL
+
+        """
+        self.base_url = base_url.rstrip("/")
+        self.session = requests.Session()
+
+    def _make_request(
+        self,
+        method: str,
+        endpoint: str,
+        headers: Optional[Dict[str, str]] = None,
+        data: Optional[Dict[str, Any]] = None,
+        params: Optional[Dict[str, str]] = None,
+    ) -> Dict[str, Any]:
+        """Make HTTP request to Connector.
+
+        Args:
+            method: HTTP method (GET, POST, DELETE, etc.)
+            endpoint: API endpoint path
+            headers: Request headers
+            data: Request body data
+            params: URL parameters
+
+        Returns:
+            Response JSON data
+
+        Raises:
+            CLIError: If request fails
+
+        """
+        url = f"{self.base_url}{endpoint}"
+
+        try:
+            if method.upper() == HTTP_GET:
+                response = self.session.get(url, headers=headers, params=params)
+            elif method.upper() == HTTP_POST:
+                response = self.session.post(url, headers=headers, json=data, params=params)
+            elif method.upper() == HTTP_DELETE:
+                response = self.session.delete(url, headers=headers, params=params)
+            elif method.upper() == HTTP_PUT:
+                response = self.session.put(url, headers=headers, json=data, params=params)
+            else:
+                raise CLIError(f"Unsupported HTTP method: {method}")
+
+            response_data = response.json()
+            if not response.ok or ("success" in response_data and response_data["success"] is False):
+                error_data = response_data.get("error", {})
+                error_message = error_data.get("message", response.status_code)
+                raise CLIError(f"API error: {error_message}")
+
+            return response_data
+
+        except requests.exceptions.ConnectionError as e:
+            raise CLIError(f"Failed to connect to {self.base_url}: {str(e)}") from e
+        except requests.exceptions.Timeout as e:
+            raise CLIError(f"Request timeout: {str(e)}") from e
+        except requests.exceptions.RequestException as e:
+            raise CLIError(f"Request failed: {str(e)}") from e
+        except json.JSONDecodeError as e:
+            raise CLIError(f"Invalid JSON response from server: {str(e)}") from e
+        except CLIError as e:
+            raise e
+        except Exception as e:
+            raise CLIError(f"An unexpected error occurred: {str(e)}") from e