wagtail-longclaw/longclaw/longclawcheckout/gateways/base.py

from longclaw.longclawcheckout.utils import PaymentError

class BasePayment():
    '''
    Provides the interface for payment backends and
    can function as a dummy backend for testing.
    '''

    def create_payment(self, request, amount, description=''):
        '''
        Dummy function for creating a payment through a payment gateway.
        Should be overridden in gateway implementations.
        Can be used for testing - to simulate a failed payment/error,
        pass `error: true` in the request data.
        '''
        err = request.data.get("error", False)
        if err:
            raise PaymentError("Dummy error requested")

        return 'fake_transaction_id'

    def get_token(self, request):
        '''
        Dummy function for generating a client token through
        a payment gateway. Most (all?) gateways have a flow which
        involves requesting a token from the server (usually to
        tokenize the payment method) and then passing that token
        to another api endpoint to create the payment.

        This function should be overriden in child classes
        '''
        return 'dummy_token'