canvas 0.32.0__py3-none-any.whl → 0.33.1__py3-none-any.whl

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v1/CANVAS_MANIFEST.json

@@ -1,29 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_module_imports_outside_plugin_v1",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_module_imports_outside_plugin_v1.protocols.my_protocol:Protocol",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v1/README.md

@@ -1,12 +0,0 @@
-==========================
-test_module_imports_outside_plugin_v1
-==========================
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v1/other_module/base.py

@@ -1,3 +0,0 @@
-def import_me() -> str:
-    """Test method."""
-    return "Successfully imported!"

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v1/protocols/my_protocol.py

@@ -1,18 +0,0 @@
-from test_module_imports_plugin.other_module.base import import_me
-
-from canvas_sdk.effects import Effect, EffectType
-from canvas_sdk.events import EventType
-from canvas_sdk.protocols import BaseProtocol
-
-
-class Protocol(BaseProtocol):
-    """
-    You should put a helpful description of this protocol's behavior here.
-    """
-
-    # Name the event type you wish to run in response to
-    RESPONDS_TO = EventType.Name(EventType.UNKNOWN)
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [Effect(type=EffectType.LOG, payload=import_me())]

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v2/CANVAS_MANIFEST.json

@@ -1,29 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_module_imports_outside_plugin_v2",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_module_imports_outside_plugin_v2.protocols.my_protocol:Protocol",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v2/README.md

@@ -1,12 +0,0 @@
-==========================
-test_module_imports_outside_plugin_v2
-==========================
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v2/other_module/base.py

@@ -1,6 +0,0 @@
-import os
-
-
-def import_me() -> list[str]:
-    """Test method."""
-    return os.listdir(".")

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v2/protocols/my_protocol.py

@@ -1,18 +0,0 @@
-from test_module_imports_outside_plugin_v2.other_module.base import import_me
-
-from canvas_sdk.effects import Effect, EffectType
-from canvas_sdk.events import EventType
-from canvas_sdk.protocols import BaseProtocol
-
-
-class Protocol(BaseProtocol):
-    """
-    You should put a helpful description of this protocol's behavior here.
-    """
-
-    # Name the event type you wish to run in response to
-    RESPONDS_TO = EventType.Name(EventType.UNKNOWN)
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [Effect(type=EffectType.LOG, payload=import_me())]

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v3/CANVAS_MANIFEST.json

@@ -1,29 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_module_imports_outside_plugin_v3",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_module_imports_outside_plugin_v3.protocols.my_protocol:Protocol",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v3/README.md

@@ -1,12 +0,0 @@
-==========================
-test_module_imports_outside_plugin_v3
-==========================
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v3/other_module/base.py

@@ -1,8 +0,0 @@
-from ...test_module_imports_outside_plugin_v2.other_module.base import (
-    import_me as other_module_import_me,
-)
-
-
-def import_me() -> list[str]:
-    """Test method."""
-    return other_module_import_me()

plugin_runner/tests/fixtures/plugins/test_module_imports_outside_plugin_v3/protocols/my_protocol.py

@@ -1,18 +0,0 @@
-from test_module_imports_outside_plugin_v3.other_module.base import import_me
-
-from canvas_sdk.effects import Effect, EffectType
-from canvas_sdk.events import EventType
-from canvas_sdk.protocols import BaseProtocol
-
-
-class Protocol(BaseProtocol):
-    """
-    You should put a helpful description of this protocol's behavior here.
-    """
-
-    # Name the event type you wish to run in response to
-    RESPONDS_TO = EventType.Name(EventType.UNKNOWN)
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [Effect(type=EffectType.LOG, payload=import_me())]

plugin_runner/tests/fixtures/plugins/test_module_imports_plugin/CANVAS_MANIFEST.json

@@ -1,29 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_module_imports_plugin",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_module_imports_plugin.protocols.my_protocol:Protocol",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_module_imports_plugin/README.md

@@ -1,12 +0,0 @@
-==========================
-test_module_imports_plugin
-==========================
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_module_imports_plugin/other_module/base.py

@@ -1,3 +0,0 @@
-def import_me() -> str:
-    """Test method."""
-    return "Successfully imported!"

plugin_runner/tests/fixtures/plugins/test_module_imports_plugin/protocols/my_protocol.py

@@ -1,18 +0,0 @@
-from test_module_imports_plugin.other_module.base import import_me
-
-from canvas_sdk.effects import Effect, EffectType
-from canvas_sdk.events import EventType
-from canvas_sdk.protocols import BaseProtocol
-
-
-class Protocol(BaseProtocol):
-    """
-    You should put a helpful description of this protocol's behavior here.
-    """
-
-    # Name the event type you wish to run in response to
-    RESPONDS_TO = EventType.Name(EventType.UNKNOWN)
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [Effect(type=EffectType.LOG, payload=import_me())]

plugin_runner/tests/fixtures/plugins/test_render_template/CANVAS_MANIFEST.json

@@ -1,47 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_render_template",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_render_template.protocols.my_protocol:ValidTemplate",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            },
-             {
-                "class": "test_render_template.protocols.my_protocol:InvalidTemplate",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            },
-             {
-                "class": "test_render_template.protocols.my_protocol:ForbiddenTemplate",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_render_template/README.md

@@ -1,11 +0,0 @@
-test_render_template
-====================
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_render_template/protocols/my_protocol.py

@@ -1,43 +0,0 @@
-from canvas_sdk.effects import Effect, EffectType
-from canvas_sdk.events import EventType
-from canvas_sdk.protocols import BaseProtocol
-from canvas_sdk.templates import render_to_string
-
-
-class ValidTemplate(BaseProtocol):
-    """You should put a helpful description of this protocol's behavior here."""
-
-    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [
-            Effect(type=EffectType.LOG, payload=render_to_string("templates/template.html", None))
-        ]
-
-
-class InvalidTemplate(BaseProtocol):
-    """You should put a helpful description of this protocol's behavior here."""
-
-    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [
-            Effect(type=EffectType.LOG, payload=render_to_string("templates/template1.html", None))
-        ]
-
-
-class ForbiddenTemplate(BaseProtocol):
-    """You should put a helpful description of this protocol's behavior here."""
-
-    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
-
-    def compute(self) -> list[Effect]:
-        """This method gets called when an event of the type RESPONDS_TO is fired."""
-        return [
-            Effect(
-                type=EffectType.LOG,
-                payload=render_to_string("../../templates/template.html", None),
-            )
-        ]

plugin_runner/tests/fixtures/plugins/test_render_template/templates/template.html

@@ -1,10 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-  </head>
-  <body>
-
-  </body>
-</html>

plugin_runner/tests/fixtures/plugins/test_simple_api/CANVAS_MANIFEST.json

@@ -1,47 +0,0 @@
-{
-    "sdk_version": "0.1.4",
-    "plugin_version": "0.0.1",
-    "name": "test_simple_api",
-    "description": "Edit the description in CANVAS_MANIFEST.json",
-    "components": {
-        "protocols": [
-            {
-                "class": "test_simple_api.protocols.my_protocol:Route",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            },
-            {
-                "class": "test_simple_api.protocols.my_protocol:ErrorRoute1",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            },
-            {
-                "class": "test_simple_api.protocols.my_protocol:ErrorRoute2",
-                "description": "A protocol that does xyz...",
-                "data_access": {
-                    "event": "",
-                    "read": [],
-                    "write": []
-                }
-            }
-        ],
-        "commands": [],
-        "content": [],
-        "effects": [],
-        "views": []
-    },
-    "secrets": [],
-    "tags": {},
-    "references": [],
-    "license": "",
-    "diagram": false,
-    "readme": "./README.md"
-}

plugin_runner/tests/fixtures/plugins/test_simple_api/README.md

@@ -1,11 +0,0 @@
-test_simple_api
-===============
-
-## Description
-
-A description of this plugin
-
-### Important Note!
-
-The CANVAS_MANIFEST.json is used when installing your plugin. Please ensure it
-gets updated if you add, remove, or rename protocols.

plugin_runner/tests/fixtures/plugins/test_simple_api/protocols/my_protocol.py

@@ -1,43 +0,0 @@
-from http import HTTPStatus
-
-from canvas_sdk.effects import Effect
-from canvas_sdk.effects.simple_api import Response
-from canvas_sdk.handlers.simple_api import Credentials, SimpleAPIRoute
-
-
-class NoAuth(SimpleAPIRoute):
-    """SimpleAPIRoute base class to bypass authentication."""
-
-    def authenticate(self, credentials: Credentials) -> bool:
-        """Authenticate the request."""
-        return True
-
-
-class Route(NoAuth):
-    """Handler for /route."""
-
-    PATH = "/route"
-
-    def get(self) -> list[Response | Effect]:
-        """Handler method for GET."""
-        return [Response(status_code=HTTPStatus.OK)]
-
-
-class ErrorRoute1(NoAuth):
-    """Handler #1 for /error."""
-
-    PATH = "/error"
-
-    def get(self) -> list[Response | Effect]:
-        """Handler method for GET."""
-        return [Response(status_code=HTTPStatus.OK)]
-
-
-class ErrorRoute2(NoAuth):
-    """Handler #2 for /error."""
-
-    PATH = "/error"
-
-    def get(self) -> list[Response | Effect]:
-        """Handler method for GET."""
-        return [Response(status_code=HTTPStatus.OK)]

plugin_runner/tests/test_application.py

@@ -1,65 +0,0 @@
-import pytest
-
-from canvas_sdk.effects import Effect
-from canvas_sdk.effects.launch_modal import LaunchModalEffect
-from canvas_sdk.events import Event, EventRequest, EventType
-from canvas_sdk.handlers.application import Application
-
-
-class ExampleApplication(Application):
-    """A concrete implementation of the Application class for testing."""
-
-    def on_open(self) -> Effect:
-        """Handle the application open event by returning a mock effect."""
-        return LaunchModalEffect(url="https://example.com").apply()
-
-
-@pytest.fixture
-def app_instance(event: Event) -> ExampleApplication:
-    """Provide an instance of the TestApplication with a mocked event."""
-    app = ExampleApplication(event)
-    return app
-
-
-def test_compute_event_not_targeted() -> None:
-    """Test that compute filters out events not targeted for the app."""
-    request = EventRequest(type=EventType.APPLICATION__ON_OPEN, target="some_identifier")
-    event = Event(request)
-    app = ExampleApplication(event)
-
-    result = app.compute()
-
-    assert result == [], "Expected no effects if the event target is not the app identifier"
-
-
-def test_compute_event_targeted() -> None:
-    """Test that compute processes events targeted for the app."""
-    request = EventRequest(
-        type=EventType.APPLICATION__ON_OPEN,
-        target=f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}",
-    )
-    event = Event(request)
-    app = ExampleApplication(event)
-    result = app.compute()
-
-    assert len(result) == 1, "Expected a single effect if the event target is the app identifier"
-    assert isinstance(result[0], Effect), "Effect should be an instance of Effect"
-
-
-def test_identifier_property() -> None:
-    """Test the identifier property of the Application class."""
-    expected_identifier = f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}"
-    request = EventRequest(
-        type=EventType.APPLICATION__ON_OPEN,
-        target=f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}",
-    )
-    event = Event(request)
-    app = ExampleApplication(event)
-
-    assert app.identifier == expected_identifier, "The identifier property is incorrect"
-
-
-def test_abstract_method_on_open() -> None:
-    """Test that the abstract method on_open must be implemented."""
-    with pytest.raises(TypeError):
-        Application(Event(EventRequest(type=EventType.UNKNOWN)))  # type: ignore[abstract]