Adds "files add" http route.

Author: hackergrrl

src/http-api/resources/files.js

@@ -0,0 +1,82 @@
+'use strict'
+
+const bs58 = require('bs58')
+const ndjson = require('ndjson')
+const Readable = require('stream').Readable
+const multipart = require('ipfs-multipart')
+const debug = require('debug')
+const log = debug('http-api:files')
+log.error = debug('http-api:files:error')
+
+exports = module.exports
+
+exports.add = {
+  handler: (request, reply) => {
+    if (!request.payload) {
+      return reply('Array, Buffer, or String is required').code(400).takeover()
+    }
+
+    const parser = multipart.reqParser(request.payload)
+
+    var file = false
+    var written = 0
+
+    var serialize = ndjson.serialize()
+    // hapi doesn't permit object streams: http://hapijs.com/api#replyerr-result
+    serialize._readableState.objectMode = false
+
+    var fileAdder = request.server.app.ipfs.files.add()
+
+    fileAdder.on('data', (file) => {
+      serialize.write({
+        Name: file.path,
+        Hash: bs58.encode(file.multihash).toString()
+      })
+      written++
+    })
+
+    fileAdder.on('end', () => {
+      if (written === 0 && file) {
+        return reply({
+          Message: 'Failed to add files',
+          Code: 0
+        }).code(500)
+      } else {
+        serialize.end()
+        return reply(serialize)
+          .header('x-chunked-output', '1')
+          .header('content-type', 'application/json')
+      }
+    })
+
+    parser.on('file', (fileName, fileStream) => {
+      var rs = new Readable()
+      var init = false
+      rs._read = () => {
+        if (init) {
+          return
+        }
+        init = true
+      }
+      fileStream.on('data', (data) => {
+        rs.push(data)
+        file = true
+      })
+      fileStream.on('end', () => {
+        rs.push(null)
+        var filePair = {
+          path: fileName,
+          stream: rs
+        }
+        fileAdder.write(filePair)
+      })
+    })
+
+    parser.on('end', () => {
+      if (!file) {
+        return reply("File argument 'data' is required").code(400).takeover()
+      }
+      fileAdder.end()
+    })
+  }
+}

src/http-api/resources/index.js

@@ -9,3 +9,4 @@ exports.config = require('./config')
 exports.block = require('./block')
 exports.swarm = require('./swarm')
 exports.bitswap = require('./bitswap')
+exports.files = require('./files')

src/http-api/routes/files.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const resources = require('./../resources')
+
+module.exports = (server) => {
+  const api = server.select('API')
+
+  api.route({
+    method: '*',
+    path: '/api/v0/add',
+    config: {
+      payload: {
+        parse: false,
+        output: 'stream'
+      },
+      handler: resources.files.add.handler
+    }
+  })
+}

src/http-api/routes/index.js

@@ -8,6 +8,7 @@ module.exports = (server) => {
   require('./object')(server)
   // require('./repo')(server)
   require('./config')(server)
+  require('./files')(server)
   require('./swarm')(server)
   require('./bitswap')(server)
 }

test/http-api-tests/test-files.js

@@ -0,0 +1,161 @@
+/* eslint-env mocha */
+'use strict'
+
+const expect = require('chai').expect
+const APIctl = require('ipfs-api')
+const fs = require('fs')
+const FormData = require('form-data')
+const streamToPromise = require('stream-to-promise')
+const Readable = require('stream').Readable
+const http = require('http')
+
+function singleFileServer (filename) {
+  return http.createServer(function (req, res) {
+    fs.createReadStream(filename).pipe(res)
+  })
+}
+
+module.exports = (httpAPI) => {
+  describe('files', () => {
+    describe('api', () => {
+      let api
+
+      it('api', () => {
+        api = httpAPI.server.select('API')
+      })
+
+      describe('/files/add', () => {
+        it('returns 400 if no tuple is provided', (done) => {
+          const form = new FormData()
+          const headers = form.getHeaders()
+
+          streamToPromise(form).then((payload) => {
+            api.inject({
+              method: 'POST',
+              url: '/api/v0/add',
+              headers: headers,
+              payload: payload
+            }, (res) => {
+              expect(res.statusCode).to.equal(400)
+              done()
+            })
+          })
+        })
+
+        it('adds a file', (done) => {
+          const form = new FormData()
+          const filePath = 'test/test-data/node.json'
+          form.append('file', fs.createReadStream(filePath))
+          const headers = form.getHeaders()
+
+          streamToPromise(form).then((payload) => {
+            api.inject({
+              method: 'POST',
+              url: '/api/v0/add',
+              headers: headers,
+              payload: payload
+            }, (res) => {
+              expect(res.statusCode).to.equal(200)
+              done()
+            })
+          })
+        })
+
+        it('adds multiple files', (done) => {
+          const form = new FormData()
+          const filePath = 'test/test-data/hello'
+          const filePath2 = 'test/test-data/otherconfig'
+          form.append('file', fs.createReadStream(filePath))
+          form.append('file', fs.createReadStream(filePath2))
+          const headers = form.getHeaders()
+
+          streamToPromise(form).then((payload) => {
+            api.inject({
+              method: 'POST',
+              url: '/api/v0/add',
+              headers: headers,
+              payload: payload
+            }, (res) => {
+              expect(res.statusCode).to.equal(200)
+              done()
+            })
+          })
+        })
+      })
+    })
+
+    describe('using js-ipfs-api', () => {
+      var ctl
+
+      it('start IPFS API ctl', (done) => {
+        ctl = APIctl('/ip4/127.0.0.1/tcp/6001')
+        done()
+      })
+
+      describe('ipfs.add', () => {
+        it('adds two files under a chunk Size', (done) => {
+          const rs = new Readable()
+          const rs2 = new Readable()
+          var files = []
+          const buffered = fs.readFileSync('test/test-data/hello')
+          const buffered2 = fs.readFileSync('test/test-data/otherconfig')
+          rs.push(buffered)
+          rs.push(null)
+          rs2.push(buffered2)
+          rs2.push(null)
+          const filePair = {path: 'hello', content: rs}
+          const filePair2 = {path: 'otherconfig', content: rs2}
+          files.push(filePair)
+          files.push(filePair2)
+
+          ctl.add(files, (err, res) => {
+            expect(err).to.not.exist
+            expect(res[0].Name).to.equal('hello')
+            expect(res[0].Hash).to.equal('QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o')
+            expect(res[1].Name).to.equal('otherconfig')
+            expect(res[1].Hash).to.equal('QmayedZNznnEbHtyfjeQvvt29opSLjYjLtLqwfwSWq28ds')
+            done()
+          })
+        })
+
+        it('adds a large file > a chunk', (done) => {
+          const rs = new Readable()
+          var files = []
+          const buffered = fs.readFileSync('test/test-data/1.2MiB.txt')
+          rs.push(buffered)
+          rs.push(null)
+          const filePair = {path: '1.2MiB.txt', content: rs}
+          files.push(filePair)
+
+          ctl.add(filePair, (err, res) => {
+            expect(err).to.not.exist
+            expect(res[0].Name).to.equal('1.2MiB.txt')
+            expect(res[0].Hash).to.equal('QmW7BDxEbGqxxSYVtn3peNPQgdDXbWkoQ6J1EFYAEuQV3Q')
+            done()
+          })
+        })
+
+        it('adds a buffer', (done) => {
+          const buffer = new Buffer('hello world')
+          ctl.add(buffer, (err, res) => {
+            expect(err).to.not.exist
+            expect(res[0].Hash).to.equal('Qmf412jQZiuVUtdgnB36FXFX7xg5V6KEbSJ4dpQuhkLyfD')
+            done()
+          })
+        })
+
+        it('adds a url', (done) => {
+          var server = singleFileServer('test/test-data/1.2MiB.txt')
+          server.listen(2913, function () {
+            ctl.add('http://localhost:2913/', (err, res) => {
+              expect(err).to.not.exist
+              const added = res[0] != null ? res[0] : res
+              expect(added).to.have.a.property('Hash', 'QmW7BDxEbGqxxSYVtn3peNPQgdDXbWkoQ6J1EFYAEuQV3Q')
+              done()
+            })
+          })
+        })
+      })
+    })
+  })
+}