Adds flow, modernizes Auth component

Author: beaucollins

.babelrc

@@ -1,3 +1,4 @@
 {
-	"presets": ["es2015"]
+  "presets": ["es2015", "flow"],
+  "plugins": [ "transform-object-rest-spread" ]
 }

.eslintrc

@@ -6,10 +6,6 @@
 		"mocha": true,
 		"node": true
 	},
-	"ecmaFeatures": {
-		"modules": true,
-		"experimentalObjectRestSpread": true
-	},
 	"rules": {
 		"brace-style": [ 1, "1tbs" ],
 		// REST API objects include underscores

.flowconfig

@@ -0,0 +1,12 @@
+[ignore]
+
+[include]
+src/
+
+[libs]
+
+[lints]
+
+[options]
+
+[strict]

package.json

@@ -8,6 +8,7 @@
     "url": "git://github.com/Simperium/node-simperium.git"
   },
   "scripts": {
+    "flow": "flow",
     "test": "mocha --compilers js:babel-core/register test/**",
     "prepublish": "babel -q -d lib/ src/"
   },
@@ -20,7 +21,13 @@
   "devDependencies": {
     "babel-cli": "^6.2.0",
     "babel-core": "^6.2.0",
-    "babel-preset-es2015": "^6.2.0",
-    "mocha": "^2.3.4"
+    "babel-eslint": "^8.2.1",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-preset-es2015": "^6.24.1",
+    "babel-preset-flow": "^6.23.0",
+    "eslint": "^4.17.0",
+    "flow": "^0.2.3",
+    "flow-bin": "^0.65.0",
+    "mocha": "^2.5.3"
   }
 }

src/simperium/auth.js

@@ -1,67 +1,94 @@
-import { EventEmitter } from 'events'
-import User from './user'
-import { format, inherits } from 'util'
+// @flow
+import events from 'events'
 import https from 'https'
 import url from 'url'
 
+// @flow
+type User = {};
+
+const fromJSON = ( json: string ) => {
+	const data = JSON.parse( json );
+	return {
+		options: data,
+		access_token: data.access_token
+	};
+};
+
+const { EventEmitter } = events;
+
 const URL = 'https://auth.simperium.com/1';
 
-export default function Auth( appId, appSecret ) {
-	this.appId = appId;
-	this.appSecret = appSecret;
+export class AuthError extends Error {
+	underlyingError: Error
+
+	constructor( underlyingError: Error ) {
+		super( 'Failed to authenticate user.' );
+		this.underlyingError = underlyingError;
+	}
 }
 
-inherits( Auth, EventEmitter );
+export class Auth extends EventEmitter {
+	appId: string
+	appSecret: string
 
-Auth.prototype.authorize = function( username, password ) {
-	var body = JSON.stringify( { username: username, password: password } ),
-		promise = this.request( 'authorize/', body );
+	constructor( appId: string, appSecret: string ) {
+		super();
+		this.appId = appId;
+		this.appSecret = appSecret;
+	}
 
-	return promise;
-}
+	authorize( username: string, password: string ) {
+		const body = JSON.stringify( { username: username, password: password } );
+		return this.request( 'authorize/', body );
+	}
 
-Auth.prototype.create = function( username, password, provider ) {
-	var userData = { username, password };
-	if ( provider ) {
-		userData.provider = provider;
+	create( username: String, password: String, provider: ?String ) {
+		const userData: { username: String, password: String, provider?: String } = { username, password };
+		if ( provider ) {
+			userData.provider = provider;
+		}
+		const body = JSON.stringify( userData );
+		return this.request( 'create/', body );
 	}
-	var body = JSON.stringify( userData ),
-	    promise = this.request( 'create/', body );
 
-	return promise;
-}
+	getUrlOptions( path: string ) {
+		const options = url.parse( `${URL}/${ this.appId }/${ path}` );
+		return {
+			... options,
+			method: 'POST',
+			headers: {'X-Simperium-API-Key': this.appSecret }
+		};
+	}
 
-Auth.prototype.getUrlOptions = function( path ) {
-	const options = url.parse( format( '%s/%s/%s', URL, this.appId, path ) );
-	return Object.assign( options, { method: 'POST', headers: {'X-Simperium-API-Key': this.appSecret}} );
-}
+	request( endpoint: string, body: string ): Promise<User> {
+		return new Promise( ( resolve, reject ) => {
+			const req = https.request( this.getUrlOptions( endpoint ), ( res ) => {
+				let responseData = '';
 
-Auth.prototype.request = function( endpoint, body ) {
-	return new Promise( ( resolve, reject ) => {
-		const req = https.request( this.getUrlOptions( endpoint ), ( res ) => {
-			var responseData = '';
+				res.on( 'data', ( data ) => {
+					responseData += data.toString();
+				} );
 
-			res.on( 'data', ( data ) => {
-				responseData += data.toString();
+				res.on( 'end', () => {
+					try {
+						const user = fromJSON( responseData );
+						resolve( user );
+						this.emit( 'authorize', user );
+					} catch ( error ) {
+						return reject( new AuthError( error ) );
+					}
+				} );
 			} );
 
-			res.on( 'end', () => {
-				var user;
-
-				try {
-					user = User.fromJSON( responseData );
-				} catch ( e ) {
-					return reject( new Error( responseData ) );
-				}
-				this.emit( 'authorize', user );
-				resolve( user );
+			req.on( 'error', ( e ) => {
+				reject( e );
 			} );
-		} );
 
-		req.on( 'error', ( e ) => {
-			reject( e );
+			req.end( body );
 		} );
+	}
+};
 
-		req.end( body );
-	} );
-}
+export default ( appId: string, appSecret: string ) => {
+	return new Auth( appId, appSecret );
+};

src/simperium/index.js

@@ -1,4 +1,3 @@
-import User from './user'
 import Client from './client'
 import Auth from './auth'
 import * as util from './util'
@@ -7,4 +6,4 @@ export default function( appId, token, options ) {
 	return new Client( appId, token, options );
 }
 
-export { Auth, User, Client, util }
+export { Auth, Client, util }

src/simperium/user.js

@@ -1,4 +1,4 @@
-import Auth from '../../src/simperium/auth'
+import buildAuth from '../../src/simperium/auth'
 import https from 'https'
 import { equal, deepEqual } from 'assert'
 import { EventEmitter } from 'events'
@@ -19,11 +19,11 @@ const stubResponse = ( data ) => stub( ( body, handler ) => {
 } )
 
 describe( 'Auth', () => {
-	var auth
+	let auth;
 
 	beforeEach( () => {
-		auth = new Auth( 'token', 'secret' );
-	} )
+		auth = buildAuth( 'token', 'secret' );
+	} );
 
 	it( 'getUrlOptions', () => {
 		const { hostname, headers, pathname, method } = auth.getUrlOptions( 'path' )
@@ -33,7 +33,7 @@ describe( 'Auth', () => {
 		deepEqual( headers, { 'X-Simperium-API-Key': 'secret' } )
 	} )
 
-	it( 'should request auth token', ( done ) => {
+	it( 'should request auth token', () => {
 		stub( ( data, handler ) => {
 			const { username, password } = JSON.parse( data )
 			const response = new EventEmitter()
@@ -45,24 +45,22 @@ describe( 'Auth', () => {
 			response.emit( 'end' );
 		} )
 
-		auth.authorize( 'username', 'password' )
-		.then( ( user ) => {
-			equal( user.access_token, 'secret-token' )
-			done()
-		} )
-	} )
+		return auth.authorize( 'username', 'password' )
+			.then( ( user ) => {
+				equal( user.access_token, 'secret-token' );
+			} );
+	} );
 
-	it( 'should fail to auth with invalid credentials', ( done ) => {
+	it( 'should fail to auth with invalid credentials', () => {
 		stubResponse( 'this is not json' )
 
-		auth.authorize( 'username', 'bad-password' )
-		.catch( ( e ) => {
-			equal( e.message, 'this is not json' )
-			done()
-		} )
+		return auth.authorize( 'username', 'bad-password' )
+			.catch( ( e ) => {
+				equal( e.message, 'Failed to authenticate user.' );
+			} );
 	} )
 
-	it( 'should create an account with valid credentials', ( done ) => {
+	it( 'should create an account with valid credentials', () => {
 		stub( ( data, handler ) => {
 			const { username, password } = JSON.parse( data )
 			const response = new EventEmitter()
@@ -74,20 +72,18 @@ describe( 'Auth', () => {
 			response.emit( 'end' );
 		} )
 
-		auth.create( 'username', 'password' )
-		.then( ( user ) => {
-			equal( user.access_token, 'secret-token' )
-			done()
-		} )
+		return auth.create( 'username', 'password' )
+			.then( user => {
+				equal( user.access_token, 'secret-token' )
+			} );
 	} )
 
-	it( 'should fail to create an account with invalid credentials', ( done ) => {
+	it( 'should fail to create an account with invalid credentials', () => {
 		stubResponse( 'this is not json' )
 
-		auth.create( 'username', 'bad-password' )
-		.catch( ( e ) => {
-			equal( e.message, 'this is not json' )
-			done()
-		} )
+		return auth.create( 'username', 'bad-password' )
+			.catch( ( e ) => {
+				equal( e.message, 'Failed to authenticate user.' );
+			} );
 	} )
 } )