Changeset 12663

Timestamp:

5 Mar 2015, 07:28:31 (10 years ago)

Author:

Henrik Bettermann

Message:

Extend contract workflow to integrate payment.

Prepare (empty) page to select payment method and finally create a payment object.

Location:

main/waeup.ikoba/trunk/src/waeup/ikoba

Files:

• customers/browser.py (modified) (5 diffs)
• customers/browser_templates/selectpaymentmethodpage.pt (added)
• customers/contracts.py (modified) (1 diff)
• customers/interfaces.py (modified) (1 diff)
• customers/reports/contract_statistics.py (modified) (3 diffs)
• customers/reports/tests/test_contract_statistics.py (modified) (2 diffs)
• customers/tests/test_browser.py (modified) (1 diff)
• customers/tests/test_export.py (modified) (4 diffs)
• customers/utils.py (modified) (2 diffs)
• customers/workflow.py (modified) (5 diffs)
• interfaces.py (modified) (1 diff)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/browser.py

@@ -60 +60 @@
     )
 from waeup.ikoba.customers.catalog import search
+from waeup.ikoba.customers.workflow import PAYMENT_TRANSITIONS
 
 grok.context(IIkobaObject)
@@ -1446 +1447 @@
     grok.require('waeup.handleCustomer')
 
+    def submission_allowed(self, action=None):
+        if self.context.state == CREATED and not self.context.fee_based:
+            return True
+        return False
+
+    def payment_expected(self, action=None):
+        if self.context.state == CREATED and self.context.fee_based:
+            return True
+        return False
+
     @property
     def form_fields(self):
@@ -1456 +1467 @@
         return
 
-    @action(_('Apply now (final submit)'), warning=WARNING_CON)
-    def finalsubmit(self, **data):
+    @action(_('Apply now (final submission)'), warning=WARNING_CON,
+            condition=submission_allowed, style='primary')
+    def submit(self, **data):
         if self.terms_and_conditions and not self.request.form.get(
             'confirm_tc', False):
@@ -1466 +1478 @@
         msave(self, **data)
         IWorkflowInfo(self.context).fireTransition('submit')
-        self.flash(_('Form has been submitted.'))
+        self.flash(_('Application form has been submitted.'))
         self.redirect(self.url(self.context))
         return
 
+    @action(_('Proceed to checkout'),
+            condition=payment_expected, style='primary')
+    def proceed_checkout(self, **data):
+        if self.terms_and_conditions and not self.request.form.get(
+            'confirm_tc', False):
+            self.flash(_('Please read the terms and conditions and '
+                     'confirm your acceptance of these by ticking '
+                     'the confirmation box.'), type="danger")
+            return
+        msave(self, **data)
+        self.redirect(self.url(self.context, 'select_payment_method'))
+        return
+
+
+class SelectPaymentMethodPage(IkobaEditFormPage):
+    """ Page to to select payment method
+    """
+    grok.context(IContract)
+    grok.name('select_payment_method')
+    grok.require('waeup.handleCustomer')
+    grok.template('selectpaymentmethodpage')
+    pnav = 4
+    label = _('Select payment method')
+
+    def update(self, CANCEL=None):
+        if self.context.state != CREATED or not self.context.fee_based:
+            emit_lock_message(self)
+            return
+        super(SelectPaymentMethodPage, self).update()
+        return
+
+    @action(_('Select payment method and proceed to payment gateway (final submission)'),
+            style='primary', warning=WARNING_CON,)
+    def confirm(self, **data):
+        IWorkflowInfo(self.context).fireTransition('await')
+        self.flash(_('Payment has been initiated.'))
+        return
 
 class ContractTriggerTransitionFormPage(IkobaEditFormPage):
@@ -1493 +1542 @@
         wf_info = IWorkflowInfo(self.context)
         allowed_transitions = [t for t in wf_info.getManualTransitions()]
+        # Skip payment transitions if total amount is zero
+        if not self.context.fee_based:
+            allowed_transitions = [t for t in allowed_transitions
+                                   if not t[0] in PAYMENT_TRANSITIONS]
         return [dict(name='', title=_('No transition'))] +[
             dict(name=x, title=y) for x, y in allowed_transitions]

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/contracts.py

@@ -161 +161 @@
             return
 
+    @property
+    def fee_based(self):
+        if self.product_options:
+            amount = 0
+            for option in self.product_options:
+                amount += option.fee
+            if amount:
+                return True
+        return False
+
 
 class SampleContract(ContractBase):

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/interfaces.py

@@ -303 +303 @@
     valid_from = Attribute('Contract valid from')
     valid_to = Attribute('Contract valid to')
+    fee_based = Attribute('Fee based contract')
 
     contract_id = schema.TextLine(

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/reports/contract_statistics.py

@@ -22 +22 @@
 from zope.interface import implementer, Interface, Attribute
 from waeup.ikoba.interfaces import (
-    IIkobaUtils, CREATED, APPROVED, SUBMITTED, EXPIRED, REJECTED)
+    IIkobaUtils,
+    CREATED, APPROVED,
+    SUBMITTED, EXPIRED,
+    REJECTED, AWAITING)
 from waeup.ikoba.customers.interfaces import ICustomersUtils
 from waeup.ikoba.interfaces import MessageFactory as _
@@ -54 +57 @@
     types = TYPES.keys()
     type_names = tuple(TYPES.values()) + (u'All',)
-    states = (CREATED, SUBMITTED, APPROVED, EXPIRED, REJECTED)
+    states = (CREATED, AWAITING, SUBMITTED, APPROVED, EXPIRED, REJECTED)
     STATES = getUtility(ICustomersUtils).TRANSLATED_CONTRACT_STATES
     state_names = tuple([STATES[state] for state in states]) + (u'Total',)
@@ -108 +111 @@
     ('LINEAFTER', (-1,0), (-1,-1), 0.25, colors.black),
     ('LINEBEFORE', (-1,0), (-1,-1), 1.0, colors.black),
-    #('LINEABOVE', (0,-1), (-1,-1), 1.0, colors.black),
+    ('LINEABOVE', (0,-1), (-1,-1), 1.0, colors.black),
     #('LINEABOVE', (0,0), (-1,0), 0.25, colors.black),
     ]

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/reports/tests/test_contract_statistics.py

@@ -17 +17 @@
     layer = FunctionalLayer
 
-    states = ('created', 'submitted for approval',  'approved', 'expired',
+    states = ('created', 'awaiting payment',
+              'submitted for approval',
+              'approved', 'expired',
               'rejected', 'Total')
 
@@ -34 +36 @@
             ((u'Sample Contract', u'All'),
              self.states,
-             ((1, 0, 0, 0, 0, 1),
-              (1, 0, 0, 0, 0, 1),))
+             ((1, 0, 0, 0, 0, 0, 1),
+              (1, 0, 0, 0, 0, 0, 1),))
             )
         return

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_browser.py

@@ -1417 +1417 @@
         # The form is also saved.
         self.browser.getLink("Edit").click()
-        self.browser.getControl("Apply").click()
+        self.browser.getControl("Proceed to checkout").click()
         self.assertTrue('confirm your acceptance of these by ticking' in self.browser.contents)
         self.assertEqual(contract.state, 'created')
         self.browser.getControl(name="confirm_tc").value = True
-        self.browser.getControl("Apply").click()
-        self.assertEqual(contract.state, 'submitted')
-        self.assertTrue('Contract State: submitted for approval' in self.browser.contents)
+        self.browser.getControl("Proceed to checkout").click()
+        self.assertEqual(contract.state, 'created')
+        self.browser.getControl("Select payment method").click()
+        self.assertEqual(contract.state, 'awaiting')
         # Customer can't edit the contract once it has been submitted
         self.browser.open(self.contracts_path + '/%s/edit' % conid)

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/tests/test_export.py

@@ -256 +256 @@
             result,
             'class_name,comment,contract_category,contract_id,document_object,'
-            'history,last_product_id,'
-            'product_object,product_options,state,tc_dict,title,user_id,'
-            'valid_from,valid_to\r\n'
-
-            'SampleContract,,sample,CON1,,[],,,[],,{},,,,\r\n'
+            'fee_based,history,last_product_id,'
+            'product_object,product_options,state,tc_dict,title,'
+            'user_id,valid_from,valid_to\r\n'
+
+            'SampleContract,,sample,CON1,,0,[],,,[],,{},,,,\r\n'
             )
         return
@@ -273 +273 @@
         self.assertMatches(
             'class_name,comment,contract_category,contract_id,document_object,'
-            'history,last_product_id,'
-            'product_object,product_options,state,tc_dict,title,user_id,'
-            'valid_from,valid_to\r\n'
-
-            'SampleContract,,sample,CON1,DOC1,[u\'2014-12-04 12:10:46 UTC - '
+            'fee_based,history,last_product_id,'
+            'product_object,product_options,state,tc_dict,title,'
+            'user_id,valid_from,valid_to\r\n'
+
+            'SampleContract,,sample,CON1,DOC1,1,[u\'2014-12-04 12:10:46 UTC - '
             'Contract created by system\'],,'
             'SAM,"[(u\'Base Fee\', u\'800.6\', u\'USD\')]",'
@@ -295 +295 @@
         self.assertMatches(
             'class_name,comment,contract_category,contract_id,document_object,'
-            'history,last_product_id,'
-            'product_object,product_options,state,tc_dict,title,user_id,'
-            'valid_from,valid_to\r\n'
-
-            'SampleContract,,sample,CON1,DOC1,[u\'2014-12-04 12:10:46 UTC - '
+            'fee_based,history,last_product_id,'
+            'product_object,product_options,state,tc_dict,title,'
+            'user_id,valid_from,valid_to\r\n'
+
+            'SampleContract,,sample,CON1,DOC1,1,[u\'2014-12-04 12:10:46 UTC - '
             'Contract created by system\'],,'
             'SAM,"[(u\'Base Fee\', u\'800.6\', u\'USD\')]",'
@@ -317 +317 @@
         self.assertMatches(
             'class_name,comment,contract_category,contract_id,document_object,'
-            'history,last_product_id,'
-            'product_object,product_options,state,tc_dict,title,user_id,'
-            'valid_from,valid_to\r\n'
-
-            'SampleContract,,sample,CON1,DOC1,[u\'2014-12-04 12:10:46 UTC - '
+            'fee_based,history,last_product_id,'
+            'product_object,product_options,state,tc_dict,title,'
+            'user_id,valid_from,valid_to\r\n'
+
+            'SampleContract,,sample,CON1,DOC1,1,[u\'2014-12-04 12:10:46 UTC - '
             'Contract created by system\'],,'
             'SAM,"[(u\'Base Fee\', u\'800.6\', u\'USD\')]",'

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/utils.py

@@ -38 +38 @@
 from waeup.ikoba.interfaces import (
     STARTED, CREATED, REQUESTED, APPROVED, SUBMITTED, VERIFIED, REJECTED,
-    EXPIRED, PROVISIONALLY,
+    EXPIRED, PROVISIONALLY, AWAITING,
     IIkobaUtils, IExtFileStore)
 from waeup.ikoba.customers.interfaces import ICustomersUtils
@@ -308 +308 @@
     TRANSLATED_CONTRACT_STATES = {
         CREATED: _('created'),
+        AWAITING: _('awaiting payment'),
         SUBMITTED: _('submitted for approval'),
         APPROVED: _('approved'),

main/waeup.ikoba/trunk/src/waeup/ikoba/customers/workflow.py

@@ -28 +28 @@
     IObjectHistory, IIkobaWorkflowInfo, IIkobaUtils, IUserAccount,
     STARTED, CREATED, REQUESTED, PROVISIONALLY, APPROVED,
-    SUBMITTED, VERIFIED, REJECTED, EXPIRED)
+    SUBMITTED, VERIFIED, REJECTED, EXPIRED, AWAITING)
 from waeup.ikoba.interfaces import MessageFactory as _
 from waeup.ikoba.workflow import (
@@ -191 +191 @@
 
     Transition(
+        transition_id = 'await',
+        title = _('Initiate payment'),
+        source = CREATED,
+        condition = NullCondition,
+        msg = _('Payment initiated'),
+        destination = AWAITING),
+
+    Transition(
+        transition_id = 'discard',
+        title = _('Discard payment'),
+        source = AWAITING,
+        condition = NullCondition,
+        msg = _('Payment discarded'),
+        destination = CREATED),
+
+    Transition(
         transition_id = 'submit',
         title = _('Submit for approval'),
@@ -198 +214 @@
 
     Transition(
+        transition_id = 'confirm',
+        title = _('Confirm payment'),
+        msg = _('Payment and submission confirmed'),
+        source = AWAITING,
+        destination = SUBMITTED),
+
+    Transition(
         transition_id = 'approve',
         title = _('Approve'),
@@ -245 +268 @@
         source = EXPIRED,
         destination = CREATED),
+
     )
+
+PAYMENT_TRANSITIONS = ['await', 'discard', 'confirm']
 
 contract_workflow = IkobaWorkflow(CONTRACT_TRANSITIONS)
@@ -286 +312 @@
     history = IObjectHistory(obj)
     history.addMessage(msg)
-    if event.transition.transition_id not in ('create', 'submit') \
-        and obj.customer:
+    if event.transition.transition_id not in (
+        'create', 'submit', 'confirm', 'await') and obj.customer:
         ikoba_utils = getUtility(IIkobaUtils)
         ikoba_utils.sendTransitionInfo(IUserAccount(obj.customer), obj, msg)

main/waeup.ikoba/trunk/src/waeup/ikoba/interfaces.py

@@ -55 +55 @@
 
 SUBMITTED = 'submitted'
-VERIFIED = 'verified'
+AWAITING = 'awaiting'
 REJECTED = 'rejected'
 EXPIRED = 'expired'
+
+VERIFIED = 'verified'
 PUBLISHED = 'published'