Merge pull request #190 from StatelessStudio/v3.2.0

[3.2.0] Aug-19-2019

Author: DrewImm

CHANGELOG.md

@@ -1,5 +1,13 @@
 # PointyApi Changelog
 
+## [3.2.0] Aug-19-2019
+
+### Additions
+- [Issue #189] Add CanReadAll() and CanWriteAll()
+
+### Fixes
+- npm update
+
 ## [3.1.0] Aug-06-2019
 
 ### Additions

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "pointyapi",
-	"version": "3.1.0",
+	"version": "3.2.0",
 	"author": "stateless-studio",
 	"license": "MIT",
 	"scripts": {
@@ -24,9 +24,9 @@
 	"dependencies": {
 		"@types/atob": "^2.1.2",
 		"@types/btoa": "^1.2.3",
-		"@types/express": "^4.17.0",
+		"@types/express": "^4.17.1",
 		"@types/jsonwebtoken": "^7.2.8",
-		"@types/node": "^10.14.14",
+		"@types/node": "^10.14.15",
 		"@types/request": "^2.48.2",
 		"atob": "^2.1.2",
 		"bcryptjs": "^2.4.3",
@@ -35,7 +35,7 @@
 		"express": "^4.17.1",
 		"jsonwebtoken": "^8.5.1",
 		"mock-req-res": "^1.1.1",
-		"pg": "^7.12.0",
+		"pg": "^7.12.1",
 		"pg-connection-string": "^2.1.0",
 		"reflect-metadata": "^0.1.13",
 		"request": "^2.88.0",
@@ -48,7 +48,7 @@
 	"devDependencies": {
 		"@istanbuljs/nyc-config-typescript": "^0.1.3",
 		"@types/jasmine": "^2.8.16",
-		"coveralls": "^3.0.5",
+		"coveralls": "^3.0.6",
 		"jasmine": "^3.4.0",
 		"nyc": "^14.1.1",
 		"source-map-support": "^0.5.13",

package.json

@@ -130,18 +130,70 @@
  */
 
 /**
- * Bodyguard Decorators
+ * # Bodyguard Decorators
  */
 import 'reflect-metadata';
 import { BodyguardOwner, UserRole } from './enums';
 
+const CanReadAllSymbol = Symbol('CanReadAll');
+const CanWriteAllSymbol = Symbol('CanWriteAll');
 const CanReadSymbol = Symbol('CanRead');
 const CanWriteSymbol = Symbol('CanWrite');
 const BodyguardKeySymbol = Symbol('BodyguardKey');
 const CanSearchSymbol = Symbol('CanSearch');
 const CanSearchRelationSymbol = Symbol('CanSearchRelation');
 const CanReadRelationSymbol = Symbol('CanReadRelationSymbol');
 
+/**
+ * ## Class Decorators
+ */
+
+/**
+ * Get if all members are readable
+ * NOTE:	This function only checks if the CanReadAll() decorator is present.
+ * 			Individual fields may have fine-grain access rights, which this
+ * 			function will ignore. Use getCanRead() instead for authorization.
+ * @param target Object to test
+ */
+export function getCanReadAll(target: any): string {
+	return Reflect.getMetadata(CanReadAllSymbol, target.constructor);
+}
+
+/**
+ * Get if all members are writableF
+ * NOTE:	This function only checks if the CanWriteAll() decorator is present.
+ * 			Individual fields may have fine-grain access rights, which this
+ * 			function will ignore. Use getCanWrite() instead for authorization.
+ * @param target Object to test
+ */
+export function getCanWriteAll(target: any): string {
+	return Reflect.getMetadata(CanWriteAllSymbol, target.constructor);
+}
+
+/**
+ * All class members are readable
+ * @param who Who can read the fields. Default is anyone
+ */
+export function CanReadAll(
+	who: BodyguardOwner | UserRole = BodyguardOwner.Anyone
+) {
+	return Reflect.metadata(CanReadAllSymbol, who);
+}
+
+/**
+ * All class members are readable
+ * @param who Who can read the fields. Default is anyone
+ */
+export function CanWriteAll(
+	who: BodyguardOwner | UserRole = BodyguardOwner.Anyone
+) {
+	return Reflect.metadata(CanWriteAllSymbol, who);
+}
+
+/**
+ * ## Member Decorators
+ */
+
 /**
  * Check if the key is a bodyguard key
  * @param target Object to test
@@ -157,7 +209,10 @@ export function isBodyguardKey(target: any, propertyKey: string): boolean {
  * @param propertyKey Key to check
  */
 export function getCanRead(target: any, propertyKey: string): string {
-	return Reflect.getMetadata(CanReadSymbol, target, propertyKey);
+	return (
+		Reflect.getMetadata(CanReadSymbol, target, propertyKey) ||
+		getCanReadAll(target)
+	);
 }
 
 /**
@@ -166,7 +221,10 @@ export function getCanRead(target: any, propertyKey: string): string {
  * @param propertyKey Key to check
  */
 export function getCanWrite(target: any, propertyKey: string): string {
-	return Reflect.getMetadata(CanWriteSymbol, target, propertyKey);
+	return (
+		Reflect.getMetadata(CanWriteSymbol, target, propertyKey) ||
+		getCanWriteAll(target)
+	);
 }
 
 /**

src/bodyguard.ts

@@ -14,10 +14,14 @@ import {
 	CanRead,
 	CanWrite,
 	CanSearch,
-	CanSearchRelation
+	CanSearchRelation,
+	CanReadAll,
+	CanWriteAll,
+	getCanReadAll,
+	getCanWriteAll
 } from '../../../../src/bodyguard';
 import { BaseModel } from '../../../../src/models';
-import { BodyguardOwner } from '../../../../src/enums';
+import { BodyguardOwner, UserRole } from '../../../../src/enums';
 
 class ExampleModel extends BaseModel {
 	@BodyguardKey() public bodyguardKey: number = undefined;
@@ -48,6 +52,76 @@ class ExampleModel extends BaseModel {
 }
 const example = new ExampleModel();
 
+@CanReadAll()
+class ExampleReadableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const exampleReadable = new ExampleReadableModel();
+
+@CanWriteAll()
+class ExampleWritableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const exampleWritable = new ExampleWritableModel();
+
+@CanReadAll(UserRole.Admin)
+class AdminReadableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const adminReadable = new AdminReadableModel();
+
+@CanWriteAll(UserRole.Admin)
+class AdminWritableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const adminWritable = new AdminWritableModel();
+
+@CanReadAll()
+class MixedReadableModel extends BaseModel {
+	public anyoneCanReadThisField: string = undefined;
+
+	@CanRead(UserRole.Admin)
+	public butOnlyAdminCanReadThisOne: string = undefined;
+}
+const mixedReadable = new MixedReadableModel();
+
+@CanWriteAll()
+class MixedWritableModel extends BaseModel {
+	public anyoneCanWriteThisField: string = undefined;
+
+	@CanWrite(UserRole.Admin)
+	public butOnlyAdminCanWriteThisOne: string = undefined;
+}
+const mixedWritable = new MixedWritableModel();
+
+/**
+ * getCanReadAll()
+ * pointyapi/bodyguard
+ */
+describe('getCanReadAll()', () => {
+	it('returns anyone if no parameter is set', () => {
+		expect(getCanReadAll(exampleReadable)).toEqual(BodyguardOwner.Anyone);
+	});
+
+	it('returns role if set as parameter', () => {
+		expect(getCanReadAll(adminReadable)).toEqual(UserRole.Admin);
+	});
+});
+
+/**
+ * getCanWriteAll()
+ * pointyapi/bodyguard
+ */
+describe('getCanWriteAll()', () => {
+	it('returns anyone if no parameter is set', () => {
+		expect(getCanWriteAll(exampleWritable)).toEqual(BodyguardOwner.Anyone);
+	});
+
+	it('returns role if set as parameter', () => {
+		expect(getCanWriteAll(adminWritable)).toEqual(UserRole.Admin);
+	});
+});
+
 /**
  * isBodyguardKey()
  * pointyapi/bodyguard
@@ -91,8 +165,16 @@ describe('getCanRead()', () => {
 		);
 	});
 
-	it('returns undefined if the member is not readable', () => {
-		expect(getCanRead(example, 'bodyguardKey')).toBe(undefined);
+	it('returns anyone if the class has CanReadAll()', () => {
+		expect(getCanRead(mixedReadable, 'anyoneCanReadThisField')).toEqual(
+			BodyguardOwner.Anyone
+		);
+	});
+
+	it('returns UserRole.Admin if CanReadAll() has been overridden', () => {
+		expect(getCanRead(mixedReadable, 'butOnlyAdminCanReadThisOne')).toEqual(
+			UserRole.Admin
+		);
 	});
 });
 
@@ -128,6 +210,18 @@ describe('getCanWrite()', () => {
 	it('returns undefined if the member is not writeable', () => {
 		expect(getCanWrite(example, 'bodyguardKey')).toBe(undefined);
 	});
+
+	it('returns anyone if the class has CanWriteAll()', () => {
+		expect(getCanWrite(mixedWritable, 'anyoneCanWriteThisField')).toEqual(
+			BodyguardOwner.Anyone
+		);
+	});
+
+	it('returns UserRole.Admin if CanWriteAll() has been overridden', () => {
+		expect(
+			getCanWrite(mixedWritable, 'butOnlyAdminCanWriteThisOne')
+		).toEqual(UserRole.Admin);
+	});
 });
 
 /**