Merge branch 'develop'

Author: LucasTonetto

README.md

@@ -79,6 +79,8 @@ git clone https://github.com/DP6/penguin-adinfo.git
    {
    	company: "NOME_EMPRESA" (string)
    	permission: "owner"(string)
+	email: "email_do_usuario" (string)
+	password: "senha_criptografada" (string)
    }
    ```
 
@@ -106,6 +108,8 @@ Para a configuração inicial do Firestore, são necessárias duas coleções.
   {
   	company: "NOME_EMPRESA" (string)
   	permission: "owner"(string)
+	email: "email_do_usuario" (string)
+	password: "senha_criptografada" (string)
   }
   ```
 
@@ -115,11 +119,17 @@ Para a configuração inicial do Firestore, são necessárias duas coleções.
 
 Para utilizar a API, é necessário criar um documento de configuração no Firestore dentro da coleção: companies > [nome_empresa] > config. O nome do documento deve ser **config_1** e ele deve conter os campos: **csvSeparator**, **separator**, **spaceSeparator**, **columns** e um campo para a ferramenta de analytics, sendo esse o valor de **ga** ou **adobe**.
 
+Todos estes campos serão utilizados para realizar a parametrização do arquivo CSV que a API irá receber.
+
+Aqui a API disponibiliza a funcionalidade de definirmos no campo **csvSeparator** uma lista contendo a prioridade de todos os possíveis caracteres que poderão ser utilizados como separadores no arquivo CSV pelos usuários. Com isso, a aplicação irá consultar essa fonte e utilizar o devido separador para parametrizar o arquivo submetido.
+
+Entretanto, este campo no arquivo de configuração não é obrigatório. Caso o campo não seja preenchido, a aplicação irá tentar verificar se o arquivo submetido está utilizando _vírgula_ ou _ponto e vírgula_ como separador e utilizar o separador identificado para a parametrização. Caso não encontre nenhum dos dois caracteres, a API irá utilizar a vírgula como separador.
+
 Abaixo segue uma explicação e um exemplo de todos os campos das configurações.
 
 | Chave                       | Tipo   | Descrição                                                                                                                                                                       | Obrigatório |
 | --------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
-| csvSeparator                | String | Separador de colunas do arquivo CSV.                                                                                                                                            | Sim         |
+| csvSeparator                | Array  | Array que irá conter todos os separadores de colunas que os arquivos CSV poderão conter.                                                                                        | Não         |
 | separator                   | String | String que será utilizada na concatenação dos campos.                                                                                                                           | Sim         |
 | spaceSeparator              | String | String que substituirá o espaço na URL, caso alguma campo tenha preenchido com mais de uma palavra.                                                                             | Sim         |
 | columns                     | Objeto | Objeto contendo as colunas do CSV e seus valores de aceitação.                                                                                                                  | Sim         |
@@ -133,6 +143,7 @@ Abaixo segue uma explicação e um exemplo de todos os campos das configuraçõe
 {
 	"separator": ":",
 	"spaceSeparator": "_",
+	"csvSeparator": [",", ";", "|"],
 	"columns": {
 		//Colunas que aparecerão no CSV
 		//A chave representa a coluna do CSV e o vetor de valores

Routes.md

@@ -2,31 +2,76 @@
 
 ## Dicionário de Parâmetros
 
-| Parâmetro  | Header/Body | Tipo   | Descrição                                                                    |
-| ---------- | ----------- | ------ | ---------------------------------------------------------------------------- |
-| token      | Header      | String | Token de permissão do usuário                                                |
-| agency     | Header      | String | Agência do usuário                                                           |
-| company    | Header      | String | Empresa proprietária do adinfo                                               |
-| permission | Header      | String | Nível de permissão do usuário, podendo ser: **user**, **admin** ou **owner** |
-| data       | Body        | File   | Arquivo CSV                                                                  |
-| file       | Header      | String | Nome do arquivo salvo no banco de arquivos (não informar a extensão)         |
-| config     | Body        | String | String correspondente ao JSON de configuração                                |
-| campaign   | Header      | String | Nome da campanha                                                             |
+| Parâmetro   | Header/Body | Tipo   | Descrição                                                                    |
+| ----------- | ----------- | ------ | ---------------------------------------------------------------------------- |
+| token       | Header      | String | Token de permissão do usuário                                                |
+| agency      | Header      | String | Agência do usuário                                                           |
+| company     | Header      | String | Empresa proprietária do adinfo                                               |
+| permission  | Header      | String | Nível de permissão do usuário, podendo ser: **user**, **admin** ou **owner** |
+| data        | Body        | File   | Arquivo CSV                                                                  |
+| file        | Header      | String | Nome do arquivo salvo no banco de arquivos (não informar a extensão)         |
+| config      | Body        | String | String correspondente ao JSON de configuração                                |
+| campaign    | Header      | String | Nome da campanha                                                             |
+| email       | Body        | String | Email do usuário                                                             |
+| password    | Body        | String | Senha do usuário                                                             |
+| newPassword | Body        | String | Nova senha do usuário                                                        |
 
 ## Rotas
 
+### (POST) /login
+
+**Parâmetros**: email, password
+
+**Descrição**: Realiza o login na aplicação e retorna um token de autenticação.
+
+### (POST) /logout
+
+**Parâmetros**: token
+
+**Descrição**: Realiza o logout da aplicação.
+
 ### (GET) /user
 
 **Parâmetros**: token
 
 **Descrição**: Recupera os dados do usuários(agência, nível de permissão e empresa) por meio do token informado.
 
+### (GET) /users
+
+**Parâmetros**: token
+
+**Descrição**: Recupera todos os dados do usuários(agência, nível de permissão, empresa e status).
+
+### (POST) /user/changepass
+
+**Parâmetros**: token, password, newpassword
+
+**Descrição**: Altera a senha do usuário que está realizando a requisição.
+
+### (POST) /user/:id/deactivate
+
+**Parâmetros**: token
+
+**Descrição**: Desativa o usuário com o ID enviado.
+
+### (POST) /user/:id/reactivate
+
+**Parâmetros**: token
+
+**Descrição**: Re-ativa o usuário com o ID enviado.
+
 ### (GET) /template
 
 **Parâmetros**: token
 
 **Descrição**: Retorna um CSV com as colunas a serem preenchidas, baseando-se no campo **columns** (colunas) da configuração.
 
+### (GET) /template/excel
+
+**Parâmetros**: token
+
+**Descrição**: Retorna um arquivo Excel (xlsx) com as colunas a serem preenchidas, baseando-se no campo **columns** (colunas) da configuração e as regras de validação.
+
 ### (POST) /register
 
 **Parâmetros**: token, agency, permission, company, email.

dist/Errors/StringEmptyError.js

@@ -0,0 +1,21 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.StringEmptyError = void 0;
+class StringEmptyError {
+	constructor(msg) {
+		const error = new Error(msg);
+		Object.defineProperty(error, 'message', {
+			get() {
+				return msg;
+			},
+		});
+		Object.defineProperty(error, 'name', {
+			get() {
+				return 'StringEmptyError';
+			},
+		});
+		Error.captureStackTrace(error, StringEmptyError);
+		return error;
+	}
+}
+exports.StringEmptyError = StringEmptyError;

dist/Errors/ValidateColumnExistsError.js

@@ -0,0 +1,21 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ValidateColumnExistsError = void 0;
+class ValidateColumnExistsError {
+	constructor(msg) {
+		const error = new Error(msg);
+		Object.defineProperty(error, 'message', {
+			get() {
+				return msg;
+			},
+		});
+		Object.defineProperty(error, 'name', {
+			get() {
+				return 'ValidateColumnExistsError';
+			},
+		});
+		Error.captureStackTrace(error, ValidateColumnExistsError);
+		return error;
+	}
+}
+exports.ValidateColumnExistsError = ValidateColumnExistsError;

dist/Errors/ValidateFieldDependencyError.js

@@ -0,0 +1,21 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ValidateFieldDependencyError = void 0;
+class ValidateFieldDependencyError {
+	constructor(msg) {
+		const error = new Error(msg);
+		Object.defineProperty(error, 'message', {
+			get() {
+				return msg;
+			},
+		});
+		Object.defineProperty(error, 'name', {
+			get() {
+				return 'ValidateFieldDependencyError';
+			},
+		});
+		Error.captureStackTrace(error, ValidateFieldDependencyError);
+		return error;
+	}
+}
+exports.ValidateFieldDependencyError = ValidateFieldDependencyError;

dist/Errors/ValidateFieldError.js

@@ -0,0 +1,21 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ValidateFieldError = void 0;
+class ValidateFieldError {
+	constructor(msg) {
+		const error = new Error(msg);
+		Object.defineProperty(error, 'message', {
+			get() {
+				return msg;
+			},
+		});
+		Object.defineProperty(error, 'name', {
+			get() {
+				return 'ValidateFieldError';
+			},
+		});
+		Error.captureStackTrace(error, ValidateFieldError);
+		return error;
+	}
+}
+exports.ValidateFieldError = ValidateFieldError;

dist/Errors/ValidateRulesForColumnError.js

@@ -0,0 +1,21 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ValidateRulesForColumnError = void 0;
+class ValidateRulesForColumnError {
+	constructor(msg) {
+		const error = new Error(msg);
+		Object.defineProperty(error, 'message', {
+			get() {
+				return msg;
+			},
+		});
+		Object.defineProperty(error, 'name', {
+			get() {
+				return 'ValidateRulesForColumnError';
+			},
+		});
+		Error.captureStackTrace(error, ValidateRulesForColumnError);
+		return error;
+	}
+}
+exports.ValidateRulesForColumnError = ValidateRulesForColumnError;

dist/Handlers/AbstractHandler.js

@@ -0,0 +1,16 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.AbstractHandler = void 0;
+class AbstractHandler {
+	setNext(handler) {
+		this.nextHandler = handler;
+		return handler;
+	}
+	handle(request) {
+		if (this.nextHandler) {
+			return this.nextHandler.handle(request);
+		}
+		return true;
+	}
+}
+exports.AbstractHandler = AbstractHandler;

dist/Handlers/Handler.js

@@ -0,0 +1,2 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });

dist/Handlers/StringEmptyHandler.js

@@ -0,0 +1,15 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.StringEmptyHandler = void 0;
+const StringUtils_1 = require('../utils/StringUtils');
+const AbstractHandler_1 = require('./AbstractHandler');
+const StringEmptyError_1 = require('../Errors/StringEmptyError');
+class StringEmptyHandler extends AbstractHandler_1.AbstractHandler {
+	handle(request) {
+		if (StringUtils_1.StringUtils.isEmpty(request)) {
+			throw new StringEmptyError_1.StringEmptyError(`String vazia detectada!`);
+		}
+		return super.handle(request);
+	}
+}
+exports.StringEmptyHandler = StringEmptyHandler;