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

backend/src/docs/asciidoc/index.adoc

@@ -33,3 +33,8 @@ operation::reviews/list[snippets='http-request,http-response']
 
 === 리뷰 특정 개수 조회
 operation::reviews/list-certain-number[snippets='http-request,http-response']
+
+[[My-Role]]
+
+=== 스터디에서 사용자 역할 조회
+operation::members/me/role[snippets='http-request,request-headers,request-parameters,http-response,response-fields']

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/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;
@@ -21,4 +23,11 @@ public ResponseEntity<MyStudiesResponse> getMyStudies(@AuthenticationPrincipal L
         final MyStudiesResponse myStudiesResponse = myStudyService.getStudies(githubId);
         return ResponseEntity.ok().body(myStudiesResponse);
     }
+
+    @GetMapping("/api/members/me/role")
+    public ResponseEntity<MyRoleResponse> getMyRoleInStudy(
+            @AuthenticationPrincipal Long githubId, @RequestParam(name = "study-id") Long studyId
+    ) {
+        return ResponseEntity.ok().body(myStudyService.findMyRoleInStudy(githubId, studyId));
+    }
 }

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

@@ -0,0 +1,6 @@
+package com.woowacourse.moamoa.study.domain;
+
+public enum MyRole {
+
+    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/service/MyStudyService.java

@@ -2,15 +2,22 @@
 
 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.MyRole;
+import com.woowacourse.moamoa.study.domain.Participants;
+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;
 import com.woowacourse.moamoa.study.service.response.MyStudiesResponse;
 
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 import org.springframework.stereotype.Service;
@@ -27,6 +34,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 +60,24 @@ 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);
+
+        final Participants participants = study.getParticipants();
+        return getMyRoleResponse(member, participants);
+    }
+
+    private MyRoleResponse getMyRoleResponse(final Member member, final Participants participants) {
+        if (Objects.equals(participants.getOwnerId(), member.getId())) {
+            return new MyRoleResponse(MyRole.OWNER);
+        }
+        if (participants.isParticipate(member.getId())) {
+            return new MyRoleResponse(MyRole.MEMBER);
+        }
+        return new MyRoleResponse(MyRole.NON_MEMBER);
+    }
 }

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.MyRole;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Getter
+public class MyRoleResponse {
+
+    private MyRole role;
+}

backend/src/main/resources/static/docs/index.html

@@ -461,6 +461,7 @@ <h1>MOAMOA</h1>
 <li><a href="#_리뷰_작성">리뷰 작성</a></li>
 <li><a href="#_리뷰_전체_조회">리뷰 전체 조회</a></li>
 <li><a href="#_리뷰_특정_개수_조회">리뷰 특정 개수 조회</a></li>
+<li><a href="#My-Role">스터디에서 사용자 역할 조회</a></li>
 </ul>
 </li>
 </ul>
@@ -492,7 +493,7 @@ <h4 id="_github_로그인_http_response"><a class="link" href="#_github_로그
 Vary: Access-Control-Request-Method
 Vary: Access-Control-Request-Headers
 Content-Type: application/json
-Content-Length: 30
+Content-Length: 28
 
 {
   "token" : "JWT 토큰"
@@ -514,9 +515,9 @@ <h4 id="_스터디_생성_http_request"><a class="link" href="#_스터디_생성
 <div class="content">
 <pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">POST /api/studies HTTP/1.1
 Content-Type: application/json
-Authorization: Bearer aaaaa.bbbbb.ccccc
+Authorization: Bearer header.payload.signature
 Accept: application/json
-Content-Length: 348
+Content-Length: 338
 Host: localhost:8080
 
 {
@@ -568,7 +569,7 @@ <h4 id="_스터디_목록_조회_http_response"><a class="link" href="#_스터
 Vary: Access-Control-Request-Method
 Vary: Access-Control-Request-Headers
 Content-Type: application/json
-Content-Length: 808
+Content-Length: 773
 
 {
   "studies" : [ {
@@ -623,9 +624,9 @@ <h4 id="_리뷰_작성_http_request"><a class="link" href="#_리뷰_작성_http_
 <div class="content">
 <pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">POST /api/studies/1/reviews HTTP/1.1
 Content-Type: application/json
-Authorization: Bearer aaaaa.bbbbb.ccccc
+Authorization: Bearer header.payload.signature
 Accept: application/json
-Content-Length: 55
+Content-Length: 53
 Host: localhost:8080
 
 {
@@ -669,7 +670,7 @@ <h4 id="_리뷰_전체_조회_http_response"><a class="link" href="#_리뷰_전
 Vary: Access-Control-Request-Method
 Vary: Access-Control-Request-Headers
 Content-Type: application/json
-Content-Length: 1326
+Content-Length: 1279
 
 {
   "reviews" : [ {
@@ -745,7 +746,7 @@ <h4 id="_리뷰_특정_개수_조회_http_response"><a class="link" href="#_리
 Vary: Access-Control-Request-Method
 Vary: Access-Control-Request-Headers
 Content-Type: application/json
-Content-Length: 683
+Content-Length: 658
 
 {
   "reviews" : [ {
@@ -777,13 +778,39 @@ <h4 id="_리뷰_특정_개수_조회_http_response"><a class="link" href="#_리
 </div>
 </div>
 </div>
+<div class="sect2">
+<h3 id="My-Role"><a class="link" href="#My-Role">스터디에서 사용자 역할 조회</a></h3>
+<div class="sect3">
+<h4 id="My-Role_http_request"><a class="link" href="#My-Role_http_request">HTTP request</a></h4>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/members/me/role?study-id=3 HTTP/1.1
+Content-Type: application/json
+Authorization: Bearer header.payload.signature
+Accept: application/json
+Host: localhost:8080</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="My-Role_http_response"><a class="link" href="#My-Role_http_response">HTTP response</a></h4>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">HTTP/1.1 200 OK
+Vary: Origin
+Vary: Access-Control-Request-Method
+Vary: Access-Control-Request-Headers</code></pre>
+</div>
+</div>
+</div>
+</div>
 </div>
 </div>
 </div>
 <div id="footer">
 <div id="footer-text">
 Version 0.0.1-SNAPSHOT<br>
-Last updated 2022-08-03 14:36:51 +0900
+Last updated 2022-08-03 21:57:59 +0900
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

backend/src/test/java/com/woowacourse/acceptance/auth/AuthAcceptanceTest.java

@@ -10,7 +10,6 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.http.HttpStatus;
-import org.springframework.test.context.jdbc.Sql;
 
 public class AuthAcceptanceTest extends AcceptanceTest {
 

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 com.woowacourse.acceptance.AcceptanceTest;
 import com.woowacourse.moamoa.auth.service.oauthclient.response.GithubProfileResponse;
@@ -103,4 +106,20 @@ 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().log().all()
+                .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/docs/DocumentationTest.java

@@ -15,8 +15,10 @@
 import com.woowacourse.moamoa.review.controller.SearchingReviewController;
 import com.woowacourse.moamoa.review.service.ReviewService;
 import com.woowacourse.moamoa.review.service.SearchingReviewService;
+import com.woowacourse.moamoa.study.controller.MyStudyController;
 import com.woowacourse.moamoa.study.controller.SearchingStudyController;
 import com.woowacourse.moamoa.study.controller.StudyController;
+import com.woowacourse.moamoa.study.service.MyStudyService;
 import com.woowacourse.moamoa.study.service.SearchingStudyService;
 import com.woowacourse.moamoa.study.service.StudyService;
 import org.junit.jupiter.api.BeforeEach;
@@ -36,7 +38,8 @@
         StudyController.class,
         SearchingStudyController.class,
         ReviewController.class,
-        SearchingReviewController.class
+        SearchingReviewController.class,
+        MyStudyController.class
 })
 @ExtendWith(RestDocumentationExtension.class)
 @Import(JwtTokenProvider.class)
@@ -75,6 +78,9 @@ public class DocumentationTest {
     @MockBean
     protected SearchingReviewService searchingReviewService;
 
+    @MockBean
+    protected MyStudyService myStudyService;
+
     @BeforeEach
     void setUp(WebApplicationContext webApplicationContext, RestDocumentationContextProvider restDocumentation) {
         mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext)

backend/src/test/java/com/woowacourse/moamoa/docs/MyStudyDocumentationTest.java

@@ -0,0 +1,49 @@
+package com.woowacourse.moamoa.docs;
+
+import static com.woowacourse.fixtures.AuthFixtures.JWT_토큰;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyLong;
+import static org.mockito.BDDMockito.given;
+import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
+import static org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.requestParameters;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import com.woowacourse.moamoa.auth.service.response.TokenResponse;
+import com.woowacourse.moamoa.study.domain.MyRole;
+import com.woowacourse.moamoa.study.service.response.MyRoleResponse;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.restdocs.payload.JsonFieldType;
+
+public class MyStudyDocumentationTest extends DocumentationTest {
+
+    @DisplayName("스터디에서 사용자의 역할을 조회한다.")
+    @Test
+    void getMyRoleInStudy() throws Exception {
+        given(myStudyService.findMyRoleInStudy(any(), any())).willReturn(new MyRoleResponse(MyRole.MEMBER));
+
+        mockMvc.perform(get("/api/members/me/role")
+                        .header(HttpHeaders.AUTHORIZATION, "Bearer " + JWT_토큰)
+                        .queryParam("study-id", "3")
+                        .contentType(MediaType.APPLICATION_JSON_VALUE)
+                        .accept(MediaType.APPLICATION_JSON))
+                .andDo(document("members/me/role",
+                        requestHeaders(
+                                headerWithName("Authorization").description(
+                                        "Bearer Token")),
+                        requestParameters(parameterWithName("study-id").description("스터디 ID")),
+                        responseFields(fieldWithPath("role").type(JsonFieldType.STRING).description("해당 스터디에서 사용자의 역할"))))
+                .andDo(print())
+                .andExpect(status().isOk());
+    }
+}