almir-soulcode/helpr-jfs5

Aplicação backend para pôr em prática os conceitos essenciais do framework Spring com REST API e boas práticas

helpr-jfs5's Issues

|BACK-END| Incrementar o PopulateService

Adicionar 10 novos usuários:

• 5 Administradores
• 3 Funcionários
• 2 Clientes

Adicionar 5 chamados:

• 3 Recebidos
• 2 Concluidos

Security: Filtro JWT

|BACK-END| Criar DTO de FuturoCliente

O DTO possui as mesmas propriedades da entidade com algumas validações:

• Nome (não-nulo) (máximo de 120 caracteres);
• Telefone (não-nulo);
• Email (formato válido) (não-vazio);
• CPF (formato válido) (não-vazio).

|BACK-END| Refatoração do método atualizar chamado

Há um problema com o método atualizar chamado, quando tentamos atualizar o status para RECEBIDO não deveríamos ser obrigados a passar o id de um funcionário, apenas quando o status for ATRIBUIDO/CONCLUIDO. Refatore o método de tal forma que esta inconsistência não ocorra mais.

CRUD de Chamados e operações especiais: query methods e nativeQuery

Criar controller de Chamado e operações de CRUD

Criar serviço de Chamado

|BACK-END| Criar entidade de FuturoCandidato e Repository

Um futuro candidato não é um usuário da aplicação, mas sim representa as solicitações públicas para fazer parte do time do HELPR.

A entidade possui as seguintes informações:

• Nome completo;
• Email (não-único);
• Descrição das habilidades;
• Setor (Marketing, Manutenção, Recursos Humanos, Desenvolvimento ou Sustentação).

O Repository precisa ter os seguintes filtros:

• Filtrar por email;
• Buscar pelo nome (containing);
• Filtrar pelo setor.

|BACK-END| Remoção de comentários didáticos e limpeza de códigos sem utilidade prática

Os comentários podem ser enriquecedores, porém a longo prazo podem ficar desatualizados ou desinformar os desenvolvedores. Também é pertinente remover alguns códigos avulsos de testes espalhados no projeto.

Security: Serviço de autenticação e controller

• CredenciaisDTO;
• TokenDTO;
• AuthService;
• AuthController;

|BACK-END| Criar controler de FuturoCliente

O controller deve expôr os seguintes endpoints para futuro cliente:

• /futuros-clientes (GET): Listar todos
• /futuros-clientes/email (GET): Filtrar por email, usar RequestParam
• /futuros-clientes/cpf (GET): Filtrar por nome, usar RequestParam
• /futuros-clientes (POST): Adicionar futuro cliente (método público sem login)
• /futuros-clientes (DELETE): Deletar futuro cliente

|BACK-END| Gerenciamento do erro: DataIntegrityException

Com base nas implementações de #40, gerenciar o erro de DataIntegrityException que ocorre quando tentamos apagar dados com relacionamentos como por exemplo um cargo de um funcionário da aplicação. A resposta no Postman deve ser:

{
    "message": "Não foi possível continuar operação",
    "status": 409,
    "timestamp": "2022-11-25T15:47:19.4079384",
    "path": "/cargos/1"
}

Dica: Testar apagar algum cargo ou funcionário com chamados.

Referências:
Códigos HTTP
Implementações da task 40

Criar serviço de Cargos para manipular Repository

Criar classe de configuração de desenvolvedor

Criar CRUD (entidade, dto, repository, service e controller) de Cliente

|BACK-END| Aplicar Swagger 2 na Rest API

Com base no artigo, aplicar a documentação de API com base no Swagger.

Observação 1: Leia atentamente o artigo e aplique apenas as configurações necessárias.
Observação 2: Atente-se para a segurança da nossa aplicação, pois apenas alguns endpoints são públicos (/auth/**).

Leitura adicional (Português): https://www.treinaweb.com.br/blog/documentando-uma-api-spring-boot-com-o-swagger/

Criar controller de Funcionario e operações de CRUD

Criar model de Chamado, seu DTO, Repository e relacionamento com Cliente e Funcionário

Criar perfil de configuração de desenvolvedor com MySQL

|BACK-END| Configurar banco de dados de teste H2

1. Criar um perfil de teste, exemplo: application-test.properties;
2. Adicione as seguintes propriedades:

spring.h2.console.enabled=true
spring.h2.console.path=/h2-console
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=sa
spring.datasource.password=
spring.datasource.driver-class-name=org.h2.Driver
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

3. Instale as dependências para o H2 no pom.xml:

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>

4. Crie um novo TestConfig, e com base no DevConfig popule o banco de dados H2 automaticamente (ignorar o ddl auto).
5. Para garantir que está funcionando nos conformes, mude o valor de spring.profiles.active=test para verificar se o H2 está funcionando normalmente. Voltar para o ambiente dev padrão após a verificação.

|BACK-END| Criar serviço de Usuario

O serviço de usuário deve expôr as seguintes operações:

• Filtrar por email;
• Filtrar por cpf;
• Filtrar por nome (containing);
• Retornar o perfil do usuário com base no email;

|BACK-END| Criar controller de Usuario

O controller deve expôr os seguintes endpoints:

• /usuarios/{email} (GET): Listar o usuário com o email indicado no Path Variable;
• /usuarios/{cpf} (GET): Listar o usuário com o cpf indicado no Path Variable;
• /usuarios/busca (GET): Listar os usuários com o termo de busca indicado no Request Param;
• /usuarios/{id}/perfil (GET): Listar o perfil (enum) do usuário com base no id indicado.

|BACK-END| Criar entidade de FuturoCliente e Repository

Um futuro cliente é uma pessoa que possui interesse em contratar os serviços da equipe do HELPR. A solicitação de futuro cliente é pública mesmo para usuários não logados.

A entidade possui as seguintes propriedades:

• Nome;
• Telefone;
• Email;
• CPF.

O Repository precisa ter os seguintes filtros:

• Filtrar por email;
• Filtrar por cpf.

|BACK-END| Criar serviço de FuturoCliente

O serviço de futuro cliente deve expôr as seguintes operações:

• Listar todos os futuros clientes;
• Listar um futuro cliente;
• Filtrar por cpf;
• Filtrar por email;
• Salvar futuro cliente;
• Deletar futuro cliente;

Security: Configurações iniciais

• Instalação de dependências;
• Melhorias no campo de senha;
• Filtragem por email.

|BACK-END| Problema com o salvar senha e atualizar senha dos usuários

1. Ao salvar um novo usuário a senha não é encriptada usando o bcrypt;
2. Ao atualizar um usuário existente a senha perde a criptografia do bcrypt.

Reajustar as funcionalidades para que ao salvar/atualizar um usuário a senha seja salva corretamente.

|BACK-END| Criar DTO de FuturoCandidato

O DTO de FuturoCandidato possui as mesmas propriedades:

• Nome completo (não-vazio);
• Email (não-nulo);
• Descrição das habilidades (não-nulo) (máximo de 120 caracteres);
• Setor (Marketing, Manutenção, Recursos Humanos, Desenvolvimento ou Sustentação) (não-nulo).

|BACK-END| Criar serviço de FuturoCandidato

O serviço de colaborador deve expôr as seguintes operações:

• Listar todos os colaboradores;
• Listar um colaborador;
• Filtrar por nome;
• Filtrar por setor;
• Filtrar por email;
• Salvar colaborador;
• Deletar colaborador;

Gerenciamento de erros com @ControllerAdvice

|BACK-END| Limite de chamados atribuídos ao Funcionário

Há um limite de chamados atribuídos (não concluídos) que um funcionário pode receber por vez, este limite deve ser um atributo inteiro estático de ChamadoService. Sempre antes de atribuir um chamado a um funcionário, verificar quantos chamados atribuídos ele possui, caso já esteja no limite, a operação não poderá continuar.

Obs: Esta task deverá gerar um erro customizado, portanto crie-o e gerencie na classe ResourceExceptionHandler.

|BACK-END| Melhoria de atualização de CPF e Email em cliente e funcionário

Por mais que o DTO envie um novo cpf ou email, essas duas informações não podem ser alteradas. Tratar os métodos de atualizar cliente e funcionário para que preservem o cpf e o email originais do usuário.

Criar serviço para popular automaticamente o banco de dados

Security: Configurações finais

• Security Config;
• Codificar senhas do populate com bcrypt e promover admin;

Security: UsuarioSecurity

|BACK-END| Coluna de limite de funcionários na entidade Cargo

Adicionar uma nova coluna na entidade de Cargo conforme o código SQL abaixo:

limiteFuncionarios INTEGER NOT NULL DEFAULT 1

Sempre antes de adicionar um novo funcionário, checar quantos funcionários ocupam o cargo escolhido e se este já está no limite. Caso esteja no limite um erro deverá ser lançado.

Obs 1: Ao adicionar uma nova coluna na entidade, atualizar o construtor e colocar get/set para o campo.
Obs 2: O erro lançado deverá ser customizado e gerenciado no ResourceExceptionHandler.

Referências:
Attributes of @Column
Como usar countBy (Inglês)

|BACK-END| Listar chamados do usuário logado com JWT

Para realizar essa filtragem e saber qual é o usuário logado devemos usar o objeto Principal que podemos ver seu uso neste artigo. Para tal use os filtros necessários para listar apenas os chamados do cliente em particular. Esta funcionalidade deve funcionar para cliente e funcionário.

Observação 1: Esta funcionalidade precisa estar presente no UsuarioService e UsuarioController;
Observação 2: Sugerimos usar um endpoint como /usuarios/clientes/logado/chamados e /usuarios/funcionarios/logado/chamados.

Criar model de Funcionário, seu DTO, Repository e relacionamento @ManyToOne com Cargo

Criar controller de Cargos e operações de CRUD

|BACK-END| Novo status de ARQUIVADO em Chamados

1. Adicionar ao enum de StatusChamado a constante ARQUIVADO. Esse status indica que o chamado está num estado de "Apagado do sistema", porém ele não será apagado de verdade.

2. Em seguida, verifique como o método de atualizar chamado irá se comportar com a adição desta nova opção, faça as alterações necessárias (ao arquivar um chamado não altera os dados já presentes no chamado).

Criar model de Cargo e Repository

Security: Implementações JWT

• Configurações JWT no application.properties;
• Classe de gerenciamento de JWT.

|BACK-END| Refatoração dos métodos de leitura das entidades

Com base no método getChamado de #14, refatore os outros métodos em CargoService, ClienteService e FuncionarioService:

public Chamado getChamado(Integer idChamado) {
    // Caso não encontre o chamado, lança a exceção.
    return this.chamadoRepository.findById(idChamado)
            .orElseThrow(() -> new RecursoNaoEncontradoError("Chamado não encontrado"));
}

Security: Enum Perfil

Criar CargoDTO e refatorar aplicação de CRUD

Criar serviço de Funcionário

|BACK-END| Criar controller de FuturoCandidato

O controller deve expôr os seguintes endpoints para futuro candidato:

• /candidatos (GET): Listar todos
• /candidatos/{setor} (GET): Filtrar por setor, usar RequestParam
• /candidatos/email (GET): Filtrar por email, usar RequestParam
• /ccandidatos/nome (GET): Filtrar por nome, usar RequestParam
• /candidatos (POST): Adicionar colaborador (método público sem login)
• /candidatos (DELETE): Deletar colaborador

Security: UsuarioSecurityService

Security: Uso da @PreAuthorize

Criar entidade de Usuario como classe abstrata, seu respectivo DTO e Repository

|BACK-END| Reajustar a obrigatoriedade de nova senha ao atualizar usuário

Sempre ao atualizarmos os usuários, somos obrigados a passar uma senha nova, no entanto, isto é impraticável para uma aplicação em larga escala. Desabilite o @notblank do UsuarioDTO, porém ao salvar um novo usuário é imprescindível verificar a nulidade da senha.