Merge branch 'master' of https://github.com/libp2p/interface-content-routing into remote/connection

.gitignore

@@ -0,0 +1,59 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Dias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,68 @@
+interface-content-routing
+=====================
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+
+> A test suite and interface you can use to implement a Content Routing module for libp2p.
+
+The primary goal of this module is to enable developers to pick and swap their Content Routing module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer.
+
+Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.
+
+The API is presented with both Node.js and Go primitives, however, there is not actual limitations for it to be extended for any other language, pushing forward the cross compatibility and interop through diferent stacks.
+
+## Lead Maintainer
+
+[Vasco Santos](https://github.com/vasco-santos).
+
+# Modules that implement the interface
+
+- [JavaScript libp2p-kad-dht](https://github.com/libp2p/js-libp2p-kad-dht)
+- [JavaScript libp2p-delegated-peer-routing](https://github.com/libp2p/js-libp2p-delegated-peer-routing)
+- [JavaScript libp2p-kad-routing](https://github.com/libp2p/js-libp2p-kad-routing)
+
+# Badge
+
+Include this badge in your readme if you make a module that is compatible with the interface-content-routing API. You can validate this by running the tests.
+
+![](https://raw.githubusercontent.com/libp2p/interface-content-routing/master/img/badge.png)
+
+# How to use the battery of tests
+
+## Node.js
+
+```javascript
+var tape = require('tape')
+var tests = require('interface-content-routing/tests')
+var yourImpl = require('../src')
+
+var common = {
+    setup: function (t, cb) {
+      cb(null, yourImpl)
+    },
+    teardown: function (t, cb) {
+      cb()
+    }
+}
+
+tests(tape, common)
+```
+
+## Go
+
+> WIP - The go-libp2p implementation does not have a test suite to be used, yet.
+
+# API
+
+A valid (read: that follows this abstraction) Content Routing module must implement the following API.
+
+### `.findProviders`
+
+- `JavaScript` peerRouting.findProviders
+
+### `.provide`
+
+- `JavaScript` peerRouting.provide

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "interface-content-routing",
+  "version": "0.0.0",
+  "description": "A test suite and interface you can use to implement a Content Routing for libp2p.",
+  "leadMaintainer": "Vasco Santos <vasco.santos@moxy.studio>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/libp2p/interface-content-routing.git"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "author": "David Dias <daviddias@ipfs.io>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/libp2p/interface-content-routing/issues"
+  },
+  "homepage": "https://github.com/libp2p/interface-content-routing",
+  "devDependencies": {},
+  "dependencies": {
+    "timed-tape": "^0.1.1"
+  }
+}

tests/base-test.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports.all = function (test, common) {
+  test('test', function (t) {
+    common.setup(test, function (err, pr) {
+      if (err) {}
+      common.teardown()
+    })
+  })
+}

tests/index.js

@@ -0,0 +1,7 @@
+'use strict'
+const timed = require('timed-tape')
+
+module.exports = function (test, common) {
+  test = timed(test)
+  require('./base-test.js').all(test, common)
+}