Merge pull request #193 from StatelessStudio/v3.3.0

[3.3.0] Nov-14-2019

Author: DrewImm

.travis.yml

@@ -1,6 +1,6 @@
 language: node_js
 node_js:
-  - "10.15.3"
+  - "12.13.0"
 before_script:
   - psql -c 'create database testdb;' -U postgres
   - cp local.config.travis.json local.config.json

CHANGELOG.md

@@ -1,11 +1,17 @@
 # PointyApi Changelog
 
-## [3.3.0] Nov-13-2019
+## [3.3.0] Nov-14-2019
 
 ### Additions
+- Add custom options object to HttpClient methods
+- Add npm keywords
+- [Issue #192] HttpClient must allow for custom headers
 
 ### Fixes
-- Lint
+- Node 12 Upgrade
+- Test classes cannot use function `this`
+- npm update (includes audit & outdated)
+- Lint (on master)
 
 ## [3.2.0] Aug-19-2019
 

package-lock.json

@@ -24,38 +24,38 @@
 	"dependencies": {
 		"@types/atob": "^2.1.2",
 		"@types/btoa": "^1.2.3",
-		"@types/express": "^4.17.1",
-		"@types/jsonwebtoken": "^7.2.8",
-		"@types/node": "^10.14.15",
-		"@types/request": "^2.48.2",
+		"@types/express": "^4.17.2",
+		"@types/jsonwebtoken": "^8.3.5",
+		"@types/node": "^12.12.7",
+		"@types/request": "^2.48.3",
 		"atob": "^2.1.2",
 		"bcryptjs": "^2.4.3",
 		"btoa": "^1.2.1",
-		"class-validator": "^0.9.1",
+		"class-validator": "^0.11.0",
 		"express": "^4.17.1",
 		"jsonwebtoken": "^8.5.1",
-		"mock-req-res": "^1.1.1",
+		"mock-req-res": "^1.1.2",
 		"pg": "^7.12.1",
 		"pg-connection-string": "^2.1.0",
 		"reflect-metadata": "^0.1.13",
 		"request": "^2.88.0",
-		"sinon": "^7.4.1",
-		"typeorm": "^0.2.18",
-		"validator": "^10.11.0"
+		"sinon": "^7.5.0",
+		"typeorm": "^0.2.20",
+		"validator": "^12.0.0"
 	},
 	"main": "./index.js",
 	"types": "./index.d.ts",
 	"devDependencies": {
 		"@istanbuljs/nyc-config-typescript": "^0.1.3",
-		"@types/jasmine": "^2.8.16",
-		"coveralls": "^3.0.6",
-		"jasmine": "^3.4.0",
+		"@types/jasmine": "^3.4.6",
+		"coveralls": "^3.0.7",
+		"jasmine": "^3.5.0",
 		"nyc": "^14.1.1",
-		"source-map-support": "^0.5.13",
-		"ts-node": "^7.0.1",
-		"tslint": "^5.18.0",
+		"source-map-support": "^0.5.16",
+		"ts-node": "^8.5.0",
+		"tslint": "^5.20.1",
 		"tslint-eslint-rules": "^5.4.0",
-		"typescript": "^3.5.3"
+		"typescript": "^3.7.2"
 	},
 	"description": "*\"Stop writing endpoints\"*",
 	"directories": {
@@ -69,5 +69,27 @@
 	"bugs": {
 		"url": "https://github.com/statelessstudio/pointyapi/issues"
 	},
-	"homepage": "https://github.com/statelessstudio/pointyapi#readme"
+	"homepage": "https://github.com/statelessstudio/pointyapi#readme",
+	"keywords": [
+		"api",
+		"server",
+		"framework",
+		"typescript",
+		"database",
+		"orm",
+		"endpoint",
+		"filter",
+		"guard",
+		"handler",
+		"http",
+		"middleware",
+		"model",
+		"query",
+		"request",
+		"response",
+		"util",
+		"jwt",
+		"authentication",
+		"authorization"
+	]
 }

package.json

@@ -24,21 +24,26 @@ export class HttpClient {
 	// Server PORT
 	public port: number | string = process.env.PORT;
 
+	// Global headers
+	public headers?: Object;
+
 	/**
 	 * Send a POST http request to the server
 	 * @param path Path to send to (e.g. /users)
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public post(
 		path: string,
 		data: object,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 201, 202, 204 ]
+		expect: number[] = [ 200, 201, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
-		const options = {
+		let options = {
 			method: 'POST',
 			url: `${this.url}:${this.port}${path}`,
 			body: data,
@@ -48,6 +53,14 @@ export class HttpClient {
 		if (bearer) {
 			options['auth'] = { bearer: `${bearer}` };
 		}
+		
+		if (this.headers) {
+			options['headers'] = this.headers;
+		}
+
+		if (customOptions) {
+			options = Object.assign(options, customOptions);
+		}
 
 		return new Promise<HttpClientResponse>((accept, reject) => {
 			this.request(options, (error, response, body) => {
@@ -75,16 +88,18 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public get(
 		path: string,
 		data: boolean | Object = false,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 202 ]
+		expect: number[] = [ 200, 202 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			const options = {
+			let options = {
 				method: 'GET',
 				url: `${this.url}:${this.port}${path}`,
 				json: true,
@@ -94,6 +109,14 @@ export class HttpClient {
 			if (bearer) {
 				options['auth'] = { bearer: `${bearer}` };
 			}
+		
+			if (this.headers) {
+				options['headers'] = this.headers;
+			}
+
+			if (customOptions) {
+				options = Object.assign(options, customOptions);
+			}
 
 			this.request(options, (error, response, body) => {
 				if (error) {
@@ -120,15 +143,17 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public patch(
 		path: string,
 		data: object,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 201, 202, 204 ]
+		expect: number[] = [ 200, 201, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
-		const options = {
+		let options = {
 			method: 'PATCH',
 			url: `${this.url}:${this.port}${path}`,
 			body: data,
@@ -138,6 +163,14 @@ export class HttpClient {
 		if (bearer) {
 			options['auth'] = { bearer: `${bearer}` };
 		}
+		
+		if (this.headers) {
+			options['headers'] = this.headers;
+		}
+
+		if (customOptions) {
+			options = Object.assign(options, customOptions);
+		}
 
 		return new Promise<HttpClientResponse>((accept, reject) => {
 			this.request(options, (error, response, body) => {
@@ -165,22 +198,32 @@ export class HttpClient {
 	 * @param data Data to send as query
 	 * @param bearer Bearer token to send
 	 * @param expect Array of status codes to expect
+	 * @param customOptions Additional request options
 	 * @return Returns a promise of HttpClientResponse
 	 */
 	public delete(
 		path: string,
 		bearer: boolean | string = false,
-		expect: number[] = [ 200, 202, 204 ]
+		expect: number[] = [ 200, 202, 204 ],
+		customOptions?: object
 	): Promise<HttpClientResponse> {
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			const options = {
+			let options = {
 				method: 'DELETE',
 				url: `${this.url}:${this.port}${path}`
 			};
 
 			if (bearer) {
 				options['auth'] = { bearer: `${bearer}` };
 			}
+		
+			if (this.headers) {
+				options['headers'] = this.headers;
+			}
+
+			if (customOptions) {
+				options = Object.assign(options, customOptions);
+			}
 
 			this.request(options, (error, response, body) => {
 				if (error) {

src/http/http-client.ts

@@ -6,25 +6,28 @@ import { getBodyguardKeys, compareIdToUser } from '../../../../src/bodyguard';
  * pointyapi/bodyguard
  */
 describe('[Bodyguard] compareIdToUser', () => {
+	let user;
+	let guardKeys;
+
 	beforeAll(() => {
 		// Create user
-		this.user = new ExampleUser();
-		this.user.id = 2;
+		user = new ExampleUser();
+		user.id = 2;
 
 		// Get bodyguard keys
-		this.guardKeys = getBodyguardKeys(new ExampleUser());
+		guardKeys = getBodyguardKeys(new ExampleUser());
 	});
 
 	it('returns true if the user matches', () => {
-		// Check if this.user has an id of 2
-		const result = compareIdToUser('id', 2, this.user, this.guardKeys);
+		// Check if user has an id of 2
+		const result = compareIdToUser('id', 2, user, guardKeys);
 
 		expect(result).toBe(true);
 	});
 
 	it('returns false if the user does not match', () => {
 		// This user should not have an id of 3
-		const result = compareIdToUser('id', 3, this.user, this.guardKeys);
+		const result = compareIdToUser('id', 3, user, guardKeys);
 
 		expect(result).toBe(false);
 	});

test/spec/api/bodyguard/compare-id-to-user.spec.ts

@@ -5,26 +5,30 @@ import { BaseDb } from '../../../../src/database';
  * pointyapi/database
  */
 describe('[BaseDb]', () => {
+	let baseDb;
+	let clog;
+	let cerr;
+
 	beforeAll(() => {
-		this.baseDb = new BaseDb();
+		baseDb = new BaseDb();
 	});
 
 	beforeEach(() => {
-		this.clog = console.log;
-		this.cerr = console.error;
+		clog = console.log;
+		cerr = console.error;
 	});
 
 	afterEach(() => {
-		console.log = this.clog;
-		console.error = this.cerr;
+		console.log = clog;
+		console.error = cerr;
 	});
 
 	it('contains setEntities() & allows chaining', () => {
-		expect(this.baseDb.setEntities([])).toEqual(this.baseDb);
+		expect(baseDb.setEntities([])).toEqual(baseDb);
 	});
 
 	it('contains connect() & returns a promise', () => {
-		expect(this.baseDb.connect({})).toEqual(jasmine.any(Promise));
+		expect(baseDb.connect({})).toEqual(jasmine.any(Promise));
 	});
 
 	it('can log a message', () => {
@@ -34,7 +38,7 @@ describe('[BaseDb]', () => {
 			result = true;
 		};
 
-		this.baseDb.logger();
+		baseDb.logger();
 		expect(result).toBe(true);
 	});
 });

test/spec/api/database/base-db.spec.ts

@@ -8,28 +8,31 @@ const ROOT_PATH = require('app-root-path').toString();
  * pointyapi/database
  */
 describe('[Database: Postgres]', async () => {
+	let db;
+	let clog;
+
 	beforeAll(() => {
-		this.db = new PointyPostgres();
-		this.db.connectionName = 'testconn';
-		this.db.errorHandler = (error) => fail(error);
-		this.db.logger = () => {};
+		db = new PointyPostgres();
+		db.connectionName = 'testconn';
+		db.errorHandler = (error) => fail(error);
+		db.logger = () => {};
 	});
 
 	beforeEach(() => {
-		this.clog = console.log;
+		clog = console.log;
 	});
 
 	afterEach(() => {
-		console.log = this.clog;
+		console.log = clog;
 	});
 
 	it('can set entities', () => {
-		this.db.setEntities([ ExampleUser ]);
+		db.setEntities([ ExampleUser ]);
 	});
 
 	it('can connect', async () => {
 		// Database
-		await this.db.connect(ROOT_PATH).catch((error) => fail(error));
+		await db.connect(ROOT_PATH).catch((error) => fail(error));
 	});
 
 	it('can connect with json options', async () => {