Changeset 12089 for main/waeup.ikoba/trunk/src/waeup/ikoba

Timestamp:

28 Nov 2014, 21:35:09 (10 years ago)

Author:

Henrik Bettermann

Message:

Implement application content components and rework workflows.

Location:

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

Files:

• app.py (modified) (3 diffs)
• customers/applications.py (added)
• customers/batching.py (modified) (2 diffs)
• customers/browser.py (modified) (3 diffs)
• customers/interfaces.py (modified) (2 diffs)
• customers/tests/test_application.py (added)
• customers/utils.py (modified) (3 diffs)
• customers/workflow.py (modified) (4 diffs)
• documents/utils.py (modified) (2 diffs)
• documents/workflow.py (modified) (6 diffs)
• interfaces.py (modified) (1 diff)

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

@@ -43 +43 @@
     _curr_doc_id = 101
 
+    _curr_app_id = 101
+
     # Setup authentication for this app. Note: this is only
     # initialized, when a new instance of this app is created.
@@ -58 +60 @@
         """A unique document id for all documents in company.
 
-        The document id returned is guaranteed to be unique. It
-        consists of some prefix (normally a single letter) followed by
-        a number with at least 7 digits.
+        The document id returned is guaranteed to be unique. 
 
         Once a document id was issued, it won't be issued again.
@@ -70 +70 @@
         new_id = u'd%s' % (self._curr_doc_id)
         self._curr_doc_id += 1
+        # self._p_changed = True
+        # commit()
+        # lock.release() # end of lock
+        return new_id
+
+    @property
+    def unique_application_id(self):
+        """A unique application id for all application objects in customers.
+
+        The application id returned is guaranteed to be unique.
+
+        Once a application id was issued, it won't be issued again.
+
+        Obtaining an application id is currently not thread-safe but can be
+        made easily by enabling commented lines.
+        """
+        # lock.acquire() # lock data
+        new_id = u'd%s' % (self._curr_app_id)
+        self._curr_app_id += 1
         # self._p_changed = True
         # commit()

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

@@ -45 +45 @@
     ICustomerDocument)
 from waeup.ikoba.customers.workflow import  (
-    IMPORTABLE_STATES, IMPORTABLE_TRANSITIONS)
+    IMPORTABLE_REGISTRATION_STATES, IMPORTABLE_REGISTRATION_TRANSITIONS,
+    IMPORTABLE_APPLICATION_STATES, IMPORTABLE_APPLICATION_TRANSITIONS)
 from waeup.ikoba.utils.batching import BatchProcessor
 
@@ -256 +257 @@
             row, self.factory_name, mode=mode)
         if 'transition' in row:
-            if row['transition'] not in IMPORTABLE_TRANSITIONS:
+            if row['transition'] not in IMPORTABLE_REGISTRATION_TRANSITIONS:
                 if row['transition'] not in (IGNORE_MARKER, ''):
                     errs.append(('transition', 'not allowed'))
         if 'state' in row:
-            if row['state'] not in IMPORTABLE_STATES:
+            if row['state'] not in IMPORTABLE_REGISTRATION_STATES:
                 if row['state'] not in (IGNORE_MARKER, ''):
                     errs.append(('state', 'not allowed'))

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

@@ -35 +35 @@
 from waeup.ikoba.interfaces import (
     IContactForm, IObjectHistory, IIkobaObject, IIkobaUtils,
-    IPasswordValidator, IUserAccount)
+    IPasswordValidator, IUserAccount,
+    VERIFIED, REJECTED, EXPIRED)
 from waeup.ikoba.browser.layout import (
     IkobaPage, IkobaEditFormPage, IkobaAddFormPage, IkobaDisplayFormPage,
@@ -46 +47 @@
 from waeup.ikoba.browser.interfaces import ICaptchaManager
 from waeup.ikoba.mandates.mandate import PasswordMandate
-from waeup.ikoba.documents.workflow import VERIFIED, REJECTED, OUTDATED
 from waeup.ikoba.utils.helpers import get_current_principal, to_timezone, now
 from waeup.ikoba.customers.interfaces import (
@@ -754 +754 @@
             return True
         return (self.request.principal.user_type == 'customer' and \
-            document.state in (VERIFIED, REJECTED, OUTDATED))
+            document.state in (VERIFIED, REJECTED, EXPIRED))
 
     @property

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

@@ -265 +265 @@
 
 class ICustomerDocument(IDocument):
-    """A customer document.
-
-    """
-
-    #is_editable = Attribute('Document editable by customer')
-    #translated_class_name = Attribute('Translatable class name')
+    """A customer document object.
+
+    """
+
+    is_editable = Attribute('Document editable by customer')
+    translated_class_name = Attribute('Translatable class name')
 
 
@@ -277 +277 @@
 
     """
+
+# Customer application interfaces
+
+class IApplicationsContainer(IIkobaObject):
+    """A container for customer aplication objects.
+
+    """
+
+    def addApplication(application):
+        """Add an application object.
+        """
+
+
+class IApplication(IIkobaObject):
+    """A customer application.
+
+    """
+    application_id = Attribute('Application Identifier')
+    history = Attribute('Object history, a list of messages')
+    state = Attribute('Returns the application state')
+    translated_state = Attribute(
+        'Returns a translated, more verbose appliction state')
+    class_name = Attribute('Name of the application class')
+    formatted_transition_date = Attribute('Last transition formatted date string')
+
+    title = schema.TextLine(
+        title = _(u'Application Title'),
+        required = True,
+        )
+
+    last_transition_date = schema.Datetime(
+        title = _(u'Last Transition Date'),
+        required = False,
+        readonly = False,
+        )

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

@@ -266 +266 @@
         )
 
+def generate_application_id():
+    new_id = grok.getSite().unique_application_id
+    return new_id
+
 class CustomersUtils(grok.GlobalUtility):
     """A collection of methods subject to customization.
@@ -283 +287 @@
     APPMANAGE_CUSTOMER_STATES = DOCMANAGE_CUSTOMER_STATES
 
-    APPMANAGE_APPLICATION_STATES = (CREATED,)
+    APPMANAGE_APPLICATION_STATES = ()
 
     SKIP_UPLOAD_VIEWLETS = ()
@@ -292 +296 @@
         REQUESTED: _('requested'),
         APPROVED: _('approved'),
+        }
+
+
+    TRANSLATED_APPLICATION_STATES = {
         }
 

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

@@ -1 @@
-## $Id: batching.py 11891 2014-10-28 20:02:45Z henrik $
+## $Id$
 ##
 ## Copyright (C) 2014 Uli Fouquet & Henrik Bettermann
@@ -25 +25 @@
 from waeup.ikoba.interfaces import (
     IObjectHistory, IIkobaWorkflowInfo, IIkobaUtils,
-    STARTED, CREATED, REQUESTED, APPROVED)
+    STARTED, CREATED, REQUESTED, APPROVED,
+    SUBMITTED, VERIFIED, REJECTED, EXPIRED)
 from waeup.ikoba.interfaces import MessageFactory as _
 from waeup.ikoba.workflow import IkobaWorkflow, IkobaWorkflowInfo
-from waeup.ikoba.customers.interfaces import ICustomer, ICustomersUtils
+from waeup.ikoba.customers.interfaces import (
+    ICustomer, ICustomersUtils,
+    IApplication)
 from waeup.ikoba.utils.helpers import get_current_principal
-
-
-IMPORTABLE_STATES = (STARTED, REQUESTED, APPROVED)
+from waeup.ikoba.documents.workflow import VERIFICATION_TRANSITIONS
+
+# Customer workflow
+
+IMPORTABLE_REGISTRATION_STATES = (STARTED, REQUESTED, APPROVED)
 
 REGISTRATION_TRANSITIONS = (
@@ -96 +101 @@
 
 
-IMPORTABLE_TRANSITIONS = [i.transition_id for i in REGISTRATION_TRANSITIONS]
+IMPORTABLE_REGISTRATION_TRANSITIONS = [i.transition_id for i in REGISTRATION_TRANSITIONS]
 
 registration_workflow = IkobaWorkflow(REGISTRATION_TRANSITIONS)
@@ -136 +141 @@
         pass
     return
+
+# Application workflow (the same as verification workflow)
+
+IMPORTABLE_APPLICATION_STATES = (CREATED, SUBMITTED, APPROVED, REJECTED, EXPIRED)
+
+APPLICATION_TRANSITIONS = (
+    Transition(
+        transition_id = 'create',
+        title = _('Create application record'),
+        source = None,
+        condition = NullCondition,
+        msg = _('Application record created'),
+        destination = CREATED),
+
+    Transition(
+        transition_id = 'submit',
+        title = _('Submit for approval'),
+        msg = _('Submitted for approval'),
+        source = CREATED,
+        destination = SUBMITTED),
+
+    Transition(
+        transition_id = 'approve',
+        title = _('Approve'),
+        msg = _('Approved'),
+        source = SUBMITTED,
+        destination = APPROVED),
+
+    Transition(
+        transition_id = 'reject',
+        title = _('Reject'),
+        msg = _('REJECTED'),
+        source = SUBMITTED,
+        destination = REJECTED),
+
+    Transition(
+        transition_id = 'reset1',
+        title = _('Reset to initial state'),
+        msg = _('Reset to initial state'),
+        source = REJECTED,
+        destination = CREATED),
+
+    Transition(
+        transition_id = 'reset2',
+        title = _('Reset to initial state'),
+        msg = _('Reset to initial state'),
+        source = APPROVED,
+        destination = CREATED),
+
+    Transition(
+        transition_id = 'reset3',
+        title = _('Reset to initial state'),
+        msg = _('Reset to initial state'),
+        source = SUBMITTED,
+        destination = CREATED),
+
+    Transition(
+        transition_id = 'expire',
+        title = _('Set to expired'),
+        msg = _('Set to expired'),
+        source = APPROVED,
+        destination = EXPIRED),
+
+    Transition(
+        transition_id = 'reset4',
+        title = _('Reset to initial state'),
+        msg = _('Reset to initial state'),
+        source = EXPIRED,
+        destination = CREATED),
+    )
+
+
+IMPORTABLE_APPLICATION_TRANSITIONS = [
+    i.transition_id for i in REGISTRATION_TRANSITIONS]
+
+application_workflow = IkobaWorkflow(APPLICATION_TRANSITIONS)
+
+class ApplicationWorkflowState(WorkflowState, grok.Adapter):
+    """An adapter to adapt Application objects to workflow states.
+    """
+    grok.context(IApplication)
+    grok.provides(IWorkflowState)
+
+    state_key = 'wf.application.state'
+    state_id = 'wf.application.id'
+
+class ApplicationWorkflowInfo(IkobaWorkflowInfo, grok.Adapter):
+    """Adapter to adapt Application objects to workflow info objects.
+    """
+    grok.context(IApplication)
+    grok.provides(IIkobaWorkflowInfo)
+
+    def __init__(self, context):
+        self.context = context
+        self.wf = application_workflow
+
+@grok.subscribe(IApplication, IWorkflowTransitionEvent)
+def handle_document_transition_event(obj, event):
+    """Append message to application history and log file and update
+    last_transition_date when transition happened.
+    """
+    msg = event.transition.user_data['msg']
+    history = IObjectHistory(obj)
+    history.addMessage(msg)
+    obj.last_transition_date = datetime.utcnow()
+    try:
+        customers_container = grok.getSite()['customers']
+        customers_container.logger.info('%s - %s' % (obj.customer_id,msg))
+    except (TypeError, AttributeError):
+        pass
+    return

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

@@ -20 +20 @@
 import grok
 from waeup.ikoba.interfaces import MessageFactory as _
-from waeup.ikoba.documents.workflow import CREATED
+from waeup.ikoba.interfaces import (
+    CREATED, SUBMITTED,
+    VERIFIED, REJECTED, EXPIRED)
 from waeup.ikoba.documents.interfaces import IDocumentsUtils
-from waeup.ikoba.documents.workflow import (
-    CREATED, SUBMITTED,
-    VERIFIED, REJECTED, OUTDATED)
 
 
@@ -42 +41 @@
         VERIFIED: _('verified'),
         REJECTED: _('rejected'),
-        OUTDATED:_('outdated')
+        EXPIRED:_('expired')
         }

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

@@ -25 +25 @@
 from waeup.ikoba.interfaces import (
     IObjectHistory, IIkobaWorkflowInfo,
-    SimpleIkobaVocabulary)
+    SimpleIkobaVocabulary,
+    CREATED, SUBMITTED, VERIFIED, REJECTED, EXPIRED)
 from waeup.ikoba.interfaces import MessageFactory as _
 from waeup.ikoba.workflow import IkobaWorkflow, IkobaWorkflowInfo
@@ -31 +32 @@
 from waeup.ikoba.documents.interfaces import IDocument
 
-CREATED = 'created'
-SUBMITTED = 'submitted'
-VERIFIED = 'verified'
-REJECTED = 'rejected'
-OUTDATED = 'outdated'
+IMPORTABLE_STATES = (CREATED, SUBMITTED, VERIFIED, REJECTED, EXPIRED)
 
-IMPORTABLE_STATES = (CREATED, SUBMITTED, VERIFIED, REJECTED)
-
-REGISTRATION_TRANSITIONS = (
+VERIFICATION_TRANSITIONS = (
     Transition(
         transition_id = 'create',
@@ -71 +66 @@
     Transition(
         transition_id = 'reset1',
-        title = _('Reset'),
+        title = _('Reset to initial state'),
         msg = _('Reset to initial state'),
         source = REJECTED,
@@ -78 +73 @@
     Transition(
         transition_id = 'reset2',
-        title = _('Reset'),
+        title = _('Reset to initial state'),
         msg = _('Reset to initial state'),
         source = VERIFIED,
@@ -85 +80 @@
     Transition(
         transition_id = 'reset3',
-        title = _('Reset'),
+        title = _('Reset to initial state'),
         msg = _('Reset to initial state'),
         source = SUBMITTED,
@@ -91 +86 @@
 
     Transition(
-        transition_id = 'outdate',
-        title = _('Set to outdated'),
-        msg = _('Set to outdated'),
+        transition_id = 'expire',
+        title = _('Set to expired'),
+        msg = _('Set to expired'),
         source = VERIFIED,
-        destination = OUTDATED),
+        destination = EXPIRED),
+
+    Transition(
+        transition_id = 'reset4',
+        title = _('Reset to initial state'),
+        msg = _('Reset to initial state'),
+        source = EXPIRED,
+        destination = CREATED),
     )
 
 
-IMPORTABLE_TRANSITIONS = [i.transition_id for i in REGISTRATION_TRANSITIONS]
+IMPORTABLE_TRANSITIONS = [i.transition_id for i in VERIFICATION_TRANSITIONS]
 
-verification_workflow = IkobaWorkflow(REGISTRATION_TRANSITIONS)
+verification_workflow = IkobaWorkflow(VERIFICATION_TRANSITIONS)
 
 class VerificationWorkflowState(WorkflowState, grok.Adapter):

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

@@ -45 +45 @@
 VIRT_JOBS_CONTAINER_NAME = 'jobs'
 
+# States for various workflows
+
 CREATED = 'created'
+
 STARTED = 'started'
 REQUESTED = 'requested'
 APPROVED = 'approved'
+
+SUBMITTED = 'submitted'
+VERIFIED = 'verified'
+REJECTED = 'rejected'
+EXPIRED = 'expired'
+
 
 #: A dict giving job status as tuple (<STRING>, <TRANSLATED_STRING>),