Merge pull request #112 from ipfs/feat/dag-api-basics

feat: DAG API basics (get, put, rm)

Author: daviddias

API/dag/README.md

@@ -1,6 +1,8 @@
 dag API
 =======
 
+> The dag API comes to replace the `object API`, it support the creation and manipulation of dag-pb object, as well as other IPLD formats (i.e dag-cbor, ethereum-block, git, etc)
+
 #### `dag.put`
 
 > Store an IPLD format node
@@ -9,13 +11,10 @@ dag API
 
 ##### `JavaScript` - ipfs.dag.put(dagNode, formatMulticodec, hashAlg, callback)
 
-`dagNode` - a DAG node that follows one of the supported IPLD formats.
-
-`formatMulticodec` - The IPLD format multicodec.
-
-`hashAlg` - The hash algorithm to be used over the serialized dagNode.
-
-`callback` must follow `function (err) {}` signature, where `err` is an error if the operation was not successful.
+- `dagNode` - a DAG node that follows one of the supported IPLD formats.
+- `formatMulticodec` - The IPLD format multicodec.
+- `hashAlg` - The hash algorithm to be used over the serialized dagNode.
+- `callback` must follow `function (err) {}` signature, where `err` is an error if the operation was not successful.
 
 If no `callback` is passed, a [promise][] is returned.
 
@@ -25,9 +24,9 @@ If no `callback` is passed, a [promise][] is returned.
 
 ##### `Go` **WIP**
 
-##### `JavaScript` - ipfs.object.get(cid, callback)
+##### `JavaScript` - ipfs.dag.get(cid, callback)
 
-`cid` is a [CID][https://github.com/ipfs/js-cid] instance.
+- `cid` is a [CID][https://github.com/ipfs/js-cid] instance.
 
 `callback` must follow `function (err, dagNode) {}` signature, where `err` is an error if the operation was not successful and `dagNode` is the IPLD format DAG node retrieved.
 

package.json

@@ -33,6 +33,7 @@
     "concat-stream": "^1.6.0",
     "detect-node": "^2.0.3",
     "ipfs-block": "^0.5.4",
+    "ipld-dag-cbor": "^0.8.5",
     "ipld-dag-pb": "^0.9.3",
     "multiaddr": "^2.1.1",
     "multihashes": "^0.3.1",
@@ -52,4 +53,4 @@
     "haad <[email protected]>",
     "nginnever <[email protected]>"
   ]
-}
+}

src/dag.js

@@ -0,0 +1,141 @@
+/* eslint-env mocha */
+/* eslint max-nested-callbacks: ["error", 8] */
+
+'use strict'
+
+const expect = require('chai').expect
+const dagPB = require('ipld-dag-pb')
+const DAGNode = dagPB.DAGNode
+const dagCBOR = require('ipld-dag-cbor')
+
+module.exports = (common) => {
+  describe.only('.dag (basics)', () => {
+    let ipfs
+
+    before(function (done) {
+      // CI is slow
+      this.timeout(20 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => {
+      common.teardown(done)
+    })
+
+    describe('callback API', () => {
+      let pbNode
+      let cborNode
+
+      before((done) => {
+        const someData = new Buffer('some data')
+
+        pbNode = DAGNode.create(someData, (err, node) => {
+          expect(err).to.not.exist
+          pbNode = node
+          done()
+        })
+
+        cborNode = {
+          data: someData
+        }
+      })
+
+      describe('.put', () => {
+        it('dag-pb with default hash func (sha2-256)', (done) => {
+          ipfs.dag.put(pbNode, 'dag-pb', 'sha2-256', done)
+        })
+
+        it('dag-pb with custom hash func (sha3-512)', (done) => {
+          ipfs.dag.put(pbNode, 'dag-pb', 'sha3-512', done)
+        })
+
+        /*
+         * This works because dag-cbor will just treat pbNode as a regular object
+        it.skip('dag-pb node with wrong multicodec', (done) => {
+          // This works because dag-cbor will just treat pbNode as a
+          // regular object
+          ipfs.dag.put(pbNode, 'dag-cbor', 'sha3-512', (err) => {
+            expect(err).to.exist
+            done()
+          })
+        })
+        */
+
+        it('dag-cbor with default hash func (sha2-256)', (done) => {
+          ipfs.dag.put(cborNode, 'dag-cbor', 'sha2-256', done)
+        })
+
+        it('dag-cbor with custom hash func (sha3-512)', (done) => {
+          ipfs.dag.put(cborNode, 'dag-cbor', 'sha3-512', done)
+        })
+
+        it('dag-cbor node with wrong multicodec', (done) => {
+          ipfs.dag.put(cborNode, 'dag-pb', 'sha3-512', (err) => {
+            expect(err).to.exist
+            done()
+          })
+        })
+      })
+
+      describe('.get', () => {
+        let pbNode
+        let cborNode
+
+        before((done) => {
+          const someData = new Buffer('some other data')
+
+          pbNode = DAGNode.create(someData, (err, node) => {
+            expect(err).to.not.exist
+            pbNode = node
+            done()
+          })
+
+          cborNode = {
+            data: someData
+          }
+        })
+
+        it('dag-pb node', (done) => {
+          ipfs.dag.put(pbNode, 'dag-pb', 'sha2-256', (err) => {
+            expect(err).to.not.exist
+            dagPB.util.cid(pbNode, (err, cid) => {
+              expect(err).to.not.exist
+              ipfs.dag.get(cid, (err, node) => {
+                expect(err).to.not.exist
+                expect(pbNode.toJSON()).to.eql(node.toJSON())
+                done()
+              })
+            })
+          })
+        })
+
+        it('dag-cbor node', (done) => {
+          ipfs.dag.put(cborNode, 'dag-cbor', 'sha2-256', (err) => {
+            expect(err).to.not.exist
+            dagCBOR.util.cid(cborNode, (err, cid) => {
+              expect(err).to.not.exist
+              ipfs.dag.get(cid, (err, node) => {
+                expect(err).to.not.exist
+                expect(cborNode).to.eql(node)
+                done()
+              })
+            })
+          })
+        })
+      })
+    })
+
+    describe('promise API', () => {
+      describe('.put', () => {})
+      describe('.get', () => {})
+    })
+  })
+}

src/index.js

@@ -8,4 +8,5 @@ exports.generic = require('./generic')
 exports.swarm = require('./swarm')
 exports.block = require('./block')
 exports.dht = require('./dht')
+exports.dag = require('./dag')
 exports.pubsub = require('./pubsub')