canvas 0.53.1__py3-none-any.whl → 0.54.0__py3-none-any.whl

canvas_generated/messages/plugins_pb2.py

@@ -14,7 +14,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'canvas_generated/messages/plugins.proto\"\x16\n\x14ReloadPluginsRequest\"(\n\x15ReloadPluginsResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'canvas_generated/messages/plugins.proto\"\x16\n\x14ReloadPluginsRequest\"(\n\x15ReloadPluginsResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"%\n\x13ReloadPluginRequest\x12\x0e\n\x06plugin\x18\x01 \x01(\t\"\'\n\x14ReloadPluginResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"%\n\x13UnloadPluginRequest\x12\x0e\n\x06plugin\x18\x01 \x01(\t\"\'\n\x14UnloadPluginResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -25,4 +25,12 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_RELOADPLUGINSREQUEST']._serialized_end=65
   _globals['_RELOADPLUGINSRESPONSE']._serialized_start=67
   _globals['_RELOADPLUGINSRESPONSE']._serialized_end=107
+  _globals['_RELOADPLUGINREQUEST']._serialized_start=109
+  _globals['_RELOADPLUGINREQUEST']._serialized_end=146
+  _globals['_RELOADPLUGINRESPONSE']._serialized_start=148
+  _globals['_RELOADPLUGINRESPONSE']._serialized_end=187
+  _globals['_UNLOADPLUGINREQUEST']._serialized_start=189
+  _globals['_UNLOADPLUGINREQUEST']._serialized_end=226
+  _globals['_UNLOADPLUGINRESPONSE']._serialized_start=228
+  _globals['_UNLOADPLUGINRESPONSE']._serialized_end=267
 # @@protoc_insertion_point(module_scope)

canvas_generated/messages/plugins_pb2.pyi

@@ -13,3 +13,27 @@ class ReloadPluginsResponse(_message.Message):
     SUCCESS_FIELD_NUMBER: _ClassVar[int]
     success: bool
     def __init__(self, success: bool = ...) -> None: ...
+
+class ReloadPluginRequest(_message.Message):
+    __slots__ = ("plugin",)
+    PLUGIN_FIELD_NUMBER: _ClassVar[int]
+    plugin: str
+    def __init__(self, plugin: _Optional[str] = ...) -> None: ...
+
+class ReloadPluginResponse(_message.Message):
+    __slots__ = ("success",)
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    success: bool
+    def __init__(self, success: bool = ...) -> None: ...
+
+class UnloadPluginRequest(_message.Message):
+    __slots__ = ("plugin",)
+    PLUGIN_FIELD_NUMBER: _ClassVar[int]
+    plugin: str
+    def __init__(self, plugin: _Optional[str] = ...) -> None: ...
+
+class UnloadPluginResponse(_message.Message):
+    __slots__ = ("success",)
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    success: bool
+    def __init__(self, success: bool = ...) -> None: ...

canvas_generated/services/plugin_runner_pb2.py

@@ -16,7 +16,7 @@ from canvas_generated.messages import events_pb2 as canvas__generated_dot_messag
 from canvas_generated.messages import plugins_pb2 as canvas__generated_dot_messages_dot_plugins__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n-canvas_generated/services/plugin_runner.proto\x12\x06\x63\x61nvas\x1a&canvas_generated/messages/events.proto\x1a\'canvas_generated/messages/plugins.proto2\x87\x01\n\x0cPluginRunner\x12\x35\n\x0bHandleEvent\x12\r.canvas.Event\x1a\x15.canvas.EventResponse0\x01\x12@\n\rReloadPlugins\x12\x15.ReloadPluginsRequest\x1a\x16.ReloadPluginsResponse0\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n-canvas_generated/services/plugin_runner.proto\x12\x06\x63\x61nvas\x1a&canvas_generated/messages/events.proto\x1a\'canvas_generated/messages/plugins.proto2\x85\x02\n\x0cPluginRunner\x12\x35\n\x0bHandleEvent\x12\r.canvas.Event\x1a\x15.canvas.EventResponse0\x01\x12@\n\rReloadPlugins\x12\x15.ReloadPluginsRequest\x1a\x16.ReloadPluginsResponse0\x01\x12=\n\x0cReloadPlugin\x12\x14.ReloadPluginRequest\x1a\x15.ReloadPluginResponse0\x01\x12=\n\x0cUnloadPlugin\x12\x14.UnloadPluginRequest\x1a\x15.UnloadPluginResponse0\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -24,5 +24,5 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'canvas_generated.services.p
 if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
   _globals['_PLUGINRUNNER']._serialized_start=139
-  _globals['_PLUGINRUNNER']._serialized_end=274
+  _globals['_PLUGINRUNNER']._serialized_end=400
 # @@protoc_insertion_point(module_scope)

canvas_generated/services/plugin_runner_pb2_grpc.py

@@ -25,6 +25,16 @@ class PluginRunnerStub(object):
                 request_serializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginsRequest.SerializeToString,
                 response_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.FromString,
                 )
+        self.ReloadPlugin = channel.unary_stream(
+                '/canvas.PluginRunner/ReloadPlugin',
+                request_serializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginRequest.SerializeToString,
+                response_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginResponse.FromString,
+                )
+        self.UnloadPlugin = channel.unary_stream(
+                '/canvas.PluginRunner/UnloadPlugin',
+                request_serializer=canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginRequest.SerializeToString,
+                response_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginResponse.FromString,
+                )
 
 
 class PluginRunnerServicer(object):
@@ -42,6 +52,18 @@ class PluginRunnerServicer(object):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def ReloadPlugin(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def UnloadPlugin(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_PluginRunnerServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -55,6 +77,16 @@ def add_PluginRunnerServicer_to_server(servicer, server):
                     request_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginsRequest.FromString,
                     response_serializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.SerializeToString,
             ),
+            'ReloadPlugin': grpc.unary_stream_rpc_method_handler(
+                    servicer.ReloadPlugin,
+                    request_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginRequest.FromString,
+                    response_serializer=canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginResponse.SerializeToString,
+            ),
+            'UnloadPlugin': grpc.unary_stream_rpc_method_handler(
+                    servicer.UnloadPlugin,
+                    request_deserializer=canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginRequest.FromString,
+                    response_serializer=canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginResponse.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'canvas.PluginRunner', rpc_method_handlers)
@@ -98,3 +130,37 @@ class PluginRunner(object):
             canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginsResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def ReloadPlugin(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/canvas.PluginRunner/ReloadPlugin',
+            canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginRequest.SerializeToString,
+            canvas__generated_dot_messages_dot_plugins__pb2.ReloadPluginResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def UnloadPlugin(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/canvas.PluginRunner/UnloadPlugin',
+            canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginRequest.SerializeToString,
+            canvas__generated_dot_messages_dot_plugins__pb2.UnloadPluginResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

canvas_sdk/caching/client.py

@@ -8,7 +8,9 @@ caches: dict[tuple[str, str], Cache] = {}
 
 
 def get_cache(
-    driver: str = "default", prefix: str = "", max_timeout_seconds: int | None = None
+    driver: str = "default",
+    prefix: str = "",
+    max_timeout_seconds: int | None = None,
 ) -> Cache:
     """Get the cache client based on the specified driver."""
     try:

canvas_sdk/caching/plugins.py

@@ -3,18 +3,21 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any
 
 from canvas_sdk.caching.client import get_cache as get_cache_client
-from canvas_sdk.utils.plugins import plugin_only
+from canvas_sdk.utils.plugins import plugin_context
 from settings import CANVAS_SDK_CACHE_TIMEOUT_SECONDS
 
 if TYPE_CHECKING:
     from canvas_sdk.caching.base import Cache
 
 
-@plugin_only
+@plugin_context
 def get_cache(**kwargs: Any) -> Cache:
     """Get the cache client for plugins."""
-    prefix = kwargs["plugin_name"]
-    return get_cache_client("plugins", prefix, CANVAS_SDK_CACHE_TIMEOUT_SECONDS)
+    return get_cache_client(
+        driver="plugins",
+        prefix=kwargs["plugin_name"],
+        max_timeout_seconds=CANVAS_SDK_CACHE_TIMEOUT_SECONDS,
+    )
 
 
 __exports__ = ("get_cache",)

canvas_sdk/effects/payment_processor.py

@@ -0,0 +1,137 @@
+from enum import StrEnum
+from typing import Any
+
+from canvas_sdk.effects import EffectType, _BaseEffect
+
+
+class PaymentProcessorMetadata(_BaseEffect):
+    """PaymentProcessorInfo effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__METADATA
+
+    class PaymentProcessorType(StrEnum):
+        """Enum for payment processor types."""
+
+        CARD = "card"
+
+    identifier: str
+    type: PaymentProcessorType
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the PaymentProcessorMetadata."""
+        return {
+            "identifier": self.identifier,
+            "type": self.type.value,
+        }
+
+
+class PaymentProcessorForm(_BaseEffect):
+    """PaymentProcessorForm effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__FORM
+
+    intent: str
+    content: str
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the PaymentProcessorMetadata."""
+        return {
+            "intent": self.intent,
+            "content": self.content,
+        }
+
+
+class CardTransaction(_BaseEffect):
+    """CardTransaction effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__CREDIT_CARD_TRANSACTION
+
+    success: bool
+    transaction_id: str | None
+    error_code: str | None = None
+    api_response: dict
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the CreditCardTransaction."""
+        return {
+            "success": self.success,
+            "transaction_id": self.transaction_id,
+            "api_response": self.api_response,
+            "error_code": self.error_code,
+        }
+
+
+class PaymentMethod(_BaseEffect):
+    """PaymentMethod effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD
+
+    payment_method_id: str
+    card_holder_name: str | None
+    brand: str
+    postal_code: str | None = None
+    country: str | None = None
+    expiration_year: int
+    expiration_month: int
+    card_last_four_digits: str
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the PaymentMethod."""
+        return {
+            "payment_method_id": self.payment_method_id,
+            "card_holder_name": self.card_holder_name,
+            "brand": self.brand,
+            "postal_code": self.postal_code,
+            "country": self.country,
+            "expiration_year": self.expiration_year,
+            "expiration_month": self.expiration_month,
+            "card_last_four_digits": self.card_last_four_digits,
+        }
+
+
+class AddPaymentMethodResponse(_BaseEffect):
+    """AddPaymentMethodResponse effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__ADD_RESPONSE
+
+    success: bool
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the AddPaymentMethodResponse."""
+        return {"success": self.success}
+
+
+class RemovePaymentMethodResponse(_BaseEffect):
+    """RemovePaymentMethodResponse effect class."""
+
+    class Meta:
+        effect_type = EffectType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHOD__REMOVE_RESPONSE
+
+    success: bool
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """Return the values of the RemovePaymentMethodResponse."""
+        return {
+            "success": self.success,
+        }
+
+
+__exports__ = (
+    "PaymentProcessorMetadata",
+    "PaymentProcessorForm",
+    "CardTransaction",
+    "PaymentMethod",
+    "AddPaymentMethodResponse",
+    "RemovePaymentMethodResponse",
+)

canvas_sdk/handlers/payment_processors/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

canvas_sdk/handlers/payment_processors/base.py

@@ -0,0 +1,93 @@
+import base64
+from abc import ABC
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.effects.payment_processor import PaymentProcessorMetadata
+from canvas_sdk.events import EventType
+from canvas_sdk.handlers import BaseHandler
+
+
+class PaymentProcessor(BaseHandler, ABC):
+    """
+    Abstract Base class for payment processors.
+    """
+
+    RESPONDS_TO = [
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__LIST),
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__SELECTED),
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__CHARGE),
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__LIST),
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__ADD),
+        EventType.Name(EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__REMOVE),
+    ]
+
+    TYPE: PaymentProcessorMetadata.PaymentProcessorType
+
+    @property
+    def identifier(self) -> str:
+        """The application identifier."""
+        identifier = f"{self.__class__.__module__}:{self.__class__.__qualname__}"
+
+        return base64.b64encode(identifier.encode("utf-8")).decode("utf-8")
+
+    def compute(self) -> list[Effect]:
+        """Compute the effects to be applied."""
+        if self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__LIST and (
+            "payment_type" not in self.event.context
+            or self.event.context["payment_type"] == self.TYPE
+        ):
+            return [self.metadata().apply()]
+        elif self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__SELECTED:
+            effects = self._on_payment_processor_selected()
+            return effects
+        elif self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__CHARGE:
+            effect = self._charge()
+            return [effect] if effect else []
+        elif self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__LIST:
+            # This event is used to list payment methods, which may not be applicable for all processors.
+            # Subclasses should override this method if they support listing payment methods.
+            return self._payment_methods()
+        elif self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__ADD:
+            effect = self._add_payment_method()
+            return [effect] if effect else []
+        elif self.event.type == EventType.REVENUE__PAYMENT_PROCESSOR__PAYMENT_METHODS__REMOVE:
+            effect = self._remove_payment_method()
+            return [effect] if effect else []
+
+        return []
+
+    def metadata(self) -> PaymentProcessorMetadata:
+        """Return information about the payment processor."""
+        return PaymentProcessorMetadata(identifier=self.identifier, type=self.TYPE)
+
+    def _on_payment_processor_selected(self) -> list[Effect]:
+        """Handle the event when a payment processor is selected."""
+        # This method should be overridden by subclasses to handle specific logic
+        # when a payment processor is selected.
+        return []
+
+    def _charge(self) -> Effect | None:
+        """Handle the event when a charge is made."""
+        # This method should be overridden by subclasses to handle specific logic
+        # when a charge is made.
+        return None
+
+    def _payment_methods(self) -> list[Effect]:
+        """List payment methods for the processor."""
+        # This method should be overridden by subclasses if they support listing payment methods.
+        return []
+
+    def _add_payment_method(self) -> Effect | None:
+        """Handle the event when a payment method is added."""
+        # This method should be overridden by subclasses to handle specific logic
+        # when a payment method is added.
+        return None
+
+    def _remove_payment_method(self) -> Effect | None:
+        """Handle the event when a payment method is removed."""
+        # This method should be overridden by subclasses to handle specific logic
+        # when a payment method is removed.
+        return None
+
+
+__exports__ = ("PaymentProcessor",)

canvas_sdk/handlers/payment_processors/card.py

@@ -0,0 +1,200 @@
+from abc import ABC, abstractmethod
+from decimal import Decimal
+from enum import StrEnum
+
+from canvas_sdk.effects import Effect
+from canvas_sdk.effects.payment_processor import (
+    AddPaymentMethodResponse,
+    CardTransaction,
+    PaymentMethod,
+    PaymentProcessorForm,
+    PaymentProcessorMetadata,
+    RemovePaymentMethodResponse,
+)
+from canvas_sdk.handlers.payment_processors.base import PaymentProcessor
+from canvas_sdk.v1.data import Patient
+
+
+class CardPaymentProcessor(PaymentProcessor, ABC):
+    """Base Card Payment Processor Handler."""
+
+    TYPE = PaymentProcessorMetadata.PaymentProcessorType.CARD
+
+    class PaymentIntent(StrEnum):
+        """Enum for payment actions."""
+
+        ADD_CARD = "add_card"
+        PAY = "pay"
+
+    def _on_payment_processor_selected(self) -> list[Effect]:
+        """Handle the event when a payment processor is selected."""
+        if self.event.context.get("identifier") == self.identifier:
+            intent = self.event.context.get("intent")
+            effects = self.on_payment_processor_selected(intent=intent)
+            return [effect.apply() for effect in effects]
+
+        return []
+
+    def _charge(self) -> Effect | None:
+        """Handle the event when a charge is made."""
+        if self.event.context.get("identifier") == self.identifier:
+            patient = (
+                Patient.objects.get(id=self.event.context.get("patient", {}).get("id"))
+                if self.event.context.get("patient")
+                else None
+            )
+
+            amount = Decimal(str(self.event.context.get("amount")))
+            token = str(self.event.context.get("token"))
+            effect = self.charge(amount=amount, token=token, patient=patient)
+
+            return effect.apply() if effect else None
+
+        return None
+
+    def _payment_methods(self) -> list[Effect]:
+        """List payment methods for the card payment processor."""
+        if self.event.context.get("identifier") == self.identifier:
+            patient = (
+                Patient.objects.get(id=self.event.context.get("patient", {}).get("id"))
+                if self.event.context.get("patient")
+                else None
+            )
+            effects = self.payment_methods(patient=patient)
+            return [effect.apply() for effect in effects]
+
+        return []
+
+    def _add_payment_method(self) -> Effect | None:
+        """Handle the event when a card is added."""
+        if self.event.context.get("identifier") == self.identifier:
+            patient = (
+                Patient.objects.get(id=self.event.context.get("patient", {}).get("id"))
+                if self.event.context.get("patient")
+                else None
+            )
+
+            if not patient:
+                return None
+
+            token = str(self.event.context.get("token"))
+            effect = self.add_payment_method(token=token, patient=patient)
+            return effect.apply() if effect else None
+
+        return None
+
+    def _remove_payment_method(self) -> Effect | None:
+        """Handle the event when a payment method is removed."""
+        if self.event.context.get("identifier") == self.identifier:
+            patient = (
+                Patient.objects.get(id=self.event.context.get("patient", {}).get("id"))
+                if self.event.context.get("patient")
+                else None
+            )
+
+            if not patient:
+                return None
+
+            token = str(self.event.context.get("token"))
+            effect = self.remove_payment_method(token=token, patient=patient)
+            return effect.apply() if effect else None
+
+        return None
+
+    def on_payment_processor_selected(self, intent: str | None) -> list[PaymentProcessorForm]:
+        """Handle the event when a payment processor is selected."""
+        patient = (
+            Patient.objects.get(id=self.event.context.get("patient", {}).get("id"))
+            if self.event.context.get("patient")
+            else None
+        )
+        match intent:
+            case self.PaymentIntent.ADD_CARD:
+                return [self.add_card_form(patient)]
+            case self.PaymentIntent.PAY:
+                return [self.payment_form(patient)]
+            case None:
+                return [self.payment_form(patient), self.add_card_form(patient)]
+            case _:
+                return []
+
+    @abstractmethod
+    def payment_form(self, patient: Patient | None = None) -> PaymentProcessorForm:
+        """Return the payment form for the credit card processor.
+
+        Args:
+            patient (Patient | None): The patient for whom the payment is being processed.
+
+        Returns:
+            PaymentProcessorForm: The form for processing the payment.
+        """
+        raise NotImplementedError("Subclasses must implement the payment_form method.")
+
+    @abstractmethod
+    def add_card_form(self, patient: Patient | None = None) -> PaymentProcessorForm:
+        """Return the form for adding a card.
+
+        Args:
+            patient (Patient | None): The patient for whom the add is being added.
+
+        Returns:
+            PaymentProcessorForm: The form for adding a card.
+        """
+        raise NotImplementedError("Subclasses must implement the add_card_form method.")
+
+    @abstractmethod
+    def charge(
+        self, amount: Decimal, token: str, patient: Patient | None = None
+    ) -> CardTransaction:
+        """Charge a credit/debit card using the provided token.
+
+        Args:
+            amount (Decimal): The amount to charge.
+            token (str): The token representing the credit card.
+            patient (Patient | None): The patient for whom the charge is being made.
+
+        Returns:
+            CardTransaction: The result of the card transaction.
+        """
+        raise NotImplementedError("Subclasses must implement the charge method.")
+
+    @abstractmethod
+    def payment_methods(self, patient: Patient | None = None) -> list[PaymentMethod]:
+        """List payment methods for the card payment processor.
+
+        Args:
+            patient (Patient | None): The patient for whom the payment methods are being listed.
+
+        Returns:
+            list[PaymentMethod]: A list of payment methods available for the card payment processor.
+        """
+        raise NotImplementedError("Subclasses must implement the payment_methods method.")
+
+    @abstractmethod
+    def add_payment_method(self, token: str, patient: Patient) -> AddPaymentMethodResponse:
+        """Add a payment method for the card payment processor.
+
+        Args:
+            token (str): The token representing the payment method.
+            patient (Patient): The patient for whom the payment method is being added.
+
+        Returns:
+            AddPaymentMethodResponse: The response indicating the result of the addition operation.
+        """
+        raise NotImplementedError("Subclasses must implement the add_payment_method method.")
+
+    @abstractmethod
+    def remove_payment_method(self, token: str, patient: Patient) -> RemovePaymentMethodResponse:
+        """Remove a payment method for the card payment processor.
+
+        Args:
+            token (str): The token representing the payment method to be removed.
+            patient (Patient): The patient for whom the payment method is being removed.
+
+        Returns:
+            RemovePaymentMethodResponse: The response indicating the result of the removal operation.
+        """
+        raise NotImplementedError("Subclasses must implement the remove_payment_method method.")
+
+
+__exports__ = ("CardPaymentProcessor",)

canvas_sdk/questionnaires/utils.py

@@ -7,7 +7,7 @@ from typing import Any, TypedDict
 import yaml
 from jsonschema import Draft7Validator, validators
 
-from canvas_sdk.utils.plugins import plugin_only
+from canvas_sdk.utils.plugins import plugin_context
 
 
 class Response(TypedDict):
@@ -75,7 +75,7 @@ def extend_with_defaults(validator_class: type[Draft7Validator]) -> type[Draft7V
 ExtendedDraft7Validator = extend_with_defaults(Draft7Validator)
 
 
-@plugin_only
+@plugin_context
 def from_yaml(questionnaire_name: str, **kwargs: Any) -> QuestionnaireConfig | None:
     """Load a Questionnaire configuration from a YAML file.
 

canvas_sdk/templates/utils.py

@@ -3,12 +3,14 @@ from typing import Any
 
 from django.template import Context, Template
 
-from canvas_sdk.utils.plugins import plugin_only
+from canvas_sdk.utils.plugins import plugin_context
 
 
-@plugin_only
+@plugin_context
 def render_to_string(
-    template_name: str, context: dict[str, Any] | None = None, **kwargs: Any
+    template_name: str,
+    context: dict[str, Any] | None = None,
+    **kwargs: Any,
 ) -> str | None:
     """Load a template and render it with the given context.