Merge pull request #314 from GSM-MSG/feature/313-generate-student-info-link

학생정보 조회 링크 생성 API 개발

Author: 김동학

sms-core/src/main/kotlin/team/msg/sms/common/util/PasswordUtil.kt

@@ -0,0 +1,25 @@
+package team.msg.sms.common.util
+
+import java.security.SecureRandom
+import java.util.stream.Collectors
+import java.util.stream.IntStream
+
+object PasswordUtil {
+	// 소문자와 숫자로 이루어진 length 만큼의 길이를 가진 문자열을 생성하는 함수
+	fun generateSecret(length: Int): String {
+		val secureRandom = SecureRandom()
+
+		val password = IntStream.concat(
+			IntStream.rangeClosed(48, 57),
+			IntStream.rangeClosed(97, 122)
+		).mapToObj { i -> i.toChar().toString() }.collect(Collectors.joining())
+
+		val builder = StringBuilder()
+
+		for (i in 0 until length) {
+			builder.append(password[secureRandom.nextInt(password.length)])
+		}
+
+		return builder.toString()
+	}
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/dto/req/CreateStudentLinkRequestData.kt

@@ -0,0 +1,8 @@
+package team.msg.sms.domain.student.dto.req
+
+import java.util.UUID
+
+data class CreateStudentLinkRequestData (
+	val studentId: UUID,
+	val periodDay: Long
+)

sms-core/src/main/kotlin/team/msg/sms/domain/student/dto/res/CreateStudentLinkResponseData.kt

@@ -0,0 +1,5 @@
+package team.msg.sms.domain.student.dto.res
+
+data class CreateStudentLinkResponseData (
+	val token: String
+)

sms-core/src/main/kotlin/team/msg/sms/domain/student/model/StudentLink.kt

@@ -0,0 +1,11 @@
+package team.msg.sms.domain.student.model
+
+import team.msg.sms.common.annotation.Aggregate
+import java.util.UUID
+
+@Aggregate
+data class StudentLink(
+    val token: String,
+    val studentId: UUID,
+    val timeToLive: Long
+)

sms-core/src/main/kotlin/team/msg/sms/domain/student/service/CheckStudentLinkService.kt

@@ -0,0 +1,5 @@
+package team.msg.sms.domain.student.service
+
+interface CheckStudentLinkService {
+    fun checkExistsByToken(token: String): Boolean
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/service/CommandStudentLinkService.kt

@@ -0,0 +1,9 @@
+package team.msg.sms.domain.student.service
+
+import team.msg.sms.domain.student.model.StudentLink
+
+interface CommandStudentLinkService {
+	fun save(
+		studentLink: StudentLink
+	): StudentLink
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/service/StudentLinkService.kt

@@ -0,0 +1,10 @@
+package team.msg.sms.domain.student.service
+
+import team.msg.sms.common.annotation.Service
+
+@Service
+class StudentLinkService (
+	commandStudentLinkService: CommandStudentLinkService,
+	checkStudentLinkService: CheckStudentLinkService
+): CommandStudentLinkService by commandStudentLinkService,
+	CheckStudentLinkService by checkStudentLinkService

sms-core/src/main/kotlin/team/msg/sms/domain/student/service/impl/CheckStudentLinkServiceImpl.kt

@@ -0,0 +1,14 @@
+package team.msg.sms.domain.student.service.impl
+
+import team.msg.sms.common.annotation.Service
+import team.msg.sms.domain.student.service.CheckStudentLinkService
+import team.msg.sms.domain.student.spi.StudentLinkPort
+
+@Service
+class CheckStudentLinkServiceImpl (
+    private val studentLinkPort: StudentLinkPort
+) : CheckStudentLinkService {
+    override fun checkExistsByToken(token: String): Boolean {
+        return studentLinkPort.existsByToken(token)
+    }
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/service/impl/CommandStudentLinkServiceImpl.kt

@@ -0,0 +1,15 @@
+package team.msg.sms.domain.student.service.impl
+
+import team.msg.sms.common.annotation.Service
+import team.msg.sms.domain.student.model.StudentLink
+import team.msg.sms.domain.student.service.CommandStudentLinkService
+import team.msg.sms.domain.student.spi.StudentLinkPort
+
+@Service
+class CommandStudentLinkServiceImpl(
+	private val studentLinkPort: StudentLinkPort
+): CommandStudentLinkService {
+	override fun save(studentLink: StudentLink): StudentLink {
+		return studentLinkPort.save(studentLink)
+	}
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/spi/CommandStudentLinkPort.kt

@@ -0,0 +1,7 @@
+package team.msg.sms.domain.student.spi
+
+import team.msg.sms.domain.student.model.StudentLink
+
+interface CommandStudentLinkPort {
+    fun save(studentLink: StudentLink): StudentLink
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/spi/QueryStudentLinkPort.kt

@@ -0,0 +1,5 @@
+package team.msg.sms.domain.student.spi
+
+interface QueryStudentLinkPort {
+	fun existsByToken(token: String): Boolean
+}

sms-core/src/main/kotlin/team/msg/sms/domain/student/spi/StudentLinkPort.kt

@@ -0,0 +1,5 @@
+package team.msg.sms.domain.student.spi
+
+interface StudentLinkPort:
+	CommandStudentLinkPort,
+	QueryStudentLinkPort

sms-core/src/main/kotlin/team/msg/sms/domain/student/usecase/CreateStudentLinkUseCase.kt

@@ -0,0 +1,32 @@
+package team.msg.sms.domain.student.usecase
+
+import team.msg.sms.common.annotation.UseCase
+import team.msg.sms.common.util.PasswordUtil.generateSecret
+import team.msg.sms.domain.student.dto.req.CreateStudentLinkRequestData
+import team.msg.sms.domain.student.dto.res.CreateStudentLinkResponseData
+import team.msg.sms.domain.student.model.StudentLink
+import team.msg.sms.domain.student.service.StudentLinkService
+import team.msg.sms.domain.student.service.StudentService
+import java.util.*
+
+@UseCase
+class CreateStudentLinkUseCase (
+	private val studentService: StudentService,
+	private val studentLinkService: StudentLinkService,
+) {
+	fun execute(createStudentLinkData: CreateStudentLinkRequestData): CreateStudentLinkResponseData {
+		val student = studentService.getStudentById(createStudentLinkData.studentId)
+		val token = generateSecret(32)
+
+		val studentLink = StudentLink(
+			token = token,
+			studentId = student.id,
+			timeToLive = createStudentLinkData.periodDay * 86400
+		)
+		studentLinkService.save(studentLink)
+
+		return CreateStudentLinkResponseData(
+			token = token
+		)
+	}
+}

sms-infrastructure/src/main/kotlin/team/msg/sms/global/security/SecurityConfig.kt

@@ -61,6 +61,7 @@ class SecurityConfig(
             .antMatchers(HttpMethod.POST, "/student").hasAuthority(STUDENT)
             .antMatchers(HttpMethod.GET, "/student").permitAll()
             .antMatchers(HttpMethod.GET, "/student/{uuid}").hasAnyAuthority(STUDENT, TEACHER)
+            .antMatchers(HttpMethod.POST, "/student/link").hasAuthority(TEACHER)
             .antMatchers(HttpMethod.GET, "/student/anonymous/{uuid}").permitAll()
 
             .antMatchers(HttpMethod.POST, "/teacher/common").hasAuthority(TEACHER)

sms-persistence/src/main/kotlin/team/msg/sms/persistence/student/StudentLinkPersistenceAdapter.kt

@@ -0,0 +1,24 @@
+package team.msg.sms.persistence.student
+
+import org.springframework.stereotype.Component
+import team.msg.sms.domain.student.model.StudentLink
+import team.msg.sms.domain.student.spi.StudentLinkPort
+import team.msg.sms.persistence.student.mapper.toDomain
+import team.msg.sms.persistence.student.mapper.toEntity
+import team.msg.sms.persistence.student.repository.StudentJpaRepository
+import team.msg.sms.persistence.student.repository.StudentLinkRepository
+
+@Component
+class StudentLinkPersistenceAdapter(
+    private val studentLinkRepository: StudentLinkRepository
+) : StudentLinkPort {
+    override fun save(studentLink: StudentLink): StudentLink {
+        return studentLinkRepository.save(
+            studentLink.toEntity()
+        ).toDomain()
+    }
+
+    override fun existsByToken(token: String): Boolean {
+        return studentLinkRepository.existsByToken(token)
+    }
+}

sms-persistence/src/main/kotlin/team/msg/sms/persistence/student/entity/StudentLinkEntity.kt

@@ -0,0 +1,20 @@
+package team.msg.sms.persistence.student.entity
+
+import org.springframework.data.annotation.Id
+import org.springframework.data.redis.core.RedisHash
+import org.springframework.data.redis.core.TimeToLive
+import org.springframework.data.redis.core.index.Indexed
+import java.util.UUID
+
+@RedisHash(value = "student_link")
+class StudentLinkEntity (
+	@Id
+	@Indexed
+	val token: String,
+
+	@Indexed
+	val studentId: UUID,
+
+	@TimeToLive
+	val timeToLive: Long
+)

sms-persistence/src/main/kotlin/team/msg/sms/persistence/student/mapper/StudentLinkMapper.kt

@@ -0,0 +1,20 @@
+package team.msg.sms.persistence.student.mapper
+
+import team.msg.sms.domain.auth.model.RefreshToken
+import team.msg.sms.domain.student.model.StudentLink
+import team.msg.sms.persistence.auth.entity.RefreshTokenEntity
+import team.msg.sms.persistence.student.entity.StudentLinkEntity
+
+fun StudentLinkEntity.toDomain(): StudentLink =
+    StudentLink(
+        token = token,
+        studentId = studentId,
+        timeToLive = timeToLive
+    )
+
+fun StudentLink.toEntity(): StudentLinkEntity =
+    StudentLinkEntity(
+        token = token,
+        studentId = studentId,
+        timeToLive = timeToLive
+    )

sms-persistence/src/main/kotlin/team/msg/sms/persistence/student/repository/StudentLinkRepository.kt

@@ -0,0 +1,10 @@
+package team.msg.sms.persistence.student.repository
+
+import org.springframework.data.repository.CrudRepository
+import org.springframework.stereotype.Repository
+import team.msg.sms.persistence.student.entity.StudentLinkEntity
+
+@Repository
+interface StudentLinkRepository : CrudRepository<StudentLinkEntity, Long> {
+	fun existsByToken(token: String): Boolean
+}

sms-presentation/src/main/kotlin/team/msg/sms/domain/student/StudentWebAdapter.kt

@@ -3,6 +3,7 @@ package team.msg.sms.domain.student
 import org.springframework.http.ResponseEntity
 import org.springframework.web.bind.annotation.*
 import team.msg.sms.common.exception.InvalidUuidException
+import team.msg.sms.domain.student.dto.req.CreateStudentLinkWebRequest
 import team.msg.sms.domain.student.dto.req.FindAllFiltersWebRequest
 import team.msg.sms.domain.student.dto.req.ModifyStudentInfoWebRequest
 import team.msg.sms.domain.student.dto.req.SignUpWebRequest
@@ -19,7 +20,8 @@ class StudentWebAdapter(
     private val studentInfoAnonymousUseCase: StudentInfoAnonymousUseCase,
     private val studentInfoDetailUseCase: StudentInfoDetailUseCase,
     private val studentInfoTeacherUseCase: StudentInfoTeacherUseCase,
-    private val modifyStudentInfoUseCase: ModifyStudentInfoUseCase
+    private val modifyStudentInfoUseCase: ModifyStudentInfoUseCase,
+    private val createStudentLinkUseCase: CreateStudentLinkUseCase
 ) {
     @GetMapping
     fun findAll(
@@ -35,6 +37,12 @@ class StudentWebAdapter(
         signUpUseCase.execute(signUpWebRequest.toData())
             .run { ResponseEntity.ok().build() }
 
+    @PostMapping("/link")
+    fun createStudentLink(@RequestBody @Valid createStudentLinkWebRequest: CreateStudentLinkWebRequest): ResponseEntity<CreateStudentLinkWebResponse> {
+        return createStudentLinkUseCase.execute(createStudentLinkWebRequest.toData())
+            .let { ResponseEntity.ok(it.toResponse()) }
+    }
+
     @PutMapping
     fun modifyStudentInfo(@RequestBody modifyStudentInfoWebRequest: ModifyStudentInfoWebRequest) {
         modifyStudentInfoUseCase.execute(modifyStudentInfoWebRequest.toData())
@@ -125,6 +133,11 @@ class StudentWebAdapter(
             prizes = this.prizes
         )
 
+    fun CreateStudentLinkResponseData.toResponse(): CreateStudentLinkWebResponse =
+        CreateStudentLinkWebResponse(
+            token = this.token
+        )
+
     private fun isValidUUID(uuid: String): Boolean {
         return try {
             UUID.fromString(uuid)
@@ -133,4 +146,4 @@ class StudentWebAdapter(
             false
         }
     }
-}
+}

sms-presentation/src/main/kotlin/team/msg/sms/domain/student/dto/req/CreateStudentLinkWebRequest.kt

@@ -0,0 +1,14 @@
+package team.msg.sms.domain.student.dto.req
+
+import java.util.UUID
+
+data class CreateStudentLinkWebRequest (
+	val studentId: UUID,
+	val periodDay: Long
+) {
+	fun toData(): CreateStudentLinkRequestData =
+		CreateStudentLinkRequestData(
+			studentId,
+			periodDay
+		)
+}

sms-presentation/src/main/kotlin/team/msg/sms/domain/student/dto/res/CreateStudentLinkWebResponse.kt

@@ -0,0 +1,5 @@
+package team.msg.sms.domain.student.dto.res
+
+data class CreateStudentLinkWebResponse (
+	val token: String
+)