[BE] issue227: 스터디원을 위한 링크공유 CRUD

backend/src/docs/asciidoc/index.adoc

@@ -45,6 +45,21 @@ operation::studies/details[snippets='http-request,http-response']
 === 참여한 스터디 목록 조회
 operation::studies/myStudy[snippets='http-request,http-response']
 
+[[Study-Room]]
+== 스터디룸
+
+=== 링크 공유글 생성
+operation::reference-room/create[snippets='http-request,request-headers,http-response']
+
+=== 링크 공유글 전체 조회
+operation::reference-room/list[snippets='http-request,request-headers,http-response']
+
+=== 링크 공유글 수정
+operation::reference-room/update[snippets='http-request,request-headers,http-response']
+
+=== 링크 공유글 삭제
+operation::reference-room/delete[snippets='http-request,request-headers,http-response']
+
 [[Tag]]
 == 태그
 

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

@@ -14,10 +14,14 @@ public class AuthRequestMatchConfig {
     @Bean
     public AuthenticationRequestMatcher authenticationRequestMatcher() {
         return new AuthenticationRequestMatcherBuilder()
-                .addUpAuthenticationPath(HttpMethod.POST, "/api/studies", "/api/studies/\\d+/reviews", "/api/studies/\\d+/reviews/\\d+")
-                .addUpAuthenticationPath(HttpMethod.GET, "/api/my/studies", "/api/members/me", "/api/members/me/role")
-                .addUpAuthenticationPath(HttpMethod.PUT, "/api/studies/\\d+/reviews/\\d+")
-                .addUpAuthenticationPath(HttpMethod.DELETE, "/api/studies/\\d+/reviews/\\d+")
+                .addUpAuthenticationPath(HttpMethod.POST, "/api/studies", "/api/studies/\\d+/reviews",
+                        "/api/studies/\\d+/reviews/\\d+", "/api/studies/\\d+/reference-room/links")
+                .addUpAuthenticationPath(HttpMethod.GET, "/api/my/studies", "/api/members/me", "/api/members/me/role",
+                        "/api/studies/\\d+/reference-room/links")
+                .addUpAuthenticationPath(HttpMethod.PUT, "/api/studies/\\d+/reviews/\\d+",
+                        "/api/studies/\\d+/reference-room/links/\\d+")
+                .addUpAuthenticationPath(HttpMethod.DELETE, "/api/studies/\\d+/reviews/\\d+",
+                        "/api/studies/\\d+/reference-room/links/\\d+")
                 .build();
     }
 }

backend/src/main/java/com/woowacourse/moamoa/common/entity/BaseEntity.java

@@ -1,6 +1,6 @@
 package com.woowacourse.moamoa.common.entity;
 
-import java.util.Date;
+import java.time.LocalDate;
 import javax.persistence.Column;
 import javax.persistence.EntityListeners;
 import javax.persistence.MappedSuperclass;
@@ -16,9 +16,9 @@ public class BaseEntity {
 
     @CreatedDate
     @Column(updatable = false, nullable = false)
-    private Date createdDate;
+    private LocalDate createdDate;
 
     @LastModifiedDate
     @Column(nullable = false)
-    private Date lastModifiedDate;
+    private LocalDate lastModifiedDate;
 }

backend/src/main/java/com/woowacourse/moamoa/member/service/exception/NotParticipatedMemberException.java

@@ -5,6 +5,6 @@
 public class NotParticipatedMemberException extends UnauthorizedException {
 
     public NotParticipatedMemberException() {
-        super("스터디에 참여한 회원만 후기를 작성할 수 있습니다.");
+        super("스터디에 참여한 회원만 작성할 수 있습니다.");
     }
 }

backend/src/main/java/com/woowacourse/moamoa/referenceroom/controller/ReferenceRoomController.java

@@ -0,0 +1,56 @@
+package com.woowacourse.moamoa.referenceroom.controller;
+
+import com.woowacourse.moamoa.auth.config.AuthenticationPrincipal;
+import com.woowacourse.moamoa.referenceroom.service.ReferenceRoomService;
+import com.woowacourse.moamoa.referenceroom.service.request.CreatingLinkRequest;
+import com.woowacourse.moamoa.referenceroom.service.request.EditingLinkRequest;
+import java.net.URI;
+import javax.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/studies/{study-id}/reference-room/links")
+@RequiredArgsConstructor
+public class ReferenceRoomController {
+
+    private final ReferenceRoomService referenceRoomService;
+
+    @PostMapping
+    public ResponseEntity<Void> createLink(
+            @AuthenticationPrincipal final Long githubId,
+            @PathVariable("study-id") final Long studyId,
+            @Valid @RequestBody final CreatingLinkRequest creatingLinkRequest
+    ) {
+        final Long id = referenceRoomService.createLink(githubId, studyId, creatingLinkRequest).getId();
+        return ResponseEntity.created(URI.create("/api/studies/" + studyId + "/reference-room/links/" + id)).build();
+    }
+
+    @PutMapping("/{link-id}")
+    public ResponseEntity<Void> updateLink(
+            @AuthenticationPrincipal final Long githubId,
+            @PathVariable("study-id") final Long studyId,
+            @PathVariable("link-id") final Long linkId,
+            @Valid @RequestBody final EditingLinkRequest editingLinkRequest
+    ) {
+        referenceRoomService.updateLink(githubId, studyId, linkId, editingLinkRequest);
+        return ResponseEntity.noContent().build();
+    }
+
+    @DeleteMapping("/{link-id}")
+    public ResponseEntity<Void> deleteLink(
+            @AuthenticationPrincipal final Long githubId,
+            @PathVariable("study-id") final Long studyId,
+            @PathVariable("link-id") final Long linkId
+    ) {
+        referenceRoomService.deleteLink(githubId, studyId, linkId);
+        return ResponseEntity.noContent().build();
+    }
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/controller/SearchingReferenceRoomController.java

@@ -0,0 +1,31 @@
+package com.woowacourse.moamoa.referenceroom.controller;
+
+import com.woowacourse.moamoa.auth.config.AuthenticationPrincipal;
+import com.woowacourse.moamoa.referenceroom.service.SearchingReferenceRoomService;
+import com.woowacourse.moamoa.referenceroom.service.response.LinksResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/studies/{study-id}/reference-room/links")
+@RequiredArgsConstructor
+public class SearchingReferenceRoomController {
+
+    private final SearchingReferenceRoomService searchingReferenceRoomService;
+
+    @GetMapping
+    public ResponseEntity<LinksResponse> getLinks(
+            @AuthenticationPrincipal final Long githubId,
+            @PathVariable("study-id") final Long studyId,
+            @PageableDefault(size = 5) final Pageable pageable
+    ) {
+        final LinksResponse linksResponse = searchingReferenceRoomService.getLinks(githubId, studyId, pageable);
+        return ResponseEntity.ok().body(linksResponse);
+    }
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/domain/Author.java

@@ -0,0 +1,18 @@
+package com.woowacourse.moamoa.referenceroom.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Embeddable;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
+@Embeddable
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+@EqualsAndHashCode
+public class Author {
+
+    @Column(name = "member_id", nullable = false)
+    private Long memberId;
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/domain/Link.java

@@ -0,0 +1,94 @@
+package com.woowacourse.moamoa.referenceroom.domain;
+
+import com.woowacourse.moamoa.common.entity.BaseEntity;
+import com.woowacourse.moamoa.referenceroom.service.exception.NotLinkAuthorException;
+import com.woowacourse.moamoa.referenceroom.service.exception.NotRelatedLinkException;
+import com.woowacourse.moamoa.review.domain.AssociatedStudy;
+import javax.persistence.Column;
+import javax.persistence.Embedded;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import org.hibernate.annotations.Where;
+
+@Entity
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+@Where(clause = "deleted = false")
+public class Link extends BaseEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Embedded
+    private AssociatedStudy associatedStudy;
+
+    @Embedded
+    private Author author;
+
+    @Column(nullable = false)
+    private String linkUrl;
+
+    private String description;
+
+    @Column(nullable = false)
+    private boolean deleted;
+
+    public Link(
+            final AssociatedStudy associatedStudy, final Author author, final String linkUrl, final String description
+    ) {
+        this(null, associatedStudy, author, linkUrl, description, false);
+    }
+
+    public void update(final Link updatedLink) {
+        validateBelongToStudy(updatedLink.associatedStudy);
+        validateAuthor(updatedLink.author);
+
+        linkUrl = updatedLink.linkUrl;
+        description = updatedLink.description;
+    }
+
+    public void delete(final AssociatedStudy associatedStudy, final Author author) {
+        validateBelongToStudy(associatedStudy);
+        validateAuthor(author);
+
+        deleted = true;
+    }
+
+    private void validateBelongToStudy(final AssociatedStudy associatedStudy) {
+        if (!this.associatedStudy.equals(associatedStudy)) {
+            throw new NotRelatedLinkException();
+        }
+    }
+
+    private void validateAuthor(final Author author) {
+        if (!this.author.equals(author)) {
+            throw new NotLinkAuthorException();
+        }
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public AssociatedStudy getAssociatedStudy() {
+        return associatedStudy;
+    }
+
+    public String getLinkUrl() {
+        return linkUrl;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public boolean isDeleted() {
+        return deleted;
+    }
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/domain/repository/JpaLinkRepository.java

@@ -0,0 +1,7 @@
+package com.woowacourse.moamoa.referenceroom.domain.repository;
+
+import com.woowacourse.moamoa.referenceroom.domain.Link;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface JpaLinkRepository extends JpaRepository<Link, Long>, LinkRepository {
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/domain/repository/LinkRepository.java

@@ -0,0 +1,11 @@
+package com.woowacourse.moamoa.referenceroom.domain.repository;
+
+import com.woowacourse.moamoa.referenceroom.domain.Link;
+import java.util.Optional;
+
+public interface LinkRepository {
+
+    Link save(Link link);
+
+    Optional<Link> findById(Long id);
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/query/LinkDao.java

@@ -0,0 +1,64 @@
+package com.woowacourse.moamoa.referenceroom.query;
+
+import com.woowacourse.moamoa.member.query.data.MemberData;
+import com.woowacourse.moamoa.referenceroom.query.data.LinkData;
+import java.time.LocalDate;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Slice;
+import org.springframework.data.domain.SliceImpl;
+import org.springframework.jdbc.core.RowMapper;
+import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
+import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
+import org.springframework.stereotype.Repository;
+
+@Repository
+@RequiredArgsConstructor
+public class LinkDao {
+
+    private final NamedParameterJdbcTemplate namedParameterJdbcTemplate;
+
+    public Slice<LinkData> findAllByStudyId(final Long studyId, final Pageable pageable) {
+        final String sql = "SELECT link.id, link.link_url, link.description, link.created_date, link.last_modified_date, "
+                + " member.github_id, member.username, member.image_url, member.profile_url "
+                + "FROM link "
+                + "JOIN member ON link.member_id = member.id "
+                + "WHERE link.deleted = false "
+                + "AND link.study_id = :studyId "
+                + "ORDER BY link.created_date DESC";
+        final MapSqlParameterSource params = new MapSqlParameterSource("studyId", studyId);
+
+        final List<LinkData> linkData = namedParameterJdbcTemplate.query(sql, params, rowMapper());
+        return new SliceImpl<>(getCurrentPageLinks(linkData, pageable), pageable, hasNext(linkData, pageable));
+    }
+
+    private List<LinkData> getCurrentPageLinks(final List<LinkData> linkData, final Pageable pageable) {
+        if (hasNext(linkData, pageable)) {
+            return linkData.subList(0, linkData.size() - 1);
+        }
+        return linkData;
+    }
+
+    private boolean hasNext(final List<LinkData> linkData, final Pageable pageable) {
+        return linkData.size() > pageable.getPageSize();
+    }
+
+    private RowMapper<LinkData> rowMapper() {
+        return (rs, rn) -> {
+            final Long id = rs.getLong("id");
+            final String linkUrl = rs.getString("link_url");
+            final String description = rs.getString("description");
+            final LocalDate createdDate = rs.getObject("created_date", LocalDate.class);
+            final LocalDate lastModifiedDate = rs.getObject("last_modified_date", LocalDate.class);
+
+            final Long githubId = rs.getLong("github_id");
+            final String username = rs.getString("username");
+            final String imageUrl = rs.getString("image_url");
+            final String profileUrl = rs.getString("profile_url");
+            final MemberData memberData = new MemberData(githubId, username, imageUrl, profileUrl);
+
+            return new LinkData(id, memberData, linkUrl, description, createdDate, lastModifiedDate);
+        };
+    }
+}

backend/src/main/java/com/woowacourse/moamoa/referenceroom/query/data/LinkData.java

@@ -0,0 +1,23 @@
+package com.woowacourse.moamoa.referenceroom.query.data;
+
+import com.woowacourse.moamoa.member.query.data.MemberData;
+import java.time.LocalDate;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+@Getter
+@EqualsAndHashCode
+public class LinkData {
+
+    private Long id;
+    private MemberData memberData;
+    private String linkUrl;
+    private String description;
+    private LocalDate createdDate;
+    private LocalDate lastModifiedDate;
+}