feat(postUser): create an endpoint for creating a new user

Author: romainVanhee

README.md

@@ -164,11 +164,28 @@ GET /random-users?count=500
 
 ```http
 PUT /random-users/{id}
-Content-Type: application/json
 ```
 
 Example body:
 
+```json
+{
+  "gender": "female",
+  "firstname": "Albert",
+  "lastname": "Bing",
+  "civility": "Mrs",
+  "email": "albert.bing@example.com",
+  "phone": "123456789",
+  "picture": "pic.jpg",
+  "nat": "FR"
+}
+```
+#### Create a new user
+```http
+POST /random-users
+```
+Example body:
+
 ```json
 {
   "gender": "female",
@@ -317,7 +334,7 @@ This project consumes the public **Random User Generator** API:
 - [ ] [Add this endpoint get /user/{id}](https://github.com/XPEHO/spring_boot_java_random_user/issues/8)
 - [X] [Add this endpoint put /user/{id}](https://github.com/XPEHO/spring_boot_java_random_user/issues/9)
 - [ ] [Add this endpoint delete /user/{id}](https://github.com/XPEHO/spring_boot_java_random_user/issues/10)
-- [ ] [Add this endpoint post /user](https://github.com/XPEHO/spring_boot_java_random_user/issues/11)
+- [x] [Add this endpoint post /user](https://github.com/XPEHO/spring_boot_java_random_user/issues/11)
 
 ---
 

src/main/java/com/xpeho/spring_boot_java_random_user/domain/usecases/CreateUserUseCase.java

@@ -0,0 +1,31 @@
+package com.xpeho.spring_boot_java_random_user.domain.usecases;
+
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserEntity;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserRequest;
+import com.xpeho.spring_boot_java_random_user.domain.services.UserService;
+import org.springframework.stereotype.Service;
+
+@Service
+public class CreateUserUseCase {
+    private final UserService userService;
+
+    public CreateUserUseCase(UserService userService) {
+        this.userService = userService;
+    }
+
+    public UserEntity execute(UserRequest user) {
+        UserEntity userToCreate = new UserEntity(
+        null,
+            user.gender(),
+            user.firstname(),
+            user.lastname(),
+            user.civility(),
+            user.email(),
+            user.phone(),
+            user.picture(),
+            user.nat()
+        );
+
+        return userService.save(userToCreate);
+    }
+}

src/main/java/com/xpeho/spring_boot_java_random_user/presentation/controllers/UserController.java

@@ -9,6 +9,7 @@
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
@@ -59,4 +60,16 @@ ResponseEntity<UserEntity> updateRandomUser(
             @RequestBody
             UserRequest user
     );
+
+    @PostMapping("")
+    @Operation(
+        summary = "Create a user",
+        description = "Creates a new user in the database.",
+        parameters = {
+            @Parameter(name = "UserRequest", description = "User data to persist")
+        }
+    )
+    @ApiResponse(responseCode = "201", description = "User successfully created")
+    @ApiResponse(responseCode = "500", description = "Internal server error")
+    ResponseEntity<UserEntity> createUser(@RequestBody UserRequest user);
 }

src/main/java/com/xpeho/spring_boot_java_random_user/presentation/handlers/UserHandler.java

@@ -3,13 +3,15 @@
 import com.xpeho.spring_boot_java_random_user.domain.entities.UserEntity;
 import com.xpeho.spring_boot_java_random_user.domain.entities.UserRequest;
 import com.xpeho.spring_boot_java_random_user.domain.exceptions.UserNotFoundException;
+import com.xpeho.spring_boot_java_random_user.domain.usecases.CreateUserUseCase;
 import com.xpeho.spring_boot_java_random_user.domain.usecases.FetchAndSaveRandomUsersUseCase;
 import com.xpeho.spring_boot_java_random_user.domain.usecases.UpdateRandomUserUseCase;
 import com.xpeho.spring_boot_java_random_user.presentation.controllers.UserController;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.io.IOException;
@@ -24,14 +26,17 @@ public class UserHandler implements UserController {
 
     private final FetchAndSaveRandomUsersUseCase fetchAndSaveRandomUsersUseCase;
     private final UpdateRandomUserUseCase updateRandomUserUseCase;
-
+    private final CreateUserUseCase createUserUseCase;
     public UserHandler(
             FetchAndSaveRandomUsersUseCase fetchAndSaveRandomUsersUseCase,
-            UpdateRandomUserUseCase updateRandomUserUseCase
+            UpdateRandomUserUseCase updateRandomUserUseCase,
+            CreateUserUseCase createUserUseCase
     ) {
         this.fetchAndSaveRandomUsersUseCase = fetchAndSaveRandomUsersUseCase;
         this.updateRandomUserUseCase = updateRandomUserUseCase;
+        this.createUserUseCase = createUserUseCase;
     }
+    
 
     @Override
     public ResponseEntity<List<UserEntity>> getRandomUsers(int count) {
@@ -55,4 +60,10 @@ public ResponseEntity<UserEntity> updateRandomUser(int id, UserRequest user) {
         }
     }
 
+
+    @Override
+    public ResponseEntity<UserEntity> createUser(@RequestBody UserRequest user) {
+        UserEntity createdUser = createUserUseCase.execute(user);
+        return ResponseEntity.status(HttpStatus.CREATED).body(createdUser);
+    }
 }

src/test/java/com/xpeho/spring_boot_java_random_user/data/services/UserServiceImplTest.java

@@ -65,7 +65,6 @@ void shouldSaveMappedUserAndReturnMappedDomainEntity() {
         UserEntity input = new UserEntity(3L, "female", "Alice", "Smith", "Mrs", "alice@smith.com", "5678", "new-pic.jpg", "US");
 
         User daoToSave = new User();
-        daoToSave.setId(3L);
         daoToSave.setFirstname("Alice");
 
         User savedDao = new User();

src/test/java/com/xpeho/spring_boot_java_random_user/domain/usecases/CreateUserUseCaseTest.java

@@ -0,0 +1,45 @@
+package com.xpeho.spring_boot_java_random_user.domain.usecases;
+
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserEntity;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserRequest;
+import com.xpeho.spring_boot_java_random_user.domain.services.UserService;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+class CreateUserUseCaseTest {
+    private UserService userService;
+    private CreateUserUseCase useCase;
+
+    @BeforeEach
+    void setUp() {
+        userService = mock(UserService.class);
+        useCase = new CreateUserUseCase(userService);
+    }
+
+    @Test
+    @DisplayName("Should create a user without keeping the input id")
+    void shouldCreateUserWithoutKeepingInputId() {
+        UserRequest payload = new UserRequest(
+            "female", "Alice", "Smith", "Mrs", "alice@smith.com", "5678", "new-pic.jpg", "US"
+        );
+        UserEntity createdUser = new UserEntity(
+            1L, "female", "Alice", "Smith", "Mrs", "alice@smith.com", "5678", "new-pic.jpg", "US"
+        );
+        UserEntity expectedSavedUser = new UserEntity(
+            null, "female", "Alice", "Smith", "Mrs", "alice@smith.com", "5678", "new-pic.jpg", "US"
+        );
+
+        when(userService.save(expectedSavedUser)).thenReturn(createdUser);
+
+        UserEntity result = useCase.execute(payload);
+
+        assertEquals(createdUser, result);
+        verify(userService).save(expectedSavedUser);
+    }
+}