refactor: use only room entry fields to create a new room via api

Author: AndreaGiulianelli

src/main/kotlin/application/presenter/api/deserializer/ApiDeserializer.kt

@@ -8,22 +8,14 @@
 
 package application.presenter.api.deserializer
 
-import application.presenter.api.model.EnvironmentalDataApiDto
 import application.presenter.api.model.MedicalTechnologyApiDto
 import application.presenter.api.model.MedicalTechnologyApiDtoType
-import application.presenter.api.model.RoomApiDto
 import application.presenter.api.model.RoomApiDtoType
-import entity.environment.Humidity
-import entity.environment.LightUnit
-import entity.environment.Luminosity
-import entity.environment.Presence
-import entity.environment.Temperature
-import entity.environment.TemperatureUnit
+import application.presenter.api.model.RoomEntry
 import entity.medicaltechnology.MedicalTechnology
 import entity.medicaltechnology.MedicalTechnologyID
 import entity.medicaltechnology.MedicalTechnologyType
 import entity.zone.Room
-import entity.zone.RoomEnvironmentalData
 import entity.zone.RoomID
 import entity.zone.RoomType
 import entity.zone.ZoneID
@@ -35,19 +27,11 @@ object ApiDeserializer {
     /**
      * Extension method to convert Room API DTO to [entity.zone.Room] class.
      */
-    fun RoomApiDto.toRoom() = Room(
+    fun RoomEntry.toRoom() = Room(
         id = RoomID(this.id),
         type = this.type.toRoomType(),
         zoneId = ZoneID(this.zoneId),
-        name = this.name,
-        environmentalData = this.environmentalData.toRoomEnvironmentalData()
-    )
-
-    private fun EnvironmentalDataApiDto.toRoomEnvironmentalData() = RoomEnvironmentalData(
-        temperature = this.temperature?.let { Temperature(it.value, TemperatureUnit.valueOf(it.unit)) },
-        humidity = this.humidity?.let { Humidity(it) },
-        luminosity = this.luminosity?.let { Luminosity(it.value, LightUnit.valueOf(it.unit)) },
-        presence = this.presence?.let { Presence(it) }
+        name = this.name
     )
 
     private fun RoomApiDtoType.toRoomType() = when (this) {

src/main/kotlin/application/presenter/api/model/RoomApiDto.kt

@@ -11,8 +11,8 @@ package application.presenter.api.model
 import kotlinx.serialization.Serializable
 
 /**
- * Presenter class to be able to deserialize data that comes from API.
- * It deserializes [id], [name], [zoneId], the [type] of the room and [environmentalData].
+ * Presenter class to be able to serialize data returned by the API.
+ * It is composed by [id], [name], [zoneId], the [type] of the room and [environmentalData].
  */
 @Serializable
 data class RoomApiDto(
@@ -24,7 +24,19 @@ data class RoomApiDto(
 )
 
 /**
- * Presenter enum class to deserialize room type that comes from API.
+ * It represents the presentation of a single [entity.zone.Room] entry.
+ * The necessary information are [id], [name], [zoneId] and the [type].
+ */
+@Serializable
+data class RoomEntry(
+    val id: String,
+    val name: String,
+    val zoneId: String,
+    val type: RoomApiDtoType
+)
+
+/**
+ * Presenter enum class to represent the room type.
  */
 @Serializable
 enum class RoomApiDtoType {

src/main/kotlin/application/presenter/api/model/RoomEntry.kt

@@ -33,7 +33,7 @@ object ApiSerializer {
         id = this.id.value,
         name = this.name.orEmpty(),
         zoneId = this.zoneId.value,
-        type = this.type.toString()
+        type = this.type.toRoomApiDtoType()
     )
 
     /**

src/main/kotlin/application/presenter/api/serializer/ApiSerializer.kt

@@ -10,7 +10,7 @@ package infrastructure.api
 
 import application.controller.RoomController
 import application.presenter.api.deserializer.ApiDeserializer.toRoom
-import application.presenter.api.model.RoomApiDto
+import application.presenter.api.model.RoomEntry
 import application.presenter.api.serializer.ApiSerializer.toRoomApiDto
 import application.service.RoomService
 import entity.zone.RoomID
@@ -38,7 +38,7 @@ import java.time.Instant
 fun Application.roomAPI(apiPath: String, port: Int, provider: ManagerProvider) {
     routing {
         post("$apiPath/rooms") {
-            val room = call.receive<RoomApiDto>().toRoom()
+            val room = call.receive<RoomEntry>().toRoom()
             RoomService.CreateRoom(
                 room,
                 RoomController(provider.roomDigitalTwinManager, provider.roomDatabaseManager)

src/main/kotlin/infrastructure/api/RoomApi.kt

@@ -50,6 +50,7 @@ class ApiSerializationTest : StringSpec({
             Presence(true)
         )
     )
+
     val roomApiDto = RoomApiDto(
         "r1",
         "name",
@@ -63,6 +64,13 @@ class ApiSerializationTest : StringSpec({
         )
     )
 
+    val roomEntry = RoomEntry(
+        id = "r1",
+        name = "name",
+        zoneId = "z1",
+        type = RoomApiDtoType.OPERATING_ROOM
+    )
+
     val medicalTechnology = MedicalTechnology(
         id = MedicalTechnologyID("mt-1"),
         name = "name",
@@ -82,20 +90,15 @@ class ApiSerializationTest : StringSpec({
     )
 
     "It should be possible to obtain the corresponding room from the data get from the API" {
-        roomApiDto.toRoom() shouldBe room
+        roomEntry.toRoom() shouldBe room
     }
 
-    "It should be possible to serialize a room in order to send it through the API" {
-        room.toRoomApiDto() shouldBe roomApiDto
+    "It should be possible to serialize a room in a room entry" {
+        room.toRoomEntry() shouldBe roomEntry
     }
 
-    "It should be possible to serialize a room in a room entry" {
-        room.toRoomEntry() shouldBe RoomEntry(
-            id = "r1",
-            name = "name",
-            zoneId = "z1",
-            type = "OPERATING_ROOM"
-        )
+    "It should be possible to serialize a room in order to send it through the API" {
+        room.toRoomApiDto() shouldBe roomApiDto
     }
 
     "It should be possible to obtain the corresponding medical technology from the data get from the API" {

src/test/kotlin/application/presenter/api/ApiSerializationTest.kt

@@ -12,7 +12,6 @@ import application.presenter.api.model.EnvironmentalDataApiDto
 import application.presenter.api.model.RoomApiDto
 import application.presenter.api.model.RoomApiDtoType
 import application.presenter.api.model.RoomEntry
-import application.presenter.api.model.ValueWithUnit
 import infrastructure.api.KtorTestingUtility.apiTestApplication
 import infrastructure.api.util.ApiResponses
 import io.kotest.assertions.ktor.client.shouldHaveStatus
@@ -35,67 +34,68 @@ import kotlinx.serialization.json.Json
 import java.time.Instant
 
 class RoomApiTest : StringSpec({
+    val roomEntry = RoomEntry(
+        "r1",
+        "name",
+        "z1",
+        RoomApiDtoType.OPERATING_ROOM
+    )
     val roomApiDto = RoomApiDto(
         "r1",
         "name",
         "z1",
         RoomApiDtoType.OPERATING_ROOM,
-        EnvironmentalDataApiDto(
-            ValueWithUnit(33.0, "CELSIUS"),
-            55.0,
-            ValueWithUnit(150.0, "LUX"),
-            true
-        )
+        EnvironmentalDataApiDto()
     )
 
-    suspend fun ApplicationTestBuilder.insertRoom(room: RoomApiDto) =
+    suspend fun ApplicationTestBuilder.insertRoom(room: RoomEntry) =
         client.post("/api/v1/rooms") {
             header(HttpHeaders.ContentType, ContentType.Application.Json.toString())
             setBody(Json.encodeToString(room))
         }
 
     "I should be able to request the creation of a room" {
         apiTestApplication {
-            val response = insertRoom(roomApiDto)
+            val response = insertRoom(roomEntry)
             response shouldHaveStatus HttpStatusCode.Created
             response.headers[HttpHeaders.Location] shouldNotBe null
         }
     }
 
     "When there is a request to add an existent room then the service should respond with a conflict status code" {
         apiTestApplication {
-            insertRoom(roomApiDto)
-            val response = insertRoom(roomApiDto)
+            insertRoom(roomEntry)
+            val response = insertRoom(roomEntry)
             response shouldHaveStatus HttpStatusCode.Conflict
         }
     }
 
     "It should be possible to obtain an existing room" {
         apiTestApplication {
-            insertRoom(roomApiDto)
-            val response = client.get("/api/v1/rooms/${roomApiDto.id}")
+            insertRoom(roomEntry)
+            val response = client.get("/api/v1/rooms/${roomEntry.id}")
             response shouldHaveStatus HttpStatusCode.OK
             Json.decodeFromString<RoomApiDto>(response.bodyAsText()) shouldBe roomApiDto
         }
     }
 
     "It should be possible to obtain historical data about a room" {
         apiTestApplication {
-            insertRoom(roomApiDto)
-            val response = client.get("/api/v1/rooms/${roomApiDto.id}?dateTime=${Instant.now()}")
+            insertRoom(roomEntry)
+            val response = client.get("/api/v1/rooms/${roomEntry.id}?dateTime=${Instant.now()}")
             response shouldHaveStatus HttpStatusCode.OK
         }
     }
 
     "It should handle the get request on a non existing room" {
         apiTestApplication {
-            client.get("/api/v1/rooms/${roomApiDto.id}") shouldHaveStatus HttpStatusCode.NotFound
+            client.get("/api/v1/rooms/${roomEntry.id}") shouldHaveStatus HttpStatusCode.NotFound
         }
     }
 
     "It should be able to get all the room entries" {
         apiTestApplication {
-            insertRoom(roomApiDto)
+            insertRoom(roomEntry)
             val response = client.get("/api/v1/rooms")
             response shouldHaveStatus HttpStatusCode.OK
             Json.decodeFromString<ApiResponses.ResponseEntryList<ApiResponses.ResponseEntry<RoomEntry>>>(
@@ -116,14 +116,14 @@ class RoomApiTest : StringSpec({
 
     "It should be possible to delete an existing room" {
         apiTestApplication {
-            insertRoom(roomApiDto)
-            client.delete("/api/v1/rooms/${roomApiDto.id}") shouldHaveStatus HttpStatusCode.NoContent
+            insertRoom(roomEntry)
+            client.delete("/api/v1/rooms/${roomEntry.id}") shouldHaveStatus HttpStatusCode.NoContent
         }
     }
 
     "It should not be possible to delete a not-existent room" {
         apiTestApplication {
-            client.delete("/api/v1/rooms/${roomApiDto.id}") shouldHaveStatus HttpStatusCode.NotFound
+            client.delete("/api/v1/rooms/${roomEntry.id}") shouldHaveStatus HttpStatusCode.NotFound
         }
     }
 })