chore(package) v2.0.0

Author: coderaiser

ChangeLog

@@ -1,3 +1,10 @@
+2018.03.30, v2.0.0
+
+feature:
+- (gritty) add auth
+- (gritty) drop support of node < 4
+
+
 2018.03.12, v1.5.2
 
 feature:

README.md

@@ -58,12 +58,19 @@ gritty('body', {
 
 ```js
 const prefix = '/gritty'; // default
-const authCheck = (accept, reject) => (username, password) => {
+
+// legacy
+const authCheck = (socket, success) => {
+    susccess();
+};
+
+const auth = (accept, reject) => (username, password) => {
     accept();
 };
 
 gritty.listen(socket, {
     prefix,
+    auth, // optional
     authCheck, // optional
 })
 ```
@@ -157,3 +164,4 @@ MIT
 [LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
 [CoverageURL]:              https://coveralls.io/github/cloudcmd/gritty?branch=master
 [CoverageIMGURL]:           https://coveralls.io/repos/cloudcmd/gritty/badge.svg?branch=master&service=github
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gritty",
-  "version": "1.5.2",
+  "version": "2.0.0",
   "author": "coderaiser <[email protected]> (https://github.com/coderaiser)",
   "description": "Web terminal emulator",
   "bin": {

server/gritty.js

@@ -78,29 +78,33 @@ module.exports.listen = (socket, options) => {
     check(socket, options);
 
     const prefix = options.prefix;
+    const auth = options.auth;
     const authCheck = options.authCheck;
 
     socket
         .of(prefix || '/gritty')
         .on('connection', (socket) => {
             const connect = connectionWraped(options, socket);
 
-            if (!authCheck)
+            if (authCheck)
+                return authCheck(socket, connect);
+            
+            if (!auth)
                 return connection(options, socket);
 
             const reject = () => socket.emit('reject');
-            socket.on('auth', authCheck(connect, reject));
+            socket.on('auth', auth(connect, reject));
         });
 };
 
 function check(socket, options) {
     if (!socket)
         throw Error('socket could not be empty!');
 
-    const authCheck = options.authCheck;
+    const auth = options.auth;
 
-    if (authCheck && typeof authCheck !== 'function')
-        throw Error('options.authCheck should be a function!');
+    if (auth && typeof auth !== 'function')
+        throw Error('options.auth should be a function!');
 }
 
 function connection(options, socket) {

test/server/gritty.js

@@ -20,7 +20,7 @@ test('gritty: listen: args: no', (t) => {
     t.end();
 });
 
-test('gritty: listen: args: authCheck', (t) => {
+test('gritty: listen: args: auth', (t) => {
     const socket = {};
     const on = sinon.stub().returns(socket)
     const of = sinon.stub().returns(socket);
@@ -29,10 +29,10 @@ test('gritty: listen: args: authCheck', (t) => {
     socket.of = of;
 
     const fn = () => gritty.listen(socket, {
-        authCheck: 'hello'
+        auth: 'hello'
     });
 
-    t.throws(fn, /options.authCheck should be a function!/, 'should throw when no args');
+    t.throws(fn, /options.auth should be a function!/, 'should throw when no args');
 
     t.end();
 });
@@ -158,15 +158,15 @@ test('gritty: server: socket: emit data', (t) => {
     });
 });
 
-test('gritty: server: socket: authCheck', (t) => {
-    const authCheck = currify((accept, reject, username, password) => {
+test('gritty: server: socket: auth', (t) => {
+    const auth = currify((accept, reject, username, password) => {
         if (username !== 'hello' || password !== 'world')
             return reject();
 
         accept();
     });
 
-    before({authCheck}, (port, after) => {
+    before({auth}, (port, after) => {
         const socket = io(`http://localhost:${port}/gritty`);
 
         socket.once('connect', () => {
@@ -248,7 +248,36 @@ test('gritty: server: socket: test env', (t) => {
     });
 });
 
+test('gritty: server: socket: authCheck', (t) => {
+    const authCheck = (socket, connection) => {
+        socket.on('auth', ({username, password}) => {
+            if (username !== 'hello' || password !== 'world')
+                return socket.emit('reject');
+            
+            connection();
+            socket.emit('accept');
+        });
+    };
+    
+    before({authCheck}, (port, after) => {
+        const socket = io(`http://localhost:${port}/gritty`);
+        
+        socket.once('connect', () => {
+            socket.emit('auth', {
+                username: 'hello',
+                password: 'world',
+            });
+            
+            socket.on('accept', () => {
+                t.pass('should emit accepet');
+                socket.close();
+                after();
+                t.end();
+            });
+        });
+    });
+});
+
 function clean(name) {
     delete require.cache[require.resolve(name)];
 }
-