Merge pull request #232 from cloudant/221-json-dumps

Honour the custom encoder parameter for json encoding.

Author: rhyshort

CHANGES.rst

@@ -1,5 +1,7 @@
 2.3.0 (Unreleased)
 ==================
+- [FIXED] Issue where the custom JSON encoder was not used when transforming
+   data.
 
 2.2.0 (2016-10-20)
 ==================

src/cloudant/client.py

@@ -727,7 +727,7 @@ def _write_cors_configuration(self, config):
         )
         resp = self.r_session.put(
             endpoint,
-            data=json.dumps(config),
+            data=json.dumps(config, cls=self.encoder),
             headers={'Content-Type': 'application/json'}
         )
         resp.raise_for_status()

src/cloudant/database.py

@@ -660,7 +660,7 @@ def bulk_docs(self, docs):
         headers = {'Content-Type': 'application/json'}
         resp = self.r_session.post(
             url,
-            data=json.dumps(data),
+            data=json.dumps(data, cls=self.client.encoder),
             headers=headers
         )
         resp.raise_for_status()
@@ -684,7 +684,7 @@ def missing_revisions(self, doc_id, *revisions):
         resp = self.r_session.post(
             url,
             headers={'Content-Type': 'application/json'},
-            data=json.dumps(data)
+            data=json.dumps(data, cls=self.client.encoder)
         )
         resp.raise_for_status()
 
@@ -713,7 +713,7 @@ def revisions_diff(self, doc_id, *revisions):
         resp = self.r_session.post(
             url,
             headers={'Content-Type': 'application/json'},
-            data=json.dumps(data)
+            data=json.dumps(data, cls=self.client.encoder)
         )
         resp.raise_for_status()
 
@@ -752,7 +752,7 @@ def set_revision_limit(self, limit):
         """
         url = posixpath.join(self.database_url, '_revs_limit')
 
-        resp = self.r_session.put(url, data=json.dumps(limit))
+        resp = self.r_session.put(url, data=json.dumps(limit, self.client.encoder))
         resp.raise_for_status()
 
         return resp.json()
@@ -991,7 +991,7 @@ def share_database(self, username, roles=None):
         doc['cloudant'] = data
         resp = self.r_session.put(
             self.security_url,
-            data=json.dumps(doc),
+            data=json.dumps(doc, cls=self.client.encoder),
             headers={'Content-Type': 'application/json'}
         )
         resp.raise_for_status()
@@ -1016,7 +1016,7 @@ def unshare_database(self, username):
         doc['cloudant'] = data
         resp = self.r_session.put(
             self.security_url,
-            data=json.dumps(doc),
+            data=json.dumps(doc, cls=self.client.encoder),
             headers={'Content-Type': 'application/json'}
         )
         resp.raise_for_status()

src/cloudant/index.py

@@ -144,7 +144,7 @@ def create(self):
         headers = {'Content-Type': 'application/json'}
         resp = self._r_session.post(
             self.index_url,
-            data=json.dumps(payload),
+            data=json.dumps(payload, cls=self._database.client.encoder),
             headers=headers
         )
         resp.raise_for_status()

tests/unit/database_tests.py

@@ -67,6 +67,41 @@ def test_constructor(self):
         self.assertEqual(self.db.r_session, self.client.r_session)
         self.assertIsInstance(self.db.result, Result)
 
+    def test_bulk_docs_uses_custom_encoder(self):
+        """
+        Test that the bulk_docs method uses the custom encoder
+        """
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        docs = [
+            {'_id': 'julia{0:03d}'.format(i), 'name': 'julia', 'age': i}
+            for i in range(3)
+        ]
+        database = self.client[self.test_dbname]
+        with self.assertRaises(TypeError):
+            # since the encoder is a str a type error should be thrown.
+            database.bulk_docs(docs)
+
+    def test_missing_revisions_uses_custom_encoder(self):
+        """
+        Test that missing_revisions uses the custom encoder.
+        """
+        revs = ['1-1', '2-1', '3-1']
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        database = self.client[self.test_dbname]
+        with self.assertRaises(TypeError):
+            # since the encoder is a str a type error should be thrown.
+            database.missing_revisions('no-such-doc', *revs)
+
+    def test_revs_diff_uses_custom_encoder(self):
+        """
+        Test that revisions_diff uses the custom encoder.
+        """
+        revs = ['1-1', '2-1', '3-1']
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        database = self.client[self.test_dbname]
+        with self.assertRaises(TypeError):
+            database.revisions_diff('no-such-doc', *revs)
+
     def test_retrieve_db_url(self):
         """
         Test retrieving the database URL
@@ -822,6 +857,27 @@ def tearDown(self):
         self.db_tear_down()
         super(CloudantDatabaseTests, self).tearDown()
 
+    def test_share_database_uses_custom_encoder(self):
+        """
+        Test that share_database uses custom encoder
+        """
+        share = 'user-{0}'.format(unicode_(uuid.uuid4()))
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        database = self.client[self.test_dbname]
+        with self.assertRaises(TypeError):
+            database.share_database(share)
+
+
+    def test_unshare_database_uses_custom_encoder(self):
+        """
+        Test that unshare_database uses custom encoder
+        """
+        share = 'user-{0}'.format(unicode_(uuid.uuid4()))
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        database = self.client[self.test_dbname]
+        with self.assertRaises(TypeError):
+            database.unshare_database(share)
+
     def test_get_security_document(self):
         """
         Test the retrieval of the security document.

tests/unit/index_tests.py

@@ -241,6 +241,17 @@ def test_create_an_index_using_design_prefix(self):
                  }
             )
 
+    def test_create_uses_custom_encoder(self):
+        """
+        Test that the create method uses the custom encoder
+        """
+        self.set_up_client(auto_connect=True, encoder="AEncoder")
+        database = self.client[self.test_dbname]
+        index = Index(database, '_design/ddoc001', 'index001', fields=['name', 'age'])
+        with self.assertRaises(TypeError):
+            index.create()
+
+
     def test_create_fails_due_to_ddocid_validation(self):
         """
         Ensure that if the design doc id is not a string the create call fails.

tests/unit/unit_t_db_base.py

@@ -134,7 +134,7 @@ def setUp(self):
         """
         self.set_up_client()
 
-    def set_up_client(self, auto_connect=False):
+    def set_up_client(self, auto_connect=False, encoder=None):
         if os.environ.get('RUN_CLOUDANT_TESTS') is None:
             admin_party = False
             if (os.environ.get('ADMIN_PARTY') and
@@ -148,7 +148,8 @@ def set_up_client(self, auto_connect=False):
                 self.pwd,
                 admin_party,
                 url=self.url,
-                connect=auto_connect
+                connect=auto_connect,
+                encoder=encoder
             )
         else:
             self.account = os.environ.get('CLOUDANT_ACCOUNT')
@@ -162,7 +163,8 @@ def set_up_client(self, auto_connect=False):
                 self.pwd,
                 url=self.url,
                 x_cloudant_user=self.account,
-                connect=auto_connect
+                connect=auto_connect,
+                encoder=encoder
             )