feat : Add Email Authentication Code Sender Api

Author: myqewr

src/docs/asciidoc/index.adoc

@@ -119,3 +119,26 @@ include::{snippetsDir}/emailDuplicationCheck/1/http-response.adoc[]
 include::{snippetsDir}/emailDuplicationCheck/1/response-fields.adoc[]
 
 ---
+
+
+=== **2. 이메일 인증 api**
+
+이메일 인증용 코드를 발송하는 api입니다.
+
+==== Request
+include::{snippetsDir}/emailAuthentication/1/http-request.adoc[]
+
+==== Request Body Fields
+include::{snippetsDir}/emailAuthentication/1/request-fields.adoc[]
+
+==== 성공 Response
+include::{snippetsDir}/emailAuthentication/1/http-response.adoc[]
+
+==== Response Body Fields
+include::{snippetsDir}/emailAuthentication/1/response-fields.adoc[]
+
+==== 실패 Response
+실패1.
+include::{snippetsDir}/emailAuthentication/2/http-response.adoc[]
+실패 2
+include::{snippetsDir}/emailAuthentication/3/http-response.adoc[]

src/main/java/com/ftm/server/adapter/controller/user/EmailAuthenticationController.java

@@ -0,0 +1,30 @@
+package com.ftm.server.adapter.controller.user;
+
+import com.ftm.server.adapter.dto.request.EmailAuthenticationRequest;
+import com.ftm.server.common.response.ApiResponse;
+import com.ftm.server.common.response.enums.SuccessResponseCode;
+import com.ftm.server.domain.dto.command.EmailAuthenticationCommand;
+import com.ftm.server.domain.usecase.user.EmailAuthenticationUseCase;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RequiredArgsConstructor
+@RestController
+public class EmailAuthenticationController {
+
+    private final EmailAuthenticationUseCase emailAuthenticationUseCase;
+
+    @PostMapping("/api/users/email/authentication")
+    public ResponseEntity<ApiResponse<Object>> emailAuthenticationCodeSender(
+            @Valid @RequestBody EmailAuthenticationRequest request) {
+        emailAuthenticationUseCase.sendEmailAuthenticationCode(
+                EmailAuthenticationCommand.from(request)); // command 객체 전달
+        return ResponseEntity.status(HttpStatus.OK)
+                .body(ApiResponse.success(SuccessResponseCode.OK));
+    }
+}

src/main/java/com/ftm/server/adapter/dto/request/.gitkeep

@@ -0,0 +1,13 @@
+package com.ftm.server.adapter.dto.request;
+
+import jakarta.validation.constraints.Pattern;
+import lombok.Data;
+
+@Data
+public class EmailAuthenticationRequest {
+
+    @Pattern(
+            regexp = "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$",
+            message = "이메일 형식이 올바르지 않습니다.")
+    private final String email;
+}

src/main/java/com/ftm/server/adapter/dto/request/EmailAuthenticationRequest.java

@@ -0,0 +1,6 @@
+package com.ftm.server.adapter.gateway;
+
+public interface MailSenderGateway {
+
+    void sendEmail(String to, String code);
+}

src/main/java/com/ftm/server/adapter/gateway/MailSenderGateway.java

@@ -0,0 +1,13 @@
+package com.ftm.server.adapter.gateway.repository;
+
+import com.ftm.server.entity.entities.EmailVerificationLogs;
+import java.util.Optional;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface EmailVerificationLogsRepository
+        extends JpaRepository<EmailVerificationLogs, Long> {
+
+    Optional<EmailVerificationLogs> findByEmail(String email);
+}

src/main/java/com/ftm/server/adapter/gateway/repository/EmailVerificationLogsRepository.java

@@ -22,9 +22,11 @@ public enum ErrorResponseCode {
     // 409번
     USER_ALREADY_EXISTS(HttpStatus.CONFLICT, "E409_001", "이미 존재하는 사용자입니다."),
     PASSWORD_NOT_MATCHED(HttpStatus.CONFLICT, "E409_002", "비밀번호가 일치하지 않습니다."),
+    EXCEED_NUMBER_OF_TRIAL(HttpStatus.CONFLICT, "E409_003", "시도 가능 횟수를 초과했습니다. 잠시 후에 다시 시도 해 주세요."),
 
     // 500번
-    UNKNOWN_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "E500_001", "알 수 없는 서버 에러가 발생했습니다.");
+    UNKNOWN_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "E500_001", "알 수 없는 서버 에러가 발생했습니다."),
+    FAIL_TO_SEND_EMAIL(HttpStatus.INTERNAL_SERVER_ERROR, "E500_002", "서버 내부 문제로 메일 전송에 실패했습니다.");
 
     private final HttpStatus httpStatus;
     private final String code;

src/main/java/com/ftm/server/common/response/enums/ErrorResponseCode.java

@@ -0,0 +1,22 @@
+package com.ftm.server.common.utils;
+
+import java.security.SecureRandom;
+import org.springframework.stereotype.Component;
+
+@Component
+public class RandomCodeCreator {
+
+    private static final int CODE_LENGTH = 6;
+
+    private final SecureRandom random = new SecureRandom();
+
+    public String generateAuthCode() {
+
+        StringBuilder sb = new StringBuilder(CODE_LENGTH);
+        for (int i = 0; i < CODE_LENGTH; i++) {
+            int digit = random.nextInt(10);
+            sb.append(digit);
+        }
+        return sb.toString();
+    }
+}

src/main/java/com/ftm/server/common/utils/.gitkeep

@@ -0,0 +1,13 @@
+package com.ftm.server.domain.dto.command;
+
+import com.ftm.server.adapter.dto.request.EmailAuthenticationRequest;
+import lombok.Data;
+
+@Data
+public class EmailAuthenticationCommand {
+    private final String email;
+
+    public static EmailAuthenticationCommand from(EmailAuthenticationRequest request) {
+        return new EmailAuthenticationCommand(request.getEmail());
+    }
+}