Merge pull request #92 from nmarley/sort-json-keys

sort keys when serializing objects to JSON

Author: whereswaldon

ipfsapi/encoding.py

@@ -277,7 +277,8 @@ def encode(self, obj):
             bytes
         """
         try:
-            result = json.dumps(obj)
+            result = json.dumps(obj, sort_keys=True, indent=None,
+                                separators=(',', ':'))
             if isinstance(result, six.text_type):
                 return result.encode("utf-8")
             else:

test/functional/tests.py

@@ -216,6 +216,19 @@ def test_add_recursive(self):
                          sorted(res,
                                 key=lambda x: x['Name']))
 
+    def test_add_json(self):
+        data = {'Action': 'Open', 'Type': 'PR', 'Name': 'IPFS', 'Pubkey': 7}
+        res = self.api.add_json(data)
+        self.assertEqual(data,
+                         self.api.get_json(res))
+
+        # have to test the string added to IPFS, deserializing JSON will not
+        # test order of keys
+        self.assertEqual(
+            '{"Action":"Open","Name":"IPFS","Pubkey":7,"Type":"PR"}',
+            self.api.cat(res).decode('utf-8')
+        )
+
     def test_add_get_pyobject(self):
         data = [-1, 3.14, u'Hän€', b'23' ]
         res = self.api.add_pyobj(data)

test/unit/test_encoding.py

@@ -107,7 +107,7 @@ def test_json_parse_chained_newlines(self):
     def test_json_encode(self):
         """Tests serilization of json formatted string into an object."""
         data = {'key': 'value'}
-        assert self.encoder_json.encode(data) == b'{"key": "value"}'
+        assert self.encoder_json.encode(data) == b'{"key":"value"}'
 
     def test_encode_pickle(self):
         """Tests serilization of pickle formatted string into an object."""