기타 접근성 정보 내려주기

app-server/build.gradle.kts

@@ -1,4 +1,5 @@
 import io.gitlab.arturbosch.detekt.Detekt
+import org.jetbrains.kotlin.gradle.plugin.ide.kotlinExtrasSerialization
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import org.springframework.boot.gradle.tasks.bundling.BootJar
 
@@ -48,7 +49,9 @@ subprojects {
             implementation(rootProject.projects.crossCuttingConcern.infra.springWeb)
         }
         val kotlinLoggingVersion: String by project
+        val kotlinSerialization: String by project
         implementation("io.github.microutils:kotlin-logging-jvm:$kotlinLoggingVersion")
+        implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinSerialization")
     }
 
     tasks.test {

app-server/detekt-config.yml

@@ -14,6 +14,8 @@ style:
     active: true
   MagicNumber:
     active: false
+  ReturnCount:
+    active: false
 naming:
   PackageNaming:
     active: false

app-server/gradle.properties

@@ -2,6 +2,7 @@ kotlin.code.style=official
 kotlinVersion=1.8.20
 kotlinxSerializationVersion=1.5.0
 kotlinLoggingVersion=3.0.5
+kotlinSerialization=1.5.1
 jakartaInjectVersion=2.0.1
 springBootVersion=3.0.5
 springDependencyManagementVersion=1.1.0

app-server/subprojects/api_specification/api/scc-api/api-spec.yaml

@@ -645,6 +645,65 @@ paths:
                 required:
                   - placeAccessibilityComment
 
+  /searchExternalAccessibilities:
+    post:
+      summary: 외부 접근성 정보가 등록된 장소를 검색한다.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                searchText:
+                  type: string
+                currentLocation:
+                  $ref: '#/components/schemas/Location'
+                distanceMetersLimit:
+                  type: integer
+                categories:
+                  type: array
+                  description: 조회하고 싶은 접근성 정보 카테고리. 현재 화장실 (TOILET) 만 있음.
+                  items:
+                    type: string
+              required:
+                - distanceMetersLimit
+      responses:
+        '200':
+          description: 응답 리스트
+          content:
+            application/json:
+              schema:
+                properties:
+                  items:
+                    items:
+                      $ref: '#/components/schemas/ExternalAccessibility'
+                    type: array
+                type: object
+
+  /getExternalAccessibility:
+    post:
+      summary: 공공 접근성 정보를 확인한다.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                externalAccessibilityId:
+                  type: string
+              required:
+                - externalAccessibilityId
+      responses:
+        '200':
+          description: 해당 접근성 정보를 응답으로 내려준다.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ExternalAccessibility'
+
+
   /searchPlaces:
     post:
       summary: 점포를 검색한다. sort 가 null 인 경우에는 정확도순을 기본으로 한다.
@@ -1564,6 +1623,50 @@ components:
         - ATTRACTION
         - HOSPITAL
         - PHARMACY
+
+    ExternalAccessibility:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+          description: 장소의 human-readable한 이름.
+        address:
+          type: string
+          description: 장소의 human-readable한 주소.
+        location:
+          $ref: '#/components/schemas/Location'
+        category:
+          type: string
+          description: 장소의 종류
+        toilet_details:
+          $ref: '#/components/schemas/ToiletAccessibilityDetails'
+      required:
+        - id
+        - name
+        - location
+        - category
+
+    ToiletAccessibilityDetails:
+      type: object
+      properties:
+        gender:
+          type: boolean
+        accessDesc:
+          type: string
+        availableDesc:
+          type: string
+        entranceDesc:
+          type: string
+        stallDesc:
+          type: string
+        doorDesc:
+          type: string
+        washStandDesc:
+          type: string
+        extra:
+          type: string
 
     PlaceListItem:
       type: object

app-server/subprojects/bounded_context/external_accessibility/application/build.gradle.kts

@@ -0,0 +1,3 @@
+dependencies {
+    implementation(projects.apiSpecification.domainEvent)
+}

app-server/subprojects/bounded_context/external_accessibility/application/src/main/kotlin/club/staircrusher/external_accessibility/application/port/in/ExternalAccessibilitySearchService.kt

@@ -0,0 +1,37 @@
+package club.staircrusher.external_accessibility.application.port.`in`
+
+import club.staircrusher.external_accessibility.application.port.out.persistence.ExternalAccessibilityRepository
+import club.staircrusher.external_accessibility.domain.model.ExternalAccessibility
+import club.staircrusher.stdlib.di.annotation.Component
+import club.staircrusher.stdlib.external_accessibility.ExternalAccessibilityCategory
+import club.staircrusher.stdlib.geography.Length
+import club.staircrusher.stdlib.geography.Location
+import club.staircrusher.stdlib.geography.LocationUtils
+import club.staircrusher.stdlib.util.string.isSimilarWith
+
+@Component
+class ExternalAccessibilitySearchService(
+    private val externalAccessibilityRepository: ExternalAccessibilityRepository,
+) {
+    fun searchExternalAccessibilities(
+        searchText: String?,
+        currentLocation: Location?,
+        distanceMetersLimit: Length,
+        categories: List<ExternalAccessibilityCategory> = emptyList(),
+    ): List<ExternalAccessibility> {
+        return (
+            if (categories.isEmpty()) externalAccessibilityRepository.findAll()
+            else externalAccessibilityRepository.findByCategoryIn(categories.toSet())
+            )
+            // FIXME: 현재 fullscan 후 필터링 중, 나중에 spatial index 걸어주기
+            .filter {
+                currentLocation ?: return@filter true
+                val distance = LocationUtils.calculateDistance(currentLocation, it.location)
+                distance <= distanceMetersLimit
+            }
+            .filter {
+                searchText ?: return@filter true
+                searchText.isSimilarWith(it.name)
+            }
+    }
+}

app-server/subprojects/bounded_context/external_accessibility/application/src/main/kotlin/club/staircrusher/external_accessibility/application/port/in/ExternalAccessibilityService.kt

@@ -0,0 +1,17 @@
+package club.staircrusher.external_accessibility.application.port.`in`
+
+import club.staircrusher.external_accessibility.application.port.out.persistence.ExternalAccessibilityRepository
+import club.staircrusher.external_accessibility.domain.model.ExternalAccessibility
+import club.staircrusher.stdlib.di.annotation.Component
+
+@Component
+class ExternalAccessibilityService(
+    private val externalAccessibilityRepository: ExternalAccessibilityRepository,
+) {
+    fun get(
+        id: String
+    ): ExternalAccessibility {
+        return externalAccessibilityRepository.findByIdOrNull(id)
+            ?: throw IllegalArgumentException("External Accessibility with id $id does not exist.")
+    }
+}

app-server/subprojects/bounded_context/external_accessibility/application/src/main/kotlin/club/staircrusher/external_accessibility/application/port/out/ExternalAccessibilityRepository.kt

@@ -0,0 +1,11 @@
+package club.staircrusher.external_accessibility.application.port.out.persistence
+
+import club.staircrusher.external_accessibility.domain.model.ExternalAccessibility
+import club.staircrusher.stdlib.domain.repository.EntityRepository
+import club.staircrusher.stdlib.external_accessibility.ExternalAccessibilityCategory
+
+@Suppress("TooManyFunctions")
+interface ExternalAccessibilityRepository : EntityRepository<ExternalAccessibility, String> {
+    fun findAll(): List<ExternalAccessibility>
+    fun findByCategoryIn(categories: Set<ExternalAccessibilityCategory>): List<ExternalAccessibility>
+}

app-server/subprojects/bounded_context/external_accessibility/domain/build.gradle.kts

@@ -0,0 +1,6 @@
+plugins {
+    kotlin("plugin.serialization")
+}
+
+dependencies {
+}

app-server/subprojects/bounded_context/external_accessibility/domain/src/main/kotlin/club/staircrusher/external_accessibility/domain/model/ExternalAccessibility.kt

@@ -0,0 +1,16 @@
+package club.staircrusher.external_accessibility.domain.model
+
+import club.staircrusher.stdlib.external_accessibility.ExternalAccessibilityCategory
+import club.staircrusher.stdlib.geography.Location
+import java.time.Instant
+
+data class ExternalAccessibility(
+    val id: String,
+    val name: String,
+    val location: Location,
+    val address: String,
+    val createdAt: Instant,
+    val updatedAt: Instant,
+    val category: ExternalAccessibilityCategory,
+    val toiletDetails: ToiletAccessibilityDetails?,
+)

app-server/subprojects/bounded_context/external_accessibility/domain/src/main/kotlin/club/staircrusher/external_accessibility/domain/model/ToiletAccessibilityDetails.kt

@@ -0,0 +1,15 @@
+package club.staircrusher.external_accessibility.domain.model
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class ToiletAccessibilityDetails(
+    val gender: Boolean? = null,
+    val accessDesc: String? = null,
+    val availableDesc: String? = null,
+    val entranceDesc: String? = null,
+    val stallDesc: String? = null,
+    val doorDesc: String? = null,
+    val washStandDesc: String? = null,
+    val extra: String? = null,
+)

app-server/subprojects/bounded_context/external_accessibility/infra/build.gradle.kts

@@ -0,0 +1,19 @@
+plugins {
+    id("io.spring.dependency-management")
+    id("org.springframework.boot")
+}
+
+dependencies {
+    api(projects.apiSpecification.api)
+    api(projects.apiSpecification.domainEvent)
+    implementation(projects.crossCuttingConcern.infra.persistenceModel)
+    implementation("org.springframework.boot:spring-boot-starter-web")
+
+    integrationTestImplementation(projects.crossCuttingConcern.test.springIt)
+
+    val awsSdkVersion: String by project
+    implementation("software.amazon.awssdk:s3:$awsSdkVersion")
+    runtimeOnly("software.amazon.awssdk:sts:$awsSdkVersion") // IRSA를 사용하기 위해서 필요함
+
+    testImplementation(projects.boundedContext.externalAccessibility.application)
+}

app-server/subprojects/bounded_context/external_accessibility/infra/src/integrationTest/kotlin/club/staircrusher/external_accessibility/infra/adapter/in/controller/ExternalAccessibilityControllerTest.kt

@@ -0,0 +1,83 @@
+package club.staircrusher.external_accessibility.infra.adapter.`in`.controller
+
+import club.staircrusher.api.converter.toDTO
+import club.staircrusher.api.spec.dto.ExternalAccessibility
+import club.staircrusher.api.spec.dto.GetExternalAccessibilityPostRequest
+import club.staircrusher.api.spec.dto.SearchExternalAccessibilitiesPostRequest
+import club.staircrusher.api.spec.dto.SearchExternalAccessibilitiesPost200Response
+import club.staircrusher.user.domain.model.User
+import club.staircrusher.external_accessibility.infra.adapter.`in`.controller.base.ExternalAccessibilityITBase
+import club.staircrusher.external_accessibility.infra.adapter.out.persistence.ExternalAccessibilityRepository
+import club.staircrusher.stdlib.geography.Length
+import club.staircrusher.stdlib.geography.Location
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertNotNull
+import org.junit.jupiter.api.Assertions.assertNull
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import kotlin.random.Random
+
+class ExternalAccessibilityControllerTest : ExternalAccessibilityITBase() {
+
+    @Autowired
+    private lateinit var externalAccessibilityRepository: ExternalAccessibilityRepository
+
+    @BeforeEach
+    fun setUp() {
+        transactionManager.doInTransaction {
+            externalAccessibilityRepository.removeAll()
+        }
+    }
+
+    @Test
+    fun 서치_정상_동작() {
+        val currentLocation = Location(127.5, 37.5)
+        // 데이터가 없다면 보여주지 않는다.
+        val response = mvc.sccRequest(
+            "/searchExternalAccessibilities",
+            SearchExternalAccessibilitiesPostRequest(
+                currentLocation = currentLocation.toDTO(),
+                distanceMetersLimit = 2000,
+            )
+        )
+            .getResult(SearchExternalAccessibilitiesPost200Response::class).items ?: emptyList()
+        assertTrue(response.isEmpty())
+
+        // 데이터가 존재한다면 보여준다.
+        testDataGenerator.createExternalAccessibility(location = currentLocation)
+        testDataGenerator.createExternalAccessibility(location = currentLocation.plusLat(Length.ofMeters(1000)))
+        val response2 = mvc.sccRequest(
+            "/searchExternalAccessibilities",
+            SearchExternalAccessibilitiesPostRequest(
+                currentLocation = currentLocation.toDTO(),
+                distanceMetersLimit = 2000,
+            )
+        )
+            .getResult(SearchExternalAccessibilitiesPost200Response::class).items ?: emptyList()
+        assertTrue(response2.size == 2)
+
+        // 범위 안의 데이터만 보여준다.
+        val response3 = mvc.sccRequest(
+            "/searchExternalAccessibilities",
+            SearchExternalAccessibilitiesPostRequest(
+                currentLocation = currentLocation.toDTO(),
+                distanceMetersLimit = 500,
+            )
+        )
+            .getResult(SearchExternalAccessibilitiesPost200Response::class).items ?: emptyList()
+        assertEquals(1, response3.size)
+    }
+
+    @Test
+    fun 서치_단건_조회() {
+        val data = testDataGenerator.createExternalAccessibility()
+        val response = mvc.sccRequest(
+            "/getExternalAccessibility",
+            GetExternalAccessibilityPostRequest(externalAccessibilityId = data.id)
+        )
+            .getResult(ExternalAccessibility::class)
+        assertEquals(data.name, response.name)
+    }
+}

app-server/subprojects/bounded_context/external_accessibility/infra/src/integrationTest/kotlin/club/staircrusher/external_accessibility/infra/adapter/in/controller/base/ExternalAccessibilityITBase.kt

@@ -0,0 +1,9 @@
+package club.staircrusher.external_accessibility.infra.adapter.`in`.controller.base
+
+import club.staircrusher.testing.spring_it.base.SccSpringITBase
+import java.time.Clock
+import org.springframework.beans.factory.annotation.Autowired
+
+open class ExternalAccessibilityITBase : SccSpringITBase() {
+    @Autowired private lateinit var clock: Clock
+}