Amélioration structurelle Best Practices Endpoint

This commit is contained in:
DahoudG
2024-09-10 23:44:56 +00:00
parent 57ad010feb
commit e54a74d248
35 changed files with 1296 additions and 1017 deletions

View File

@@ -1,143 +1,142 @@
package com.lions.dev.resource;
import com.lions.dev.entity.Users;
import com.lions.dev.entity.users.Users;
import com.lions.dev.repository.UsersRepository;
import com.lions.dev.dto.request.users.UserRequestDTO;
import com.lions.dev.dto.response.users.UserResponseDTO;
import com.lions.dev.exception.UserNotFoundException;
import jakarta.inject.Inject;
import jakarta.transaction.Transactional;
import jakarta.validation.Valid;
import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotNull;
import jakarta.ws.rs.*;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import lombok.Getter;
import lombok.Setter;
import java.time.LocalDateTime;
import java.util.UUID;
import org.eclipse.microprofile.openapi.annotations.Operation;
import org.eclipse.microprofile.openapi.annotations.tags.Tag;
import java.util.List;
import java.util.UUID;
import org.jboss.logging.Logger;
/**
* Ressource REST pour gérer les entités Users.
* Ressource REST pour la gestion des utilisateurs dans le système AfterWork.
* Cette classe expose des endpoints pour créer, authentifier, récupérer et supprimer des utilisateurs.
*
* Tous les logs nécessaires pour la traçabilité sont intégrés.
*/
@Path("/users")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Tag(name = "Users", description = "Opérations liées à l'entité Users")
@Produces("application/json")
@Consumes("application/json")
@Tag(name = "Users", description = "Opérations liées à la gestion des utilisateurs")
public class UsersResource {
@Inject
UsersRepository usersRepository;
/**
* Récupère tous les utilisateurs.
*
* @return Liste des utilisateurs.
*/
@GET
@Operation(summary = "Récupérer tous les utilisateurs", description = "Retourne une liste de tous les utilisateurs")
public List<Users> getAllUsers() {
return usersRepository.listAll();
}
private static final Logger LOG = Logger.getLogger(UsersResource.class);
/**
* Crée un nouvel utilisateur.
* Endpoint pour créer un nouvel utilisateur.
*
* @param user L'utilisateur à créer.
* @return L'utilisateur créé.
* @param userRequestDTO Le DTO contenant les informations de l'utilisateur à créer.
* @return Une réponse HTTP contenant l'utilisateur créé ou un message d'erreur.
*/
@POST
@Transactional
@Operation(summary = "Créer un nouvel utilisateur", description = "Crée un nouvel utilisateur")
public Response createUser(@Valid Users user) {
if (user.getId() != null && usersRepository.findById(user.getId()) != null) {
@Operation(summary = "Créer un nouvel utilisateur", description = "Crée un nouvel utilisateur et retourne les détails")
public Response createUser(UserRequestDTO userRequestDTO) {
LOG.info("Tentative de création d'un nouvel utilisateur avec l'email : " + userRequestDTO.getEmail());
if (usersRepository.existsByEmail(userRequestDTO.getEmail())) {
LOG.warn("Un utilisateur avec cet email existe déjà : " + userRequestDTO.getEmail());
return Response.status(Response.Status.CONFLICT)
.entity("L'utilisateur avec l'ID " + user.getId() + " existe déjà.")
.build();
.entity("Un utilisateur avec cet email existe déjà.").build();
}
if (user.getMotDePasse() == null || user.getMotDePasse().isEmpty()) {
return Response.status(Response.Status.BAD_REQUEST)
.entity("Le mot de passe est obligatoire.")
.build();
Users user = new Users();
user.setNom(userRequestDTO.getNom());
user.setPrenoms(userRequestDTO.getPrenoms());
user.setEmail(userRequestDTO.getEmail());
user.setMotDePasse(userRequestDTO.getMotDePasse()); // Hachage automatique dans l'entité
// Assigner un rôle par défaut si non fourni (par exemple : USER)
if (user.getRole() == null) {
user.setRole("USER"); // Définir le rôle par défaut
}
usersRepository.persist(user);
return Response.status(Response.Status.CREATED).entity(user).build();
LOG.info("Utilisateur créé avec succès : " + user.getEmail() + " à " + LocalDateTime.now());
UserResponseDTO responseDTO = new UserResponseDTO(user);
return Response.status(Response.Status.CREATED).entity(responseDTO).build();
}
/**
* Authentifie un utilisateur avec son email et mot de passe.
* Endpoint pour authentifier un utilisateur.
*
* @param credentials Les identifiants de l'utilisateur.
* @return L'utilisateur authentifié.
* @param userRequestDTO Le DTO contenant les informations d'authentification.
* @return Une réponse HTTP indiquant si l'authentification a réussi ou échoué.
*/
@POST
@Path("/authenticate")
@Transactional
@Operation(summary = "Authentifier un utilisateur", description = "Authentifie un utilisateur avec email et mot de passe")
public Response authenticateUser(@Valid UserCredentials credentials) {
Users user = usersRepository.find("email", credentials.getEmail()).firstResult();
if (user == null || !user.getMotDePasse().equals(credentials.getMotDePasse())) {
return Response.status(Response.Status.UNAUTHORIZED)
.entity("Email ou mot de passe incorrect")
.build();
@Operation(summary = "Authentifier un utilisateur", description = "Vérifie les informations de connexion de l'utilisateur")
public Response authenticateUser(UserRequestDTO userRequestDTO) {
LOG.info("Tentative d'authentification pour l'utilisateur avec l'email : " + userRequestDTO.getEmail());
Users user = usersRepository.findByEmail(userRequestDTO.getEmail())
.orElseThrow(() -> new UserNotFoundException("Utilisateur non trouvé avec l'email : " + userRequestDTO.getEmail()));
if (!user.verifierMotDePasse(userRequestDTO.getMotDePasse())) {
LOG.warn("Échec de l'authentification : mot de passe incorrect pour l'email : " + userRequestDTO.getEmail());
return Response.status(Response.Status.UNAUTHORIZED).entity("Mot de passe incorrect.").build();
}
return Response.ok(user).build();
LOG.info("Authentification réussie pour l'utilisateur : " + user.getEmail());
UserResponseDTO responseDTO = new UserResponseDTO(user);
return Response.ok(responseDTO).build();
}
/**
* Met à jour un utilisateur existant.
* Endpoint pour récupérer les détails d'un utilisateur par ID.
*
* @param id L'ID de l'utilisateur à mettre à jour.
* @param user Les nouvelles informations de l'utilisateur.
* @return L'utilisateur mis à jour.
* @param id L'ID de l'utilisateur.
* @return Une réponse HTTP contenant les informations de l'utilisateur.
*/
@PUT
@Path("{id}")
@Transactional
@Operation(summary = "Mettre à jour un utilisateur", description = "Met à jour un utilisateur existant par ID")
public Response updateUser(@PathParam("id") UUID id, @Valid Users user) {
Users entity = usersRepository.findById(id);
if (entity == null) {
return Response.status(Response.Status.NOT_FOUND).build();
@GET
@Path("/{id}")
@Operation(summary = "Récupérer un utilisateur par ID", description = "Retourne les détails de l'utilisateur demandé")
public Response getUserById(@PathParam("id") UUID id) {
LOG.info("Récupération de l'utilisateur avec l'ID : " + id);
Users user = usersRepository.findById(id);
if (user == null) {
LOG.warn("Utilisateur non trouvé avec l'ID : " + id);
return Response.status(Response.Status.NOT_FOUND)
.entity("Utilisateur non trouvé.").build();
}
entity.setNom(user.getNom());
entity.setPrenoms(user.getPrenoms());
entity.setEmail(user.getEmail());
entity.setMotDePasse(user.getMotDePasse());
return Response.ok(entity).build();
UserResponseDTO responseDTO = new UserResponseDTO(user);
LOG.info("Utilisateur trouvé : " + user.getEmail());
return Response.ok(responseDTO).build();
}
/**
* Supprime un utilisateur existant.
* Endpoint pour supprimer un utilisateur par ID.
*
* @param id L'ID de l'utilisateur à supprimer.
* @return Une réponse vide avec le statut HTTP approprié.
* @return Une réponse HTTP indiquant le succès ou l'échec de la suppression.
*/
@DELETE
@Path("{id}")
@Path("/{id}")
@Transactional
@Operation(summary = "Supprimer un utilisateur", description = "Supprime un utilisateur existant par ID")
@Operation(summary = "Supprimer un utilisateur", description = "Supprime un utilisateur de la base de données")
public Response deleteUser(@PathParam("id") UUID id) {
LOG.info("Tentative de suppression de l'utilisateur avec l'ID : " + id);
boolean deleted = usersRepository.deleteById(id);
if (!deleted) {
return Response.status(Response.Status.NOT_FOUND).build();
if (deleted) {
LOG.info("Utilisateur supprimé avec succès.");
return Response.noContent().build();
} else {
LOG.warn("Échec de la suppression : utilisateur introuvable avec l'ID : " + id);
return Response.status(Response.Status.NOT_FOUND)
.entity("Utilisateur non trouvé.").build();
}
return Response.noContent().build();
}
/**
* Classe pour les identifiants de l'utilisateur lors de l'authentification.
*/
@Setter
@Getter
public static class UserCredentials {
@NotNull
@Email
private String email;
@NotNull
private String motDePasse;
}
}