Dev backend

backend/core/build.gradle

@@ -45,8 +45,12 @@ dependencies {
 	annotationProcessor 'org.projectlombok:lombok'
 	annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.5.Final'
 
+	testAnnotationProcessor "org.mapstruct:mapstruct-processor:1.5.5.Final"
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
 	testImplementation 'org.springframework.security:spring-security-test'
+	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+	testCompileOnly 'org.projectlombok:lombok'
+	testAnnotationProcessor 'org.projectlombok:lombok'
 }
 
 tasks.named('bootBuildImage') {

backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateApi.java

@@ -4,10 +4,12 @@
 import com.rollthedice.backend.domain.debate.dto.request.DebateRoomRequest;
 import com.rollthedice.backend.domain.debate.dto.response.DebateMessageResponse;
 import com.rollthedice.backend.domain.debate.dto.response.DebateRoomResponse;
+import com.rollthedice.backend.domain.debate.dto.response.DebateSummaryResponse;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import org.springframework.data.domain.Pageable;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -21,7 +23,7 @@ public interface DebateApi {
             summary = "토론방 생성",
             description = "주제가 선택된 토론방을 생성합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_room"}
+            tags = {"토론방"}
     )
     @ApiResponse(
             responseCode = "201",
@@ -33,23 +35,23 @@ public interface DebateApi {
             summary = "토론방 전체 조회",
             description = "회원의 토론방을 페이지로 나누어 조회합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_room"}
+            tags = {"토론방"}
     )
     @ApiResponse(
             responseCode = "200",
-            description = "OK"
+            description = "요청에 성공하였습니다."
     )
     List<DebateRoomResponse> getDebateRooms(Pageable pageable);
 
     @Operation(
             summary = "토론방 삭제",
             description = "토론방을 삭제합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_room"}
+            tags = {"토론방"}
     )
     @ApiResponse(
             responseCode = "204",
-            description = "No Content"
+            description = "토론방 삭제에 성공하였으며, 응답값은 없습니다."
     )
     void deleteDebateRoom(@Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
                           Long roomId
@@ -59,7 +61,7 @@ void deleteDebateRoom(@Parameter(in = ParameterIn.PATH, description = "토론방
             summary = "[인간] 토론 메세지 저장",
             description = "사용자가 보낸 토론 메세지를 저장합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_message"}
+            tags = {"토론 메세지"}
     )
     @ApiResponse(
             responseCode = "201",
@@ -76,7 +78,7 @@ void saveHumanDebateMessage(
             summary = "[AI] 토론 메세지 저장",
             description = "ChatGPT OPENAI가 보낸 토론 메세지를 저장합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_message"}
+            tags = {"토론 메세지"}
     )
     @ApiResponse(
             responseCode = "201",
@@ -89,21 +91,82 @@ void saveAIDebateMessage(
             @RequestBody DebateMessageRequest request
     );
 
+    @Operation(
+            summary = "토론 종료",
+            description = "토론을 종료합니다.",
+            security = {@SecurityRequirement(name = "access_token")},
+            tags = {"토론방"}
+    )
+    @ApiResponses(value = {
+            @ApiResponse(
+                    responseCode = "204",
+                    description = "요청에 성공하였으며 응답값은 없습니다."
+            ),
+            @ApiResponse(
+                    responseCode = "404",
+                    description = "토론방을 찾지 못했습니다."
+            )
+    })
+    void finishDebate(
+            @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
+            Long roomId
+    );
+
     @Operation(
             summary = "토론 메세지 조회",
             description = "토론방의 토론 메세지 이력을 조회합니다.",
             security = {@SecurityRequirement(name = "access_token")},
-            tags = {"debate_message"}
+            tags = {"토론 메세지"}
     )
     @ApiResponse(
             responseCode = "200",
-            description = "OK"
+            description = "요청에 성공하였습니다."
     )
     List<DebateMessageResponse> getDebateMessages(
             @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
             Long roomId
     );
 
+    @Operation(
+            summary = "토론 요약",
+            description = "토론방의 토론 메세지들을 요약합니다.",
+            security = {@SecurityRequirement(name = "access_token")},
+            tags = {"토론방"}
+    )
+    @ApiResponses(value = {
+            @ApiResponse(
+                    responseCode = "201",
+                    description = "토론 요약이 성공하였습니다."
+            ),
+            @ApiResponse(
+                    responseCode = "404",
+                    description = "토론방을 찾지 못했습니다."
+            )
+    })
+    DebateSummaryResponse summarizeDebate(
+            @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
+            Long roomId
+    );
 
+    @Operation(
+            summary = "토론 요약 조회",
+            description = "토론 요약 내용을 조회합니다.",
+            security = {@SecurityRequirement(name = "access_token")},
+            tags = {"토론방"}
+    )
+    @ApiResponses(value = {
+            @ApiResponse(
+                    responseCode = "200",
+                    description = "요청에 성공하였습니다."
+            ),
+            @ApiResponse(
+                    responseCode = "404",
+                    description = "토론방을 찾지 못했습니다."
+            )
+    })
+    DebateSummaryResponse getSummarizedDebate(
+            @Parameter(in = ParameterIn.PATH, description = "토론방 ID", required = true)
+            Long roomId
+    );
 
 }

backend/core/src/main/java/com/rollthedice/backend/domain/debate/api/DebateController.java

@@ -4,6 +4,7 @@
 import com.rollthedice.backend.domain.debate.dto.request.DebateRoomRequest;
 import com.rollthedice.backend.domain.debate.dto.response.DebateMessageResponse;
 import com.rollthedice.backend.domain.debate.dto.response.DebateRoomResponse;
+import com.rollthedice.backend.domain.debate.dto.response.DebateSummaryResponse;
 import com.rollthedice.backend.domain.debate.service.DebateMessageService;
 import com.rollthedice.backend.domain.debate.service.DebateRoomService;
 import jakarta.validation.Valid;
@@ -56,10 +57,30 @@ public void saveAIDebateMessage(@PathVariable final Long roomId, @RequestBody fi
         debateMessageService.saveAIDebateMessage(roomId, request);
     }
 
-    @ResponseStatus(HttpStatus.OK)
+    @ResponseStatus(HttpStatus.NO_CONTENT)
+    @PatchMapping("/{roomId}")
+    public void finishDebate(@PathVariable final Long roomId) {
+        debateRoomService.closeDebate(roomId);
+    }
+
+    @ResponseStatus(HttpStatus.CREATED)
     @GetMapping("/{roomId}")
     @Override
     public List<DebateMessageResponse> getDebateMessages(@PathVariable final Long roomId) {
         return debateMessageService.getDebateMessages(roomId);
     }
+
+    @ResponseStatus(HttpStatus.OK)
+    @PostMapping("/summary/{roomId}")
+    @Override
+    public DebateSummaryResponse summarizeDebate(@PathVariable final Long roomId) {
+        return debateRoomService.summaryDebate(roomId);
+    }
+
+    @ResponseStatus(HttpStatus.OK)
+    @GetMapping("/summary/{roomId}")
+    @Override
+    public DebateSummaryResponse getSummarizedDebate(@PathVariable final Long roomId) {
+        return debateRoomService.getSummarizedDebate(roomId);
+    }
 }

backend/core/src/main/java/com/rollthedice/backend/domain/debate/dto/response/DebateRoomResponse.java

@@ -12,4 +12,5 @@
 public class DebateRoomResponse {
     private Long id;
     private String topic;
+    private Boolean isClosed;
 }

backend/core/src/main/java/com/rollthedice/backend/domain/debate/dto/response/DebateSummaryResponse.java

@@ -0,0 +1,18 @@
+package com.rollthedice.backend.domain.debate.dto.response;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class DebateSummaryResponse {
+    Long roomId;
+
+    @Schema(description = "4문장의 요약된 토론 내용")
+    String summary;
+}

backend/core/src/main/java/com/rollthedice/backend/domain/debate/entity/DebateRoom.java

@@ -7,6 +7,7 @@
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import org.hibernate.annotations.ColumnDefault;
 
 @Getter
 @Entity
@@ -17,6 +18,10 @@ public class DebateRoom extends BaseTimeEntity {
     private Long id;
 
     private String topic;
+    private String summary;
+
+    @ColumnDefault("false")
+    private boolean isClosed;
 
     @ManyToOne(fetch = FetchType.LAZY)
     @JoinColumn(name = "member_id")
@@ -27,4 +32,12 @@ public DebateRoom(Member member, String topic) {
         this.member = member;
         this.topic = topic;
     }
+
+    public void closeDebate() {
+        this.isClosed = true;
+    }
+
+    public void updateSummary(String summary) {
+        this.summary = summary;
+    }
 }

backend/core/src/main/java/com/rollthedice/backend/domain/debate/service/ClovaSummary.java

@@ -0,0 +1,119 @@
+package com.rollthedice.backend.domain.debate.service;
+
+import com.rollthedice.backend.global.error.ErrorCode;
+import com.rollthedice.backend.global.error.exception.ExternalApiException;
+import lombok.extern.slf4j.Slf4j;
+import net.minidev.json.JSONObject;
+import org.apache.tomcat.util.json.JSONParser;
+import org.apache.tomcat.util.json.ParseException;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.stereotype.Service;
+
+import java.io.BufferedReader;
+import java.io.DataOutputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.util.LinkedHashMap;
+
+@Slf4j
+@Service
+public class ClovaSummary {
+    private static final String KOREAN = "ko";
+    private static final int POLITE_TONE = 2;
+    private static final int SUMMARY_COUNT = 4;
+
+    private static final String API_URL = "https://naveropenapi.apigw.ntruss.com/text-summary/v1/summarize";
+
+
+    @Value("${clova.secret-key}")
+    private String SECRET;
+
+    @Value("${clova.client-id}")
+    private String CLIENT_ID;
+
+    public String summaryDebate(String messages) {
+        log.info("요약할 메세지: {}" ,messages);
+        try {
+            URL url = new URL(API_URL);
+            HttpURLConnection connection = createRequestHeader(url);
+            createRequestBody(connection, messages);
+
+            log.info("정상1");
+            StringBuilder response = getResponse(connection);
+            log.info("정상2");
+            return parseResponse(response);
+        } catch (Exception e) {
+            e.printStackTrace();
+            throw new ExternalApiException(ErrorCode.CLOVA_API_ERROR);
+        }
+    }
+
+    private HttpURLConnection createRequestHeader(URL url) throws IOException {
+        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
+        connection.setDoInput(true);
+        connection.setDoOutput(true);
+        connection.setRequestMethod("POST");
+        connection.setRequestProperty("Content-Type", "application/json;");
+        connection.setRequestProperty("X-NCP-APIGW-API-KEY-ID", CLIENT_ID);
+        connection.setRequestProperty("X-NCP-APIGW-API-KEY", SECRET);
+        return connection;
+    }
+
+    private void createRequestBody(HttpURLConnection connection, String content) throws IOException {
+        JSONObject document = new JSONObject();
+        document.put("content", content);
+
+        JSONObject option = new JSONObject();
+        option.put("language", KOREAN);
+        option.put("tone", POLITE_TONE);
+        option.put("summaryCount", SUMMARY_COUNT);
+
+        JSONObject requestObject = new JSONObject();
+        requestObject.put("document", document);
+        requestObject.put("option", option);
+
+        connection.connect();
+        DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream());
+        outputStream.write(requestObject.toString().getBytes(StandardCharsets.UTF_8));
+        outputStream.flush();
+        outputStream.close();
+    }
+
+
+    private StringBuilder getResponse(HttpURLConnection connection) throws IOException {
+        BufferedReader reader = checkResponse(connection);
+        String line;
+        StringBuilder response = new StringBuilder();
+        while ((line = reader.readLine()) != null) {
+            response.append(line);
+        }
+        reader.close();
+        return response;
+    }
+
+    private BufferedReader checkResponse(HttpURLConnection connection) throws IOException {
+        int responseCode = connection.getResponseCode();
+
+        return getResponseResult(connection, responseCode);
+    }
+
+    private BufferedReader getResponseResult(HttpURLConnection connection, int responseCode) throws IOException {
+        if (HttpStatusCode.valueOf(responseCode).is2xxSuccessful()) {
+            return new BufferedReader(new InputStreamReader(connection.getInputStream()));
+        }
+        log.error("Clova Api error response code: {}", responseCode);
+        return new BufferedReader(new InputStreamReader(connection.getErrorStream()));
+    }
+
+
+    private String parseResponse(StringBuilder response) throws ParseException {
+        JSONParser parser = new JSONParser(response.toString());
+        LinkedHashMap<String, String> hashMap = (LinkedHashMap<String, String>) parser.parse();
+        JSONObject parsed = new JSONObject(hashMap);
+        return parsed.get("summary").toString();
+    }
+}