[BE] feat: 회원의 학생 인증 정보 조회 API 구현 (#496) (#531)

* refactor: 메서드 네이밍 수정 (verifiacte -> verify) * feat: 학생 인증 정보 조회 기능 구현 * refactor: findByMemberIdWithFetch INNER JOIN으로 수정 * refactor: inner line return 으로 수정 * refactor: 캐싱된 Response 반환
woowacourse-teams · Nov 16, 2023 · cb887dd · cb887dd
1 parent 33e26fa
commit cb887dd
Show file tree

Hide file tree

Showing 9 changed files with 259 additions and 7 deletions.
diff --git a/backend/src/main/java/com/festago/presentation/StudentController.java b/backend/src/main/java/com/festago/presentation/StudentController.java
@@ -2,13 +2,15 @@
 
 import com.festago.auth.annotation.Member;
 import com.festago.student.application.StudentService;
+import com.festago.student.dto.StudentResponse;
 import com.festago.student.dto.StudentSendMailRequest;
 import com.festago.student.dto.StudentVerificateRequest;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -33,10 +35,18 @@ public ResponseEntity<Void> sendEmail(@Member Long memberId,
 
     @PostMapping("/verification")
     @Operation(description = "학교 인증을 수행한다.", summary = "학생 인증 수행")
-    public ResponseEntity<Void> verificate(@Member Long memberId,
-                                           @RequestBody @Valid StudentVerificateRequest request) {
-        studentService.verificate(memberId, request);
+    public ResponseEntity<Void> verify(@Member Long memberId,
+                                       @RequestBody @Valid StudentVerificateRequest request) {
+        studentService.verify(memberId, request);
         return ResponseEntity.ok()
             .build();
     }
+
+    @GetMapping
+    @Operation(description = "학생 인증 정보를 조회한다.", summary = "학생 인증 정보 조회")
+    public ResponseEntity<StudentResponse> findVerification(@Member Long memberId) {
+        StudentResponse response = studentService.findVerification(memberId);
+        return ResponseEntity.ok()
+            .body(response);
+    }
 }
diff --git a/backend/src/main/java/com/festago/student/application/StudentService.java b/backend/src/main/java/com/festago/student/application/StudentService.java
@@ -12,6 +12,7 @@
 import com.festago.student.domain.StudentCode;
 import com.festago.student.domain.VerificationCode;
 import com.festago.student.domain.VerificationMailPayload;
+import com.festago.student.dto.StudentResponse;
 import com.festago.student.dto.StudentSendMailRequest;
 import com.festago.student.dto.StudentVerificateRequest;
 import com.festago.student.repository.StudentCodeRepository;
@@ -89,7 +90,7 @@ private void saveStudentCode(VerificationCode code, Member member, School school
             );
     }
 
-    public void verificate(Long memberId, StudentVerificateRequest request) {
+    public void verify(Long memberId, StudentVerificateRequest request) {
         validateStudent(memberId);
         Member member = findMember(memberId);
         StudentCode studentCode = studentCodeRepository.findByCodeAndMember(new VerificationCode(request.code()),
@@ -98,4 +99,10 @@ public void verificate(Long memberId, StudentVerificateRequest request) {
         studentRepository.save(new Student(member, studentCode.getSchool(), studentCode.getUsername()));
         studentCodeRepository.deleteByMember(member);
     }
+
+    public StudentResponse findVerification(Long memberId) {
+        return studentRepository.findByMemberIdWithFetch(memberId)
+            .map(value -> StudentResponse.verified(value.getSchool()))
+            .orElseGet(StudentResponse::notVerified);
+    }
 }
diff --git a/backend/src/main/java/com/festago/student/dto/StudentResponse.java b/backend/src/main/java/com/festago/student/dto/StudentResponse.java
@@ -0,0 +1,22 @@
+package com.festago.student.dto;
+
+import com.festago.school.domain.School;
+
+public record StudentResponse(
+    boolean isVerified,
+    StudentSchoolResponse school
+) {
+
+    private static final StudentResponse NOT_VERIFIED = new StudentResponse(false, null);
+
+    public static StudentResponse verified(School school) {
+        return new StudentResponse(
+            true,
+            StudentSchoolResponse.from(school)
+        );
+    }
+
+    public static StudentResponse notVerified() {
+        return NOT_VERIFIED;
+    }
+}
diff --git a/backend/src/main/java/com/festago/student/dto/StudentSchoolResponse.java b/backend/src/main/java/com/festago/student/dto/StudentSchoolResponse.java
@@ -0,0 +1,18 @@
+package com.festago.student.dto;
+
+import com.festago.school.domain.School;
+
+public record StudentSchoolResponse(
+    Long id,
+    String schoolName,
+    String domain
+) {
+
+    public static StudentSchoolResponse from(School school) {
+        return new StudentSchoolResponse(
+            school.getId(),
+            school.getName(),
+            school.getDomain()
+        );
+    }
+}
diff --git a/backend/src/main/java/com/festago/student/repository/StudentRepository.java b/backend/src/main/java/com/festago/student/repository/StudentRepository.java
@@ -2,7 +2,10 @@
 
 import com.festago.member.domain.Member;
 import com.festago.student.domain.Student;
+import java.util.Optional;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
 
 public interface StudentRepository extends JpaRepository<Student, Long> {
 
@@ -11,4 +14,12 @@ public interface StudentRepository extends JpaRepository<Student, Long> {
     boolean existsByUsernameAndSchoolId(String username, Long id);
 
     boolean existsByMemberId(Long id);
+
+    @Query("""
+        SELECT st
+        FROM Student st
+        INNER JOIN FETCH st.school sc
+        WHERE st.member.id = :memberId
+        """)
+    Optional<Student> findByMemberIdWithFetch(@Param("memberId") Long memberId);
 }
diff --git a/backend/src/test/java/com/festago/presentation/StudentControllerTest.java b/backend/src/test/java/com/festago/presentation/StudentControllerTest.java
@@ -1,14 +1,22 @@
 package com.festago.presentation;
 
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+import static org.mockito.ArgumentMatchers.anyLong;
+import static org.mockito.BDDMockito.given;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.festago.student.application.StudentService;
+import com.festago.student.dto.StudentResponse;
+import com.festago.student.dto.StudentSchoolResponse;
 import com.festago.student.dto.StudentSendMailRequest;
 import com.festago.student.dto.StudentVerificateRequest;
 import com.festago.support.CustomWebMvcTest;
 import com.festago.support.WithMockAuth;
+import java.nio.charset.StandardCharsets;
 import org.junit.jupiter.api.DisplayNameGeneration;
 import org.junit.jupiter.api.DisplayNameGenerator.ReplaceUnderscores;
 import org.junit.jupiter.api.Nested;
@@ -93,4 +101,42 @@ class 학생_인증 {
                 .andExpect(status().isOk());
         }
     }
+
+    @Nested
+    class 학생_인증_정보_조회 {
+
+        @Test
+        void 인증이_되지_않으면_401() throws Exception {
+            // given
+            StudentVerificateRequest request = new StudentVerificateRequest("123456");
+
+            // when & then
+            mockMvc.perform(get("/students")
+                    .contentType(MediaType.APPLICATION_JSON)
+                    .content(objectMapper.writeValueAsString(request)))
+                .andExpect(status().isUnauthorized());
+        }
+
+        @Test
+        @WithMockAuth
+        void 학생_인증_조회() throws Exception {
+            // given
+            StudentResponse expected = new StudentResponse(true, new StudentSchoolResponse(1L, "테코대학교", "teco.ac.kr"));
+            given(studentService.findVerification(anyLong()))
+                .willReturn(expected);
+
+            // when & then
+            String content = mockMvc.perform(get("/students")
+                    .contentType(MediaType.APPLICATION_JSON)
+                    .header(HttpHeaders.AUTHORIZATION, "Bearer token")
+                )
+                .andExpect(status().isOk())
+                .andDo(print())
+                .andReturn()
+                .getResponse()
+                .getContentAsString(StandardCharsets.UTF_8);
+            StudentResponse actual = objectMapper.readValue(content, StudentResponse.class);
+            assertThat(actual).isEqualTo(expected);
+        }
+    }
 }
diff --git a/backend/src/test/java/com/festago/student/application/StudentServiceTest.java b/backend/src/test/java/com/festago/student/application/StudentServiceTest.java
@@ -8,6 +8,7 @@
 import static com.festago.common.exception.ErrorCode.TOO_FREQUENT_REQUESTS;
 import static org.assertj.core.api.Assertions.assertThatNoException;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.assertj.core.api.SoftAssertions.assertSoftly;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyString;
@@ -20,8 +21,10 @@
 import com.festago.member.repository.MemberRepository;
 import com.festago.school.domain.School;
 import com.festago.school.repository.SchoolRepository;
+import com.festago.student.domain.Student;
 import com.festago.student.domain.StudentCode;
 import com.festago.student.domain.VerificationCode;
+import com.festago.student.dto.StudentResponse;
 import com.festago.student.dto.StudentSendMailRequest;
 import com.festago.student.dto.StudentVerificateRequest;
 import com.festago.student.infrastructure.MockMailClient;
@@ -32,6 +35,7 @@
 import com.festago.support.SchoolFixture;
 import com.festago.support.SetUpMockito;
 import com.festago.support.StudentCodeFixture;
+import com.festago.support.StudentFixture;
 import java.time.Clock;
 import java.time.LocalDateTime;
 import java.util.Optional;
@@ -186,7 +190,7 @@ class 학생_인증 {
                 .willReturn(true);
 
             // when & then
-            assertThatThrownBy(() -> studentService.verificate(memberId, request))
+            assertThatThrownBy(() -> studentService.verify(memberId, request))
                 .isInstanceOf(BadRequestException.class)
                 .hasMessage(ALREADY_STUDENT_VERIFIED.getMessage());
         }
@@ -202,7 +206,7 @@ class 학생_인증 {
                 .willReturn(Optional.empty());
 
             // when & then
-            assertThatThrownBy(() -> studentService.verificate(memberId, request))
+            assertThatThrownBy(() -> studentService.verify(memberId, request))
                 .isInstanceOf(BadRequestException.class)
                 .hasMessage(INVALID_STUDENT_VERIFICATION_CODE.getMessage());
         }
@@ -225,7 +229,47 @@ class 학생_인증 {
 
             // when & then
             assertThatNoException()
-                .isThrownBy(() -> studentService.verificate(memberId, request));
+                .isThrownBy(() -> studentService.verify(memberId, request));
+        }
+    }
+
+    @Nested
+    class 멤버_아이디로_인증정보_조회 {
+
+        @Test
+        void 학생_인증된_멤버의_경우() {
+            // given
+            Long memberId = 1L;
+            School school = SchoolFixture.school().id(2L).build();
+            Student student = StudentFixture.student().id(3L).school(school).build();
+            given(studentRepository.findByMemberIdWithFetch(memberId))
+                .willReturn(Optional.of(student));
+
+            // when
+            StudentResponse actual = studentService.findVerification(memberId);
+
+            // then
+            assertSoftly(softly -> {
+                softly.assertThat(actual.isVerified()).isTrue();
+                softly.assertThat(actual.school().id()).isEqualTo(school.getId());
+            });
+        }
+
+        @Test
+        void 학생_인증되지_않은_사용자의_경우() {
+            // given
+            Long memberId = 1L;
+            given(studentRepository.findByMemberIdWithFetch(memberId))
+                .willReturn(Optional.empty());
+
+            // when
+            StudentResponse actual = studentService.findVerification(memberId);
+
+            // then
+            assertSoftly(softly -> {
+                softly.assertThat(actual.isVerified()).isFalse();
+                softly.assertThat(actual.school()).isNull();
+            });
         }
     }
 }
diff --git a/backend/src/test/java/com/festago/student/repository/StudentRepositoryTest.java b/backend/src/test/java/com/festago/student/repository/StudentRepositoryTest.java
@@ -0,0 +1,50 @@
+package com.festago.student.repository;
+
+import static org.assertj.core.api.SoftAssertions.assertSoftly;
+
+import com.festago.member.domain.Member;
+import com.festago.member.repository.MemberRepository;
+import com.festago.school.domain.School;
+import com.festago.school.repository.SchoolRepository;
+import com.festago.student.domain.Student;
+import com.festago.support.MemberFixture;
+import com.festago.support.SchoolFixture;
+import com.festago.support.StudentFixture;
+import java.util.Optional;
+import org.junit.jupiter.api.DisplayNameGeneration;
+import org.junit.jupiter.api.DisplayNameGenerator.ReplaceUnderscores;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
+
+@DisplayNameGeneration(ReplaceUnderscores.class)
+@SuppressWarnings("NonAsciiCharacters")
+@DataJpaTest
+class StudentRepositoryTest {
+
+    @Autowired
+    StudentRepository studentRepository;
+
+    @Autowired
+    SchoolRepository schoolRepository;
+
+    @Autowired
+    MemberRepository memberRepository;
+
+    @Test
+    void 멤버id로_조회() {
+        // given
+        Member member = memberRepository.save(MemberFixture.member().build());
+        School school = schoolRepository.save(SchoolFixture.school().build());
+        Student student = studentRepository.save(StudentFixture.student().school(school).member(member).build());
+
+        // when
+        Optional<Student> actual = studentRepository.findByMemberIdWithFetch(member.getId());
+
+        // then
+        assertSoftly(softly -> {
+            softly.assertThat(actual).isNotEmpty();
+            softly.assertThat(actual.get().getId()).isEqualTo(student.getId());
+        });
+    }
+}
diff --git a/backend/src/test/java/com/festago/support/StudentFixture.java b/backend/src/test/java/com/festago/support/StudentFixture.java
@@ -0,0 +1,44 @@
+package com.festago.support;
+
+import com.festago.member.domain.Member;
+import com.festago.school.domain.School;
+import com.festago.student.domain.Student;
+
+public class StudentFixture {
+
+    private Long id;
+    private Member member = MemberFixture.member().build();
+    private School school = SchoolFixture.school().build();
+    private String username = "xxeol2";
+
+    private StudentFixture() {
+    }
+
+    public static StudentFixture student() {
+        return new StudentFixture();
+    }
+
+    public StudentFixture id(Long id) {
+        this.id = id;
+        return this;
+    }
+
+    public StudentFixture member(Member member) {
+        this.member = member;
+        return this;
+    }
+
+    public StudentFixture school(School school) {
+        this.school = school;
+        return this;
+    }
+
+    public StudentFixture username(String username) {
+        this.username = username;
+        return this;
+    }
+
+    public Student build() {
+        return new Student(id, member, school, username);
+    }
+}