From 9b513dd44692ffa14cd19440951785cd07868578 Mon Sep 17 00:00:00 2001
From: David Dias <daviddias.p@gmail.com>
Date: Thu, 30 Jun 2016 14:12:34 +0100
Subject: [PATCH] refactor(module+tests): Enable running the tests individually
 and reduce complexity inside ipfs-api

---
 API.md                  | 204 ----------------------------------------
 README.md               |  48 +++++++++-
 package.json            |  29 +++---
 src/api/config.js       |  59 +++++++++---
 src/get-files-stream.js |   4 +-
 src/request-api.js      |   6 +-
 test/api/config.spec.js | 142 +++-------------------------
 7 files changed, 122 insertions(+), 370 deletions(-)
 delete mode 100644 API.md

diff --git a/API.md b/API.md
deleted file mode 100644
index b700119ee..000000000
--- a/API.md
+++ /dev/null
@@ -1,204 +0,0 @@
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
-- [API Reference](#api-reference)
-  - [Core](#core)
-      - [`version([callback])`](#versioncallback)
-      - [`id([callback])`](#idcallback)
-      - [`block`](#block)
-        - [`block.put(buffer, [callback])`](#blockputbuffer-callback)
-        - [`block.get(hash, [callback])`](#blockgethash-callback)
-        - [`block.stat(hash, [callback])`](#blockstathash-callback)
-      - [`object`](#object)
-        - [`object.put(buffer, encoding, [callback])`](#objectputbuffer-encoding-callback)
-        - [`object.get(hash, [callback])`](#objectgethash-callback)
-        - [`object.data(hash, [callback])`](#objectdatahash-callback)
-        - [`object.stat(hash, [callback])`](#objectstathash-callback)
-        - [`object.links(hash, [callback])`](#objectlinkshash-callback)
-        - [`object.new(hash, [callback])`](#objectnewhash-callback)
-        - [`object.patch`](#objectpatch)
-          - [`object.patch.addLink(hash, name, ref, [callback])`](#objectpatchaddlinkhash-name-ref-callback)
-          - [`object.patch.rmLink(hash, name, [callback])`](#objectpatchrmlinkhash-name-callback)
-          - [`object.patch.setData(hash, data, [callback])`](#objectpatchsetdatahash-data-callback)
-          - [`object.patch.appendData(hash, data, ref, [callback])`](#objectpatchappenddatahash-data-ref-callback)
-      - [`refs(hash, options, [callback])`](#refshash-options-callback)
-        - [`refs.local(hash, [callback])`](#refslocalhash-callback)
-      - [`pin`](#pin)
-        - [`pin.add(hash, options, [callback])`](#pinaddhash-options-callback)
-        - [`pin.remove(hash, options, [callback])`](#pinremovehash-options-callback)
-        - [`pin.list(hash, options, [callback])`](#pinlisthash-options-callback)
-      - [`log`](#log)
-        - [`log.tail([callback])`](#logtailcallback)
-  - [Extensions](#extensions)
-      - [`add(arrayOrBufferOrStream, [callback])`](#addarrayorbufferorstream-callback)
-      - [`name`](#name)
-        - [`name.publish(hash, [callback])`](#namepublishhash-callback)
-        - [`name.resolve(hash, [callback])`](#nameresolvehash-callback)
-      - [`files`](#files)
-        - [`files.cp(src, target, [callback])`](#filescpsrc-target-callback)
-        - [`files.ls(folder, [callback])`](#fileslsfolder-callback)
-        - [`files.mkdir(folder, [options, callback])`](#filesmkdirfolder-options-callback)
-        - [`files.stat(fileOrFolder, [callback])`](#filesstatfileorfolder-callback)
-        - [`files.rm(fileOrFolder, [options, callback])`](#filesrmfileorfolder-options-callback)
-        - [`files.read(fileOrFolder, [callback])`](#filesreadfileorfolder-callback)
-        - [`files.write(file, bufferOrArray, [options, callback])`](#fileswritefile-bufferorarray-options-callback)
-        - [`files.mv(src, target, [callback])`](#filesmvsrc-target-callback)
-      - [`mount(ipfs, ipns, [callback])`](#mountipfs-ipns-callback)
-  - [Tooling](#tooling)
-      - [`commands([callback])`](#commandscallback)
-      - [`update`](#update)
-        - [`update.apply([callback])`](#updateapplycallback)
-        - [`update.check([callback])`](#updatecheckcallback)
-        - [`update.log([callback])`](#updatelogcallback)
-      - [`diag`](#diag)
-        - [`diag.net([callback])`](#diagnetcallback)
-        - [`diag.sys([callback])`](#diagsyscallback)
-        - [`diag.cmds([callback])`](#diagcmdscallback)
-  - [Network](#network)
-      - [`ping(id, [callback])`](#pingid-callback)
-      - [`dht`](#dht)
-        - [`dht.findprovs([callback])`](#dhtfindprovscallback)
-        - [`dht.get(key, [options, callback])`](#dhtgetkey-options-callback)
-        - [`dht.put(key, value, [options, callback])`](#dhtputkey-value-options-callback)
-      - [`swarm`](#swarm)
-        - [`swarm.peers([callback])`](#swarmpeerscallback)
-        - [`swarm.connect(address, [callback])`](#swarmconnectaddress-callback)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-# API Reference
-
-We classify the API calls by 'core', 'extensions', 'tooling', and 'network', following the same API spec organization available at [ipfs/specs](https://github.com/ipfs/specs/tree/master/api).
-
-The tests folder also contains great examples that can be used to understand how this client library interacts with the HTTP-API. You can find the [tests here](test/api).
-
-## Core
-
-#### `version([callback])`
-
-- [tests](test/api/version.spec.js)
-
-#### `id([callback])`
-
-- [tests](test/api/id.spec.js)
-
-#### `block`
-
-- [tests](test/api/block.spec.js)
-
-##### `block.put(buffer, [callback])`
-##### `block.get(hash, [callback])`
-##### `block.stat(hash, [callback])`
-
-#### `object`
-
-- [tests](test/api/object.spec.js)
-
-##### `object.put(buffer, encoding, [callback])`
-##### `object.get(hash, [callback])`
-##### `object.data(hash, [callback])`
-##### `object.stat(hash, [callback])`
-##### `object.links(hash, [callback])`
-##### `object.new(hash, [callback])`
-
-##### `object.patch`
-
-###### `object.patch.addLink(hash, name, ref, [callback])`
-###### `object.patch.rmLink(hash, name, [callback])`
-###### `object.patch.setData(hash, data, [callback])`
-###### `object.patch.appendData(hash, data, ref, [callback])`
-
-#### `refs(hash, options, [callback])`
-
-- [tests](test/api/refs.spec.js)
-
-##### `refs.local(hash, [callback])`
-
-
-#### `pin`
-
-- [tests](test/api/pin.spec.js)
-
-##### `pin.add(hash, options, [callback])`
-##### `pin.remove(hash, options, [callback])`
-##### `pin.list(hash, options, [callback])`
-
-#### `log`
-
-- [tests](test/api/log.spec.js)
-
-##### `log.tail([callback])`
-
-## Extensions
-
-#### `add(arrayOrBufferOrStream, [callback])`
-
-- [tests](test/api/add.spec.js)
-
-#### `name`
-
-- [tests](test/api/name.spec.js)
-
-##### `name.publish(hash, [callback])`
-##### `name.resolve(hash, [callback])`
-
-#### `files`
-
-- [tests](test/api/files.spec.js)
-
-##### `files.cp(src, target, [callback])`
-##### `files.ls(folder, [callback])`
-##### `files.mkdir(folder, [options, callback])`
-##### `files.stat(fileOrFolder, [callback])`
-##### `files.rm(fileOrFolder, [options, callback])`
-##### `files.read(fileOrFolder, [callback])`
-##### `files.write(file, bufferOrArray, [options, callback])`
-##### `files.mv(src, target, [callback])`
-
-#### `mount(ipfs, ipns, [callback])`
-
-- [tests](test/api/mount.spec.js)
-
-## Tooling
-
-#### `commands([callback])`
-
-- [tests](test/api/commands.spec.js)
-
-#### `update`
-
-- [tests](test/api/update.spec.js)
-
-##### `update.apply([callback])`
-##### `update.check([callback])`
-##### `update.log([callback])`
-
-#### `diag`
-
-- [tests](test/api/diag.spec.js)
-
-##### `diag.net([callback])`
-##### `diag.sys([callback])`
-##### `diag.cmds([callback])`
-
-## Network
-
-#### `ping(id, [callback])`
-
-- [tests](test/api/ping.spec.js)
-
-#### `dht`
-
-- [tests](test/api/dht.spec.js)
-
-##### `dht.findprovs([callback])`
-##### `dht.get(key, [options, callback])`
-##### `dht.put(key, value, [options, callback])`
-
-#### `swarm`
-
-- [tests](test/api/swarm.spec.js)
-
-##### `swarm.peers([callback])`
-##### `swarm.connect(address, [callback])`
diff --git a/README.md b/README.md
index 8e63759b9..5a9197595 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-# js-ipfs-api
+ipfs-api
+========
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
@@ -9,7 +10,9 @@
 [![Travis CI](https://travis-ci.org/ipfs/js-ipfs-api.svg?branch=master)](https://travis-ci.org/ipfs/js-ipfs-api)
 [![Circle CI](https://circleci.com/gh/ipfs/js-ipfs-api.svg?style=svg)](https://circleci.com/gh/ipfs/js-ipfs-api)
 
-> A client library for the IPFS HTTP API, implemented in JavaScript.
+> A client library for the IPFS HTTP API, implemented in JavaScript. This client library implements the [interface-ipfs-core](https://github.com/ipfs/interface-ipfs-core) enabling applications to change between a embebed js-ipfs node and any remove IPFS node without having to change the code. In addition, this client library implements a set of utility functions.
+
+![](https://github.com/ipfs/interface-ipfs-core/raw/master/img/badge.png)
 
 ## Table of Contents
 
@@ -20,7 +23,7 @@
   - [In the Browser through `<script>` tag](#in-the-browser-through-script-tag)
   - [CORS](#cors)
 - [Usage](#usage)
-  - [Callbacks and promises](#callbacks-and-promises)
+  - [Callbacks and Promises](#callbacks-and-promises)
 - [Contribute](#contribute)
 - [License](#license)
 
@@ -99,7 +102,7 @@ $ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin "[\"http://exam
 
 ## Usage
 
-See [API.md](API.md) and [`tests/api`](test/api) for details on available methods.
+See [interface-ipfs-core](https://github.com/ipfs/interface-ipfs-core) for the standard IPFS API. In addition, this module implements a set of utility functions.
 
 ### Callbacks and promises
 
@@ -118,9 +121,40 @@ ipfs.id()
 This relies on a global `Promise` object. If you are in an environment where that is not
 yet available you need to bring your own polyfill.
 
+### Utility functions
+
+These utility functions are scoped behind the `ipfs.util`.
+
+#### Add files or entire directories from the FileSystem to IPFS
+
+> `ipfs.util.fsAdd(path, callback)`
+
+Reads path from disk, if it is a directory, will add it recursively, if not, will add the file.
+
+```JavaScript
+```
+
+#### Add a file from a URL to IPFS
+
+> `ipfs.util.urlAdd(url, callback)`
+
+```JavaScript
+```
+
+#### Add a file from a stream to IPFS
+
+> `ipfs.util.streamAdd(stream, callback)`
+
+This is very similar to `ipfs.files.add({path:'', content: stream})`. It is like the reverse of cat
+
+```JavaScript
+```
+
+
+
 ## Contribute
 
-The js-ipfs API is a work in progress. As such, there's a few things you can do right now to help out:
+The js-ipfs-api is a work in progress. As such, there's a few things you can do right now to help out:
 
 * **[Check out the existing issues](https://github.com/ipfs/js-ipfs-api/issues)**!
 * **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
@@ -131,6 +165,10 @@ The js-ipfs API is a work in progress. As such, there's a few things you can do
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
 
+## Historical context
+
+This module started as a direct mapping from the go-ipfs cli to a JavaScript implementation, although this was useful and familiar to a lot of developers that were coming to IPFS for the first time, it also created some confusion on how to operate the core of IPFS and have access to the full capacity of the protocol. After much consideration, we decided to create `interface-ipfs-core` with the goal of standardizing the interface of a core implementation of IPFS, and keep the utility functions the IPFS community learned to use and love, such as reading files from disk and storing them directly to IPFS.
+
 ## License
 
 [MIT](LICENSE)
diff --git a/package.json b/package.json
index 38adb7b71..5e8aab7b5 100644
--- a/package.json
+++ b/package.json
@@ -1,9 +1,21 @@
 {
   "name": "ipfs-api",
   "version": "6.0.3",
-  "description": "A client library for the IPFS API",
+  "description": "A client library for the IPFS HTTP API. Follows interface-ipfs-core spec",
   "main": "lib/index.js",
   "jsnext:main": "src/index.js",
+  "scripts": {
+    "test": "gulp test",
+    "test:node": "gulp test:node",
+    "test:browser": "gulp test:browser",
+    "lint": "aegir-lint",
+    "build": "gulp build",
+    "release": "gulp release",
+    "release-minor": "gulp release --type minor",
+    "release-major": "gulp release --type major",
+    "coverage": "gulp coverage",
+    "coverage-publish": "aegir-coverage publish"
+  },
   "dependencies": {
     "async": "^2.0.0-rc.5",
     "babel-runtime": "^6.6.1",
@@ -20,6 +32,7 @@
     "ndjson": "^1.4.3",
     "promisify-es6": "^1.0.1",
     "qs": "^6.1.0",
+    "streamifier": "^0.1.1",
     "wreck": "^7.0.2"
   },
   "engines": {
@@ -40,18 +53,6 @@
     "stream-http": "^2.2.0",
     "streamifier": "^0.1.1"
   },
-  "scripts": {
-    "test": "gulp test",
-    "test:node": "gulp test:node",
-    "test:browser": "gulp test:browser",
-    "lint": "aegir-lint",
-    "build": "gulp build",
-    "release": "gulp release",
-    "release-minor": "gulp release --type minor",
-    "release-major": "gulp release --type major",
-    "coverage": "gulp coverage",
-    "coverage-publish": "aegir-coverage publish"
-  },
   "pre-commit": [
     "lint",
     "test"
@@ -94,4 +95,4 @@
     "url": "https://github.com/ipfs/js-ipfs-api/issues"
   },
   "homepage": "https://github.com/ipfs/js-ipfs-api"
-}
\ No newline at end of file
+}
diff --git a/src/api/config.js b/src/api/config.js
index 582362bb6..670a3265e 100644
--- a/src/api/config.js
+++ b/src/api/config.js
@@ -1,31 +1,64 @@
 'use strict'
 
-const argCommand = require('../cmd-helpers').argCommand
+const streamifier = require('streamifier')
 
 module.exports = (send) => {
   return {
-    get: argCommand(send, 'config'),
-    set (key, value, opts, cb) {
-      if (typeof (opts) === 'function') {
-        cb = opts
+    get (key, callback) {
+      if (typeof key === 'function') {
+        callback = key
+        key = undefined
+      }
+
+      if (!key) {
+        return send('config/show', null, null, null, true, callback)
+      }
+
+      return send('config', key, null, null, (err, result) => {
+        if (err) {
+          return callback(err)
+        }
+        callback(null, result.Value)
+      })
+    },
+    set (key, value, opts, callback) {
+      if (typeof opts === 'function') {
+        callback = opts
         opts = {}
       }
+      if (typeof key !== 'string') {
+        return callback(new Error('Invalid key type'))
+      }
+
+      if (typeof value !== 'object' &&
+          typeof value !== 'boolean' &&
+          typeof value !== 'string') {
+        return callback(new Error('Invalid value type'))
+      }
 
-      if (typeof (value) === 'object') {
+      if (typeof value === 'object') {
         value = JSON.stringify(value)
         opts = { json: true }
-      } else if (typeof (value) === 'boolean') {
+      }
+
+      if (typeof value === 'boolean') {
         value = value.toString()
         opts = { bool: true }
       }
 
-      return send('config', [key, value], opts, null, cb)
-    },
-    show (cb) {
-      return send('config/show', null, null, null, true, cb)
+      return send('config', [key, value], opts, null, callback)
     },
-    replace (file, cb) {
-      return send('config/replace', null, null, file, cb)
+    replace (config, callback) {
+      // Its a path
+      if (typeof config === 'string') {
+        return send('config/replace', null, null, config, callback)
+      }
+
+      // Its a config obj
+      if (typeof config === 'object') {
+        config = streamifier.createReadStream(new Buffer(JSON.stringify(config)))
+        return send('config/replace', null, null, config, callback)
+      }
     }
   }
 }
diff --git a/src/get-files-stream.js b/src/get-files-stream.js
index f723b34fd..485e06cce 100644
--- a/src/get-files-stream.js
+++ b/src/get-files-stream.js
@@ -93,7 +93,9 @@ function loadPaths (opts, file) {
 }
 
 function getFilesStream (files, opts) {
-  if (!files) return null
+  if (!files) {
+    return null
+  }
 
   const mp = new Multipart()
 
diff --git a/src/request-api.js b/src/request-api.js
index bef4fafcf..e3d173a43 100644
--- a/src/request-api.js
+++ b/src/request-api.js
@@ -25,7 +25,8 @@ function onRes (buffer, cb) {
 
     const stream = Boolean(res.headers['x-stream-output'])
     const chunkedObjects = Boolean(res.headers['x-chunked-output'])
-    const isJson = res.headers['content-type'] && res.headers['content-type'].indexOf('application/json') === 0
+    const isJson = res.headers['content-type'] &&
+                   res.headers['content-type'].indexOf('application/json') === 0
 
     if (res.statusCode >= 400 || !res.statusCode) {
       const error = new Error(`Server responded with ${res.statusCode}`)
@@ -84,7 +85,7 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
   const port = config.port ? `:${config.port}` : ''
 
   const opts = {
-    method: files ? 'POST' : 'GET',
+    method: 'POST',
     uri: `${config.protocol}://${config.host}${port}${config['api-path']}${path}?${Qs.stringify(qs, {arrayFormat: 'repeat'})}`,
     headers: {}
   }
@@ -100,7 +101,6 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
     }
 
     opts.headers['Content-Type'] = `multipart/form-data; boundary=${stream.boundary}`
-    opts.downstreamRes = stream
     opts.payload = stream
   }
 
diff --git a/test/api/config.spec.js b/test/api/config.spec.js
index 21ca82d8e..af096e6ae 100644
--- a/test/api/config.spec.js
+++ b/test/api/config.spec.js
@@ -2,133 +2,15 @@
 /* globals apiClients */
 'use strict'
 
-const expect = require('chai').expect
-const isNode = require('detect-node')
-const path = require('path')
-
-describe('.config', () => {
-  describe('.config.{set, get}', () => {
-    it('string', (done) => {
-      const confKey = 'arbitraryKey'
-      const confVal = 'arbitraryVal'
-
-      apiClients.a.config.set(confKey, confVal, (err, res) => {
-        expect(err).to.not.exist
-        apiClients.a.config.get(confKey, (err, res) => {
-          expect(err).to.not.exist
-          expect(res).to.have.a.property('Value', confVal)
-          done()
-        })
-      })
-    })
-
-    it('bool', (done) => {
-      const confKey = 'otherKey'
-      const confVal = true
-
-      apiClients.a.config.set(confKey, confVal, (err, res) => {
-        expect(err).to.not.exist
-        apiClients.a.config.get(confKey, (err, res) => {
-          expect(err).to.not.exist
-          expect(res.Value).to.deep.equal(confVal)
-          done()
-        })
-      })
-    })
-
-    it('json', (done) => {
-      const confKey = 'API.HTTPHeaders.Access-Control-Allow-Origin'
-      const confVal = ['http://example.io']
-
-      apiClients.a.config.set(confKey, confVal, (err, res) => {
-        expect(err).to.not.exist
-        apiClients.a.config.get(confKey, (err, res) => {
-          expect(err).to.not.exist
-          expect(res.Value).to.deep.equal(confVal)
-          done()
-        })
-      })
-    })
-  })
-
-  it('.config.show', (done) => {
-    apiClients.c.config.show((err, res) => {
-      expect(err).to.not.exist
-      expect(res).to.exist
-      done()
-    })
-  })
-
-  it('.config.replace', (done) => {
-    if (!isNode) {
-      return done()
-    }
-
-    apiClients.c.config.replace(path.join(__dirname, '/../r-config.json'), (err, res) => {
-      expect(err).to.not.exist
-      expect(res).to.be.equal(null)
-      done()
-    })
-  })
-
-  describe('promise', () => {
-    describe('.config.{set, get}', () => {
-      it('string', () => {
-        const confKey = 'arbitraryKey'
-        const confVal = 'arbitraryVal'
-
-        return apiClients.a.config.set(confKey, confVal)
-          .then((res) => {
-            return apiClients.a.config.get(confKey)
-          })
-          .then((res) => {
-            expect(res).to.have.a.property('Value', confVal)
-          })
-      })
-
-      it('bool', () => {
-        const confKey = 'otherKey'
-        const confVal = true
-
-        return apiClients.a.config.set(confKey, confVal)
-          .then((res) => {
-            return apiClients.a.config.get(confKey)
-          })
-          .then((res) => {
-            expect(res.Value).to.deep.equal(confVal)
-          })
-      })
-
-      it('json', () => {
-        const confKey = 'API.HTTPHeaders.Access-Control-Allow-Origin'
-        const confVal = ['http://example.com']
-
-        return apiClients.a.config.set(confKey, confVal)
-          .then((res) => {
-            return apiClients.a.config.get(confKey)
-          })
-          .then((res) => {
-            expect(res.Value).to.deep.equal(confVal)
-          })
-      })
-    })
-
-    it('.config.show', () => {
-      return apiClients.c.config.show()
-        .then((res) => {
-          expect(res).to.exist
-        })
-    })
-
-    it('.config.replace', () => {
-      if (!isNode) {
-        return
-      }
-
-      return apiClients.c.config.replace(path.join(__dirname, '/../r-config.json'))
-        .then((res) => {
-          expect(res).to.be.equal(null)
-        })
-    })
-  })
-})
+const test = require('interface-ipfs-core')
+
+const common = {
+  setup: function (cb) {
+    cb(null, apiClients.a)
+  },
+  teardown: function (cb) {
+    cb()
+  }
+}
+
+test.config(common)