canvas 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

canvas_sdk/protocols/__init__.py

@@ -0,0 +1 @@
+from canvas_sdk.protocols.base import BaseProtocol

canvas_sdk/protocols/base.py

@@ -0,0 +1,12 @@
+import json
+
+
+class BaseProtocol:
+    """
+    The class that protocols inherit from.
+    """
+
+    def __init__(self, event, secrets=None) -> None:
+        self.event = event
+        self.context = json.loads(event.context)
+        self.secrets = secrets or {}

canvas_sdk/utils/__init__.py

@@ -0,0 +1,3 @@
+from canvas_sdk.utils.http import Http
+
+__all__ = ("Http",)

canvas_sdk/utils/http.py

@@ -0,0 +1,72 @@
+import time
+from functools import wraps
+from typing import Any, Callable, TypeVar
+
+import requests
+import statsd
+
+F = TypeVar("F", bound=Callable)
+
+
+class Http:
+    """A helper class for completing HTTP calls with metrics tracking."""
+
+    def __init__(self) -> None:
+        self.session = requests.Session()
+        self.statsd_client = statsd.StatsClient()
+
+    @staticmethod
+    def measure_time(fn: F | None = None) -> Callable[[F], F] | F:
+        """A decorator to store timing of HTTP calls."""
+
+        def _decorator(fn: F) -> F:
+            @wraps(fn)
+            def wrapper(self: "Http", *args: Any, **kwargs: Any) -> Any:
+                start_time = time.time()
+                result = fn(self, *args, **kwargs)
+                end_time = time.time()
+                timing = int((end_time - start_time) * 1000)
+                self.statsd_client.timing(f"http_{fn.__name__}", timing)
+                return result
+
+            return wrapper
+
+        return _decorator(fn) if fn else _decorator
+
+    @measure_time
+    def get(self, url: str, headers: dict = {}) -> requests.Response:
+        """Sends a GET request."""
+        return self.session.get(url, headers=headers)
+
+    @measure_time
+    def post(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: dict = {},
+    ) -> requests.Response:
+        """Sends a POST request."""
+        return self.session.post(url, json=json, data=data, headers=headers)
+
+    @measure_time
+    def put(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: dict = {},
+    ) -> requests.Response:
+        """Sends a PUT request."""
+        return self.session.put(url, json=json, data=data, headers=headers)
+
+    @measure_time
+    def patch(
+        self,
+        url: str,
+        json: dict | None = None,
+        data: dict | str | list | bytes | None = None,
+        headers: dict = {},
+    ) -> requests.Response:
+        """Sends a PATCH request."""
+        return self.session.patch(url, json=json, data=data, headers=headers)

canvas_sdk/utils/tests.py

@@ -0,0 +1,63 @@
+from unittest.mock import MagicMock, patch
+
+from canvas_sdk.utils import Http
+
+
+@patch("requests.Session.get")
+def test_http_get(mock_get: MagicMock) -> None:
+    http = Http()
+    http.get("https://www.canvasmedical.com/", headers={"Authorization": "Bearer as;ldkfjdkj"})
+    mock_get.assert_called_once_with(
+        "https://www.canvasmedical.com/", headers={"Authorization": "Bearer as;ldkfjdkj"}
+    )
+
+
+@patch("requests.Session.post")
+def test_http_post(mock_post: MagicMock) -> None:
+    http = Http()
+    http.post(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )
+    mock_post.assert_called_once_with(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )
+
+
+@patch("requests.Session.put")
+def test_http_put(mock_put: MagicMock) -> None:
+    http = Http()
+    http.put(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )
+    mock_put.assert_called_once_with(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )
+
+
+@patch("requests.Session.patch")
+def test_http_patch(mock_patch: MagicMock) -> None:
+    http = Http()
+    http.patch(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )
+    mock_patch.assert_called_once_with(
+        "https://www.canvasmedical.com/",
+        json={"hey": "hi"},
+        data="grant-type=client_credentials",
+        headers={"Content-type": "application/json"},
+    )

canvas/main.py

@@ -1,19 +0,0 @@
-import typer
-from canvas_brush.apps.auth import app as auth_app
-from canvas_brush.apps.logs import logs as logs_command
-from canvas_brush.apps.plugin import app as plugin_app
-from canvas_brush.main import main, print_config
-
-app = typer.Typer()
-
-app.add_typer(auth_app, name="auth", help="Manage authenticating in Canvas instances")
-app.add_typer(plugin_app, name="plugin", help="Manage plugins in a Canvas instance")
-
-app.command(short_help="Listens and prints log streams from the instance")(logs_command)
-app.command(short_help="Print the config and exit")(print_config)
-
-app.callback()(main)
-
-
-if __name__ == "__main__":
-    app()

canvas-0.1.4.dist-info/METADATA

@@ -1,285 +0,0 @@
-Metadata-Version: 2.1
-Name: canvas
-Version: 0.1.4
-Summary: SDK to customize event-driven actions in your Canvas instance
-License: MIT
-Author: Canvas Team
-Author-email: engineering@canvasmedical.com
-Requires-Python: >=3.12,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: canvas-brush (>=1.2.2,<2.0.0)
-Requires-Dist: canvas-core (>=0.84.1,<0.85.0)
-Requires-Dist: typer (>=0.9.0,<0.10.0)
-Description-Content-Type: text/markdown
-
-### Getting Started
-
-`pip install canvas`
-
-**Usage**:
-
-```console
-$ canvas [OPTIONS] COMMAND [ARGS]...
-```
-
-**Options**:
-
-- `--no-ansi`: Disable colorized output
-- `--version`
-- `--verbose`: Show extra output
-- `--install-completion`: Install completion for the current shell.
-- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
-- `--help`: Show this message and exit.
-
-**Commands**:
-
-- `auth`: Manage authenticating in Canvas instances
-- `logs`: Listens and prints log streams from the instance
-- `plugin`: Manage plugins in a Canvas instance
-- `print-config`: Print the config and exit
-
-## `canvas auth`
-
-Manage authenticating in Canvas instances
-
-**Usage**:
-
-```console
-$ canvas auth [OPTIONS] COMMAND [ARGS]...
-```
-
-**Options**:
-
-- `--help`: Show this message and exit.
-
-**Commands**:
-
-- `add-api-key`: Add a host=api-key pair to the keychain, so it can be used in other requests
-- `get-api-key`: Print the api_key for the given host
-- `remove-api-key`: Removes a host from the keychain, and as the default if it's the one
-- `set-default-host`: Set the host as the default host in the config file
-
-### `canvas auth add-api-key`
-
-Add a host=api-key pair to the keychain, so it can be used in other requests.
-Optionally set a default so `--host` isn't required everywhere
-
-**Usage**:
-
-```console
-$ canvas auth add-api-key [OPTIONS]
-```
-
-**Options**:
-
-- `--host TEXT`: [required]
-- `--api-key TEXT`: [required]
-- `--is-default / --no-is-default`: [required]
-- `--help`: Show this message and exit.
-
-### `canvas auth get-api-key`
-
-Print the api_key for the given host.
-
-**Usage**:
-
-```console
-$ canvas auth get-api-key [OPTIONS] HOST
-```
-
-**Arguments**:
-
-- `HOST`: [required]
-
-**Options**:
-
-- `--help`: Show this message and exit.
-
-### `canvas auth remove-api-key`
-
-Removes a host from the keychain, and as the default if it's the one.
-This method always succeeds, regardless of username existence.
-
-**Usage**:
-
-```console
-$ canvas auth remove-api-key [OPTIONS] HOST
-```
-
-**Arguments**:
-
-- `HOST`: [required]
-
-**Options**:
-
-- `--help`: Show this message and exit.
-
-### `canvas auth set-default-host`
-
-Set the host as the default host in the config file. Validates it exists in the keychain.
-
-**Usage**:
-
-```console
-$ canvas auth set-default-host [OPTIONS] HOST
-```
-
-**Arguments**:
-
-- `HOST`: [required]
-
-**Options**:
-
-- `--help`: Show this message and exit.
-
-## `canvas logs`
-
-Listens and prints log streams from the instance.
-
-**Usage**:
-
-```console
-$ canvas logs [OPTIONS]
-```
-
-**Options**:
-
-- `--host TEXT`: Canvas instance to connect to
-- `--api-key TEXT`: Canvas api-key for the provided host
-- `--help`: Show this message and exit.
-
-## `canvas plugin`
-
-Manage plugins in a Canvas instance
-
-**Usage**:
-
-```console
-$ canvas plugin [OPTIONS] COMMAND [ARGS]...
-```
-
-**Options**:
-
-- `--help`: Show this message and exit.
-
-**Commands**:
-
-- `delete`: Delete a disabled plugin from an instance
-- `init`: Create a plugin from a template using Cookiecutter
-- `install`: Installs a given Python package into a running Canvas instance
-- `list`: Lists all plugins from the instance
-- `update`: Updates a plugin from an instance
-
-### `canvas plugin delete`
-
-Delete a disabled plugin from an instance.
-
-**Usage**:
-
-```console
-$ canvas plugin delete [OPTIONS] NAME
-```
-
-**Arguments**:
-
-- `NAME`: Plugin name to delete [required]
-
-**Options**:
-
-- `--host TEXT`: Canvas instance to connect to
-- `--api-key TEXT`: Canvas api-key for the provided host
-- `--help`: Show this message and exit.
-
-### `canvas plugin init`
-
-Create a plugin from a template using Cookiecutter.
-
-**Usage**:
-
-```console
-$ canvas plugin init [OPTIONS] [TEMPLATE]
-```
-
-**Arguments**:
-
-- `[TEMPLATE]`: [default: (dynamic)]
-
-**Options**:
-
-- `--no-input`: Don't prompt the user at command line
-- `--help`: Show this message and exit.
-
-### `canvas plugin install`
-
-Installs a given Python package into a running Canvas instance.
-
-**Usage**:
-
-```console
-$ canvas plugin install [OPTIONS] PACKAGE
-```
-
-**Arguments**:
-
-- `PACKAGE`: Path to either a dir or wheel or sdist file containing the python package to install [required]
-
-**Options**:
-
-- `--host TEXT`: Canvas instance to connect to
-- `--api-key TEXT`: Canvas api-key for the provided host
-- `--help`: Show this message and exit.
-
-### `canvas plugin list`
-
-Lists all plugins from the instance.
-
-**Usage**:
-
-```console
-$ canvas plugin list [OPTIONS]
-```
-
-**Options**:
-
-- `--host TEXT`: Canvas instance to connect to
-- `--api-key TEXT`: Canvas api-key for the provided host
-- `--help`: Show this message and exit.
-
-### `canvas plugin update`
-
-Updates a plugin from an instance.
-
-**Usage**:
-
-```console
-$ canvas plugin update [OPTIONS] NAME
-```
-
-**Arguments**:
-
-- `NAME`: Plugin name to update [required]
-
-**Options**:
-
-- `--package PATH`: Path to a wheel or sdist file containing the python package to install
-- `--enable / --disable`: Enable/disable the plugin
-- `--host TEXT`: Canvas instance to connect to
-- `--api-key TEXT`: Canvas api-key for the provided host
-- `--help`: Show this message and exit.
-
-## `canvas print-config`
-
-Simple command to print the config and exit.
-
-**Usage**:
-
-```console
-$ canvas print-config [OPTIONS]
-```
-
-**Options**:
-
-- `--help`: Show this message and exit.
-

canvas-0.1.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-canvas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-canvas/main.py,sha256=UPjM6iDT_aI30Ur0LHIt3tTiHlalVRn6OEquJhoZVc0,635
-canvas-0.1.4.dist-info/METADATA,sha256=6Jkv5-BiulGddkusL68Gu_Q3xrZVWLvdPJt3q17GzaY,5801
-canvas-0.1.4.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-canvas-0.1.4.dist-info/entry_points.txt,sha256=hsTDoLuwUTBak71S0KIxgSq-SVzf89Gh56UpbNwz5V8,42
-canvas-0.1.4.dist-info/RECORD,,

canvas-0.1.4.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-canvas=canvas.main:app
-