feat(converters): refactor UserConverter and update DAO classes for better encapsulation

Author: Theo-lbg

src/main/java/com/xpeho/spring_boot_java_random_user/data/converters/UserConverter.java

@@ -38,20 +38,20 @@ public UserEntity toDomain(User user) {
     }
     // API -> Domain
     public UserEntity fromApiModel(RandomUserResultDAO model) {
-        String firstName = model.name != null ? model.name.first : null;
-        String lastName = model.name != null ? model.name.last : null;
-        String civility = model.name != null ? model.name.title : null;
-        String picture = model.picture != null ? model.picture.medium : null;
+        String firstName = model.getName() != null ? model.getName().getFirst() : null;
+        String lastName = model.getName() != null ? model.getName().getLast() : null;
+        String civility = model.getName() != null ? model.getName().getTitle() : null;
+        String picture = model.getPicture() != null ? model.getPicture().getMedium() : null;
         return new UserEntity(
             null,
-            model.gender,
+            model.getGender(),
             firstName,
             lastName,
             civility,
-            model.email,
-            model.phone,
+            model.getEmail(),
+            model.getPhone(),
             picture,
-            model.nat
+            model.getNat()
         );
     }
 

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/RandomUserPictureDAO.java

@@ -1,5 +1,13 @@
 package com.xpeho.spring_boot_java_random_user.data.models;
 
 public class RandomUserPictureDAO {
-    public String medium;
+    private String medium;
+
+    public String getMedium() {
+        return medium;
+    }
+
+    public void setMedium(String medium) {
+        this.medium = medium;
+    }
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/api/RandomUserNameDAO.java

@@ -1,7 +1,14 @@
 package com.xpeho.spring_boot_java_random_user.data.models.api;
 
 public class RandomUserNameDAO {
-    public String title;
-    public String first;
-    public String last;
+    private String title;
+    private String first;
+    private String last;
+
+    public String getTitle() { return title; }
+    public void setTitle(String title) { this.title = title; }
+    public String getFirst() { return first; }
+    public void setFirst(String first) { this.first = first; }
+    public String getLast() { return last; }
+    public void setLast(String last) { this.last = last; }
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/api/RandomUserPictureDAO.java

@@ -1,5 +1,13 @@
 package com.xpeho.spring_boot_java_random_user.data.models.api;
 
 public class RandomUserPictureDAO {
-    public String medium;
+    private String medium;
+
+    public String getMedium() {
+        return medium;
+    }
+
+    public void setMedium(String medium) {
+        this.medium = medium;
+    }
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/api/RandomUserResultDAO.java

@@ -1,10 +1,23 @@
 package com.xpeho.spring_boot_java_random_user.data.models.api;
 
 public class RandomUserResultDAO {
-    public String gender;
-    public RandomUserNameDAO name;
-    public String email;
-    public String phone;
-    public RandomUserPictureDAO picture;
-    public String nat;
+    private String gender;
+    private RandomUserNameDAO name;
+    private String email;
+    private String phone;
+    private RandomUserPictureDAO picture;
+    private String nat;
+
+    public String getGender() { return gender; }
+    public void setGender(String gender) { this.gender = gender; }
+    public RandomUserNameDAO getName() { return name; }
+    public void setName(RandomUserNameDAO name) { this.name = name; }
+    public String getEmail() { return email; }
+    public void setEmail(String email) { this.email = email; }
+    public String getPhone() { return phone; }
+    public void setPhone(String phone) { this.phone = phone; }
+    public RandomUserPictureDAO getPicture() { return picture; }
+    public void setPicture(RandomUserPictureDAO picture) { this.picture = picture; }
+    public String getNat() { return nat; }
+    public void setNat(String nat) { this.nat = nat; }
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/services/UserServiceImpl.java

@@ -27,7 +27,7 @@ public List<UserEntity> saveAll(List<UserEntity> users) {
         List<User> daoUsers = users.stream().map(userConverter::toDao).toList();
         Iterable<User> saved = userRepository.saveAll(daoUsers);
         return StreamSupport.stream(saved.spliterator(), false)
-                .map(userConverter::toDomain)
-                .collect(Collectors.toList());
+            .map(userConverter::toDomain)
+            .toList();
     }
 }

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

@@ -1,7 +1,8 @@
 package com.xpeho.spring_boot_java_random_user.presentation.controllers;
 
-import com.xpeho.spring_boot_java_random_user.presentation.dto.UserDTO;
 import org.springframework.http.ResponseEntity;
+import java.util.List;
+import com.xpeho.spring_boot_java_random_user.presentation.dto.UserDTO;
 import jakarta.validation.constraints.Max;
 import jakarta.validation.constraints.Min;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -15,7 +16,6 @@
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
 
-import java.util.List;
 
 @RequestMapping("/random-users")
 @Tag(name = "User", description = "Endpoints for random user generation")
@@ -29,12 +29,10 @@ public interface UserController {
             @Parameter(name = "count", description = "Number of users to generate (max 5000)", example = "500")
         }
     )
-    @ApiResponses({
-        @ApiResponse(responseCode = "200", description = "List of users successfully fetched and saved"),
-        @ApiResponse(responseCode = "500", description = "Internal server error"),
-        @ApiResponse(responseCode = "503", description = "External service unavailable")
-    })
-    ResponseEntity<?> getRandomUsers(
+    @ApiResponse(responseCode = "200", description = "List of users successfully fetched and saved")
+    @ApiResponse(responseCode = "500", description = "Internal server error")
+    @ApiResponse(responseCode = "503", description = "External service unavailable")
+    ResponseEntity<List<UserDTO>> getRandomUsers(
         @RequestParam(defaultValue = "500")
         @Min(1)
         @Max(5000)

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

@@ -15,6 +15,8 @@
 import java.util.List;
 import java.util.Map;
 
+import static java.util.Collections.emptyList;
+
 @RestController
 public class UserHandler implements UserController {
 
@@ -29,18 +31,15 @@ public UserHandler(FetchAndSaveRandomUsersUseCase fetchAndSaveRandomUsersUseCase
     }
 
     @Override
-    public ResponseEntity<?> getRandomUsers(int count) {
+    public ResponseEntity<List<UserDTO>> getRandomUsers(int count) {
             try {
                 List<UserEntity> users = fetchAndSaveRandomUsersUseCase.execute(count);
                 List<UserDTO> dtos = users.stream().map(userConverter::toDto).toList();
                 return ResponseEntity.ok(dtos);
             } catch (IOException e) {
                 logger.error("Error fetching random users: {}", e.getMessage(), e);
                 return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
-                        .body(Map.of(
-                            "error", "External API Error",
-                            "message", "Impossible to fetch random users from the external API. Please try again later."
-                        ));
+                        .body(emptyList());
             }
     }
 }

src/test/java/com/xpeho/spring_boot_java_random_user/data/converters/UserConverterTest.java

@@ -16,18 +16,18 @@ class UserConverterTest {
     @Test
     void fromApiModel_fullData() {
         RandomUserNameDAO name = new RandomUserNameDAO();
-        name.first = "John";
-        name.last = "Doe";
-        name.title = "Mr";
+        name.setFirst("John");
+        name.setLast("Doe");
+        name.setTitle("Mr");
         RandomUserPictureDAO picture = new RandomUserPictureDAO();
-        picture.medium = "pic.jpg";
+        picture.setMedium("pic.jpg");
         RandomUserResultDAO api = new RandomUserResultDAO();
-        api.gender = "male";
-        api.name = name;
-        api.email = "john@doe.com";
-        api.phone = "1234";
-        api.picture = picture;
-        api.nat = "FR";
+        api.setGender("male");
+        api.setName(name);
+        api.setEmail("john@doe.com");
+        api.setPhone("1234");
+        api.setPicture(picture);
+        api.setNat("FR");
         UserEntity entity = converter.fromApiModel(api);
         assertNull(entity.id());
         assertEquals("male", entity.gender());
@@ -43,12 +43,12 @@ void fromApiModel_fullData() {
     @Test
     void fromApiModel_nullNameAndPicture() {
         RandomUserResultDAO api = new RandomUserResultDAO();
-        api.gender = "female";
-        api.name = null;
-        api.email = "jane@doe.com";
-        api.phone = "5678";
-        api.picture = null;
-        api.nat = "US";
+        api.setGender("female");
+        api.setName(null);
+        api.setEmail("jane@doe.com");
+        api.setPhone("5678");
+        api.setPicture(null);
+        api.setNat("US");
         UserEntity entity = converter.fromApiModel(api);
         assertNull(entity.firstname());
         assertNull(entity.lastname());