index.js

/** ****************************************************************************************************
 * File: index.js
 * Project: http-response-class
 * @author Nick Soggin <iSkore@users.noreply.github.com> on 11-Jul-2017
 *******************************************************************************************************/
'use strict';

class Response
{
	constructor( statusCode, data, origin, ...metadata )
	{
		if( statusCode instanceof Response ) {
			return statusCode;
		} else if( data instanceof Response ) {
			return data;
		} else if( origin instanceof Response ) {
			return origin;
		} else if( metadata instanceof Response || metadata[ 0 ] instanceof Response ) {
			return metadata[ 0 ] || metadata;
		}
		
		if( statusCode && ( typeof statusCode !== 'number' || statusCode !== +statusCode ) ) {
			throw new Error( 'Argument Error - [statusCode] must be typeof number.' );
		} else if( statusCode && !this.isHTTPCode( statusCode ) ) {
			throw new Error( 'Argument Error - [statusCode] must be valid HTTP code' );
		} else {
			this.setClassification( statusCode );
		}
		
		this.statusCode = statusCode;
		this.data       = data;
		this.message    = Response.codes[ statusCode ];
		
		if( origin ) {
			this.origin = origin;
		}
		
		if( metadata.length ) {
			this.metadata = metadata;
		}
	}
	
	static getCodeFromMessage( message )
	{
		for( const code in Response.codes ) {
			if( Response.codes.hasOwnProperty( code ) ) {
				if( Response.codes[ code ] === message ) {
					return +code;
				}
			}
		}
	}
	
	getCodeFromMessage( message )
	{
		return Response.getCodeFromMessage( message || this.message );
	}
	
	toJSON()
	{
		const
			res = {
				statusCode: this.statusCode,
				message: this.message,
				data: this.data
			};
		
		if( this.origin ) {
			res.origin = this.origin;
		}
		
		if( this.metadata ) {
			res.metadata = this.metadata;
		}
		
		return res;
	}
	
	toString()
	{
		return JSON.stringify( this.toJSON() );
	}
	
	static isInformational( code )
	{
		return /^(10[0-3])$/.test( code );
	}
	
	isInformational( code )
	{
		return Response.isInformational( code || this.statusCode );
	}
	
	static isSuccess( code )
	{
		return /^(20[0-8]|226)$/.test( code );
	}
	
	isSuccess( code )
	{
		return Response.isSuccess( code || this.statusCode );
	}
	
	static isRedirection( code )
	{
		return /^(30[0-8])$/.test( code );
	}
	
	isRedirection( code )
	{
		return Response.isRedirection( code || this.statusCode );
	}
	
	static isClientError( code )
	{
		return /^(40[0-9]|41[0-8]|42[1-6,8,9]|431|451)$/.test( code );
	}
	
	isClientError( code )
	{
		return Response.isClientError( code || this.statusCode );
	}
	
	static isServerError( code )
	{
		return /^(50[0-9]|51[0,1])$/.test( code );
	}
	
	isServerError( code )
	{
		return Response.isServerError( code || this.statusCode );
	}
	
	static isWarning( code )
	{
		return /^(11[0-3])|199|214|299$/.test( code );
	}
	
	isWarning( code )
	{
		return Response.isWarning( code || this.statusCode );
	}
	
	static isHTTPCode( code )
	{
		return /^(1[0-1][0-3]|199)|(20[0-8]|214|226|299)|(30[0-8])|(40[0-9]|41[0-8]|42[1-6,8,9]|431|451)|(50[0-9]|51[0,1])$$/.test( code );
	}
	
	isHTTPCode( code )
	{
		return Response.isHTTPCode( code || this.statusCode );
	}
	
	getClassification()
	{
		return this.classification;
	}
	
	getStatusCode()
	{
		return this.statusCode;
	}
	
	getMessage()
	{
		return this.message;
	}
	
	getData()
	{
		return this.data;
	}
	
	setClassification( code )
	{
		if( this.isInformational( code ) ) {
			this.classification = 'Informational';
		} else if( this.isSuccess( code ) ) {
			this.classification = 'Success';
		} else if( this.isRedirection( code ) ) {
			this.classification = 'Redirection';
		} else if( this.isClientError( code ) ) {
			this.classification = 'Client Error';
		} else if( this.isServerError( code ) ) {
			this.classification = 'Server Error';
		} else if( this.isWarning( code ) ) {
			this.classification = 'Warning';
		} else {
			this.classification = 'Unknown';
		}
	}
	
	setStatusCode( code, message = 'Unknown' )
	{
		this.statusCode = code;
		
		if( this.isHTTPCode( code ) ) {
			this.message = this.statusText( code );
		} else {
			this.message = message;
		}
		
		this.setClassification( code );
	}
	
	setMessage( message, code )
	{
		code            = this.getCodeFromMessage( message ) || code;
		this.statusCode = code;
		this.message    = message;
		this.setClassification( code );
	}
	
	static getMessageForCode( code )
	{
		return Response.isHTTPCode( code ) ? Response.codes[ code ] : 'Unknown';
	}
	
	getMessageForCode( code )
	{
		return Response.getMessageForCode( code || this.statusCode );
	}
	
	statusText( code )
	{
		return this.getMessageForCode( code ) || this.message;
	}
	
	get [ Symbol.toStringTag ]()
	{
		return this.constructor.name || 'Response';
	}
	
	static [ Symbol.hasInstance ]( obj )
	{
		return obj ? (
			obj.hasOwnProperty( 'statusCode' ) &&
			obj.hasOwnProperty( 'message' ) &&
			obj.hasOwnProperty( 'data' )
		) : false;
	}
}

Response.codes = {
	100: 'Continue',
	101: 'Switching Protocols',
	102: 'Processing',
	103: 'Early Hints',
	110: 'Response is Stale',
	111: 'Revalidation Failed',
	112: 'Disconnected Operation',
	113: 'Heuristic Expiration',
	199: 'Miscellaneous Warning',
	200: 'OK',
	201: 'Created',
	202: 'Accepted',
	203: 'Non-Authoritative Information',
	204: 'No Content',
	205: 'Reset Content',
	206: 'Partial Content',
	207: 'Multi-Status',
	208: 'Already Reported',
	214: 'Transformation Applied',
	226: 'IM Used',
	299: 'Miscellaneous Persistent Warning',
	300: 'Multiple Choices',
	301: 'Moved Permanently',
	302: 'Found',
	303: 'See Other',
	304: 'Not Modified',
	305: 'Use Proxy',
	306: 'Switch Proxy',
	307: 'Temporary Redirect',
	308: 'Permanent Redirect',
	400: 'Bad Request',
	401: 'Unauthorized',
	402: 'Payment Required',
	403: 'Forbidden',
	404: 'Not Found',
	405: 'Method Not Allowed',
	406: 'Not Acceptable',
	407: 'Proxy Authentication Required',
	408: 'Request Timeout',
	409: 'Conflict',
	410: 'Gone',
	411: 'Length Required',
	412: 'Precondition Failed',
	413: 'Payload Too Large',
	414: 'URI Too Long',
	415: 'Unsupported Media Type',
	416: 'Range Not Satisfiable',
	417: 'Expectation Failed',
	418: 'I\'m a teapot',
	421: 'Misdirected Request',
	422: 'Unprocessable Entity',
	423: 'Locked',
	424: 'Failed Dependency',
	425: 'Too Early',
	426: 'Upgrade Required',
	428: 'Precondition Required',
	429: 'Too Many Requests',
	431: 'Request Header Fields Too Large',
	451: 'Unavailable For Legal Reasons',
	500: 'Internal Server Error',
	501: 'Not Implemented',
	502: 'Bad Gateway',
	503: 'Service Unavailable',
	504: 'Gateway Timeout',
	505: 'HTTP Version Not Supported',
	506: 'Variant Also Negotiates',
	507: 'Insufficient Storage',
	508: 'Loop Detected',
	509: 'Bandwidth Limit Exceeded',
	510: 'Not Extended',
	511: 'Network Authentication Required'
};

module.exports = Response;