Merge pull request #67 from ckeenan/extra-opts

add opts param to IpfsAPI, allow 'protocol' config

Author: daviddias

README.md

@@ -22,7 +22,13 @@ $ npm install --save ipfs-api
 var ipfsAPI = require('ipfs-api')
 
 // connect to ipfs daemon API server
-var ipfs = ipfsAPI('localhost', '5001') // leaving out the arguments will default to these values
+var ipfs = ipfsAPI('localhost', '5001', {protocol: 'http'}) // leaving out the arguments will default to these values
+
+// or connect with multiaddr
+var ipfs = ipfsAPI('/ip4/127.0.0.1/tcp/5001')
+
+// or using options
+var ipfs = ipfsAPI({host: 'localhost', port: '5001', procotol: 'http'})
 ```
 
 ### In the Browser through browserify

dist/ipfsapi.js

@@ -47,7 +47,7 @@ module.exports = function (config) {
     basePath: '',
     frameworks: ['mocha'],
     files: [
-      'test/tests.js'
+      'test/*.spec.js'
     ],
     exclude: [],
     preprocessors: {

dist/ipfsapi.min.js

@@ -7,6 +7,7 @@ exports = module.exports = () => {
     'api-path': '/api/v0/',
     'user-agent': `/node-${pkg.name}/${pkg.version}/`,
     'host': 'localhost',
-    'port': '5001'
+    'port': '5001',
+    'protocol': 'http'
   }
 }

karma.conf.js

@@ -8,23 +8,33 @@ const ndjson = require('ndjson')
 
 exports = module.exports = IpfsAPI
 
-function IpfsAPI (host_or_multiaddr, port) {
+function IpfsAPI (host_or_multiaddr, port, opts) {
   const self = this
   const config = getConfig()
 
   if (!(self instanceof IpfsAPI)) {
-    return new IpfsAPI(host_or_multiaddr, port)
+    return new IpfsAPI(host_or_multiaddr, port, opts)
   }
 
   try {
     const maddr = multiaddr(host_or_multiaddr).nodeAddress()
     config.host = maddr.address
     config.port = maddr.port
   } catch (e) {
-    config.host = host_or_multiaddr
-    config.port = port || config.port
+    if (typeof host_or_multiaddr === 'string') {
+      config.host = host_or_multiaddr
+      config.port = port && typeof port !== 'object' ? port : config.port
+    }
+  }
+
+  let lastIndex = arguments.length
+  while (!opts && lastIndex-- > 0) {
+    opts = arguments[lastIndex]
+    if (opts) break
   }
 
+  Object.assign(config, opts)
+
   // autoconfigure in browser
   if (!config.host &&
     typeof window !== 'undefined') {

src/config.js

@@ -89,7 +89,7 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
 
   const opts = {
     method: files ? 'POST' : 'GET',
-    uri: `http://${config.host}:${config.port}${config['api-path']}${path}?${Qs.stringify(qs, {arrayFormat: 'repeat'})}`,
+    uri: `${config.protocol}://${config.host}:${config.port}${config['api-path']}${path}?${Qs.stringify(qs, {arrayFormat: 'repeat'})}`,
     headers: {}
   }
 

src/index.js

@@ -34,7 +34,7 @@ gulp.task('test:browser', done => {
 })
 
 gulp.task('mocha', () => {
-  return gulp.src('test/tests.js')
+  return gulp.src('test/*.spec.js')
     .pipe($.mocha())
 })
 

src/request-api.js

@@ -0,0 +1,51 @@
+'use strict'
+
+const ipfsAPI = require('../src/index.js')
+const assert = require('assert')
+
+describe('ipfsAPI constructor tests', () => {
+  describe('parameter permuations', () => {
+    const apiAddrs = require('./tmp-disposable-nodes-addrs.json')
+    const apiAddr = apiAddrs.a.split('/')
+
+    function clientWorks (client, done) {
+      client.id((err, res) => {
+        if (err) throw err
+        const id = res
+        assert(id.ID)
+        assert(id.PublicKey)
+        done()
+      })
+    }
+
+    it('opts', (done) => {
+      clientWorks(ipfsAPI({
+        host: apiAddr[2],
+        port: apiAddr[4],
+        protocol: 'http'
+      }), done)
+    })
+
+    it('mutliaddr, opts', (done) => {
+      clientWorks(ipfsAPI(
+        apiAddrs.a,
+        {protocol: 'http'}
+      ), done)
+    })
+
+    it('host, port', (done) => {
+      clientWorks(ipfsAPI(
+        apiAddr[2],
+        apiAddr[4]
+      ), done)
+    })
+
+    it('host, port, opts', (done) => {
+      clientWorks(ipfsAPI(
+        apiAddr[2],
+        apiAddr[4],
+        {protocol: 'http'}
+      ), done)
+    })
+  })
+})