Merge lp:~cjwatson/lazr.restful/json-publishable-date into lp:lazr.restful

[Colin Watson]

Fix encoding of date(time) fields for ETags.

[Thiago F. Pappacena (pappacena)]

LGTM

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2021-05-18 16:49:19 +0000
+++ NEWS.rst	2021-05-20 14:25:47 +0000
@@ -15,6 +15,8 @@
 Stabilize ETags of entries containing collections of strings between Python
 2 and 3 (bug 1928474).
 
+Add an ``IJSONPublishable`` adapter for ``date`` and ``datetime``.
+
 1.0.2 (2021-05-14)
 ==================
 

=== modified file 'src/lazr/restful/_resource.py'
--- src/lazr/restful/_resource.py	2021-05-18 16:49:19 +0000
+++ src/lazr/restful/_resource.py	2021-05-20 14:25:47 +0000
@@ -17,6 +17,7 @@
     'EntryHTMLView',
     'EntryResource',
     'HTTPResource',
+    'JSONDate',
     'JSONItem',
     'ReadOnlyResource',
     'RedirectResource',
@@ -71,6 +72,7 @@
     providedBy,
     Interface,
     )
+from zope.interface.common.idatetime import IDate
 from zope.interface.common.sequence import IFiniteSequence
 from zope.interface.interfaces import (
     ComponentLookupError,
@@ -160,7 +162,7 @@
     elif isinstance(value, bytes):
         return value.decode("utf-8")
     else:
-        return simplejson.dumps(value)
+        return simplejson.dumps(value, cls=ResourceJSONEncoder)
 
 
 def _default_html_renderer(value):
@@ -242,6 +244,19 @@
         return str(self.context.title)
 
 
+@implementer(IJSONPublishable)
+@adapter(IDate)
+class JSONDate:
+    """JSONPublishable adapter for date/datetime."""
+
+    def __init__(self, context):
+        self.context = context
+
+    def toDataForJSON(self, media_type):
+        """See `IJSONPublishable`."""
+        return self.context.isoformat()
+
+
 @implementer(IHTTPResource)
 class RedirectResource(URLDereferencingMixin):
     """A resource that redirects to another URL."""

=== modified file 'src/lazr/restful/configure.zcml'
--- src/lazr/restful/configure.zcml	2012-03-13 02:03:47 +0000
+++ src/lazr/restful/configure.zcml	2021-05-20 14:25:47 +0000
@@ -136,6 +136,7 @@
     <adapter factory="lazr.restful.ScopedCollection" />
 
     <adapter factory="lazr.restful.JSONItem" />
+    <adapter factory="lazr.restful.JSONDate" />
 
     <!-- Adapter for URL generation -->
     <adapter

=== modified file 'src/lazr/restful/tests/test_etag.py'
--- src/lazr/restful/tests/test_etag.py	2021-05-18 16:49:19 +0000
+++ src/lazr/restful/tests/test_etag.py	2021-05-20 14:25:47 +0000
@@ -6,8 +6,16 @@
 __metaclass__ = type
 
 from collections import OrderedDict
+from datetime import (
+    date,
+    datetime,
+    )
+import os.path
 import unittest
 
+from pkg_resources import resource_filename
+import pytz
+from van.testing.layer import zcml_layer
 from zope.component import provideUtility
 
 from lazr.restful.interfaces import IWebServiceConfiguration
@@ -21,12 +29,22 @@
     )
 
 
+class FunctionalLayer:
+    allow_teardown = False
+    zcml = os.path.abspath(resource_filename('lazr.restful', 'ftesting.zcml'))
+
+
+zcml_layer(FunctionalLayer)
+
+
 class TestEntryResourceETags(unittest.TestCase):
     # The EntryResource uses the field values that can be written or might
     # othwerise change as the basis for its ETags.  The make_entry_etag_cores
     # function is passed the data about the fields and returns the read and
     # write cores.
 
+    layer = FunctionalLayer
+
     def test_no_field_details(self):
         # If make_entry_etag_cores is given no field details (because no
         # fields exist), the resulting cores empty strings.
@@ -91,10 +109,17 @@
             ('dict_field',
              {'writable': False,
               'value': OrderedDict((('first', 'one'), ('second', 'two')))}),
+            ('date_field',
+             {'writable': False,
+              'value': date(2009, 7, 7)}),
+            ('datetime_field',
+             {'writable': False,
+              'value': datetime(2009, 7, 7, 13, 45, 0, tzinfo=pytz.utc)}),
             ]
         self.assertEqual(
             make_entry_etag_cores(field_details),
-            [b'["first", "second"]\0{"first": "one", "second": "two"}', b''])
+            [b'["first", "second"]\x00{"first": "one", "second": "two"}\x00'
+             b'"2009-07-07"\x00"2009-07-07T13:45:00+00:00"', b''])
 
 
 class TestHTTPResourceETags(unittest.TestCase):