Add multiaddr support

Author: tim

README.rst

@@ -54,7 +54,7 @@ Tests
 
 .. code-block:: bash
 
-    $ pip install --process-dependency-links -e .[dev]
+    $ pip install -e .[dev]
     $ py.test -v
 
 

ipld/ipld.py

@@ -1,7 +1,8 @@
 from copy import deepcopy
-from multihash import digest
 
 from cbor import dumps, loads, Tag
+from multiaddr import Multiaddr
+from multihash import digest
 
 
 # NOTE: jbenet plans to register tag 258:
@@ -19,8 +20,13 @@ def transform(di):
                 di[k] = transform(v)
 
         if LINK_SYMBOL in di:
-            # TODO: Support: https://github.com/jbenet/js-multiaddr
             link = di.pop(LINK_SYMBOL)
+
+            try:
+                link = Multiaddr(link).to_bytes()
+            except ValueError:
+                pass
+
             if di:
                 raise KeyError('Links must not have siblings')
             return Tag(LINK_TAG, link)
@@ -35,15 +41,22 @@ def unmarshal(cbor_data):
     json_data = loads(cbor_data)
 
     def transform(di):
-        # NOTE: https://github.com/ipfs/js-ipld/blob/master/src/cbor.js#L81
-        #       Am I right in assuming that this is not supported in IPLD
-        #       anymore, as links cannot have properties themselves?
         for k, v in di.items():
-            # NOTE: Dear Python-experts: Is this safe?
             if isinstance(v, Tag):
-                di[k] = {
-                    LINK_SYMBOL: v.value
-                }
+                link = Multiaddr(bytes_addr=v.value)
+
+                try:
+                    # the __str__ method of Multiaddr could fail
+                    # if wrong values are passed to it (for example,
+                    # any value that is not a bytes list)
+                    link = str(link)
+                except:
+                    link = v.value
+                finally:
+                    di[k] = {
+                        LINK_SYMBOL: link
+                    }
+
             elif isinstance(v, dict):
                 di[k] = transform(v)
         return di

setup.py

@@ -64,6 +64,7 @@ def find_version(*file_paths):
         'cbor==1.0.0',
         'base58==0.2.2',
         'pymultihash==0.8.2',
+        'multiaddr==0.0.2',
     ],
     setup_requires=['pytest-runner'],
     tests_require=tests_require,

tests/test_ipld.py

@@ -2,6 +2,7 @@
 
 from cbor import dumps, Tag
 from ipld import LINK_TAG, marshal, multihash, unmarshal
+from multiaddr import Multiaddr
 
 
 def test_transform_dict_to_cbor():
@@ -151,6 +152,56 @@ def test_transform_cbor_with_nested_link_to_dict():
     assert unmarshal(src) == expected
 
 
+def test_transform_dict_to_cbor_with_multiaddr():
+    addr1 = Multiaddr('/ip4/127.0.0.1/udp/1234')
+    addr2 = Multiaddr('/ipfs/Qmafmh1Cw3H1bwdYpaaj5AbCW4LkYyUWaM7Nykpn5NZoYL')
+
+    src = {
+        'data': 'hello world',
+        'size': 11,
+        'l1': {
+            '/': str(addr1),
+        },
+        'l2': {
+            '/': str(addr2),
+        }
+    }
+
+    expected = {
+        'data': 'hello world',
+        'size': 11,
+        'l1': Tag(LINK_TAG, addr1.to_bytes()),
+        'l2': Tag(LINK_TAG, addr2.to_bytes()),
+    }
+
+    assert marshal(src) == dumps(expected, sort_keys=True)
+
+
+def test_transform_cbor_to_dict_with_multiaddr():
+    addr1 = Multiaddr('/ip4/127.0.0.1/udp/1234')
+    addr2 = Multiaddr('/ipfs/Qmafmh1Cw3H1bwdYpaaj5AbCW4LkYyUWaM7Nykpn5NZoYL')
+
+    src = dumps({
+        'data': 'hello world',
+        'size': 11,
+        'l1': Tag(LINK_TAG, addr1.to_bytes()),
+        'l2': Tag(LINK_TAG, addr2.to_bytes()),
+    }, sort_keys=True)
+
+    expected = {
+        'data': 'hello world',
+        'size': 11,
+        'l1': {
+            '/': str(addr1),
+        },
+        'l2': {
+            '/': str(addr2),
+        }
+    }
+
+    assert unmarshal(src) == expected
+
+
 def test_multihashing_cbor():
     src = dumps({
         'name': 'hello.txt',