Adds a meta column to the submissions table

HISTORY.rst

@@ -1,5 +1,9 @@
 Changelog
 ---------
+
+- Adds a meta column to the submissions table.
+  [href]
+
 0.28.0 (2017-12-19)
 ~~~~~~~~~~~~~~~~~~~
 

onegov/form/collection.py

@@ -133,7 +133,7 @@ def query(self):
 
         return query
 
-    def add(self, name, form, state, id=None, payment_method=None):
+    def add(self, name, form, state, id=None, payment_method=None, meta=None):
         """ Takes a filled-out form instance and stores the submission
         in the database. The form instance is expected to have a ``_source``
         parameter, which contains the source used to build the form (as only
@@ -169,6 +169,7 @@ def add(self, name, form, state, id=None, payment_method=None):
         submission.id = id or uuid4()
         submission.name = name
         submission.state = state
+        submission.meta = meta or {}
         submission.payment_method = (
             payment_method or
             definition and definition.payment_method or
@@ -189,7 +190,8 @@ def add(self, name, form, state, id=None, payment_method=None):
 
         return submission
 
-    def add_external(self, form, state, id=None, payment_method=None):
+    def add_external(self, form, state, id=None, payment_method=None,
+                     meta=None):
         """ Takes a filled-out form instance and stores the submission
         in the database. The form instance is expected to have a ``_source``
         parameter, which contains the source used to build the form (as only
@@ -205,7 +207,8 @@ def add_external(self, form, state, id=None, payment_method=None):
             form=form,
             state=state,
             id=id,
-            payment_method=payment_method
+            payment_method=payment_method,
+            meta=meta,
         )
 
     def complete_submission(self, submission):

onegov/form/models/submission.py

@@ -49,6 +49,9 @@ class FormSubmission(Base, TimestampMixin, Payable, AssociatedFiles):
     #: checksums are guaranteed to have the exact same definition
     checksum = Column(Text, nullable=False)
 
+    #: metadata about this submission
+    meta = Column(JSON, nullable=False)
+
     #: the submission data
     data = Column(JSON, nullable=False)
 

onegov/form/upgrade.py

@@ -10,6 +10,7 @@
 from onegov.form import FormDefinitionCollection
 from onegov.form import FormFile
 from onegov.form import FormSubmission
+from onegov.core.orm.types import JSON
 from sqlalchemy import Column, Text
 
 
@@ -97,3 +98,13 @@ def add_payment_method_to_definitions_and_submissions(context):
 
     for form in context.records_per_table('forms'):
         form.content.pop('payment_method', None)
+
+
+@upgrade_task('Add meta dictionary to submissions')
+def add_meta_directory_to_submissions(context):
+
+    context.add_column_with_defaults(
+        table='submissions',
+        column=Column('meta', JSON, nullable=False),
+        default=lambda submission: dict()
+    )