Merge pull request #58 from Simperium/cleanup/auth

Modernizes the Auth module

Author: roundhill

.babelrc

@@ -1,5 +1,7 @@
 {
   "presets": [
-    [ "env", { "targets": { "browsers": "last 2 versions"} } ]
-  ]
-}
+    [ "env", { "targets": { "browsers": "last 2 versions"} } ],
+    "flow"
+  ],
+  "plugins": [ "transform-object-rest-spread" ]
+}

.flowconfig

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

package.json

@@ -11,6 +11,7 @@
     "lib/"
   ],
   "scripts": {
+    "flow": "flow",
     "test:coverage": "nyc npm test",
     "test": "mocha --reporter dot --require babel-core/register test/**",
     "babel": "babel -q -d lib/ src/",
@@ -27,7 +28,9 @@
     "babel-cli": "^6.26.0",
     "babel-core": "^6.26.0",
     "babel-eslint": "^8.2.1",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
     "babel-preset-env": "^1.6.1",
+    "babel-preset-flow": "^6.23.0",
     "eslint": "^4.17.0",
     "mocha": "^5.0.0",
     "nyc": "^11.4.1"

src/simperium/auth.js

@@ -1,67 +1,116 @@
-import { EventEmitter } from 'events'
-import User from './user'
-import { format, inherits } from 'util'
-import https from 'https'
+// @flow
+import events from 'events'
+import { request } from 'https'
 import url from 'url'
 
+// @flow
+type User = {
+	options: {},
+	access_token: string,
+};
+
+const fromJSON = ( json: string ): User => {
+	const data: {} = JSON.parse( json );
+	if ( ! data.access_token && typeof data.access_token !== 'string' ) {
+		throw new Error( 'access_token not present' );
+	}
+	return {
+		options: data,
+		access_token: new String( data.access_token ).toString()
+	};
+};
+
+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 );
+/**
+ * Client for creating and authenticating Simperium.com user accounts.
+ */
+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 );
+	/**
+	 * Creates an instance of the Auth client
+	 *
+	 * @param {string} appId - Simperium.com application ID
+	 * @param {string} appSecret - Simperium.com application secret
+	 */
+	constructor( appId: string, appSecret: string ) {
+		super();
+		this.appId = appId;
+		this.appSecret = appSecret;
+	}
 
-	return promise;
-}
+	/**
+	 * Authorizes a user account with username and password
+	 *
+	 * @param {string} username account username
+	 * @param {string} password account password
+	 * @returns {Promise<User>} user account data
+	 */
+	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 = 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,31 @@ 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 if missing access_token', () => {
+		stubResponse( '{"hello":"world"}' );
+		return auth.authorize( 'username', 'password' )
+			.catch( error => {
+				equal( error.message, 'Failed to authenticate user.' );
+				equal( error.underlyingError.message, 'access_token not present' );
+			} );
+	} );
 
-	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 +81,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.' );
+			} );
 	} )
 } )