Feature: Add feature to find user by name

Author: KangDroid

src/main/kotlin/com/mptsix/todaydiary/controller/UserController.kt

@@ -92,4 +92,12 @@ class UserController(
             userService.getFollowingUser(userToken)
         )
     }
+
+    @GetMapping("/api/v1/user/{name}")
+    fun findUserByName(@RequestHeader header: HttpHeaders, @PathVariable("name") targetName: String): ResponseEntity<List<UserFiltered>> {
+        val userToken: String = header["X-AUTH-TOKEN"]!![0]
+        return ResponseEntity.ok(
+            userService.findUserByName(userToken, targetName)
+        )
+    }
 }

src/main/kotlin/com/mptsix/todaydiary/data/user/UserRepository.kt

@@ -8,6 +8,7 @@ import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import org.springframework.data.mongodb.core.MongoTemplate
 import org.springframework.data.mongodb.core.aggregation.*
+import org.springframework.data.mongodb.core.find
 import org.springframework.data.mongodb.core.findOne
 import org.springframework.data.mongodb.core.query.Criteria
 import org.springframework.data.mongodb.core.query.Query
@@ -46,6 +47,13 @@ class UserRepository(
         }
     }
 
+    private fun findAllByQuery(fieldName: String, fieldTargetValue: String): List<User> {
+        // Find it
+        return mongoTemplate.find<User>(
+            getQueryForFindBy(fieldName, fieldTargetValue)
+        )
+    }
+
     // Add or update user
     fun addUser(user: User): User = mongoTemplate.save(user)
 
@@ -55,6 +63,9 @@ class UserRepository(
     // Find User by User Name
     fun findByUserName(userName: String): User = findOneByQuery(userNameField, userName)
 
+    // Find all user by user name
+    fun findAllByUserName(userName: String): List<User> = findAllByQuery(userNameField, userName)
+
     // Find category size by user id / by category name
     fun findCategorySizeByUserId(categoryName: String, userId:String):Int {
         // First, match user Id

src/main/kotlin/com/mptsix/todaydiary/service/UserService.kt

@@ -167,6 +167,23 @@ class UserService(
         }
     }
 
+    fun findUserByName(userToken: String, userName: String): List<UserFiltered> {
+        val user: User = userRepository.findByUserId(getUserIdFromToken(userToken))
+        val userList: List<User> = userRepository.findAllByUserName(userName)
+
+        return userList.map {
+            UserFiltered(
+                userName = it.userName,
+                userId = it.userId,
+                isUserFollowedTargetUser = (
+                    user.followList.find { eachString ->
+                        eachString == it.userId
+                    }
+                ) != null
+            )
+        }
+    }
+
     private fun createJournalCategoryList(userId: String): List<JournalCategoryResponse> {
         return enumValues<JournalCategory>().map {
             JournalCategoryResponse(

src/test/kotlin/com/mptsix/todaydiary/controller/UserControllerTest.kt

@@ -261,4 +261,20 @@ internal class UserControllerTest {
         assertThat(responseEntity.hasBody()).isEqualTo(true)
         assertThat(responseEntity.body!!.size).isEqualTo(0)
     }
+
+    @Test
+    fun is_findUserByName_works_well() {
+        val loginToken: String = loginUser()
+        val url: String = "${serverUrl}/api/v1/user/test"
+        val httpHeaders: HttpHeaders = HttpHeaders().apply {
+            put("X-AUTH-TOKEN", listOf(loginToken))
+        }
+
+        val responseEntity: ResponseEntity<List<UserFiltered>> =
+            restTemplate.exchange(url, HttpMethod.GET, HttpEntity<Unit>(httpHeaders))
+
+        assertThat(responseEntity.statusCode).isEqualTo(HttpStatus.OK)
+        assertThat(responseEntity.hasBody()).isEqualTo(true)
+        assertThat(responseEntity.body!!.size).isEqualTo(0)
+    }
 }

src/test/kotlin/com/mptsix/todaydiary/service/UserServiceTest.kt

@@ -385,4 +385,31 @@ internal class UserServiceTest {
             assertThat(size).isEqualTo(1)
         }
     }
+
+    @Test
+    fun is_findUserByName_works_well() {
+        val loginToken: String = loginUser()
+
+        // Register another 3 user
+        registerUser("test")
+        registerUser("test2")
+        registerUser("test3")
+
+        // Follow one of them
+        userService.followUser(loginToken, "test")
+
+        userService.findUserByName(loginToken, "test").also {
+            assertThat(it.size).isEqualTo(1)
+            assertThat(it[0].isUserFollowedTargetUser).isEqualTo(true) // we followed test user.
+            assertThat(it[0].userId).isEqualTo("test")
+            assertThat(it[0].userName).isEqualTo("test")
+        }
+
+        userService.findUserByName(loginToken, "test2").also {
+            assertThat(it.size).isEqualTo(1)
+            assertThat(it[0].isUserFollowedTargetUser).isEqualTo(false)
+            assertThat(it[0].userId).isEqualTo("test2")
+            assertThat(it[0].userName).isEqualTo("test2")
+        }
+    }
 }