Merge pull request #207 from DevKor-github/feat/vote

Feat: 장소 투표 기능

Author: Yyang-YE

src/main/java/devkor/com/teamcback/domain/vote/controller/AdminVoteController.java

@@ -0,0 +1,39 @@
+package devkor.com.teamcback.domain.vote.controller;
+
+import devkor.com.teamcback.domain.vote.dto.response.ChangeVoteStatusRes;
+import devkor.com.teamcback.domain.vote.service.VoteService;
+import devkor.com.teamcback.global.response.CommonResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import lombok.RequiredArgsConstructor;
+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
+@RequiredArgsConstructor
+@RequestMapping("/api/admin/votes")
+public class AdminVoteController {
+    private final VoteService voteService;
+
+    /**
+     * 투표 상태 변경
+     */
+    @Operation(summary = "투표 상태 변경", description = "투표 상태 변경")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "정상 처리 되었습니다."),
+            @ApiResponse(responseCode = "404", description = "Not Found",
+                    content = @Content(schema = @Schema(implementation = CommonResponse.class))),
+    })
+    @GetMapping("/{voteId}")
+    public CommonResponse<ChangeVoteStatusRes> changeVoteStatus(
+            @Parameter(description = "투표 ID", example = "1")
+            @PathVariable(name = "voteId") Long voteId) {
+        return CommonResponse.success(voteService.changeVoteStatus(voteId));
+    }
+}

src/main/java/devkor/com/teamcback/domain/vote/controller/VoteController.java

@@ -0,0 +1,65 @@
+package devkor.com.teamcback.domain.vote.controller;
+
+import devkor.com.teamcback.domain.vote.dto.request.SaveVoteRecordReq;
+import devkor.com.teamcback.domain.vote.dto.response.GetVoteRes;
+import devkor.com.teamcback.domain.vote.dto.response.SaveVoteRecordRes;
+import devkor.com.teamcback.domain.vote.service.VoteService;
+import devkor.com.teamcback.global.response.CommonResponse;
+import devkor.com.teamcback.global.security.UserDetailsImpl;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import lombok.RequiredArgsConstructor;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/api/votes")
+public class VoteController {
+    private final VoteService voteService;
+
+    /**
+     * 장소별 투표 정보 조회
+     * @param placeId 장소 ID
+     */
+    @Operation(summary = "투표 정보 조회", description = "투표 정보 조회")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "정상 처리 되었습니다."),
+            @ApiResponse(responseCode = "404", description = "Not Found",
+                    content = @Content(schema = @Schema(implementation = CommonResponse.class))),
+    })
+    @GetMapping("/topics/{voteTopicId}/places/{placeId}")
+    public CommonResponse<GetVoteRes> getVoteByPlace(
+            @Parameter(description = "투표 주제 ID", example = "1")
+            @PathVariable(name = "voteTopicId") Long voteTopicId,
+            @Parameter(description = "장소 ID", example = "1")
+            @PathVariable(name = "placeId") Long placeId) {
+        return CommonResponse.success(voteService.getVoteByPlace(voteTopicId, placeId));
+    }
+
+    /**
+     * 투표 기록 저장
+     * @param userDetail 사용자 정보
+     */
+    @Operation(summary = "투표 저장", description = "투표 저장")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "정상 처리 되었습니다."),
+            @ApiResponse(responseCode = "404", description = "Not Found",
+                    content = @Content(schema = @Schema(implementation = CommonResponse.class))),
+    })
+    @PostMapping("")
+    public CommonResponse<SaveVoteRecordRes> saveVoteRecord(
+            @Parameter(description = "사용자정보")
+            @AuthenticationPrincipal UserDetailsImpl userDetail,
+            @Parameter(description = "투표 저장")
+            @RequestBody SaveVoteRecordReq req
+            ) {
+        Long userId = userDetail == null ? null : userDetail.getUser().getUserId();
+        return CommonResponse.success(voteService.saveVoteRecord(userId, req));
+    }
+
+}

src/main/java/devkor/com/teamcback/domain/vote/dto/request/SaveVoteRecordReq.java

@@ -0,0 +1,15 @@
+package devkor.com.teamcback.domain.vote.dto.request;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class SaveVoteRecordReq {
+    @Schema(description = "투표 id", example = "1")
+    private Long voteId;
+
+    @Schema(description = "투표 옵션 id", example = "1")
+    private Long voteOptionId;
+}

src/main/java/devkor/com/teamcback/domain/vote/dto/response/ChangeVoteStatusRes.java

@@ -0,0 +1,9 @@
+package devkor.com.teamcback.domain.vote.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "투표 종료 완료")
+@JsonIgnoreProperties
+public class ChangeVoteStatusRes {
+}

src/main/java/devkor/com/teamcback/domain/vote/dto/response/GetVoteOptionRes.java

@@ -0,0 +1,26 @@
+package devkor.com.teamcback.domain.vote.dto.response;
+
+import com.querydsl.core.annotations.QueryProjection;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Getter;
+
+@Schema(description = "투표 항목 조회 결과")
+@Getter
+public class GetVoteOptionRes {
+
+    @Schema(description = "투표 항목 ID", example = "1")
+    private Long voteOptionId;
+
+    @Schema(description = "투표 항목", example = "있다")
+    private String optionText;
+
+    @Schema(description = "투표수", example = "5")
+    private int voteCount;
+
+    @QueryProjection
+    public GetVoteOptionRes(Long voteOptionId, String optionText, int voteCount) {
+        this.voteOptionId = voteOptionId;
+        this.optionText = optionText;
+        this.voteCount = voteCount;
+    }
+}

src/main/java/devkor/com/teamcback/domain/vote/dto/response/GetVoteRes.java

@@ -0,0 +1,42 @@
+package devkor.com.teamcback.domain.vote.dto.response;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Getter;
+
+import java.util.List;
+
+@Schema(description = "투표 목록 조회 결과")
+@Getter
+public class GetVoteRes {
+
+    @Schema(description = "투표 ID", example = "1")
+    private Long voteId;
+
+    @Schema(description = "투표 상태", example = "종료")
+    private String status;
+
+    @Schema(description = "투표 주제 ID", example = "1")
+    private Long voteTopicId;
+
+    @Schema(description = "투표 주제", example = "콘센트 유무")
+    private String topic;
+
+    @Schema(description = "장소 ID", example = "1")
+    private Long placeId;
+
+    @Schema(description = "장소명", example = "101호")
+    private String placeName;
+
+    @Schema(description = "투표 항목 리스트")
+    private List<GetVoteOptionRes> optionList;
+
+    public GetVoteRes(Long voteId, String status, Long voteTopicId, String topic, Long placeId, String placeName, List<GetVoteOptionRes> optionList) {
+        this.voteId = voteId;
+        this.voteTopicId = voteTopicId;
+        this.topic = topic;
+        this.status = status;
+        this.placeId = placeId;
+        this.placeName = placeName;
+        this.optionList = optionList;
+    }
+}

src/main/java/devkor/com/teamcback/domain/vote/dto/response/SaveVoteRecordRes.java

@@ -0,0 +1,9 @@
+package devkor.com.teamcback.domain.vote.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "투표 내용 저장 완료")
+@JsonIgnoreProperties
+public class SaveVoteRecordRes {
+}

src/main/java/devkor/com/teamcback/domain/vote/entity/Vote.java

@@ -0,0 +1,42 @@
+package devkor.com.teamcback.domain.vote.entity;
+
+import devkor.com.teamcback.domain.common.entity.BaseEntity;
+import devkor.com.teamcback.global.exception.exception.GlobalException;
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import static devkor.com.teamcback.domain.vote.entity.VoteStatus.CLOSED;
+import static devkor.com.teamcback.domain.vote.entity.VoteStatus.OPEN;
+import static devkor.com.teamcback.global.response.ResultCode.CLOSED_VOTE;
+
+@Entity
+@Getter
+@Setter
+@Table(name = "tb_vote")
+@NoArgsConstructor
+public class Vote extends BaseEntity {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private Long voteTopicId;
+
+    @Column
+    private Long placeId;
+
+    @Column
+    @Enumerated(EnumType.STRING)
+    private VoteStatus status;
+
+    public void checkStatus() {
+        if(this.status == CLOSED) throw new GlobalException(CLOSED_VOTE);
+    }
+
+    public void changeStatus() {
+        if(this.status == CLOSED) this.status = OPEN;
+        else this.status = CLOSED;
+    }
+}

src/main/java/devkor/com/teamcback/domain/vote/entity/VoteOption.java

@@ -0,0 +1,26 @@
+package devkor.com.teamcback.domain.vote.entity;
+
+import devkor.com.teamcback.domain.common.entity.BaseEntity;
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Entity
+@Getter
+@Setter
+@Table(name = "tb_vote_option")
+@NoArgsConstructor
+public class VoteOption extends BaseEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private Long voteTopicId;
+
+    @Column(nullable = false)
+    private String optionText;
+
+}

src/main/java/devkor/com/teamcback/domain/vote/entity/VoteRecord.java

@@ -0,0 +1,33 @@
+package devkor.com.teamcback.domain.vote.entity;
+
+import devkor.com.teamcback.domain.common.entity.BaseEntity;
+import jakarta.persistence.*;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+@Entity
+@Getter
+@Setter
+@Table(name = "tb_vote_record")
+@NoArgsConstructor
+public class VoteRecord extends BaseEntity {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private Long userId;
+
+    @Column(nullable = false)
+    private Long voteId;
+
+    @Column
+    private Long voteOptionId;
+
+    public VoteRecord(Long userId, Long voteId, Long voteOptionId) {
+        this.userId = userId;
+        this.voteId = voteId;
+        this.voteOptionId = voteOptionId;
+    }
+}