New API + use bin-wrapper (bundle in all arch without any concern) + global install

.gitignore

@@ -33,3 +33,6 @@ node_modules
 
 lib
 dist
+
+# Bin default dir
+vendor

.npmignore

@@ -30,3 +30,6 @@ build
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+
+# Bin default dir
+vendor

README.md

@@ -25,6 +25,8 @@ Install:
 npm install --save ipfsd-ctl
 ```
 
+__The current go ipfs version used is v0.4.3-rc3__
+
 ## Usage
 
 IPFS daemons are already easy to start and stop, but this module is here to do it from javascript itself.
@@ -36,17 +38,58 @@ IPFS daemons are already easy to start and stop, but this module is here to do i
 // IPFS_PATH will point to /tmp/ipfs_***** and will be
 // cleaned up when the process exits.
 
-var ipfsd = require('ipfsd-ctl')
-
-ipfsd.disposableApi(function (err, ipfs) {
-  ipfs.id(function (err, id) {
-    console.log(id)
-    process.kill()
+const ipfsd = require('ipfsd-ctl')
+
+ipfsd.create((err, node) => {
+  if (err) throw err
+  node.startDaemon((err) => {
+    if (err) throw err
+    const ipfs = node.apiCtl()
+    ipfs.id((err, id) => {
+      console.log(id)
+      process.kill()
+    })
   })
 })
 ```
 
-If you need want to use an existing ipfs installation you can set `$IPFS_EXEC=/path/to/ipfs` to ensure it uses that.
+The daemon controller safely spawns the node for you and exposes you an ipfs API client through `node.apiCtl()`. __If the parent process exits, the daemon will also be killed__ ensuring that the daemon isn't left hanging.
+
+This module works by downloading the binary once, on first use, if it detects that no current binary is available to use. So keep in mind that the first command executed might throw in some overhead.
+
+If you want to use an existing ipfs installation you can set `$IPFS_EXEC=/path/to/ipfs` to ensure it uses that.
+
+## API
+
+## ipfsd
+
+#### ipfsd.local(path, done)
+
+#### ipfsd.create(opts, done)
+
+## IPFSNode(path, opts, disposable)
+
+#### node.init(initOpts, done)
+
+#### node.shutdown(done)
+
+#### node.startDaemon(done)
+
+#### node.stopDaemon(done)
+
+#### node.apiCtl(done)
+
+#### node.daemonPid()
+
+#### node.getConfig(key, done)
+
+#### node.setConfig(key, value, done)
+
+#### node.replaceConf(file, done)
+
+#### node.version(done)
+
+#### node.subprocess
 
 ## Contribute
 

bin/check-binary

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+'use strict'
+
+console.log('Checking IPFS binary...')
+const binary = require('../src/binary')()
+const version = require('../src/config').version
+
+binary.check((err) => {
+  if (err) throw err
+  console.log(`IPFS binary version ${version} working`)
+})

examples/id.js

@@ -1,6 +1,6 @@
 'use strict'
 
-var ipfsd = require('../index.js')
+var ipfsd = require('../src')
 
 ipfsd.disposableApi(function (err, ipfs) {
   if (err) throw err

examples/local.js

@@ -1,6 +1,6 @@
 'use strict'
 
-var ipfsd = require('../index.js')
+var ipfsd = require('../src')
 
 // opens an api connection to local running ipfs node
 

package.json

@@ -5,6 +5,7 @@
   "main": "lib/index.js",
   "jsxnext:main": "src/index.js",
   "scripts": {
+    "postinstall": "./bin/check-binary",
     "lint": "aegir-lint",
     "coverage": "aegir-coverage",
     "test": "aegir-test --env node",
@@ -43,17 +44,17 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "go-ipfs-dep": "0.4.1",
     "ipfs-api": "^4.1.0",
     "multiaddr": "^2.0.0",
     "rimraf": "^2.4.5",
     "run-series": "^1.1.4",
     "shutdown": "^0.2.4",
-    "subcomandante": "^1.0.5"
+    "execa": "git://github.com/sindresorhus/execa.git#master",
+    "bin-wrapper": "^3.0.2"
   },
   "devDependencies": {
-    "aegir": "^8.0.1",
-    "mkdirp": "^0.5.1",
+    "aegir": "^8.1.0",
+    "chai": "^3.5.0",
     "pre-commit": "^1.1.2"
   },
   "repository": {
@@ -68,4 +69,4 @@
     "example": "examples",
     "test": "test"
   }
-}
+}

src/binary.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const BinWrapper = require('bin-wrapper')
+const config = require('./config')
+
+const binWrapper = new BinWrapper()
+  .src(config.baseUrl + 'darwin-386.tar.gz', 'darwin', 'ia32')
+  .src(config.baseUrl + 'darwin-amd64.tar.gz', 'darwin', 'x64')
+  .src(config.baseUrl + 'freebsd-amd64.tar.gz', 'freebsd', 'x64')
+  .src(config.baseUrl + 'linux-386.tar.gz', 'linux', 'ia32')
+  .src(config.baseUrl + 'linux-amd64.tar.gz', 'linux', 'x64')
+  .src(config.baseUrl + 'linux-arm.tar.gz', 'linux', 'arm')
+  .src(config.baseUrl + 'windows-386.tar.gz', 'win32', 'ia32')
+  .src(config.baseUrl + 'windows-amd64.tar.gz', 'win32', 'x64')
+  .use(process.platform === 'win32' ? 'ipfs.exe' : 'ipfs')
+
+function Binary (execPath) {
+  // Set dest path for the exec file
+  binWrapper.dest(process.env.IPFS_EXEC || execPath || config.defaultExecPath)
+  return {
+    path: () => binWrapper.path(),
+    // Has the binary been checked?
+    checked: false,
+    // Check that the binary exists and works
+    check (cb) {
+      if (this.checked) return cb()
+      binWrapper.run(['version'], (err) => {
+        // The binary is ok if no error poped up
+        this.checked = !err
+        return cb(err)
+      })
+    }
+  }
+}
+
+module.exports = Binary

src/config.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const path = require('path')
+
+const config = {
+  version: 'v0.4.3-rc4', // ipfs dist version
+  defaultExecPath: path.join(__dirname, '..', 'vendor'), // default path for the downloaded exec
+  gracePeriod: 7500 // amount of ms to wait before sigkill
+}
+
+const version = config.version
+config.baseUrl = `https://dist.ipfs.io/go-ipfs/${version}/go-ipfs_${version}_`
+
+module.exports = config

src/exec.js

@@ -0,0 +1,57 @@
+'use strict'
+
+const execa = require('execa')
+
+function exec (cmd, args, opts, handlers) {
+  opts = opts || {}
+  let err = ''
+  let result = ''
+  let callback
+  // Handy method if we just want the result and err returned in a callback
+  if (typeof handlers === 'function') {
+    callback = handlers
+    handlers = {
+      error: callback,
+      data: (data) => {
+        result += data
+      },
+      done: () => {
+        if (err) return callback(new Error(err))
+        callback(null, result)
+      }
+    }
+  }
+
+  // The listeners that will actually be set on the process
+  const listeners = {
+    data: handlers.data,
+    error: (data) => {
+      err += data
+    },
+    done: (code) => {
+      if (code !== 0) {
+        return handlers.error(
+          new Error(`non-zero exit code ${code}\n
+            while running: ${cmd} ${args.join(' ')}\n\n
+            ${err}`)
+        )
+      }
+      if (handlers.done) handlers.done()
+    }
+  }
+
+  const command = execa(cmd, args, opts)
+
+  if (listeners.data) command.stdout.on('data', listeners.data)
+
+  command.stderr.on('data', listeners.error)
+
+  // If command fails to execute return directly to the handler
+  command.on('error', handlers.error)
+
+  command.on('close', listeners.done)
+
+  return command
+}
+
+module.exports = exec

src/index.js

@@ -9,10 +9,15 @@ function tempDir () {
   return join(os.tmpdir(), `ipfs_${String(Math.random()).substr(2)}`)
 }
 
+const defaultOptions = {
+  'Addresses.Swarm': ['/ip4/0.0.0.0/tcp/0'],
+  'Addresses.Gateway': '',
+  'Addresses.API': '/ip4/127.0.0.1/tcp/0',
+  disposable: true,
+  init: true
+}
+
 module.exports = {
-  version (done) {
-    (new Node()).version(done)
-  },
   local (path, done) {
     if (!done) {
       done = path
@@ -24,36 +29,23 @@ module.exports = {
       done(null, new Node(path))
     })
   },
-  disposableApi (opts, done) {
+  create (opts, done) {
     if (typeof opts === 'function') {
       done = opts
       opts = {}
     }
-    this.disposable(opts, (err, node) => {
-      if (err) return done(err)
-      node.startDaemon(done)
-    })
-  },
-  disposable (opts, done) {
-    if (typeof opts === 'function') {
-      done = opts
-      opts = {}
-    }
-    opts['Addresses.Swarm'] = ['/ip4/0.0.0.0/tcp/0']
-    opts['Addresses.Gateway'] = ''
-    opts['Addresses.API'] = '/ip4/127.0.0.1/tcp/0'
 
-    if (opts.apiAddr) {
-      opts['Addresses.API'] = opts.apiAddr
-    }
+    let options = {}
+    Object.assign(options, defaultOptions, opts || {})
 
-    if (opts.gatewayAddr) {
-      opts['Addresses.Gateway'] = opts.gatewayAddr
-    }
+    const repoPath = options.repoPath || tempDir()
+    const disposable = options.disposable
+    delete options.disposable
+    delete options.repoPath
 
-    const node = new Node(opts.repoPath || tempDir(), opts, true)
+    const node = new Node(repoPath, options, disposable)
 
-    if (typeof opts.init === 'boolean' && opts.init === false) {
+    if (typeof options.init === 'boolean' && options.init === false) {
       process.nextTick(() => {
         done(null, node)
       })