Merge pull request #2 from libp2p/feat/initial-implementation

feat: initial implementation

.gitignore

@@ -0,0 +1,40 @@
+docs
+**/node_modules/
+**/*.log
+test/repo-tests*
+
+# Logs
+logs
+*.log
+
+coverage
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+build
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+dist
+
+docs
+
+package-lock.json
+yarn.lock

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Protocol Labs, Inc.
+
+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

@@ -1 +1,82 @@
-# js-libp2p-pubsub
+js-libp2p-pubsub
+==================
+
+[![](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://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-pubsub/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-pubsub?branch=master)
+[![Travis CI](https://travis-ci.org/libp2p/js-libp2p-pubsub.svg?branch=master)](https://travis-ci.org/libp2p/js-libp2p-pubsub)
+[![Circle CI](https://circleci.com/gh/libp2p/js-libp2p-pubsub.svg?style=svg)](https://circleci.com/gh/libp2p/js-libp2p-pubsub)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-pubsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-pubsub) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+[![](https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square)](https://waffle.io/libp2p/js-libp2p-pubsub)
+
+> libp2p-pubsub consits on the base protocol for libp2p pubsub implementation. This module is responsible for all the logic regarding peer connections.
+
+## Lead Maintainer
+
+[Vasco Santos](https://github.com/vasco-santos).
+
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+```sh
+> npm install libp2p-pubsub
+```
+
+## Usage
+
+A pubsub implementation **MUST** override the `_processConnection`, `publish`, `subscribe` and `unsubscribe` functions. `add_peer` and `remove_peer` may be overwritten if the pubsub implementation needs to add custom logic when peers are added and remove. All the remaining functions **MUST NOT** be overwritten.
+
+The following example aims to show how to create your pubsub implementation extending this base protocol. The pubsub implementation will handle the subscriptions logic.
+
+```JavaScript
+const Pubsub = require('libp2p-pubsub')
+
+class PubsubImplementation extends Pubsub {
+  constructor(libp2p) {
+    super('libp2p:pubsub', '/pubsub-implementation/1.0.0', libp2p)
+  }
+
+  _processConnection(idB58Str, conn, peer) {
+    // Required to be implemented by the subclass
+    // Process each message accordingly
+  }
+
+  publish() {
+    // Required to be implemented by the subclass
+  }
+
+  subscribe() {
+    // Required to be implemented by the subclass
+  }
+
+  unsubscribe() {
+    // Required to be implemented by the subclass
+  }
+}
+```
+
+## Implementations using this base protocol
+
+You can use the following implementations as examples for building your own pubsub implementation.
+
+- [libp2p/js-libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub)
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-pubsub/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
+
+## License
+
+Copyright (c) Protocol Labs, Inc. under the **MIT License**. See [LICENSE file](./LICENSE) for details.

ci/Jenkinsfile

@@ -0,0 +1,2 @@
+// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+javascript()

package.json

@@ -0,0 +1,66 @@
+{
+    "name": "libp2p-pubsub",
+    "version": "0.0.0",
+    "description": "Pubsub base protocol for libp2p pubsub routers",
+    "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
+    "main": "src/index.js",
+    "scripts": {
+        "lint": "aegir lint",
+        "test": "aegir test -t node",
+        "test:node": "aegir test -t node",
+        "build": "aegir build",
+        "docs": "aegir-docs",
+        "release": "aegir release --docs",
+        "release-minor": "aegir release --type minor --docs",
+        "release-major": "aegir release --type major --docs",
+        "coverage": "aegir coverage",
+        "coverage-publish": "aegir coverage --provider coveralls"
+    },
+    "files": [
+        "src",
+        "dist"
+    ],
+    "pre-push": [
+        "lint"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/libp2p/js-libp2p-pubsub.git"
+    },
+    "keywords": [
+        "IPFS",
+        "libp2p",
+        "pubsub",
+        "gossip",
+        "flood",
+        "flooding"
+    ],
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/libp2p/js-libp2p-pubsub/issues"
+    },
+    "homepage": "https://github.com/libp2p/js-libp2p-pubsub#readme",
+    "devDependencies": {
+        "aegir": "^18.0.3",
+        "benchmark": "^2.1.4",
+        "chai": "^4.2.0",
+        "chai-spies": "^1.0.0",
+        "dirty-chai": "^2.0.1",
+        "libp2p": "~0.24.4",
+        "libp2p-secio": "~0.11.0",
+        "libp2p-spdy": "~0.13.1",
+        "libp2p-tcp": "~0.13.0",
+        "lodash": "^4.17.11",
+        "peer-id": "~0.12.2",
+        "peer-info": "~0.15.1"
+    },
+    "dependencies": {
+        "async": "^2.6.1",
+        "debug": "^4.1.1",
+        "err-code": "^1.1.2",
+        "length-prefixed-stream": "^1.6.0",
+        "protons": "^1.0.1",
+        "pull-pushable": "^2.2.0"
+    },
+    "contributors": []
+}