Initial commit

Author: itaylor

Diff for: .gitignore

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

Diff for: dist/index.js

@@ -0,0 +1,51 @@
+/**
+* Allows you to register actions that when dispatched, send the action to the server via a socket.io socket.
+*/
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+exports['default'] = createSocketIoMiddleware;
+
+function createSocketIoMiddleware(socket) {
+  var actionTypesOrTestFnOrPrefix = arguments.length <= 1 || arguments[1] === undefined ? [] : arguments[1];
+
+  return function (store) {
+    //Wire socket.io to dispatch actions sent by the server.
+    socket.on('action', store.dispatch);
+
+    var optionType = typeof actionTypesOrTestFnOrPrefix;
+
+    return function (next) {
+      return function (action) {
+        var type = action.type;
+
+        var result = next(action);
+
+        if (type) {
+          var emit = false;
+          // String Prefix
+          if (optionType === 'string' && type.indexOf(actionTypesOrTestFnOrPrefix) === 0) {
+            emit = true;
+          }
+          // test function
+          else if (optionType === 'function' && actionTypesOrTestFnOrPrefix(type)) {
+              emit = true;
+            }
+            // Array of types
+            else if (Array.isArray(actionTypesOrTestFnOrPrefix) && actionTypesOrTestFnOrPrefix.indexOf(type) !== -1) {
+                emit = true;
+              }
+
+          if (emit) {
+            socket.emit(type, action);
+          }
+        }
+        return result;
+      };
+    };
+  };
+}
+
+module.exports = exports['default'];

Diff for: gulpfile.js

@@ -0,0 +1,15 @@
+var gulp = require('gulp');
+var babel = require('gulp-babel');
+
+gulp.task('babel', function() {
+  return gulp.src('src/*.js')
+    .pipe(babel())
+    .pipe(gulp.dest('dist/'));
+});
+
+gulp.task('watch', function() {
+  gulp.watch('*.js', ['babel']);
+});
+
+// Default Task
+gulp.task('default', ['babel']);

Diff for: package.json

@@ -0,0 +1,29 @@
+{
+  "name": "redux-socket.io",
+  "version": "0.0.1",
+  "description": "An opinionated connector between socket.io and redux",
+  "main": "dist/index.js",
+  "repository":"github:itaylor/redux-socket.io",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha -r qunit-mocha-ui --ui qunit-mocha-ui --compilers js:babel/register"
+  },
+  "keywords": [
+    "redux",
+    "middleware",
+    "socket.io",
+    "action"
+  ],
+  "author": "[email protected]",
+  "license": "MIT",
+  "devDependencies": {
+    "babel": "^5.8.23",
+    "gulp": "^3.9.0",
+    "gulp-babel": "^5.3.0",
+    "mocha": "^2.3.3",
+    "qunit-mocha-ui": "0.0.5",
+    "redux": "^3.0.3"
+  }
+}

Diff for: readme.md

@@ -0,0 +1,23 @@
+# redux-socket.io
+An opinionated connector between socket.io and redux.
+
+Philosophy
+-------------
+Socket.io client->server messages should should be sent by dispatching actions, where the action is the payload.  Socket.io server->client messages should be dispatched as actions when received.
+
+How to use
+-------------
+### Installation
+```
+npm install --save redux-socket.io
+```
+
+
+### MIT License
+Copyright (c) 2015 Ian Taylor
+
+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.

Diff for: src/index.js

@@ -0,0 +1,38 @@
+/**
+* Allows you to register actions that when dispatched, send the action to the server via a socket.io socket.
+*/
+export default function createSocketIoMiddleware(socket, actionTypesOrTestFnOrPrefix = []){
+
+  return store => {
+    //Wire socket.io to dispatch actions sent by the server.
+    socket.on('action', store.dispatch);
+
+    const optionType = typeof actionTypesOrTestFnOrPrefix;
+
+    return next => action => {
+      const {type} = action;
+      const result = next(action);
+
+      if(type){
+        let emit = false;
+        // String Prefix
+        if (optionType === 'string' && (type.indexOf(actionTypesOrTestFnOrPrefix) === 0)){
+          emit = true;
+        }
+        // test function
+        else if(optionType === 'function' && actionTypesOrTestFnOrPrefix(type)){
+          emit = true;
+        }
+        // Array of types
+        else if(Array.isArray(actionTypesOrTestFnOrPrefix) && (actionTypesOrTestFnOrPrefix.indexOf(type) !== -1)){
+          emit = true;
+        }
+
+        if(emit){
+          socket.emit(type, action);
+        }
+      }
+      return result;
+    }
+  }
+}

Diff for: test/index.js

@@ -0,0 +1,81 @@
+import { createStore, applyMiddleware } from 'redux';
+import createSocketIoMiddleware from '../dist/index.js';
+
+suite('Redux-socket.io middleware basic tests');
+
+test('Using a string prefix to determine whether to call socket', 5, () => {
+  const socket = new MockSocket();
+  const socketIoMiddleware = createSocketIoMiddleware(socket, 'server/');
+  const createStoreWithMiddleware = applyMiddleware(socketIoMiddleware)(createStore);
+  const store = createStoreWithMiddleware(simpleReducer);
+
+  store.dispatch({type:'server/socketAction1', payload:'action1'});
+  store.dispatch({type:'action2', payload:'action2'});
+
+  equal(store.getState().socketAction1, 'action1');
+  equal(store.getState().action2, 'action2');
+  equal(socket.emitted.length, 1);
+  equal(socket.emitted[0][0], 'server/socketAction1');
+  equal(socket.emitted[0][1].payload, 'action1');
+});
+
+test('Using an array of action names to determine whether to call socket', 5, () => {
+  const socket = new MockSocket();
+  const socketIoMiddleware = createSocketIoMiddleware(socket, ['server/socketAction1']);
+  const createStoreWithMiddleware = applyMiddleware(socketIoMiddleware)(createStore);
+  const store = createStoreWithMiddleware(simpleReducer);
+
+  store.dispatch({type:'server/socketAction1', payload:'action1'});
+  store.dispatch({type:'action2', payload:'action2'});
+
+  equal(store.getState().socketAction1, 'action1');
+  equal(store.getState().action2, 'action2');
+  equal(socket.emitted.length, 1);
+  equal(socket.emitted[0][0], 'server/socketAction1');
+  equal(socket.emitted[0][1].payload, 'action1');
+});
+
+test('Using a function to determine whether to call socket', 5, () => {
+  const socket = new MockSocket();
+  function callSocketTestFn(type) {
+    return type.match(/server\//);
+  }
+  const socketIoMiddleware = createSocketIoMiddleware(socket, callSocketTestFn);
+  const createStoreWithMiddleware = applyMiddleware(socketIoMiddleware)(createStore);
+  const store = createStoreWithMiddleware(simpleReducer);
+
+  store.dispatch({type:'server/socketAction1', payload:'action1'});
+  store.dispatch({type:'action2', payload:'action2'});
+
+  equal(store.getState().socketAction1, 'action1');
+  equal(store.getState().action2, 'action2');
+  equal(socket.emitted.length, 1);
+  equal(socket.emitted[0][0], 'server/socketAction1');
+  equal(socket.emitted[0][1].payload, 'action1');
+});
+
+class MockSocket{
+  constructor(){
+    this.emitted = [];
+  }
+  emit(...args){
+    this.emitted.push(args);
+  }
+  on(){
+  }
+}
+
+function simpleReducer(state={}, action){
+  switch(action.type){
+    case 'server/socketAction1':
+      return Object.assign({}, state, {
+        'socketAction1': action.payload
+      });
+    case 'action2':
+      return Object.assign({}, state, {
+        'action2': action.payload
+      });
+    default:
+      return state;
+  }
+}