ipfs-inactive · Oct 11, 2015 · Oct 11, 2015
Showing with 198 additions and 19 deletions.

+35 −0 README.md

+12 −0 examples/files-api.js

+1 −0 package.json

+17 −0 src/index.js

+3 −1 src/request-api.js

+130 −18 test/test.js
diff --git a/README.md b/README.md
@@ -215,3 +215,38 @@ curl 'http://localhost:5001/api/v0/object/get?arg=QmYEqnfCZp7a39Gxrgyv3qRS4MoCTG
 #### Pin
 
 #### Gateway
+
+#### Files
+
+##### mkdir
+
+bash:
+`curl "http://localhost:5001/api/v0/files/mkdir?arg=%2F<folder name>`"
+
+response: (it returns empty when successful)
+```
+```
+
+javascript:
+```JavaScript
+ipfs.files.mkdir(<folderName>, function (err) {})
+```
+
+response: (it returns empty when successful)
+```
+```
+
+##### cp
+
+##### ls
+
+##### stat
+
+##### rm
+
+##### read
+
+##### write
+
+##### mv
+curl "http://localhost:5001/api/v0/files/mkdir?arg=%2Ffolder4"
diff --git a/examples/files-api.js b/examples/files-api.js
@@ -0,0 +1,12 @@
+var ipfs = require('../src')('localhost', 5001)
+
+ipfs.files.ls('/folder1', function (err, res) {
+  if (err) {
+    return console.log(err)
+  }
+  if (res.readable) {
+    res.pipe(process.stdout)
+  } else {
+    console.log(res)
+  }
+})
diff --git a/package.json b/package.json
@@ -34,6 +34,7 @@
   },
   "scripts": {
     "test": "./node_modules/.bin/mocha",
+    "test-usn": "USE_SYSTEM_NODE='true' ./node_modules/.bin/mocha",
     "lint": "./node_modules/.bin/standard",
     "build": "./node_modules/.bin/browserify -t brfs -s ipfsAPI -e ./src/index.js | tee dist/ipfsapi.js | ./node_modules/.bin/uglifyjs -m > dist/ipfsapi.min.js"
   },

diff --git a/src/index.js b/src/index.js
@@ -233,4 +233,21 @@ function IpfsAPI (host_or_multiaddr, port) {
       return requestAPI('dht/put', [key, value], opts, null, cb)
     }
   }
+
+  self.files = {
+    cp: argCommand('files/cp'),
+    ls: argCommand('files/ls'),
+    mkdir: argCommand('files/mkdir'),
+    stat: argCommand('files/stat'),
+    rm: function (key, value, opts, cb) {
+      if (typeof (opts) === 'function') {
+        cb = opts
+        opts = {}
+      }
+      return requestAPI('config', [key, value], opts, null, cb)
+    },
+    read: argCommand('files/read'),
+    write: argCommand('files/write'),
+    mv: argCommand('files/mv')
+  }
 }
diff --git a/src/request-api.js b/src/request-api.js
@@ -83,7 +83,9 @@ function requestAPI (path, args, opts, files, buffer, cb) {
       }
 
       if (res.statusCode >= 400 || !res.statusCode) {
-        if (!data) data = new Error()
+        if (!data) {
+          data = new Error('Response error:' + res.statusCode)
+        }
         return cb(data, null)
       }
       return cb(null, data)

diff --git a/test/test.js b/test/test.js
@@ -22,19 +22,25 @@ describe('ipfs node api', function () {
     this.timeout(20000)
     log('ipfs node setup')
 
-    ipfsd.disposable(function (err, node) {
-      if (err) throw err
-      log('ipfs init done')
-      ipfsNode = node
-
-      ipfsNode.startDaemon(function (err, ignore) {
+    if (!process.env.USE_SYSTEM_NODE) {
+      ipfsd.disposable(function (err, node) {
         if (err) throw err
-        log('ipfs daemon running')
+        log('ipfs init done')
+        ipfsNode = node
 
-        ipfs = ipfsApi(ipfsNode.apiAddr)
-        done()
+        ipfsNode.startDaemon(function (err, ignore) {
+          if (err) throw err
+          log('ipfs daemon running')
+
+          ipfs = ipfsApi(ipfsNode.apiAddr)
+          done()
+        })
       })
-    })
+    } else {
+      log('NOTE: some tests will not pass if not connected to other nodes( ls, refs for e.g')
+      ipfs = ipfsApi('localhost', 5001)
+      done()
+    }
   })
 
   it('has the api object', function () {
@@ -287,17 +293,123 @@ describe('ipfs node api', function () {
     })
   })
 
-  it('test for error after daemon stops', function (done) {
-    this.timeout(6000)
-    var nodeStopped
-    ipfsNode.stopDaemon(function () {
-      if (!nodeStopped) {
-        nodeStopped = true
-        ipfs.id(function (err, res) {
-          assert.equal(err.code, 'ECONNREFUSED')
+  // [x] files.mkdir
+  // [x] files.cp
+  // [x] files.ls
+  // [x] files.stat
+  // [ ] files.read
+  // [ ] files.write
+  // [ ] files.mv
+  // [x] files.rm
+
+  // added on the add test 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
+
+  // --- files api tests
+
+  it('files.mkdir', function (done) {
+    this.timeout(20000)
+
+    ipfs.files.mkdir('/test-folder', function (err) {
+      console.log('->', err)
+      assert(!err)
+      if (err) {
+        return done()
+      }
+      done()
+    })
+  })
+
+  it('files.cp', function (done) {
+    this.timeout(20000)
+
+    ipfs.files
+      .cp(['/ipfs/Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP', '/test-folder/test-file'], function (err) {
+      assert(!err)
+      if (err) {
+        return done()
+      }
+      done()
+    })
+  })
+
+  it('files.ls', function (done) {
+    this.timeout(20000)
+
+    ipfs.files.ls('/test-folder', function (err, res) {
+      assert(!err)
+      if (err) {
+        return done()
+      }
+      assert.equal(res.Entries.length, 1)
+      done()
+    })
+  })
+
+  it('files.stat', function (done) {
+    this.timeout(20000)
+
+    ipfs.files.stat('/test-folder/test-file', function (err, res) {
+      assert(!err)
+      if (err) {
+        return done()
+      }
+      assert.deepEqual(res, {
+        Hash: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP',
+        Size: 12,
+        CumulativeSize: 20,
+        Blocks: 0
+      })
+
+      done()
+    })
+  })
+
+  // -
+
+  it('files.read', function (done) {
+    this.timeout(20000)
+
+    ipfs.files.read('/test-folder/test-file', function (err, stream) {
+      if (err) throw err
+      var buf = ''
+      stream
+        .on('error', function (err) { throw err })
+        .on('data', function (data) { buf += data })
+        .on('end', function () {
+          assert.equal(buf, fs.readFileSync(testfile))
           done()
         })
+    })
+  })
+
+  // -
+
+  it('files.rm', function (done) {
+    this.timeout(20000)
+
+    // TODO fix the recursive qs value based on Jeromy input
+    ipfs.files.rm('/test-folder', { '-r': true }, function (err) {
+      assert(!err)
+      if (err) {
+        return done()
       }
+      done()
     })
   })
+
+  it('test for error after daemon stops', function (done) {
+    if (!process.env.USE_SYSTEM_NODE) {
+      this.timeout(6000)
+      var nodeStopped
+      ipfsNode.stopDaemon(function () {
+        if (!nodeStopped) {
+          nodeStopped = true
+          ipfs.id(function (err, res) {
+            assert.equal(err.code, 'ECONNREFUSED')
+            done()
+          })
+        }
+      })
+    } else { done() }
+  })
 })