[BE] issue187: 특정 스터디에서 나의 role을 확인하는 API 생성

backend/src/docs/asciidoc/index.adoc

@@ -16,10 +16,7 @@ operation::auth/login[snippets='http-request,http-response']
 == 회원
 
 === 스터디에서 나의 Role 확인
-//operation::studies/summary[snippets='http-request,http-response']
-
-=== 로그인한 사용자 정보 조회
-//operation::studies/summary[snippets='http-request,http-response']
+operation::members/me/role[snippets='http-request,request-headers,request-parameters,http-response,response-fields']
 
 [[Study]]
 == 스터디

backend/src/main/java/com/woowacourse/moamoa/auth/config/AuthRequestMatchConfig.java

@@ -15,7 +15,7 @@ public class AuthRequestMatchConfig {
     public AuthenticationRequestMatcher authenticationRequestMatcher() {
         return new AuthenticationRequestMatcherBuilder()
                 .addUpAuthenticationPath(HttpMethod.POST, "/api/studies", "/api/studies/\\d+/reviews")
-                .addUpAuthenticationPath(HttpMethod.GET, "/api/my/studies")
+                .addUpAuthenticationPath(HttpMethod.GET, "/api/my/studies", "/api/members/me/role")
                 .build();
     }
 }

backend/src/main/java/com/woowacourse/moamoa/auth/controller/AuthenticationInterceptor.java

@@ -24,6 +24,7 @@ public class AuthenticationInterceptor implements HandlerInterceptor {
     @Override
     public boolean preHandle(final HttpServletRequest request, final HttpServletResponse response,
                              final Object handler) {
+
         if (isPreflight(request)) {
             return true;
         }

backend/src/main/java/com/woowacourse/moamoa/study/controller/MyStudyController.java

@@ -2,10 +2,12 @@
 
 import com.woowacourse.moamoa.auth.config.AuthenticationPrincipal;
 import com.woowacourse.moamoa.study.service.MyStudyService;
+import com.woowacourse.moamoa.study.service.response.MyRoleResponse;
 import com.woowacourse.moamoa.study.service.response.MyStudiesResponse;
 
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import lombok.RequiredArgsConstructor;
@@ -17,8 +19,15 @@ public class MyStudyController {
     private final MyStudyService myStudyService;
 
     @GetMapping("/api/my/studies")
-    public ResponseEntity<MyStudiesResponse> getMyStudies(@AuthenticationPrincipal Long githubId) {
+    public ResponseEntity<MyStudiesResponse> getMyStudies(@AuthenticationPrincipal final Long githubId) {
         final MyStudiesResponse myStudiesResponse = myStudyService.getStudies(githubId);
         return ResponseEntity.ok().body(myStudiesResponse);
     }
+
+    @GetMapping("/api/members/me/role")
+    public ResponseEntity<MyRoleResponse> getMyRoleInStudy(
+            @AuthenticationPrincipal final Long githubId, @RequestParam(name = "study-id") final Long studyId
+    ) {
+        return ResponseEntity.ok().body(myStudyService.findMyRoleInStudy(githubId, studyId));
+    }
 }

backend/src/main/java/com/woowacourse/moamoa/study/domain/MemberRole.java

@@ -0,0 +1,6 @@
+package com.woowacourse.moamoa.study.domain;
+
+public enum MemberRole {
+
+    MEMBER, NON_MEMBER, OWNER
+}

backend/src/main/java/com/woowacourse/moamoa/study/domain/Participants.java

@@ -12,12 +12,14 @@
 import javax.persistence.ElementCollection;
 import javax.persistence.Embeddable;
 import javax.persistence.JoinColumn;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
 
 @Embeddable
-@ToString
 @NoArgsConstructor(access = PROTECTED)
+@Getter
+@ToString
 public class Participants {
 
     @Column(name = "current_member_count")
@@ -51,6 +53,10 @@ boolean isAlreadyParticipated(Long memberId) {
         return participants.contains(new Participant(memberId)) || ownerId.equals(memberId);
     }
 
+    public boolean isParticipate(Long memberId) {
+        return participants.contains(new Participant(memberId));
+    }
+
     int getSize() {
         return size;
     }

backend/src/main/java/com/woowacourse/moamoa/study/domain/Study.java

@@ -5,8 +5,10 @@
 
 import com.woowacourse.moamoa.study.domain.exception.InvalidPeriodException;
 import com.woowacourse.moamoa.study.service.exception.FailureParticipationException;
+import com.woowacourse.moamoa.study.service.response.MyRoleResponse;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
+import java.util.Objects;
 import javax.persistence.Column;
 import javax.persistence.Embedded;
 import javax.persistence.Entity;
@@ -115,4 +117,14 @@ public boolean isCloseStudy() {
     private boolean isFullOfCapacity() {
         return recruitPlanner.hasCapacity() && recruitPlanner.getCapacity() == participants.getSize();
     }
+
+    public MemberRole getRole(final Long memberId) {
+        if (Objects.equals(participants.getOwnerId(), memberId)) {
+            return MemberRole.OWNER;
+        }
+        if (participants.isParticipate(memberId)) {
+            return MemberRole.MEMBER;
+        }
+        return MemberRole.NON_MEMBER;
+    }
 }

backend/src/main/java/com/woowacourse/moamoa/study/service/MyStudyService.java

@@ -2,8 +2,12 @@
 
 import com.woowacourse.moamoa.member.domain.Member;
 import com.woowacourse.moamoa.member.domain.repository.MemberRepository;
-import com.woowacourse.moamoa.member.service.exception.MemberNotFoundException;
+import com.woowacourse.moamoa.study.domain.Study;
+import com.woowacourse.moamoa.study.domain.repository.StudyRepository;
 import com.woowacourse.moamoa.study.query.MyStudyDao;
+import com.woowacourse.moamoa.study.service.exception.StudyNotFoundException;
+import com.woowacourse.moamoa.study.service.response.MyRoleResponse;
+import com.woowacourse.moamoa.member.service.exception.MemberNotFoundException;
 import com.woowacourse.moamoa.study.query.data.StudyOwnerAndTagsData;
 import com.woowacourse.moamoa.study.service.response.MyStudyResponse;
 import com.woowacourse.moamoa.study.query.data.MyStudySummaryData;
@@ -27,6 +31,8 @@ public class MyStudyService {
 
     private final MemberRepository memberRepository;
 
+    private final StudyRepository studyRepository;
+
     public MyStudiesResponse getStudies(final Long githubId) {
         final Member member = memberRepository.findByGithubId(githubId)
                 .orElseThrow(MemberNotFoundException::new);
@@ -51,4 +57,13 @@ private List<MyStudyResponse> mapToResponse(final List<MyStudySummaryData> myStu
                 ))
                 .collect(Collectors.toList());
     }
+
+    public MyRoleResponse findMyRoleInStudy(final Long githubId, final Long studyId) {
+        final Member member = memberRepository.findByGithubId(githubId)
+                .orElseThrow(MemberNotFoundException::new);
+        final Study study = studyRepository.findById(studyId)
+                .orElseThrow(StudyNotFoundException::new);
+
+        return new MyRoleResponse(study.getRole(member.getId()));
+    }
 }

backend/src/main/java/com/woowacourse/moamoa/study/service/response/MyRoleResponse.java

@@ -0,0 +1,14 @@
+package com.woowacourse.moamoa.study.service.response;
+
+import com.woowacourse.moamoa.study.domain.MemberRole;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Getter
+public class MyRoleResponse {
+
+    private MemberRole role;
+}

backend/src/test/java/com/woowacourse/acceptance/study/GettingMyStudiesAcceptanceTest.java

@@ -2,6 +2,9 @@
 
 import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.Matchers.is;
+import static org.springframework.http.HttpHeaders.AUTHORIZATION;
+import static org.springframework.http.HttpHeaders.CONTENT_TYPE;
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
 import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document;
 
 import com.woowacourse.acceptance.AcceptanceTest;
@@ -105,4 +108,21 @@ void getMyStudies() {
                 .body("studies[0].tags.id", contains(2, 4, 5))
                 .body("studies[0].tags.name", contains("4기", "FE", "React"));
     }
+
+    @Test
+    @DisplayName("특정 스터디에서 나의 Role을 확인한다.")
+    void isMyStudy() {
+        final String token = getBearerTokenBySignInOrUp(new GithubProfileResponse(4L, "verus", "https://image", "github.com"));
+
+        RestAssured.given(spec).log().all()
+                .filter(document("members/me/role"))
+                .header(CONTENT_TYPE, APPLICATION_JSON_VALUE)
+                .header(AUTHORIZATION, token)
+                .queryParam("study-id", 7)
+                .when()
+                .get("/api/members/me/role")
+                .then().log().all()
+                .statusCode(HttpStatus.OK.value())
+                .body("role", is("OWNER"));
+    }
 }

backend/src/test/java/com/woowacourse/moamoa/study/controller/MyStudyControllerTest.java

@@ -7,6 +7,7 @@
 import com.woowacourse.moamoa.common.RepositoryTest;
 import com.woowacourse.moamoa.member.domain.repository.MemberRepository;
 import com.woowacourse.moamoa.member.query.data.MemberData;
+import com.woowacourse.moamoa.study.domain.repository.StudyRepository;
 import com.woowacourse.moamoa.study.query.MyStudyDao;
 import com.woowacourse.moamoa.study.service.response.MyStudyResponse;
 import com.woowacourse.moamoa.study.service.MyStudyService;
@@ -34,14 +35,17 @@ class MyStudyControllerTest {
     @Autowired
     private MemberRepository memberRepository;
 
+    @Autowired
+    private StudyRepository studyRepository;
+
     @Autowired
     private JdbcTemplate jdbcTemplate;
 
     private MyStudyController myStudyController;
 
     @BeforeEach
     void setUp() {
-        myStudyController = new MyStudyController(new MyStudyService(myStudyDao, memberRepository));
+        myStudyController = new MyStudyController(new MyStudyService(myStudyDao, memberRepository, studyRepository));
 
         jdbcTemplate.update("INSERT INTO member(id, github_id, username, image_url, profile_url) VALUES (1, 1, 'jjanggu', 'https://image', 'github.com')");
         jdbcTemplate.update("INSERT INTO member(id, github_id, username, image_url, profile_url) VALUES (2, 2, 'greenlawn', 'https://image', 'github.com')");

backend/src/test/java/com/woowacourse/moamoa/study/domain/StudyTest.java

@@ -5,21 +5,26 @@
 import static com.woowacourse.moamoa.study.domain.StudyStatus.DONE;
 import static com.woowacourse.moamoa.study.domain.StudyStatus.IN_PROGRESS;
 import static com.woowacourse.moamoa.study.domain.StudyStatus.PREPARE;
-import static java.time.LocalDateTime.now;
+
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatCode;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
+import static java.time.LocalDateTime.now;
+
 import com.woowacourse.moamoa.study.domain.exception.InvalidPeriodException;
 import com.woowacourse.moamoa.study.service.exception.FailureParticipationException;
+
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.Set;
 import java.util.stream.Stream;
+
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.CsvSource;
 import org.junit.jupiter.params.provider.MethodSource;
 
 public class StudyTest {
@@ -257,6 +262,21 @@ void writeReviewByNotParticipant() {
         assertThat(sut.isWritableReviews(2L)).isFalse();
     }
 
+    @DisplayName("스터디에서 나의 역할을 조회한다.")
+    @ParameterizedTest
+    @CsvSource(value = {"2,MEMBER", "3,NON_MEMBER", "1,OWNER"})
+    void getMyRoleInStudy(Long memberId, MemberRole role) {
+        final Content content = new Content("title", "excerpt", "thumbnail", "description");
+        final Participants participants = Participants.createBy(1L);
+        final RecruitPlanner recruitPlanner = new RecruitPlanner(10, RecruitStatus.RECRUITMENT_START, LocalDate.now());
+        final StudyPlanner studyPlanner = new StudyPlanner(LocalDate.now(), LocalDate.now(), IN_PROGRESS);
+        final Study sut = new Study(content, participants, recruitPlanner, studyPlanner, AttachedTags.empty(), now());
+
+        sut.participate(2L);
+
+        assertThat(sut.getRole(memberId)).isEqualTo(role);
+    }
+
     @DisplayName("스터디 종료기간이 넘으면 자동으로 종료 상태가 된다.")
     @Test
     public void autoCloseStudyStatus() {

backend/src/test/java/com/woowacourse/moamoa/study/service/MyStudyServiceTest.java

@@ -9,9 +9,11 @@
 import java.util.List;
 import java.time.LocalDateTime;
 
+import com.woowacourse.moamoa.study.service.exception.StudyNotFoundException;
 import com.woowacourse.moamoa.common.RepositoryTest;
 import com.woowacourse.moamoa.member.domain.repository.MemberRepository;
 import com.woowacourse.moamoa.member.query.data.MemberData;
+import com.woowacourse.moamoa.study.domain.repository.StudyRepository;
 import com.woowacourse.moamoa.member.service.exception.MemberNotFoundException;
 import com.woowacourse.moamoa.study.query.MyStudyDao;
 import com.woowacourse.moamoa.study.service.response.MyStudiesResponse;
@@ -21,6 +23,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.jdbc.core.JdbcTemplate;
 
@@ -36,11 +39,14 @@ class MyStudyServiceTest {
     @Autowired
     private MemberRepository memberRepository;
 
+    @Autowired
+    private StudyRepository studyRepository;
+
     private MyStudyService myStudyService;
 
     @BeforeEach
     void setUp() {
-        myStudyService = new MyStudyService(myStudyDao, memberRepository);
+        myStudyService = new MyStudyService(myStudyDao, memberRepository, studyRepository);
 
         jdbcTemplate.update("INSERT INTO member(id, github_id, username, image_url, profile_url) VALUES (1, 1, 'jjanggu', 'https://image', 'github.com')");
         jdbcTemplate.update("INSERT INTO member(id, github_id, username, image_url, profile_url) VALUES (2, 2, 'greenlawn', 'https://image', 'github.com')");
@@ -151,4 +157,20 @@ void getMyStudyNotExistUser() {
                 .isInstanceOf(MemberNotFoundException.class)
                 .hasMessageContaining("회원을 찾을 수 없습니다.");
     }
+
+    @DisplayName("사용자 역할 조회하는 기능에서 존재하지 않는 사용자 조회 시 예외 발생")
+    @Test
+    void getMemberRoleNotExistUser() {
+        assertThatThrownBy(() -> myStudyService.findMyRoleInStudy(5L, 1L))
+                .isInstanceOf(MemberNotFoundException.class)
+                .hasMessageContaining("회원을 찾을 수 없습니다.");
+    }
+
+    @DisplayName("사용자 역할 조회하는 기능에서 존재하지 않는 스터디 조회 시 예외 발생")
+    @Test
+    void getMemberRoleNotExistStudy() {
+        assertThatThrownBy(() -> myStudyService.findMyRoleInStudy(1L, 10L))
+                .isInstanceOf(StudyNotFoundException.class)
+                .hasMessageContaining("스터디가 존재하지 않습니다.");
+    }
 }