Merge pull request #87 from grida-diary/main

Docs

grida-core/core-api/src/main/kotlin/org/grida/presentation/v1/diaryimage/DiaryImageController.kt

@@ -0,0 +1,27 @@
+package org.grida.presentation.v1.diaryimage
+
+import io.wwan13.wintersecurity.resolve.RequestUserId
+import org.grida.api.ApiResponse
+import org.grida.api.dto.IdResponse
+import org.grida.domain.diaryimage.DiaryImageService
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+@RequestMapping("/api/v1/diary")
+class DiaryImageController(
+    private val diaryImageService: DiaryImageService
+) {
+
+    @PostMapping("/{diaryId}/image")
+    fun generateDiaryImage(
+        @RequestUserId userId: Long,
+        @PathVariable diaryId: Long
+    ): ApiResponse<IdResponse> {
+        val generatedDiaryImageId = diaryImageService.generateDiaryImage(diaryId, userId)
+        val response = IdResponse(generatedDiaryImageId)
+        return ApiResponse.success(response)
+    }
+}

grida-core/core-api/src/main/kotlin/org/grida/presentation/v1/user/UserController.kt

@@ -23,13 +23,13 @@ class UserController(
     fun signIn(
         @RequestBody request: SignInRequest
     ): ApiResponse<IdResponse> {
-        val ROLEUser = User(
+        val user = User(
             username = request.username,
             password = passwordEncoder.encode(request.password),
             nickname = request.username,
             role = Role.ROLE_USER
         )
-        val userId = userService.appendNormalUser(ROLEUser, request.passwordConfirm)
+        val userId = userService.appendNormalUser(user, request.passwordConfirm)
         val response = IdResponse(userId)
         return ApiResponse.success(response)
     }

grida-core/core-api/src/test/kotlin/org/grida/docs/diaryimage/DiaryImageApiDocsTest.kt

@@ -0,0 +1,46 @@
+package org.grida.docs.diaryimage
+
+import com.ninjasquad.springmockk.MockkBean
+import io.mockk.every
+import io.wwan13.api.document.snippets.NUMBER
+import io.wwan13.api.document.snippets.isTypeOf
+import io.wwan13.api.document.snippets.whichMeans
+import org.grida.docs.ApiDocsTest
+import org.grida.domain.diaryimage.DiaryImageService
+import org.grida.presentation.v1.diaryimage.DiaryImageController
+import org.junit.jupiter.api.Test
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
+
+@WebMvcTest(controllers = [DiaryImageController::class])
+class DiaryImageApiDocsTest(
+    private val diaryImageController: DiaryImageController
+) : ApiDocsTest(
+    diaryImageController,
+    "diary-image"
+) {
+
+    @MockkBean
+    private lateinit var diaryImageService: DiaryImageService
+
+    @Test
+    fun `일기 이미지 생성 API`() {
+        every { diaryImageService.generateDiaryImage(any(), any()) } returns 1L
+
+        val api = api.post("/api/v1/diary/{diaryId}/image", 1L) {
+            withBearerToken()
+        }
+
+        documentFor(api, "generate-diary-image") {
+            summary("일기 이미지 생성 API")
+            requestHeaders(
+                "Authorization" whichMeans "인증 토큰"
+            )
+            pathParameters(
+                "diaryId" whichMeans "생성하려는 일기의 ID"
+            )
+            responseFields(
+                "data.id" isTypeOf NUMBER whichMeans "생성된 일기 이미지 ID"
+            )
+        }
+    }
+}

grida-core/core-domain/src/main/kotlin/org/grida/domain/diaryimage/DiaryImage.kt

@@ -0,0 +1,10 @@
+package org.grida.domain.diaryimage
+
+import org.grida.domain.image.Image
+
+data class DiaryImage(
+    val id: Long = 0,
+    val userId: Long,
+    val diaryId: Long,
+    val image: Image
+)

grida-core/core-domain/src/main/kotlin/org/grida/domain/diaryimage/DiaryImageAppender.kt

@@ -0,0 +1,25 @@
+package org.grida.domain.diaryimage
+
+import org.grida.domain.diary.DiaryReader
+import org.grida.domain.user.UserReader
+import org.springframework.stereotype.Component
+import org.springframework.transaction.annotation.Transactional
+
+@Component
+class DiaryImageAppender(
+    private val diaryImageRepository: DiaryImageRepository,
+    private val diaryReader: DiaryReader,
+    private val userReader: UserReader
+) {
+
+    @Transactional
+    fun append(
+        diaryImage: DiaryImage,
+        diaryId: Long,
+        userId: Long
+    ): Long {
+        val diary = diaryReader.read(diaryId)
+        val user = userReader.read(userId)
+        return diaryImageRepository.save(diaryImage, diary, user)
+    }
+}

grida-core/core-domain/src/main/kotlin/org/grida/domain/diaryimage/DiaryImageGenerator.kt

@@ -0,0 +1,12 @@
+package org.grida.domain.diaryimage
+
+import org.springframework.stereotype.Component
+
+@Component
+class DiaryImageGenerator {
+
+    fun generate(diaryContent: String): String {
+        // TODO
+        return "https://tmpImageUrl.com"
+    }
+}

grida-core/core-domain/src/main/kotlin/org/grida/domain/diaryimage/DiaryImageRepository.kt

@@ -0,0 +1,8 @@
+package org.grida.domain.diaryimage
+
+import org.grida.domain.diary.Diary
+import org.grida.domain.user.User
+
+interface DiaryImageRepository {
+    fun save(diaryImage: DiaryImage, diary: Diary, user: User): Long
+}

grida-core/core-domain/src/main/kotlin/org/grida/domain/diaryimage/DiaryImageService.kt

@@ -0,0 +1,32 @@
+package org.grida.domain.diaryimage
+
+import org.grida.domain.diary.DiaryReader
+import org.grida.domain.diary.DiaryValidator
+import org.grida.domain.image.Image
+import org.grida.domain.image.ImageStatus
+import org.springframework.stereotype.Service
+
+@Service
+class DiaryImageService(
+    private val diaryImageAppender: DiaryImageAppender,
+    private val diaryImageGenerator: DiaryImageGenerator,
+    private val diaryReader: DiaryReader,
+    private val diaryValidator: DiaryValidator
+) {
+
+    fun generateDiaryImage(
+        diaryId: Long,
+        userId: Long
+    ): Long {
+        val diary = diaryReader.read(diaryId)
+        diaryValidator.validateIsOwner(diary, userId)
+        val generatedImageUrl = diaryImageGenerator.generate(diary.content)
+
+        val diaryImage = DiaryImage(
+            userId = userId,
+            diaryId = diaryId,
+            image = Image(generatedImageUrl, ImageStatus.DEACTIVATE)
+        )
+        return diaryImageAppender.append(diaryImage, diaryId, userId)
+    }
+}

grida-core/core-domain/src/main/kotlin/org/grida/domain/image/Image.kt

@@ -6,12 +6,4 @@ data class Image(
     val url: String,
     val status: ImageStatus = ImageStatus.ACTIVATE,
     val timestamp: Timestamp = Timestamp()
-) {
-    fun activate(): Image {
-        return Image(this.url, ImageStatus.ACTIVATE)
-    }
-
-    fun deactivate(): Image {
-        return Image(this.url, ImageStatus.DEACTIVATE)
-    }
-}
+)

grida-database/database-rds/src/main/kotlin/org/grida/persistence/diary/DiaryEntity.kt

@@ -1,8 +1,6 @@
 package org.grida.persistence.diary
 
-import org.grida.domain.diary.Diary
 import org.grida.domain.diary.DiaryScope
-import org.grida.domain.user.User
 import org.grida.persistence.base.BaseEntity
 import org.grida.persistence.user.UserEntity
 import java.time.LocalDate
@@ -39,37 +37,11 @@ class DiaryEntity(
     var user: UserEntity
 ) : BaseEntity() {
 
-    fun toDiary(): Diary {
-        return Diary(
-            id = id,
-            timestamp = this.toTimeStamp(),
-            targetDate = targetDate,
-            content = content,
-            scope = scope,
-            userId = user.id
-        )
-    }
-
     fun updateContent(content: String) {
         this.content = content
     }
 
     fun updateScope(scope: DiaryScope) {
         this.scope = scope
     }
-
-    companion object {
-        fun from(
-            diary: Diary,
-            user: User
-        ): DiaryEntity {
-            return DiaryEntity(
-                id = diary.id,
-                targetDate = diary.targetDate,
-                content = diary.content,
-                scope = diary.scope,
-                user = UserEntity.from(user)
-            )
-        }
-    }
-}
+}

grida-database/database-rds/src/main/kotlin/org/grida/persistence/diary/DiaryEntityMapper.kt

@@ -0,0 +1,26 @@
+package org.grida.persistence.diary
+
+import org.grida.domain.diary.Diary
+import org.grida.domain.user.User
+import org.grida.persistence.user.toEntity
+
+fun Diary.toEntity(user: User): DiaryEntity {
+    return DiaryEntity(
+        id = this.id,
+        targetDate = this.targetDate,
+        content = this.content,
+        scope = this.scope,
+        user = user.toEntity()
+    )
+}
+
+fun DiaryEntity.toDomain(): Diary {
+    return Diary(
+        id = this.id,
+        timestamp = this.toTimeStamp(),
+        targetDate = this.targetDate,
+        content = this.content,
+        scope = this.scope,
+        userId = this.user.id
+    )
+}

grida-database/database-rds/src/main/kotlin/org/grida/persistence/diary/DiaryEntityRepository.kt

@@ -19,13 +19,14 @@ class DiaryEntityRepository(
         diary: Diary,
         user: User
     ): Long {
-        val diaryEntity = diaryJpaEntityRepository.save(DiaryEntity.from(diary, user))
+        val diaryEntity = diary.toEntity(user)
+        diaryJpaEntityRepository.save(diaryEntity)
         return diaryEntity.id
     }
 
     override fun findById(id: Long): Diary {
         val diaryEntity = diaryJpaEntityRepository.findByIdOrException(id)
-        return diaryEntity.toDiary()
+        return diaryEntity.toDomain()
     }
 
     override fun existsByUserIdAndTargetDate(

grida-database/database-rds/src/main/kotlin/org/grida/persistence/diaryimage/DiaryImageEntity.kt

@@ -0,0 +1,42 @@
+package org.grida.persistence.diaryimage
+
+import org.grida.domain.diaryimage.DiaryImage
+import org.grida.domain.image.ImageStatus
+import org.grida.persistence.base.BaseEntity
+import org.grida.persistence.diary.DiaryEntity
+import org.grida.persistence.user.UserEntity
+import javax.persistence.Column
+import javax.persistence.Entity
+import javax.persistence.EnumType
+import javax.persistence.Enumerated
+import javax.persistence.FetchType
+import javax.persistence.GeneratedValue
+import javax.persistence.GenerationType
+import javax.persistence.Id
+import javax.persistence.JoinColumn
+import javax.persistence.ManyToOne
+import javax.persistence.Table
+
+@Entity
+@Table(name = "diary_image")
+class DiaryImageEntity(
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "diary_image_id")
+    var id: Long = 0,
+
+    @Column(length = 511)
+    var imageUrl: String,
+
+    @Enumerated(EnumType.STRING)
+    @Column(length = 127)
+    var status: ImageStatus,
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "user_id")
+    var user: UserEntity,
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "diary_id")
+    var diary: DiaryEntity,
+) : BaseEntity()

grida-database/database-rds/src/main/kotlin/org/grida/persistence/diaryimage/DiaryImageEntityMapper.kt

@@ -0,0 +1,34 @@
+package org.grida.persistence.diaryimage
+
+import org.grida.domain.diary.Diary
+import org.grida.domain.diaryimage.DiaryImage
+import org.grida.domain.image.Image
+import org.grida.domain.user.User
+import org.grida.persistence.diary.toEntity
+import org.grida.persistence.user.toEntity
+
+fun DiaryImage.toEntity(
+    user: User,
+    diary: Diary
+): DiaryImageEntity {
+    return DiaryImageEntity(
+        id = this.id,
+        imageUrl = this.image.url,
+        status = this.image.status,
+        user = user.toEntity(),
+        diary = diary.toEntity(user)
+    )
+}
+
+fun DiaryImageEntity.toDomain(): DiaryImage {
+    return DiaryImage(
+        id = this.id,
+        userId = this.user.id,
+        diaryId = this.diary.id,
+        image = Image(
+            url = imageUrl,
+            status = this.status,
+            timestamp = this.toTimeStamp()
+        )
+    )
+}