Adds tests for signAsync, and README

Author: grrowl

Diff for: README.md

@@ -61,6 +61,10 @@ export default (initialState) => {
 It wraps your store's root reducer (to store history), `getState` (to return the
 current state in history) and `dispatch` (to connect to peers).
 
+If you're using the redux devtools enhancer, it must come *after* the redux-
+scuttlebutt enhancer (or scuttlebutt will try to emit `PERFORM_ACTION` across
+the network)
+
 ## options
 
 The store enhancer takes an options object, including the key
@@ -79,29 +83,43 @@ scuttlebutt({
 
   // options passed through to the dispatcher (and their defaults)
   dispatcherOptions: {
-    // the default will batch-reduce actions by the hundred, firing redux's
-    // subscribe method on the last one, triggering the actual rendering on the
-    // next animationFrame.
-    // see: https://github.com/grrowl/redux-scuttlebutt/blob/master/src/dispatcher.js#L22
-    customDispatch: getDelayedDispatch, // (dispatcher) => (action) => {}
-
-    // returns whether an action's type should be broadcast to the network.
-    // (returns false for @@INIT and internal @@scuttlebutt-prefixed action
-    // types)
-    isGossipType: isGossipType, // (actionType) => bool
-
-    // if specified, the specified function must call the callback with false or
-    // true, depending on whether the action is valid.
-    verifyAsync, // (callback, action, getStateHistory) => {}
-  },
+    customDispatch: function getDelayedDispatch(dispatcher) {
+      return function (action) {
+        // the default will batch-reduce actions by the hundred, firing redux's
+        // subscribe method on the last one, triggering the actual rendering on
+        // the next animationFrame.
+        // see: https://github.com/grrowl/redux-scuttlebutt/blob/master/src/dispatcher.js#L22
+      }
+    },
+
+    isGossipType: function(actionType) {
+      // returns a boolean representing whether an action's type should be
+      // broadcast to the network.
+      // (by default, returns false for actions prefixed with @@, such as @@INIT
+      // and internal @@scuttlebutt-prefixed action types)
+    },
+
+    verifyAsync: function(callback, action, getStateHistory) {
+      // if specified, the verifyAsync function must call callback(false) if the
+      // action is invalid, or callback(true) if the action is valid.
+      // getStateHistory() will return an array of ordered updates
+    },
+
+    signAsync: function(callback, action, getStateHistory) {
+      // if specified, the signAsync will be called for every locally dispatched
+      // action. must call callback(action) and can mutate the action if
+      // desired.
+      // getStateHistory() will return an array of ordered updates
+    },
+  }
 })
 ```
 
-### verifyAsync
+### verifyAsync & signAsync
 
-The dispatcher option `verifyAsync` allows you to filter actions dispatched or
-gossiped about through scuttlebutt. You could validate an action's contents
-against a cryptographic signature, or rate limit, or an arbitrary rule:
+The dispatcher option `verifyAsync` allows you to filter remote actions
+dispatched or gossiped about through scuttlebutt. You could validate an action's
+contents against a cryptographic signature, or rate limit, or an arbitrary rule:
 
 ```js
 import { UPDATE_ACTION } from 'redux-scuttlebutt'

Diff for: test/dispatcher.spec.js

@@ -111,11 +111,52 @@ tape('dispatcher({ verifyAsync })', function (t) {
 
   setTimeout(() => {
     t.ok(dispatch.calledTwice, 'called dispatch twice')
+
     // first call
     t.equal(dispatch.getCall(0).args[0].payload, valid[0], 'called dispatch with valid action 1')
+
     // second call
     t.equal(dispatch.getCall(1).args[0].payload, valid[1], 'called dispatch with valid action 2')
+
     t.equal(getState.callCount, 4, 'getState was called for each getHistory')
     t.end()
   }, 20)
 })
+
+tape('dispatcher({ signAsync })', function (t) {
+  const
+    payloads = ['what', 'up'],
+    signAsync = (callback, action, getHistory) => {
+      t.ok(Array.isArray(getHistory()), 'getHistory() returns an array')
+
+      setTimeout(() => {
+        // payloads containing 'e' are invalid
+        t.ok(payloads.includes(action.payload), 'payload is in payloads')
+        callback({ ...action, signed: true })
+      }, 5)
+    },
+    dispatcher = new Dispatcher({ signAsync }),
+    dispatch = spy(),
+    wrappedDispatch = dispatcher.wrapDispatch(dispatch),
+    getState = spy(() => []) // becomes getHistory, returns array
+
+  dispatcher.wrapGetState(getState)
+
+  wrappedDispatch(createAction(payloads[0]))
+  wrappedDispatch(createAction(payloads[1]))
+
+  setTimeout(() => {
+    t.ok(dispatch.calledTwice, 'called dispatch twice')
+
+    // first call
+    t.equal(dispatch.getCall(0).args[0].payload, payloads[0], 'called dispatch with valid action 1')
+    t.equal(dispatch.getCall(0).args[0].signed, payloads[0], 'called dispatch with signed action 1')
+
+    // second call
+    t.equal(dispatch.getCall(1).args[0].payload, payloads[1], 'called dispatch with valid action 2')
+    t.equal(dispatch.getCall(1).args[0].signed, payloads[0], 'called dispatch with signed action 2')
+
+    t.equal(getState.callCount, 2, 'getState was called for each getHistory')
+    t.end()
+  }, 20)
+})