Merge pull request #90 from boolean-uk/80-backend---insert-missing-responsedtos-in-update-user-endpoint

80 backend   insert missing responsedtos in update user endpoint

Author: hansjhaland

exercise.tests/IntegrationTests/UserTests.cs

@@ -184,7 +184,7 @@ public async Task UpdateUserSuccess()
         }
 
         [Test]
-        public async Task UpdateUserNoContent()
+        public async Task UpdateUserNullFieldsOnly()
         {
             var fieldsToUpdate = new Dictionary<string, object?>{};
 
@@ -194,7 +194,7 @@ public async Task UpdateUserNoContent()
             int userId = 1;
             var response = await _client.PatchAsync($"/users/{userId}", content);
 
-            Assert.That(response.StatusCode, Is.EqualTo(HttpStatusCode.NoContent));
+            Assert.That(response.StatusCode, Is.EqualTo(HttpStatusCode.BadRequest));
         }
 
         [Test]

exercise.wwwapi/Endpoints/UserEndpoints.cs

@@ -64,14 +64,14 @@ private static IResult Register(RegisterRequestDTO request, IRepository<User> se
             // syntax checks
             // check valid password
             string validationResult = Validator.Password(request.password);
-            if (validationResult != "Accepted") return TypedResults.BadRequest(new ResponseDTO<Object>() { Message = validationResult });
+            if (validationResult != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = validationResult });
             // check valid email
             string emailValidation = Validator.Email(request.email);
-            if (emailValidation != "Accepted") return TypedResults.BadRequest(new ResponseDTO<Object>() { Message = emailValidation });
+            if (emailValidation != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = emailValidation });
 
             // check if email is in database
             var emailExists = service.GetAllFiltered(q => q.Email == request.email);
-            if (emailExists.Count() != 0) return Results.Conflict(new ResponseDTO<Object>() { Message = "Fail" });
+            if (emailExists.Count() != 0) return Results.Conflict(new ResponseDTO<string>() { Message = "Fail" });
 
 
             string passwordHash = BCrypt.Net.BCrypt.HashPassword(request.password);
@@ -95,6 +95,7 @@ private static IResult Register(RegisterRequestDTO request, IRepository<User> se
 
         [ProducesResponseType(StatusCodes.Status200OK)]
         [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesResponseType(StatusCodes.Status401Unauthorized)]
         private static IResult Login(LoginRequestDTO request, IRepository<User> service, IConfigurationSettings config, IMapper mapper)
         {
             //if (string.IsNullOrEmpty(request.username)) request.username = request.email;
@@ -108,7 +109,7 @@ private static IResult Login(LoginRequestDTO request, IRepository<User> service,
             //email doesn't exist, should probably be 404 user not found, but should maybe just say invalid email or password
             //check if email is in database
             var emailExists = service.GetAllFiltered(q => q.Email == request.email);
-            if (emailExists.Count() == 0) return TypedResults.BadRequest(new ResponseDTO<Object>() { Message = "Invalid email and/or password provided"});
+            if (emailExists.Count() == 0) return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Invalid email and/or password provided"});
 
 
 
@@ -117,8 +118,11 @@ private static IResult Login(LoginRequestDTO request, IRepository<User> service,
 
             if (!BCrypt.Net.BCrypt.Verify(request.password, user.PasswordHash))
             {
-                // should probably be 401 unauthorized
-                return Results.BadRequest(new ResponseDTO<Object>() { Message = "Invalid email and/or password provided" });
+                // TypedResults.Unauthorized did not support Message. "Custom" solution which includes message. 
+                return Results.Json(new ResponseDTO<string>
+                {
+                    Message = "Invalid email and/or password provided"
+                }, statusCode: StatusCodes.Status401Unauthorized);
             }
 
             string token = CreateToken(user, config);
@@ -142,7 +146,7 @@ private static IResult Login(LoginRequestDTO request, IRepository<User> service,
         public static async Task<IResult> GetUserById(IRepository<User> service, int id, IMapper mapper)
         {
             var user = service.GetById(id);
-            if (user == null) return TypedResults.NotFound();
+            if (user == null) return TypedResults.NotFound(new ResponseDTO<string> { Message = "User not found" });
 
             ResponseDTO<UserDTO> response = new ResponseDTO<UserDTO>
             {
@@ -154,48 +158,48 @@ public static async Task<IResult> GetUserById(IRepository<User> service, int id,
         }
 
         [ProducesResponseType(StatusCodes.Status200OK)]
-        [ProducesResponseType(StatusCodes.Status204NoContent)]
         [ProducesResponseType(StatusCodes.Status400BadRequest)]
         [ProducesResponseType(StatusCodes.Status404NotFound)]
-        public static async Task<IResult> UpdateUser(IRepository<User> repository, int id, UserPatchDTO userPatch)
+        public static async Task<IResult> UpdateUser(IRepository<User> repository, int id, UserPatchDTO userPatch, IMapper mapper)
         {
-            if (userPatch.GetType().GetProperties().Length > 0 && userPatch.GetType().GetProperties().All((p) => p.GetValue(userPatch) == null)) return TypedResults.NoContent();
+            if (userPatch.GetType().GetProperties().Length > 0 && userPatch.GetType().GetProperties().All((p) => p.GetValue(userPatch) == null)) 
+                return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Provide at least one field for update" });
 
             var user = repository.GetById(id);
 
-            if (user == null) return TypedResults.NotFound();
+            if (user == null) return TypedResults.NotFound(new ResponseDTO<string> { Message = "User not found" });
 
             if (userPatch.Username != null && userPatch.Username != user.Username)
             {
                 // Validate username
-                if (Validator.Username(userPatch.Username) != "Accepted") return TypedResults.BadRequest("Invalid username");
+                if (Validator.Username(userPatch.Username) != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Invalid username" });
                 var usernameExists = repository.GetAllFiltered(q => q.Username == userPatch.Username);
-                if (usernameExists.Count() != 0) return TypedResults.BadRequest("Username is already in use");
+                if (usernameExists.Count() != 0) return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Username is already in use" });
                 // Update
                 user.Username = userPatch.Username;
             }
             if (userPatch.GithubUsername != null && userPatch.GithubUsername != user.GithubUsername)
             {
                 // Validate github username
-                if (Validator.Username(userPatch.GithubUsername) != "Accepted") return TypedResults.BadRequest("Invalid GitHub username");
+                if (Validator.Username(userPatch.GithubUsername) != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Invalid GitHub username" });
                 var gitUsernameExists = repository.GetAllFiltered(q => q.GithubUsername == userPatch.GithubUsername);
-                if (gitUsernameExists.Count() != 0) return TypedResults.BadRequest("GitHub username is already in use");
+                if (gitUsernameExists.Count() != 0) return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "GitHub username is already in use" });
                 // Update
                 user.GithubUsername = userPatch.GithubUsername;
             }
             if (userPatch.Email != null && userPatch.Email != user.Email)
             {
-                // Validate username
-                if (Validator.Email(userPatch.Email) != "Accepted") return TypedResults.BadRequest("Invalid email");
+                // Validate email
+                if (Validator.Email(userPatch.Email) != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Invalid email" });
                 var emailExists = repository.GetAllFiltered(q => q.Email == userPatch.Email);
-                if (emailExists.Count() != 0) return TypedResults.BadRequest("Email is already in use");
+                if (emailExists.Count() != 0) return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Email is already in use" });
                 // Update
                 user.Email = userPatch.Email;
             }
             if (userPatch.Password != null)
             {
                 // Validate username
-                if (Validator.Password(userPatch.Password) != "Accepted") return TypedResults.BadRequest("Invalid password");
+                if (Validator.Password(userPatch.Password) != "Accepted") return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Invalid password" });
                 // Hash
                 string passwordHash = BCrypt.Net.BCrypt.HashPassword(userPatch.Username);
                 // Update
@@ -208,7 +212,7 @@ public static async Task<IResult> UpdateUser(IRepository<User> repository, int i
             {
                 if (userPatch.Role == 0) { user.Role = Roles.student; }
                 else if (userPatch.Role == 1) { user.Role = Roles.teacher; }
-                else {return TypedResults.BadRequest("Role does not exist");}
+                else {return TypedResults.BadRequest(new ResponseDTO<string>() { Message = "Role does not exist" });}
             }
             if (userPatch.Specialism != null) user.Specialism = userPatch.Specialism;
             // TODO: Add cohort support after implementing the Cohort model and adding it to user.
@@ -220,7 +224,13 @@ public static async Task<IResult> UpdateUser(IRepository<User> repository, int i
             repository.Update(user);
             repository.Save();
 
-            return TypedResults.Ok(userPatch);
+            ResponseDTO<UserDTO> response = new ResponseDTO<UserDTO>
+            {
+                Message = "success",
+                Data = mapper.Map<UserDTO>(user)
+            };
+
+            return TypedResults.Ok(response);
         }
         private static string CreateToken(User user, IConfigurationSettings config)
         {