#150 | Revert | Fix response type of save user endpoint

src/main/java/com/ays/user/controller/UserController.java

@@ -8,8 +8,10 @@
 import com.ays.user.model.dto.request.UserSaveRequest;
 import com.ays.user.model.dto.request.UserUpdateRequest;
 import com.ays.user.model.dto.response.UserResponse;
+import com.ays.user.model.dto.response.UserSavedResponse;
 import com.ays.user.model.dto.response.UsersResponse;
 import com.ays.user.model.mapper.UserToUserResponseMapper;
+import com.ays.user.model.mapper.UserToUserSavedResponseMapper;
 import com.ays.user.model.mapper.UserToUsersResponseMapper;
 import com.ays.user.service.UserSaveService;
 import com.ays.user.service.UserService;
@@ -34,6 +36,7 @@ class UserController {
     private final UserService userService;
     private final UserSaveService userSaveService;
 
+    private final UserToUserSavedResponseMapper userToUserSavedResponseMapper = UserToUserSavedResponseMapper.initialize();
     private final UserToUserResponseMapper userToUserResponseMapper = UserToUserResponseMapper.initialize();
     private final UserToUsersResponseMapper userToUsersResponseMapper = UserToUsersResponseMapper.initialize();
 
@@ -80,9 +83,10 @@ public AysResponse<UserResponse> getUserById(@PathVariable @UUID String id) {
      */
     @PostMapping("/user")
     @PreAuthorize("hasAnyAuthority('ADMIN')")
-    public AysResponse<Void> saveUser(@RequestBody @Valid UserSaveRequest saveRequest) {
-        userSaveService.saveUser(saveRequest);
-        return AysResponse.SUCCESS;
+    public AysResponse<UserSavedResponse> saveUser(@RequestBody @Valid UserSaveRequest saveRequest) {
+        User user = userSaveService.saveUser(saveRequest);
+        UserSavedResponse userSavedResponse = userToUserSavedResponseMapper.map(user);
+        return AysResponse.successOf(userSavedResponse);
     }
 
     /**

src/main/java/com/ays/user/model/dto/response/UserSavedResponse.java

@@ -0,0 +1,31 @@
+package com.ays.user.model.dto.response;
+
+import lombok.Builder;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * A DTO class representing the response data returned when a user is saved.
+ * <p>
+ * This class provides getters and setters for the username and password fields.
+ * It also includes a builder pattern implementation for constructing instances of this class with optional parameters.
+ * <p>
+ * The purpose of this class is to encapsulate the response data related to saving a user, allowing for easy
+ * transfer of the data between different layers of the application.
+ */
+@Getter
+@Setter
+@Builder
+public class UserSavedResponse {
+
+    /**
+     * This field is created by the application.
+     */
+    private String username;
+
+    /**
+     * This field is created by the application.
+     */
+    private String password;
+
+}

src/main/java/com/ays/user/model/mapper/UserToUserSavedResponseMapper.java

@@ -0,0 +1,28 @@
+package com.ays.user.model.mapper;
+
+import com.ays.common.model.mapper.BaseMapper;
+import com.ays.user.model.User;
+import com.ays.user.model.dto.response.UserSavedResponse;
+import org.mapstruct.Mapper;
+import org.mapstruct.factory.Mappers;
+
+/**
+ * UserToUserResponseMapper is an interface that defines the mapping between an {@link User} and an {@link UserSavedResponse}.
+ * This interface uses the MapStruct annotation @Mapper to generate an implementation of this interface at compile-time.
+ * <p>The class provides a static method {@code initialize()} that returns an instance of the generated mapper implementation.
+ * <p>The interface extends the MapStruct interface {@link BaseMapper}, which defines basic mapping methods.
+ * The interface adds no additional mapping methods, but simply defines the types to be used in the mapping process.
+ */
+@Mapper
+public interface UserToUserSavedResponseMapper extends BaseMapper<User, UserSavedResponse> {
+
+    /**
+     * Initializes the mapper.
+     *
+     * @return the initialized mapper object.
+     */
+    static UserToUserSavedResponseMapper initialize() {
+        return Mappers.getMapper(UserToUserSavedResponseMapper.class);
+    }
+
+}

src/main/java/com/ays/user/service/UserSaveService.java

@@ -12,7 +12,8 @@ public interface UserSaveService {
      * Saves a saveRequest to the database.
      *
      * @param saveRequest the UserSaveRequest entity
+     * @return User
      */
-    void saveUser(UserSaveRequest saveRequest);
+    User saveUser(UserSaveRequest saveRequest);
 
 }

src/main/java/com/ays/user/service/impl/UserSaveServiceImpl.java

@@ -36,9 +36,10 @@ class UserSaveServiceImpl implements UserSaveService {
      * Saves a new user based on the provided save request.
      *
      * @param saveRequest the request object containing user data to be saved
+     * @return the saved user
      * @throws AysUserAlreadyExistsByPhoneNumberException if a user with the same phone number already exists
      */
-    public void saveUser(final UserSaveRequest saveRequest) {
+    public User saveUser(final UserSaveRequest saveRequest) {
 
         final List<UserEntity> usersFromDatabase = userRepository.findAll();
 
@@ -57,6 +58,11 @@ public void saveUser(final UserSaveRequest saveRequest) {
                 );
 
         userRepository.save(userEntity);
+
+        return User.builder()
+                .username(username)
+                .password(password)
+                .build();
     }
 
     /**

src/test/java/com/ays/user/controller/UserControllerTest.java

@@ -14,6 +14,8 @@
 import com.ays.user.model.UserBuilder;
 import com.ays.user.model.dto.request.*;
 import com.ays.user.model.dto.response.UserResponse;
+import com.ays.user.model.dto.response.UserSavedResponse;
+import com.ays.user.model.dto.response.UserSavedResponseBuilder;
 import com.ays.user.model.dto.response.UsersResponse;
 import com.ays.user.model.entity.UserEntity;
 import com.ays.user.model.entity.UserEntityBuilder;
@@ -33,6 +35,7 @@
 import org.springframework.data.domain.PageImpl;
 import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
 
 import java.util.List;
 
@@ -59,11 +62,20 @@ void givenValidUserSaveRequest_whenUserSaved_thenReturnUserSavedResponse() throw
                 .build();
 
         // When
-        Mockito.doNothing().when(userSaveService).saveUser(Mockito.any(UserSaveRequest.class));
+        User mockUser = new UserBuilder()
+                .withUsername("123456")
+                .withPassword("987654")
+                .withStatus(UserStatus.ACTIVE).build();
+        Mockito.when(userSaveService.saveUser(Mockito.any(UserSaveRequest.class)))
+                .thenReturn(mockUser);
 
         // Then
         String endpoint = BASE_PATH.concat("/user");
-        AysResponse<Void> mockResponse = AysResponseBuilder.SUCCESS;
+        UserSavedResponse mockUserSavedResponse = new UserSavedResponseBuilder()
+                .withUsername(mockUser.getUsername())
+                .withPassword(mockUser.getPassword())
+                .build();
+        AysResponse<UserSavedResponse> mockResponse = AysResponseBuilder.successOf(mockUserSavedResponse);
         mockMvc.perform(AysMockMvcRequestBuilders
                         .post(endpoint, mockAdminUserToken.getAccessToken(), mockUserSaveRequest))
                 .andDo(MockMvcResultHandlers.print())
@@ -75,7 +87,11 @@ void givenValidUserSaveRequest_whenUserSaved_thenReturnUserSavedResponse() throw
                 .andExpect(AysMockResultMatchersBuilders.isSuccess()
                         .value(mockResponse.getIsSuccess()))
                 .andExpect(AysMockResultMatchersBuilders.response()
-                        .doesNotExist());
+                        .isNotEmpty())
+                .andExpect(MockMvcResultMatchers.jsonPath("$.response.username")
+                        .value(mockResponse.getResponse().getUsername()))
+                .andExpect(MockMvcResultMatchers.jsonPath("$.response.password")
+                        .value(mockResponse.getResponse().getPassword()));
 
         Mockito.verify(userSaveService, Mockito.times(1))
                 .saveUser(Mockito.any(UserSaveRequest.class));

src/test/java/com/ays/user/controller/UserSystemTest.java

@@ -13,6 +13,8 @@
 import com.ays.user.model.UserBuilder;
 import com.ays.user.model.dto.request.*;
 import com.ays.user.model.dto.response.UserResponse;
+import com.ays.user.model.dto.response.UserSavedResponse;
+import com.ays.user.model.dto.response.UserSavedResponseBuilder;
 import com.ays.user.model.dto.response.UsersResponse;
 import com.ays.user.model.entity.UserEntity;
 import com.ays.user.model.entity.UserEntityBuilder;
@@ -29,6 +31,7 @@
 import org.springframework.data.domain.PageImpl;
 import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
 
 import java.util.List;
 
@@ -50,7 +53,8 @@ void givenValidUserSaveRequest_whenUserSaved_thenReturnUserSavedResponse() throw
 
         // Then
         String endpoint = BASE_PATH.concat("/user");
-        AysResponse<Void> response = AysResponseBuilder.SUCCESS;
+        UserSavedResponse userSavedResponse = new UserSavedResponseBuilder().build();
+        AysResponse<UserSavedResponse> response = AysResponseBuilder.successOf(userSavedResponse);
         mockMvc.perform(AysMockMvcRequestBuilders
                         .post(endpoint, adminUserTokenOne.getAccessToken(), userSaveRequest))
                 .andDo(MockMvcResultHandlers.print())
@@ -62,7 +66,11 @@ void givenValidUserSaveRequest_whenUserSaved_thenReturnUserSavedResponse() throw
                 .andExpect(AysMockResultMatchersBuilders.isSuccess()
                         .value(response.getIsSuccess()))
                 .andExpect(AysMockResultMatchersBuilders.response()
-                        .doesNotExist());
+                        .isNotEmpty())
+                .andExpect(MockMvcResultMatchers.jsonPath("$.response.username")
+                        .isNotEmpty())
+                .andExpect(MockMvcResultMatchers.jsonPath("$.response.password")
+                        .isNotEmpty());
     }
 
     @Test

src/test/java/com/ays/user/model/dto/response/UserSavedResponseBuilder.java

@@ -0,0 +1,21 @@
+package com.ays.user.model.dto.response;
+
+import com.ays.common.model.TestDataBuilder;
+
+public class UserSavedResponseBuilder extends TestDataBuilder<UserSavedResponse> {
+
+    public UserSavedResponseBuilder() {
+        super(UserSavedResponse.class);
+    }
+
+    public UserSavedResponseBuilder withUsername(String username) {
+        data.setUsername(username);
+        return this;
+    }
+
+    public UserSavedResponseBuilder withPassword(String password) {
+        data.setPassword(password);
+        return this;
+    }
+
+}

src/test/java/com/ays/user/service/impl/UserSaveServiceImplTest.java

@@ -57,8 +57,13 @@ void givenValidUserSaveRequest_whenUserSaved_thenReturnUser() {
                 .thenReturn(AysRandomUtil.generateUUID());
 
         // Then
-        userSaveService.saveUser(mockUserSaveRequest);
-
+        User user = userSaveService.saveUser(mockUserSaveRequest);
+
+        Assertions.assertNotNull(user.getUsername());
+        Assertions.assertEquals(6, user.getUsername().length());
+        Assertions.assertNotNull(user.getPassword());
+        Assertions.assertEquals(6, user.getPassword().length());
+
         Mockito.verify(userRepository, Mockito.times(1)).findAll();
         Mockito.verify(identity, Mockito.times(1)).getInstitutionId();
         Mockito.verify(passwordEncoder, Mockito.times(1)).encode(Mockito.anyString());