Feat/endpoint usersfilter (#59)

* feat(endpoint-userfilter): add the endpoint

* feat(endpoint-userfilter): add enum for gender

* feat(endpoint-userfilter): update readme

* feat(endpoint-userfilter): add test for usecase and services

* feat(endpoint-userfilter): add jpa for api criteria

---------

Co-authored-by: Romain Vanhee <romain.vanhee@yrycom.com>

Author: profotoce59

README.md

@@ -88,6 +88,7 @@ dummy.api.base-url=https://dummyjson.com/
 | `POST` | `/random-users`          | Create a new user | ✅ |
 | `PUT` | `/random-users/{id}`     | Update user | ✅ |
 | `DELETE` | `/random-users/{id}`     | Delete user | ✅ |
+| `GET` | `/random-users/filter` | Filter users by criteria | ✅ |
 
 ### Example Request
 
@@ -115,6 +116,12 @@ curl -X POST "http://localhost:8080/random-users" \
     "nat": "FR"
   }'
 
+# Filter users by gender and nationality
+curl -X GET "http://localhost:8080/random-users/filter?gender=MALE&nat=FR"
+
+# Filter users by firstname (partial match, case-insensitive)
+curl -X GET "http://localhost:8080/random-users/filter?firstname=john"
+
 # Update user
 curl -X PUT "http://localhost:8080/random-users/1" \
   -H "Content-Type: application/json" \

pom.xml

@@ -50,7 +50,7 @@
         </dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-data-jdbc</artifactId>
+			<artifactId>spring-boot-starter-data-jpa</artifactId>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
@@ -78,11 +78,6 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-actuator-test</artifactId>
 			<scope>test</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.springframework.boot</groupId>
-			<artifactId>spring-boot-starter-data-jdbc-test</artifactId>
-			<scope>test</scope>
 		</dependency>
 			<dependency>
 				<groupId>org.springframework.boot</groupId>

src/main/java/com/xpeho/spring_boot_java_random_user/data/models/database/User.java

@@ -1,34 +1,39 @@
 package com.xpeho.spring_boot_java_random_user.data.models.database;
 
-import org.springframework.data.annotation.Id;
-import org.springframework.data.relational.core.mapping.Column;
-import org.springframework.data.relational.core.mapping.Table;
-
-@Table("users")
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+
+@Entity
+@Table(name = "users")
 public class User {
     @Id
-    @Column("id")
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "id")
     private Long id;
-    @Column("gender")
+    @Column(name = "gender")
     private String gender;
-    @Column("firstname")
+    @Column(name = "firstname")
     private String firstname;
-    @Column("lastname")
+    @Column(name = "lastname")
     private String lastname;
-    @Column("civility")
+    @Column(name = "civility")
     private String civility;
-    @Column("email")
+    @Column(name = "email")
     private String email;
-    @Column("phone")
+    @Column(name = "phone")
     private String phone;
-    @Column("picture")
+    @Column(name = "picture")
     private String picture;
-    @Column("nationality")
+    @Column(name = "nationality")
     private String nationality;
 
-    // Required by Spring Data JDBC to instantiate the entity via reflection
+    // Required by JPA
     public User() {
-        // No initialization needed; fields are populated by Spring Data JDBC after instantiation
+        // No initialization needed
     }
 
     public Long getId() {

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

@@ -3,7 +3,9 @@
 import com.xpeho.spring_boot_java_random_user.data.converters.UserConverter;
 import com.xpeho.spring_boot_java_random_user.data.models.database.User;
 import com.xpeho.spring_boot_java_random_user.data.sources.database.UserRepository;
+import com.xpeho.spring_boot_java_random_user.data.sources.database.UserSpecifications;
 import com.xpeho.spring_boot_java_random_user.domain.entities.UserEntity;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserFilter;
 import com.xpeho.spring_boot_java_random_user.domain.services.LocalUserService;
 import org.springframework.stereotype.Service;
 
@@ -47,4 +49,11 @@ public UserEntity save(UserEntity user) {
     public void deleteById(long id) {
         userRepository.deleteById(id);
     }
+
+    @Override
+    public List<UserEntity> filterUsers(UserFilter filter) {
+        return userRepository.findAll(UserSpecifications.byFilter(filter)).stream()
+                .map(userConverter::toDomain)
+                .toList();
+    }
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/sources/database/UserRepository.java

@@ -1,7 +1,8 @@
 package com.xpeho.spring_boot_java_random_user.data.sources.database;
 
 import com.xpeho.spring_boot_java_random_user.data.models.database.User;
-import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
 
-public interface UserRepository extends CrudRepository<User, Long> {
+public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {
 }

src/main/java/com/xpeho/spring_boot_java_random_user/data/sources/database/UserSpecifications.java

@@ -0,0 +1,55 @@
+package com.xpeho.spring_boot_java_random_user.data.sources.database;
+
+import com.xpeho.spring_boot_java_random_user.data.models.database.User;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserFilter;
+import jakarta.persistence.criteria.CriteriaBuilder;
+import jakarta.persistence.criteria.Path;
+import jakarta.persistence.criteria.Predicate;
+import org.springframework.data.jpa.domain.Specification;
+import org.springframework.util.StringUtils;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public final class UserSpecifications {
+    private UserSpecifications() {
+    }
+
+    public static Specification<User> byFilter(UserFilter filter) {
+        return (user, query, criteriaBuilder) -> {
+            List<Predicate> predicates = new ArrayList<>();
+
+            if (filter.gender() != null) {
+                predicates.add(criteriaBuilder.equal(
+                        criteriaBuilder.lower(user.get("gender")),
+                        filter.gender().name().toLowerCase()
+                ));
+            }
+
+            addContainsPredicate(predicates, criteriaBuilder, user.get("firstname"), filter.firstname());
+            addContainsPredicate(predicates, criteriaBuilder, user.get("lastname"), filter.lastname());
+            addContainsPredicate(predicates, criteriaBuilder, user.get("civility"), filter.civility());
+            addContainsPredicate(predicates, criteriaBuilder, user.get("email"), filter.email());
+            addContainsPredicate(predicates, criteriaBuilder, user.get("phone"), filter.phone());
+            addContainsPredicate(predicates, criteriaBuilder, user.get("nationality"), filter.nat());
+
+            return criteriaBuilder.and(predicates.toArray(new Predicate[0]));
+        };
+    }
+
+    private static void addContainsPredicate(
+            List<Predicate> predicates,
+            CriteriaBuilder criteriaBuilder,
+            Path<String> field,
+            String value
+    ) {
+        if (!StringUtils.hasText(value)) {
+            return;
+        }
+
+        predicates.add(criteriaBuilder.like(
+                criteriaBuilder.lower(field),
+                "%" + value.toLowerCase() + "%"
+        ));
+    }
+}

src/main/java/com/xpeho/spring_boot_java_random_user/domain/entities/UserFilter.java

@@ -0,0 +1,14 @@
+package com.xpeho.spring_boot_java_random_user.domain.entities;
+
+import com.xpeho.spring_boot_java_random_user.domain.enums.Gender;
+
+public record UserFilter(
+        Gender gender,
+        String firstname,
+        String lastname,
+        String civility,
+        String email,
+        String phone,
+        String nat
+) {
+}

src/main/java/com/xpeho/spring_boot_java_random_user/domain/enums/Gender.java

@@ -0,0 +1,6 @@
+package com.xpeho.spring_boot_java_random_user.domain.enums;
+
+public enum Gender {
+    MALE,
+    FEMALE
+}

src/main/java/com/xpeho/spring_boot_java_random_user/domain/services/LocalUserService.java

@@ -1,6 +1,7 @@
 package com.xpeho.spring_boot_java_random_user.domain.services;
 
 import com.xpeho.spring_boot_java_random_user.domain.entities.UserEntity;
+import com.xpeho.spring_boot_java_random_user.domain.entities.UserFilter;
 
 import java.util.List;
 import java.util.Optional;
@@ -13,5 +14,7 @@ public interface LocalUserService {
     UserEntity save(UserEntity user);
 
     void deleteById(long id);
+
+    List<UserEntity> filterUsers(UserFilter filter);
 }
 

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

@@ -0,0 +1,21 @@
+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.UserFilter;
+import com.xpeho.spring_boot_java_random_user.domain.services.LocalUserService;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+
+@Service
+public class FilterUsersUseCase {
+    private final LocalUserService userService;
+
+    public FilterUsersUseCase(LocalUserService userService) {
+        this.userService = userService;
+    }
+
+    public List<UserEntity> execute(UserFilter filter) {
+        return userService.filterUsers(filter);
+    }
+}