Changeset 12295

Timestamp:

22 Dec 2014, 16:14:04 (10 years ago)

Author:

uli

Message:

Extend interfaces.

Location:

main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments

Files:

• interfaces.py (modified) (5 diffs)
• tests/test_interfaces.py (modified) (2 diffs)

main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/interfaces.py

@@ -17 +17 @@
 ##
 import decimal
+from zc.sourcefactory.basic import BasicSourceFactory
 from zope import schema
+from zope.component import getUtilitiesFor
 from zope.interface import Interface
 from waeup.ikoba.interfaces import (
     IIkobaObject, SimpleIkobaVocabulary, ContextualDictSourceFactoryBase)
 from waeup.ikoba.interfaces import MessageFactory as _
-
+from waeup.ikoba.payments.currencies import ISO_4217_CURRENCIES_VOCAB
 
 #: Possible states of payments
@@ -36 +38 @@
 
 
+class PaymentGatewayServicesSource(BasicSourceFactory):
+    """A source that lists available payment services.
+
+    Suitable for forms etc. Token and value correspond to the name the
+    respective IPaymentGatewayService utility is registered with.
+    """
+
+    _services = None
+
+    @classmethod
+    def services(cls):
+        """Cache the services registered on startup.
+
+        We assume that services do not change after startup.
+        """
+        if cls._services is None:
+            cls._services = dict(getUtilitiesFor(IPaymentGatewayService))
+        return cls._services
+
+    def getValues(self):
+        """Get payment gateway registration names.
+        """
+        return sorted(PaymentGatewayServicesSource.services().keys())
+
+    def getTitle(self, value):
+        """Get title of the respective service, if it exists.
+        """
+        service = PaymentGatewayServicesSource.services().get(value, None)
+        if service is not None:
+            return service.title
+
+
 class IPaymentGatewayService(Interface):
     """A financial gateway service.
@@ -51 +85 @@
         required=True,
         )
+
+    def create_payment(payer_id, payee_id, payment_item_id):
+        """Create a payment.
+        """
 
 
@@ -105 +143 @@
     payed_item_id = schema.TextLine(
         title=u'Payed Item ID',
+        default=None,
+        required=True,
+        )
+
+    gateway_service = schema.Choice(
+        title=u'Payment Gateway',
+        description=u'Payment gateway that handles this transaction.',
+        source=PaymentGatewayServicesSource(),
         default=None,
         required=True,
@@ -188 +234 @@
     def approve():
         "Approve an online payment and set to paid."
+
+
+class IPayer(Interface):
+    """A payer.
+    """
+    payer_id = schema.TextLine(
+        title=u'Payer ID',
+        required=True,
+        )
+
+
+class IPayee(Interface):
+    """A person or institution being paid.
+    """
+    payee_id = schema.TextLine(
+        title=u'Payee ID',
+        required=True
+        )
+
+
+class IPaymentItem(Interface):
+    """Something to sell.
+    """
+    item_id = schema.TextLine(
+        title=u'Payment Item ID',
+        required=True,
+        )
+
+    title = schema.TextLine(
+        title=u'Title',
+        description=u'A short title of the good sold.',
+        required=True,
+        default=u'Unnamed'
+        )
+
+    amount = schema.Decimal(
+        title=u'Amount',
+        description=u'Total amount, includung any taxes, fees, etc.',
+        required=True,
+        default=decimal.Decimal('0.00'),
+        )
+
+    currency = schema.Choice(
+        title=u'Currency',
+        source=ISO_4217_CURRENCIES_VOCAB,
+        required=True,
+        default='USD',
+        )

main/waeup.ikoba/branches/uli-payments/src/waeup/ikoba/payments/tests/test_interfaces.py

@@ -20 +20 @@
 """
 from zope.interface.verify import verifyClass, verifyObject
-from waeup.ikoba.payments.interfaces import IPaymentsContainer
+from waeup.ikoba.payments.interfaces import (
+    IPaymentsContainer, PaymentGatewayServicesSource,
+    )
 from waeup.ikoba.payments.container import PaymentsContainer
 from waeup.ikoba.testing import (FunctionalLayer, FunctionalTestCase)
@@ -48 +50 @@
         self.assertRaises(
             NotImplementedError, container.clear)
+
+    def test_payment_gateway_services_source(self):
+        # the payment gateway services source provides a list of registered
+        # payment gateways
+        source = PaymentGatewayServicesSource()
+        services = list(source)
+        assert len(services) > 0
+
+    def test_payment_gateway_services_source_title(self):
+        # we can get titles from gateway sources
+        source = PaymentGatewayServicesSource()
+        service1 = list(source)[0]
+        title = source.factory.getTitle(service1)
+        assert title != service1
+        assert isinstance(title, basestring)