Use BaseResponse for proposal history to add API support

docs/HISTORY.txt

@@ -10,6 +10,7 @@ Changelog
 - Add main dossier count to contentstats. [njohner]
 - No longer add journal entry for document file modification. [njohner]
 - Revoke permissions for former responsible, when task gets rejected. [phgross]
+- Use BaseResponse for proposal history to add API support. [njohner]
 
 
 2019.4.0rc5 (2019-11-13)

docs/public/dev-manual/api/proposals.rst

@@ -58,3 +58,56 @@ Auch Anträge können via REST API bedient werden. Die Erstellung eines Antrags
         },
         "...": "..."
       }
+
+
+Antragverlauf
+-------------
+Der Verlauf eines Antrags ist in der GET Repräsentation eines Antrags unter dem Attribut ``responses`` enthalten.
+
+
+**Beispiel-Respones auf ein GET Request**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Accept: application/json
+
+      {
+        "@id": "http://example.org/ordnungssystem/fuehrung/dossier-1/proposal-5",
+        "@type": "opengever.meeting.proposal",
+        "UID": "3a551f6e3b62421da029dfceb71656e6",
+        "items": [],
+        "responses": [
+          {
+            "@id": "http://example.org/ordnungssystem/fuehrung/dossier-1/proposal-5/@responses/1569394746972113",
+            "response_id": 1569394746972113,
+            "response_type": "successor_created",
+            "additional_data": {
+                "successor_oguid": "fd:593382572"
+            },
+            "changes": [],
+            "creator": {
+                "title": "hugo.boss",
+                "token": "hugo.boss"
+            },
+            "created": "2019-05-21T13:57:42",
+            "text": "",
+          },
+          {
+            "@id": "http://example.org/ordnungssystem/fuehrung/dossier-1/proposal-5/@responses/1573486804000000",
+            "response_id": 1573486804000000
+            "response_type": "commented"
+            "additional_data": [],
+            "changes": [],
+            "creator": {
+                "title": "hugo.boss",
+                "token": "hugo.boss"
+            },
+            "created": "2019-11-11T16:40:04",
+            "text": "Suspendisse faucibus, nunc et pellentesque egestas.",
+          },
+        ]
+        "review_state": "proposal-state-submitted",
+        "...": "...",
+      }
+

opengever/api/configure.zcml

@@ -25,7 +25,10 @@
   <adapter factory=".response.SerializeResponseToJson" />
   <adapter factory=".task.SerializeTaskResponseToJson" />
   <adapter factory=".task.TaskDeserializeFromJson" />
+  <adapter factory=".proposal.SerializeProposalResponseToJson" />
   <adapter factory=".serializer.long_converter" />
+  <adapter factory=".field_deserializers.PersistentDefaultFieldDeserializer" />
+  <adapter factory=".field_deserializers.PersistentDatetimeFieldDeserializer" />
 
   <adapter factory=".todo.DeserializeToDoFromJson" />
   <adapter factory=".mail.DeserializeMailFromJson" />

opengever/api/field_deserializers.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+from plone.restapi.deserializer.dxfields import DatetimeFieldDeserializer
+from plone.restapi.deserializer.dxfields import DefaultFieldDeserializer
+from plone.restapi.interfaces import IFieldDeserializer
+from persistent.interfaces import IPersistent
+from zope.component import adapter
+from zope.interface import implementer
+from zope.publisher.interfaces.browser import IBrowserRequest
+from zope.schema.interfaces import IDatetime
+from zope.schema.interfaces import IField
+
+
+@implementer(IFieldDeserializer)
+@adapter(IField, IPersistent, IBrowserRequest)
+class PersistentDefaultFieldDeserializer(DefaultFieldDeserializer):
+    """Default field deserializer for persisten objects"""
+
+
+@implementer(IFieldDeserializer)
+@adapter(IDatetime, IPersistent, IBrowserRequest)
+class PersistentDatetimeFieldDeserializer(DatetimeFieldDeserializer):
+    """Datetime field deserializer for persisten objects"""

opengever/api/proposal.py

@@ -0,0 +1,13 @@
+from opengever.api.response import SerializeResponseToJson
+from plone.restapi.interfaces import ISerializeToJson
+from zope.component import adapter
+from zope.interface import implementer
+from zope.interface import Interface
+from opengever.meeting.proposalhistory import IProposalResponse
+
+
+@implementer(ISerializeToJson)
+@adapter(IProposalResponse, Interface)
+class SerializeProposalResponseToJson(SerializeResponseToJson):
+
+    model = IProposalResponse

opengever/api/tests/test_content_creation.py

@@ -3,6 +3,7 @@
 from opengever.api.add import get_validation_errors
 from opengever.base.behaviors.lifecycle import ILifeCycle
 from opengever.base.oguid import Oguid
+from opengever.base.response import IResponseContainer
 from opengever.dossier.behaviors.dossier import IDossier
 from opengever.repository.interfaces import IRepositoryFolder
 from opengever.testing import FunctionalTestCase
@@ -254,6 +255,11 @@ def test_proposal_creation(self, browser):
         self.assertEqual(IBumblebeeDocument(self.proposal_template).get_checksum(),
                          checksum)
 
+        # Creating a proposal should generate a history entry
+        responses = IResponseContainer(proposal).list()
+        self.assertEqual(1, len(responses))
+        self.assertEqual('created', responses[0].response_type)
+
     @browsing
     def test_template_is_mandatory_for_proposal_creation(self, browser):
         self.login(self.meeting_user, browser)

opengever/api/tests/test_proposal.py

@@ -0,0 +1,75 @@
+from ftw.testbrowser import browsing
+from opengever.testing import IntegrationTestCase
+from os.path import join as pjoin
+from plone.restapi.serializer.converters import json_compatible
+
+
+class TestProposalSerialization(IntegrationTestCase):
+
+    @browsing
+    def test_proposal_contains_a_list_of_responses(self, browser):
+        self.login(self.regular_user, browser=browser)
+        browser.open(self.proposal, method="GET", headers=self.api_headers)
+        self.maxDiff = None
+        responses = browser.json['responses']
+
+        self.assertEquals(3, len(responses))
+
+        response_id = 1472645373000000
+        expected_path = pjoin(self.proposal.absolute_url(),
+                              '@responses',
+                              str(response_id))
+        self.assertEquals(
+            {u'@id': expected_path,
+             u'additional_data': {},
+             u'changes': [],
+             u'created': json_compatible(self.proposal.created().utcdatetime()),
+             u'creator': {u'title': u'Ziegler Robert', u'token': u'robert.ziegler'},
+             u'response_id': response_id,
+             u'response_type': u'created',
+             u'text': u''},
+            responses[0])
+
+    @browsing
+    def test_getting_specific_response_from_proposal(self, browser):
+        self.login(self.regular_user, browser=browser)
+
+        response_id = 1472645373000000
+        url = pjoin(self.proposal.absolute_url(), '@responses', str(response_id))
+        browser.open(url, method="GET", headers=self.api_headers)
+        self.maxDiff = None
+
+        self.assertEquals(
+            {u'@id': url,
+             u'additional_data': {},
+             u'changes': [],
+             u'created': json_compatible(self.proposal.created().utcdatetime()),
+             u'creator': {u'title': u'Ziegler Robert', u'token': u'robert.ziegler'},
+             u'response_id': response_id,
+             u'response_type': u'created',
+             u'text': u''},
+            browser.json)
+
+    @browsing
+    def test_submitted_proposal_contains_a_list_of_responses(self, browser):
+        self.login(self.meeting_user, browser=browser)
+        browser.open(self.submitted_proposal, method="GET", headers=self.api_headers)
+        self.maxDiff = None
+        responses = browser.json['responses']
+
+        self.assertEquals(2, len(responses))
+
+        response_id = 1472645373000000
+        expected_path = pjoin(self.submitted_proposal.absolute_url(),
+                              '@responses',
+                              str(response_id))
+        self.assertEquals(
+            {u'@id': expected_path,
+             u'additional_data': {},
+             u'changes': [],
+             u'created': json_compatible(self.submitted_proposal.created().utcdatetime()),
+             u'creator': {u'title': u'Ziegler Robert', u'token': u'robert.ziegler'},
+             u'response_id': response_id,
+             u'response_type': u'submitted',
+             u'text': u''},
+            responses[0])

opengever/base/response.py

@@ -18,7 +18,6 @@
 from zope.interface import implements
 from zope.interface import Interface
 from zope.schema import getFields
-import time
 
 
 class IResponseAddedEvent(IObjectEvent):
@@ -145,11 +144,11 @@ class IResponse(Interface):
 
     response_id = schema.Int(required=True)
 
-    created = schema.Date(required=True)
+    created = schema.Datetime(required=True)
 
     creator = schema.TextLine(required=True)
 
-    text = schema.Text(required=False)
+    text = schema.Text(required=False, default=u'', missing_value=u'')
 
     changes = schema.List(required=False, value_type=schema.Dict())
 
@@ -169,7 +168,7 @@ def __init__(self, response_type='default'):
         self.created = datetime.now()
         self.creator = api.user.get_current().id
 
-        self.text = ''
+        self.text = u''
         self.changes = PersistentList()
 
     def add_change(self, field_id, before, after, field_title=''):