Merge pull request #8 from ryumada/develop

Collaboration Implemented

Author: ryumada

docs/scenario.collaboration.md

@@ -0,0 +1,79 @@
+Folder: Collaborations
+
+## Skenario 1: Adding Note using Owner User
+- status code: **201** (Created)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - is **noteId** exist?
+
+## Skenario 2: Adding Collaborator User as Collaborator to Added Note
+- status code: **201** (Created)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - is **collaborationId** exist?
+
+## Skenario 3: Getting All Notes using Collaborator User
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - is the result an **array** named **notes** that have **one item**?
+
+## Skenario 4: Getting Added Note using Collaborator User
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+
+## Skenario 5: Editing Added Note using Collaborator User
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+
+## Skenario 6: Deleting Added Note using Collaborator User
+- status code: **403** (Forbidden)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - does the result have **correct property & value**?
+
+## Skenario 7: Deleting Collaborator User from Collaborator to Added Note
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - does the result have **correct property & value**?
+
+## Skenario 8: Adding Collaborator User as Collaborator to Added Note using Collaborator User
+- status code: **403** (Forbidden)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - does the result have **correct property & value**?
+
+## Skenario 9: Getting All Notes using Collaborator User
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - is the result an **array** named **notes** that have **zero (0) item**?
+
+## Skenario 10: Getting Added Note using Collaborator User
+- status code: **403** (Forbidden)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - does the result have **correct property & value**?
+
+## Skenario 11: Editing Added Note using Collaborator User
+- status code: **403** (Forbidden)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**
+- body response (**data**)
+  - does the result have **correct property & value**?
+
+## Skenario 12: Deleting Added Note using Owner User
+- status code: **200** (OK)
+- header response
+  - **Content-Type**: **application/json; charset=utf-8**

migrations/1638880680860_add-foreign-key-to-owner-column.js

@@ -0,0 +1,26 @@
+/* eslint-disable quotes */
+/* eslint-disable camelcase */
+
+exports.shorthands = undefined;
+
+exports.up = pgm => {
+	// membuat user baru.
+	pgm.sql("INSERT INTO users(id, username, password, fullname) VALUES ('old_notes', 'old_notes', 'old_notes', 'old_notes')");
+	
+	// mengubah nilai owner pada note yang owner-nya bernilai NULL
+	pgm.sql("UPDATE notes SET owner = 'old_notes' WHERE owner = NULL");
+
+	// memberi constraint foreign key pada owner terhadap kolom id dari tabel users
+	pgm.addConstraint('notes', 'fk_notes.owner_users.id', 'FOREIGN KEY(owner) REFERENCES users(id) ON DELETE CASCADE');
+};
+
+exports.down = pgm => {
+	// menghapus constraint fk_notes.owner_users.id pada tabel notes
+	pgm.dropConstraint('notes', 'fk_notes.owner_users.id');
+
+	// mengubah nilai owner old_notes pada note menjadi NULL
+	pgm.sql("UPDATE notes SET owner = NULL WHERE owner = 'old_notes'");
+
+	// menghapus user baru
+	pgm.sql("DELETE FROM users WHERE id = 'old_notes'");
+};

migrations/1638936746734_create-collaboration-table.js

@@ -0,0 +1,36 @@
+/* eslint-disable camelcase */
+
+exports.shorthands = undefined;
+
+exports.up = pgm => {
+	// membuat table collaborations
+	pgm.createTable('collaborations', {
+		id: {
+			type: 'VARCHAR(50)',
+			primaryKey: true,
+		},
+		note_id: {
+			type: 'VARCHAR(50)',
+			notNull: true,
+		},
+		user_id: {
+			type: 'VARCHAR(50)',
+			notNul: true,
+		},
+	});
+
+	/**
+	 * Menambahkan constraint UNIQUE, kombinasi dari kolom note_id dan user_id.
+	 * Guna menghindari duplikasi data antara nilai keduanya.
+	 */
+	pgm.addConstraint('collaborations', 'unique_note_id_and_user_id', 'UNIQUE(note_id, user_id)');
+
+	// memberikan constraint foreign key pada kolom note_id dan user_id terhadap notes.id dan users.id
+	pgm.addConstraint('collaborations', 'fk_collaborations.note_id_notes.id', 'FOREIGN KEY(note_id) REFERENCES notes(id) ON DELETE CASCADE');
+	pgm.addConstraint('collaborations', 'fk_collaborations.user_id_users.id', 'FOREIGN KEY(user_id) REFERENCES users(id) ON DELETE CASCADE');
+};
+
+exports.down = pgm => {
+	// menghapus tabel collaborations
+	pgm.dropTable('collaborations');
+};

src/api/collaborations/handler.js

@@ -0,0 +1,88 @@
+const ClientError = require('../../exceptions/ClientError');
+
+class CollaborationsHandler {
+	constructor(collaborationsService, notesService, validator) {
+		this._collaborationsService = collaborationsService;
+		this._notesService = notesService;
+		this._validator = validator;
+
+		// bind global variable this
+		this.postCollaborationHandler = this.postCollaborationHandler.bind(this);
+		this.deleteCollaborationHandler = this.deleteCollaborationHandler.bind(this);
+	}
+
+	async postCollaborationHandler(request, h) {
+		try {
+			this._validator.validateCollaborationPayload(request.payload);
+			const { id: credentialId } = request.auth.credentials;
+			const { noteId, userId } = request.payload;
+
+			await this._notesService.verifyNoteOwner(noteId, credentialId);
+			const collaborationId = await this._collaborationsService.addCollaboration(noteId, userId);
+
+			const response = h.response({
+				status: 'success',
+				message: 'Kolaborasi berhasil ditambahkan',
+				data: {
+					collaborationId,
+				},
+			});
+			response.code(201);
+			return response;
+		} catch (error) {
+			if(error instanceof ClientError) {
+				const response = h.response({
+					status: 'fail',
+					message: error.message,
+				});
+				response.code(error.statusCode);
+				return response;
+			}
+
+			// SERVER ERROR
+			const response = h.response({
+				status: 'error',
+				message: 'Maaf, terjadi kegagalan pada server kami.',
+			});
+			response.code(500);
+			console.error(error);
+			return response;
+		}
+	}
+
+	async deleteCollaborationHandler(request, h) {
+		try{
+			this._validator.validateCollaborationPayload(request.payload);
+			const { id: credentialId } = request.auth.credentials;
+			const { noteId, userId } = request.payload;
+
+			await this._notesService.verifyNoteOwner(noteId, credentialId);
+			await this._collaborationsService.deleteCollaboration(noteId, userId);
+
+			return {
+				status: 'success',
+				message: 'Kolaborasi berhasil dihapus',
+			};
+		} catch(error) {
+			if(error instanceof ClientError) {
+				const response = h.response({
+					status: 'fail',
+					message: error.message,
+				});
+				response.code(error.statusCode);
+				return response;
+			}
+
+			// SERVER ERROR
+			const response = h.response({
+				status: 'error',
+				message: 'Maaf, terjadi kegagalan pada server kami.'
+			});
+			response.code(500);
+			console.error(error);
+			return response;
+		}
+	}
+}
+
+module.exports = CollaborationsHandler;

src/api/collaborations/index.js

@@ -0,0 +1,14 @@
+const CollaborationsHandler = require('./handler');
+const routes = require('./routes');
+
+module.exports = {
+	name: 'collaborations',
+	version: '1.0.0',
+	register: async(server, { collaborationsService, notesService, validator }) => {
+		const collaborationsHandler = new CollaborationsHandler(
+			collaborationsService, notesService, validator,
+		);
+
+		server.route(routes(collaborationsHandler));
+	},
+};

src/api/collaborations/routes.js

@@ -0,0 +1,20 @@
+const routes = (handler) => [
+	{
+		method: 'POST',
+		path: '/collaborations',
+		handler: handler.postCollaborationHandler,
+		options: {
+			auth: 'notesapp_jwt',
+		},
+	},
+	{
+		method: 'DELETE',
+		path: '/collaborations',
+		handler: handler.deleteCollaborationHandler,
+		options: {
+			auth: 'notesapp_jwt',
+		},
+	},
+];
+
+module.exports = routes;

src/api/notes/handler.js

@@ -71,7 +71,7 @@ class NotesHandler {
 			const { id } = request.params;
 			const { id: credentialId } = request.auth.credentials;
 
-			await this._service.verifyNoteOwner(id, credentialId);
+			await this._service.verifyNoteAccess(id, credentialId);
 			const note = await this._service.getNoteById(id);
 
 			return {
@@ -107,7 +107,7 @@ class NotesHandler {
 			const { id } = request.params;
 			const { id: credentialId } = request.auth.credentials;
 
-			await this._service.verifyNoteOwner(id, credentialId);
+			await this._service.verifyNoteAccess(id, credentialId);
 			await this._service.editNoteById(id, request.payload);
 
 			return {

src/api/users/handler.js

@@ -8,6 +8,7 @@ class UsersHandler {
 		// bind this variable
 		this.postUserHandler = this.postUserHandler.bind(this);
 		this.getUserByIdHandler = this.getUserByIdHandler.bind(this);
+		this.getUsersByUsernameHandler = this.getUsersByUsernameHandler.bind(this);
 	}
 
 	async postUserHandler(request, h) {
@@ -79,6 +80,38 @@ class UsersHandler {
 			return response;
 		}
 	}
+
+	async getUsersByUsernameHandler(request, h) {
+		try {
+			const { username = '' } = request.query;
+			const users = await this._service.getUsersByUsername(username);
+
+			return {
+				status: 'success',
+				data: {
+					users,
+				},
+			};
+		} catch (error) {
+			if(error instanceof ClientError) {
+				const response = h.response({
+					status: 'fail',
+					message: error.message,
+				});
+				response.code(error.statusCode);
+				return response;
+			}
+
+			// SERVER ERROR
+			const response = h.response({
+				status: 'error',
+				message: 'Maaf, terjadi kegagalan pada server kami.',
+			});
+			response.code(500);
+			console.error(error);
+			return response;
+		}
+	}
 }
 
 module.exports = UsersHandler;

src/api/users/routes.js

@@ -9,6 +9,11 @@ const routes = (handler) => [
 		path: '/users/{id}',
 		handler: handler.getUserByIdHandler,
 	},
+	{
+		method: 'GET',
+		path: '/users',
+		handler: handler.getUsersByUsernameHandler,
+	},
 ];
 
 module.exports = routes;

src/server.js

@@ -20,8 +20,14 @@ const AuthenticationsService = require('./services/postgres/AuthenticationsServi
 const TokenManager = require('./tokenize/TokenManager');
 const AuthenticationsValidator = require('./validator/authentications');
 
+// collaborations
+const collaborations = require('./api/collaborations');
+const CollaborationsService = require('./services/postgres/CollaborationsService');
+const CollaborationsValidator = require('./validator/collaborations');
+
 const init = async () => {
-	const notesService = new NotesService();
+	const collaborationsService = new CollaborationsService();
+	const notesService = new NotesService(collaborationsService);
 	const usersService = new UsersService();
 	const authenticationsService = new AuthenticationsService();
 
@@ -87,6 +93,14 @@ const init = async () => {
 				validator: AuthenticationsValidator,
 			},
 		},
+		{
+			plugin: collaborations,
+			options: {
+				collaborationsService,
+				notesService,
+				validator: CollaborationsValidator,
+			},
+		},
 	]);
 
 	await server.start();