Provide json.dumps an encoder for datetime (#15)

- add util wrapper for json.dumps
- declares default encoder for datetime, datetime.date values
- tests and fixes #14

Author: labkey-nicka

labkey/domain.py

@@ -16,7 +16,7 @@
 from __future__ import unicode_literals
 import json
 
-from labkey.utils import ServerContext
+from labkey.utils import json_dumps, ServerContext
 
 
 def strip_none_values(data, do_strip=True):
@@ -326,7 +326,7 @@ def create(server_context, domain_definition, container_path=None):
 
     domain = None
 
-    raw_domain = server_context.make_request(url, json.dumps(domain_definition), headers=headers)
+    raw_domain = server_context.make_request(url, json_dumps(domain_definition), headers=headers)
 
     if raw_domain is not None:
         domain = Domain.from_data(raw_domain)
@@ -355,7 +355,7 @@ def drop(server_context, schema_name, query_name, container_path=None):
         'queryName': query_name
     }
 
-    return server_context.make_request(url, json.dumps(payload), headers=headers)
+    return server_context.make_request(url, json_dumps(payload), headers=headers)
 
 
 def get(server_context, schema_name, query_name, container_path=None):
@@ -431,4 +431,4 @@ def save(server_context, schema_name, query_name, domain, container_path=None):
         'schemaName': schema_name
     }
 
-    return server_context.make_request(url, json.dumps(payload), headers=headers)
+    return server_context.make_request(url, json_dumps(payload), headers=headers)

labkey/experiment.py

@@ -14,9 +14,8 @@
 # limitations under the License.
 #
 from __future__ import unicode_literals
-import json
 
-from labkey.utils import ServerContext
+from labkey.utils import json_dumps, ServerContext
 
 
 # TODO Incorporate logging
@@ -42,7 +41,7 @@ def load_batch(server_context, assay_id, batch_id):
         'Accept': 'text/plain'
     }
 
-    json_body = server_context.make_request(load_batch_url, json.dumps(payload, sort_keys=True), headers=headers)
+    json_body = server_context.make_request(load_batch_url, json_dumps(payload, sort_keys=True), headers=headers)
     if json_body is not None:
         loaded_batch = Batch.from_data(json_body['batch'])
 
@@ -95,7 +94,7 @@ def save_batches(server_context, assay_id, batches):
         'Accept': 'text/plain'
     }
 
-    json_body = server_context.make_request(save_batch_url, json.dumps(payload, sort_keys=True), headers=headers)
+    json_body = server_context.make_request(save_batch_url, json_dumps(payload, sort_keys=True), headers=headers)
     if json_body is not None:
         resp_batches = json_body['batches']
         return [Batch.from_data(resp_batch) for resp_batch in resp_batches]

labkey/query.py

@@ -41,7 +41,8 @@
 ############################################################################
 """
 from __future__ import unicode_literals
-import json
+
+from labkey.utils import json_dumps
 
 _query_headers = {
     'Content-Type': 'application/json'
@@ -80,7 +81,7 @@ def delete_rows(server_context, schema_name, query_name, rows, container_path=No
         'rows': rows
     }
 
-    return server_context.make_request(url, json.dumps(payload, sort_keys=True), headers=_query_headers, timeout=timeout)
+    return server_context.make_request(url, json_dumps(payload, sort_keys=True), headers=_query_headers, timeout=timeout)
 
 
 def execute_sql(server_context, schema_name, sql, container_path=None,
@@ -161,7 +162,7 @@ def insert_rows(server_context, schema_name, query_name, rows, container_path=No
         'rows': rows
     }
 
-    return server_context.make_request(url, json.dumps(payload, sort_keys=True), headers=_query_headers,
+    return server_context.make_request(url, json_dumps(payload, sort_keys=True), headers=_query_headers,
                                        timeout=timeout)
 
 
@@ -281,7 +282,7 @@ def update_rows(server_context, schema_name, query_name, rows, container_path=No
         'rows': rows
     }
 
-    return server_context.make_request(url, json.dumps(payload, sort_keys=True), headers=_query_headers,
+    return server_context.make_request(url, json_dumps(payload, sort_keys=True), headers=_query_headers,
                                        timeout=timeout)
 
 

labkey/unsupported/wiki.py

@@ -23,9 +23,10 @@
 """
 from __future__ import unicode_literals
 
-import json
 from requests.exceptions import SSLError
 
+from labkey.utils import json_dumps
+
 
 def update_wiki(server_context, wiki_name, wiki_body, container_path=None):
     """
@@ -100,7 +101,7 @@ def update_wiki(server_context, wiki_name, wiki_body, container_path=None):
     wiki_vars['body'] = wiki_body
 
     try:
-        data = server_context.make_request(update_wiki_url, payload=json.dumps(wiki_vars, sort_keys=True),
+        data = server_context.make_request(update_wiki_url, payload=json_dumps(wiki_vars, sort_keys=True),
                                            headers=headers, non_json_response=True)
     except SSLError as e:
         print("There was a problem while attempting to submit the read for the wiki page '" + str(wiki_name) + "' via the URL " + str(e.geturl()) + ". The HTTP response code was " + str(e.getcode()))

labkey/utils.py

@@ -16,6 +16,9 @@
 from __future__ import unicode_literals
 
 import requests
+import json
+from functools import wraps
+from datetime import date, datetime
 
 from requests.exceptions import RequestException
 from labkey.exceptions import RequestError, RequestAuthorizationError, QueryNotFoundError, ServerContextError, \
@@ -179,3 +182,18 @@ def handle_response(response, non_json_response=False):
     else:
         # consider response.raise_for_status()
         raise RequestError(response)
+
+
+# Issue #14: json.dumps on datetime throws TypeError
+class DateTimeEncoder(json.JSONEncoder):
+    def default(self, o):
+        if isinstance(o, (datetime, date)):
+            return o.isoformat()
+
+        return super(DateTimeEncoder, self).default(o)
+
+
+@wraps(json.dumps)
+def json_dumps(*args, **kwargs):
+    kwargs.setdefault('cls', DateTimeEncoder)
+    return json.dumps(*args, **kwargs)

test/test_domain.py

@@ -28,7 +28,7 @@
 from labkey.domain import create, Domain, drop, get, infer_fields, save
 from labkey.exceptions import RequestAuthorizationError
 
-from test_utils import MockLabKey, mock_server_context, success_test, success_test_get, throws_error_test, throws_error_test_get
+from utilities import MockLabKey, mock_server_context, success_test, success_test_get, throws_error_test, throws_error_test_get
 
 
 domain_controller = 'property'

test/test_experiment_api.py

@@ -25,7 +25,7 @@
 from labkey.experiment import load_batch, save_batch, Batch, Run
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from test_utils import MockLabKey, mock_server_context, success_test, throws_error_test
+from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockLoadBatch(MockLabKey):

test/test_labkey.py

@@ -22,6 +22,7 @@
 from test_query_api import suite as query_suite
 from test_security import suite as security_suite
 from test_unsupported import suite as unsupported_suite
+from test_utils import suite as utils_suite
 
 if __name__ == '__main__':
 
@@ -35,6 +36,7 @@
         exp_suite(),
         query_suite(),
         security_suite(),
-        unsupported_suite()
+        unsupported_suite(),
+        utils_suite()
     ])
     unittest.TextTestRunner().run(all_tests)

test/test_query_api.py

@@ -25,7 +25,7 @@
 from labkey.query import delete_rows, update_rows, insert_rows, select_rows, execute_sql
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from test_utils import MockLabKey, mock_server_context, success_test, throws_error_test
+from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockSelectRows(MockLabKey):

test/test_security.py

@@ -27,7 +27,7 @@
     remove_from_group, remove_from_role, add_to_role, get_roles, list_groups
 from labkey.exceptions import RequestError, QueryNotFoundError, ServerNotFoundError, RequestAuthorizationError
 
-from test_utils import MockLabKey, mock_server_context, success_test, throws_error_test
+from utilities import MockLabKey, mock_server_context, success_test, throws_error_test
 
 
 class MockSecurityController(MockLabKey):

test/test_unsupported.py

@@ -19,7 +19,7 @@
 from labkey import utils
 from labkey.unsupported import messageboard
 
-from test_utils import MockLabKey, mock_server_context, success_test
+from utilities import MockLabKey, mock_server_context, success_test
 
 
 class MockPostMessage(MockLabKey):

test/test_utils.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2017 LabKey Corporation
+# Copyright (c) 2018 LabKey Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,132 +14,49 @@
 # limitations under the License.
 #
 from __future__ import unicode_literals
-import requests
+from datetime import date, datetime
+import unittest
 
 try:
     import mock
 except ImportError:
     import unittest.mock as mock
 
-from labkey.utils import create_server_context
+from labkey import utils
 
 
-def mock_server_context(mock_action):
-    # mock the CSRF token
-    with mock.patch('labkey.utils.requests.sessions.Session.get') as mock_get:
+class TestJsonDumps(unittest.TestCase):
 
-        mock_get.return_value = mock_action.get_csrf_response()
-        return create_server_context(mock_action.server_name, mock_action.project_path, mock_action.context_path,
-                                     api_key=mock_action.api_key)
+    def test_encoder(self):
+        # test date and datetime encoding
+        payload = {
+            'my_date': date(1985, 9, 11),
+            'my_date_time': datetime(2018, 9, 18, 5, 25)
+        }
 
+        utils.json_dumps(payload)
 
-def success_test(test, expected_response, api_method, compare_response, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.post') as mock_post:
-        mock_post.return_value = expected_response
-        resp = api_method(*args)
+    def test_encoder_override(self):
+        payload = {
+            'testdate': datetime(2018, 9, 11, 6, 45)
+        }
 
-        # validate response is as expected
-        if compare_response:
-            test.assertEqual(resp, expected_response.text)
+        try:
+            # disable the "cls" override by passing None
+            utils.json_dumps(payload, cls=None)
+        except TypeError as e:
+            if "is not JSON serializable" not in str(e):
+                print("Did not see expected exception")
+                raise e
 
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_post.assert_called_once_with(*expected_args, **expected_kwargs)
 
+def suite():
+    load_tests = unittest.TestLoader().loadTestsFromTestCase
+    return unittest.TestSuite([
+        load_tests(TestJsonDumps)
+    ])
 
-def success_test_get(test, expected_response, api_method, compare_response, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.get') as mock_get:
-        mock_get.return_value = expected_response
-        resp = api_method(*args)
 
-        # validate response is as expected
-        if compare_response:
-            test.assertEqual(resp, expected_response.text)
-
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_get.assert_called_once_with(*expected_args, **expected_kwargs)
-
-
-def throws_error_test(test, expected_error, expected_response, api_method, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.post') as mock_post:
-        with test.assertRaises(expected_error):
-            mock_post.return_value = expected_response
-            api_method(*args)
-
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_post.assert_called_once_with(*expected_args, **expected_kwargs)
-
-
-def throws_error_test_get(test, expected_error, expected_response, api_method, *args, **expected_kwargs):
-    with mock.patch('labkey.utils.requests.Session.get') as mock_get:
-        with test.assertRaises(expected_error):
-            mock_get.return_value = expected_response
-            api_method(*args)
-
-        # validate call is made as expected
-        expected_args = expected_kwargs.pop('expected_args')
-        mock_get.assert_called_once_with(*expected_args, **expected_kwargs)
-
-
-class MockLabKey:
-    api = ""
-    default_protocol = 'https://'
-    default_server = 'my_testServer:8080'
-    default_context_path = 'testPath'
-    default_project_path = 'testProject/subfolder'
-    default_action = 'query'
-    default_success_body = ''
-    default_unauthorized_body = ''
-    default_server_not_found_body = ''
-    default_query_not_found_body = ''
-    default_general_server_error_body = ''
-    default_api_key = None
-
-    def __init__(self, **kwargs):
-        self.protocol = kwargs.pop('protocol', self.default_protocol)
-        self.server_name = kwargs.pop('server_name', self.default_server)
-        self.context_path = kwargs.pop('context_path', self.default_context_path)
-        self.project_path = kwargs.pop('project_path', self.default_project_path)
-        self.action = kwargs.pop('action', self.default_action)
-        self.success_body = kwargs.pop('success_body', self.default_success_body)
-        self.unauthorized_body = kwargs.pop('unauthorized_body', self.default_unauthorized_body)
-        self.server_not_found_body = kwargs.pop('server_not_found_body', self.default_server_not_found_body)
-        self.query_not_found_body = kwargs.pop('query_not_found_body', self.default_query_not_found_body)
-        self.general_server_error_body = kwargs.pop('general_server_error_body', self.default_general_server_error_body)
-        self.api_key = kwargs.pop('api_key', self.default_api_key)
-
-    def _get_mock_response(self, code, url, body):
-        mock_response = mock.Mock(requests.Response)
-        mock_response.status_code = code
-        mock_response.url = url
-        mock_response.text = body
-        mock_response.json.return_value = mock_response.text
-        return mock_response
-
-    def get_server_url(self):
-        return "{protocol}{server}/{context}/{container}/{action}-{api}"\
-            .format(protocol=self.protocol, server=self.server_name, context=self.context_path,
-                    container=self.project_path, action=self.action, api=self.api)
-
-    def get_successful_response(self, code=200):
-        return self._get_mock_response(code, self.get_server_url(), self.success_body)
-
-    def get_unauthorized_response(self, code=401):
-        return self._get_mock_response(code, self.get_server_url(), self.unauthorized_body)
-
-    def get_server_not_found_response(self, code=404):
-        response = self._get_mock_response(code, self.get_server_url(), self.server_not_found_body)
-        # calling json() on empty response body causes a ValueError
-        response.json.side_effect = ValueError()
-        return response
-
-    def get_query_not_found_response(self, code=404):
-        return self._get_mock_response(code, self.get_server_url(), self.query_not_found_body)
-
-    def get_general_error_response(self, code=500):
-        return self._get_mock_response(code, self.get_server_url(), self.general_server_error_body)
-
-    def get_csrf_response(self, code=200):
-        return self._get_mock_response(code, self.get_server_url(), {'CSRF': 'MockCSRF'})
+if __name__ == '__main__':
+    utils.DISABLE_CSRF_CHECK = True
+    unittest.main()