modularize js-ipfs-api (#561)

* refactor: modularize js-ipfs-api(#544)

Author: nunofmn

.gitignore

@@ -4,3 +4,6 @@ test/setup/tmp-disposable-nodes-addrs.json
 dist
 coverage
 **/*.swp
+examples/sub-module/**/bundle.js
+examples/sub-module/**/*-minified.js
+examples/sub-module/*-bundle.js

README.md

@@ -25,6 +25,7 @@ ipfs-api
 - [Install](#install)
   - [Running the daemon with the right port](#running-the-daemon-with-the-right-port)
   - [Importing the module and usage](#importing-the-module-and-usage)
+  - [Importing a sub-module and usage](#importing-a-sub-module-and-usage)
   - [In a web browser through Browserify](#in-a-web-browser-through-browserify)
   - [In a web browser from CDN](#in-a-web-browser-from-cdn)
   - [CORS](#cors)
@@ -74,6 +75,14 @@ var ipfs = ipfsAPI('/ip4/127.0.0.1/tcp/5001')
 // or using options
 var ipfs = ipfsAPI({host: 'localhost', port: '5001', protocol: 'http'})
 ```
+### Importing a sub-module and usage
+```javascript
+const bitswap = require('ipfs-api/src/bitswap')('/ip4/127.0.0.1/tcp/5001')
+
+bitswap.unwant(key, (err) => {
+  // ...
+}
+```
 
 ### In a web browser through Browserify
 
@@ -224,12 +233,15 @@ This means:
 - [`ipfs.id([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#id)
 - [`ipfs.version([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#version)
 - [`ipfs.ping()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#ping)
-- [`ipfs.log()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#log)
 
-#### [key](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key)
+- log:
+  - [`ipfs.log.ls([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic)
+  - [`ipfs.log.tail([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic)
+  - [`ipfs.log.level(subsystem, level, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic)
 
-- [`ipfs.key.gen(name, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#gen)
-- [`ipfs.key.list([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#list)
+- key:
+  - [`ipfs.key.gen(name, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#gen)
+  - [`ipfs.key.list([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#list)
 
 ##### [name](https://github.com/ipfs/interface-ipfs-core/tree/master/API/name)
 

examples/sub-module/bundles-size-KBs.csv

@@ -0,0 +1,28 @@
+name, bundled (KBs), minified (KBs)
+IPFS, 1685.41, 661.64
+add, 968.11, 344.13
+bitswap, 684.80, 232.13
+block, 724.77, 250.23
+bootstrap, 685.64, 232.39
+cat, 725.05, 250.33
+commands, 683.89, 231.76
+config, 686.87, 233.10
+dht, 688.51, 233.41
+diag, 684.97, 232.18
+files, 1120.38, 404.30
+get, 907.74, 318.35
+id, 684.31, 231.95
+key, 684.59, 232.03
+log, 685.40, 232.38
+ls, 684.00, 231.80
+mount, 684.18, 231.86
+name, 684.63, 232.06
+object, 923.66, 340.57
+pin, 685.51, 232.39
+ping, 684.59, 231.90
+pubsub, 740.40, 249.54
+refs, 684.39, 231.94
+repo, 684.56, 232.02
+swarm, 1324.18, 527.03
+update, 684.45, 231.96
+version, 684.21, 231.88

examples/sub-module/complete-module.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../src')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/add/add.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/add')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/bitswap/bitswap.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/bitswap')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/block/block.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/block')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/bootstrap/bootstrap.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/bootstrap')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/cat/cat.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/cat')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/commands/commands.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/commands')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/config/config.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/config')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/dht/dht.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/dht')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/diag/diag.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/diag')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/files/files.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/files')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/get/get.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/get')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/id/id.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/id')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/key/key.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/key')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/log/log.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/log')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/ls/ls.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/ls')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/mount/mount.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/mount')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/name/name.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/name')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/object/object.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/object')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/pin/pin.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/pin')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/ping/ping.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/ping')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/pubsub/pubsub.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/pubsub')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/refs/refs.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/refs')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/repo/repo.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/repo')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/swarm/swarm.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/swarm')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/update/update.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/update')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/modules/version/version.js

@@ -0,0 +1,3 @@
+'use strict'
+
+require('../../../../src/version')('/ip4/127.0.0.1/tcp/5001')

examples/sub-module/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "sub-module",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Nuno Nogueira",
+  "license": "MIT",
+  "devDependencies": {
+    "babel-core": "^6.25.0",
+    "babel-loader": "^7.1.0",
+    "babel-preset-env": "^1.5.2",
+    "babili": "^0.1.4",
+    "webpack": "^3.0.0"
+  }
+}

examples/sub-module/test-modules-size.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+set -e
+
+modules=($(ls modules/))
+
+echo "name, bundled (KBs), minified (KBs)"
+
+# Full IPFS module
+webpack --display none --config webpack.confg.js complete-module.js complete-bundle.js
+babili complete-bundle.js -o complete-bundle-minified.js
+
+ipfsBundleSize=($(wc -c < complete-bundle.js | awk '{b=$1/1024; printf "%.2f\n", b}' | sed 's/,/./g'))
+ipfsMinSize=($(wc -c < complete-bundle-minified.js | awk '{b=$1/1024; printf "%.2f\n", b}' | sed 's/,/./g'))
+
+echo IPFS, $ipfsBundleSize, $ipfsMinSize
+
+for module in "${modules[@]}"
+do
+  moduledir="modules/$module"
+  webpack --display none --config webpack.config.js $moduledir/$module.js $moduledir/bundle.js
+  babili $moduledir/bundle.js -o $moduledir/bundle-minified.js
+
+  bundlesize=($(wc -c < $moduledir/bundle.js | awk '{b=$1/1024; printf "%.2f\n", b}' | sed 's/,/./g'))
+  minsize=($(wc -c < $moduledir/bundle-minified.js | awk '{b=$1/1024; printf "%.2f\n", b}' | sed 's/,/./g'))
+  echo $module, $bundlesize, $minsize
+done

examples/sub-module/webpack.config.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  module: {
+    loaders: [{
+      test: /\.js$/,
+      loaders: ['babel-loader']
+    }]
+  },
+  node: {
+    fs: 'empty',
+    net: 'empty',
+    tls: 'empty'
+  }
+}

src/add.js

@@ -0,0 +1,9 @@
+'use strict'
+
+const moduleConfig = require('./utils/module-config')
+
+module.exports = (arg) => {
+  const send = moduleConfig(arg)
+
+  return require('./files/add')(send)
+}