apply cr

Author: dignifiedquire

API/pubsub/README.md

@@ -11,7 +11,7 @@ pubsub API
 
 - `topic: string`
 - `options: Object` - (Optional), might contain the following properties:
-  - `discover`: type: Boolean - Will use the DHT to find
+  - `discover`: type: Boolean - Will use the DHT to find other peers.
 - `handler: (msg) => ()` - Event handler which will be called with a message object everytime one is received. The `msg` has the format `{from: string, seqno: Buffer, data: Buffer, topicCIDs: Array<string>}`.
 - `callback: (Error) => ()` (Optional) Called once the subscription is established.
 
@@ -41,9 +41,10 @@ This works like `EventEmitter.removeListener`, as that only the `handler` passed
 ##### `JavaScript` - ipfs.pubsub.publish(topic, data, callback)
 
 - `topic: string`
+- `data: buffer` - The actual message to send
 - `callback: (Error) => ()` - Calls back with an error or nothing if the publish was successfull.
 
-- Returns: `Promise` if no `callback` was passed otherwise `undefined`.
+If no `callback` is passed, a promise is returned.
 
 #### `pubsub.ls`
 
@@ -56,7 +57,7 @@ This works like `EventEmitter.removeListener`, as that only the `handler` passed
 - `topic: string`
 - `callback: (Error, Array<string>>) => ()` - Calls back with an error or a list of topicCIDs that this peer is subscribed to.
 
-- Returns: `Promise<Array<string>>` if no `callback` was passed otherwise `undefined`.
+If no `callback` is passed, a promise is returned.
 
 #### `pubsub.peers`
 
@@ -69,4 +70,4 @@ This works like `EventEmitter.removeListener`, as that only the `handler` passed
 - `topic: string`
 - `callback: (Error, Array<string>>) => ()` - Calls back with an error or a list of peer ids subscribed to the `topic`.
 
-- Returns: `Promise<Array<string>>` if no `callback` was passed otherwise `undefined`.
+If no `callback` is passed, a promise is returned.

src/object.js

@@ -42,7 +42,7 @@ module.exports = (common) => {
           })
         })
 
-        it.skip('template unixfs-dir', (done) => {
+        it('template unixfs-dir', (done) => {
           ipfs.object.new('unixfs-dir', (err, node) => {
             expect(err).to.not.exist
             const nodeJSON = node.toJSON()

src/pubsub.js

@@ -92,8 +92,11 @@ module.exports = (common) => {
 
       describe('single node', () => {
         describe('.publish', () => {
-          it('message from string', (done) => {
-            ipfs1.pubsub.publish(topic, 'hello friend', done)
+          it('errors on string messags', (done) => {
+            ipfs1.pubsub.publish(topic, 'hello friend', (err) => {
+              expect(err).to.exist
+              done()
+            })
           })
 
           it('message from buffer', (done) => {
@@ -124,7 +127,7 @@ module.exports = (common) => {
 
             ipfs1.pubsub.subscribe(topic, handler, (err) => {
               expect(err).to.not.exist
-              ipfs1.pubsub.publish(topic, 'hi', check)
+              ipfs1.pubsub.publish(topic, new Buffer('hi'), check)
             })
           })
 
@@ -163,7 +166,7 @@ module.exports = (common) => {
               (cb) => ipfs1.pubsub.subscribe(topic, handler2, cb)
             ], (err) => {
               expect(err).to.not.exist
-              ipfs1.pubsub.publish(topic, 'hello', check)
+              ipfs1.pubsub.publish(topic, new Buffer('hello'), check)
             })
           })
 
@@ -180,7 +183,7 @@ module.exports = (common) => {
               discover: true
             }, handler, (err) => {
               expect(err).to.not.exist
-              ipfs1.pubsub.publish(topic, 'hi', check)
+              ipfs1.pubsub.publish(topic, new Buffer('hi'), check)
             })
           })
         })
@@ -369,7 +372,7 @@ module.exports = (common) => {
             ], (err) => {
               expect(err).to.not.exist
 
-              ipfs2.pubsub.publish(topic, expectedString, check)
+              ipfs2.pubsub.publish(topic, new Buffer(expectedString), check)
             })
           })
 
@@ -410,7 +413,7 @@ module.exports = (common) => {
               expect(err).to.not.exist
 
               outbox.forEach((msg) => {
-                ipfs2.pubsub.publish(topic, msg, check)
+                ipfs2.pubsub.publish(topic, new Buffer(msg), check)
               })
             })
           })
@@ -464,7 +467,7 @@ module.exports = (common) => {
                 () => sendCount < count,
                 (cb) => {
                   sendCount++
-                  ipfs2.pubsub.publish(topic, expectedString, cb)
+                  ipfs2.pubsub.publish(topic, new Buffer(expectedString), cb)
                 },
                 done
               )
@@ -480,7 +483,7 @@ module.exports = (common) => {
               () => sendCount < count,
               (cb) => {
                 sendCount++
-                ipfs1.pubsub.publish(topic, expectedString, cb)
+                ipfs1.pubsub.publish(topic, new Buffer(expectedString), cb)
               },
               done
             )
@@ -548,7 +551,7 @@ module.exports = (common) => {
         }
 
         return ipfs1.pubsub.subscribe(topic, sub)
-          .then(() => ipfs1.pubsub.publish(topic, 'hi'))
+          .then(() => ipfs1.pubsub.publish(topic, new Buffer('hi')))
       })
 
       it('.peers', () => {