fix: use JSON API types to create a vehicle inspection

Author: jwilkinson87

build.gradle.kts

@@ -25,6 +25,7 @@ dependencies {
     implementation(libs.jetbrains.kotlinx.serialization.json)
     implementation(libs.jsonapi.converter)
     implementation(libs.jackson.datatype.jsr)
+    implementation(libs.jackson.kotlin)
 
     testImplementation(kotlin("test"))
     testImplementation(libs.mockk)

gradle/libs.versions.toml

@@ -5,6 +5,7 @@ ktor = "3.0.3"
 kotlinSerialization = "1.7.3"
 mockk = "1.9.3"
 jsonapi = "0.14"
+jacksonKotlin = "2.18.2"
 
 [libraries]
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
@@ -17,4 +18,5 @@ kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref =
 jetbrains-kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinSerialization" }
 mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 jsonapi-converter = { module = "com.github.jasminb:jsonapi-converter", version.ref = "jsonapi" }
-jackson-datatype-jsr = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "datatypeJsr" }
+jackson-datatype-jsr = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310", version.ref = "datatypeJsr" }
+jackson-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jacksonKotlin" }

src/main/kotlin/com/ctrlhub/core/assets/vehicles/VehicleInspectionsRouter.kt

@@ -1,13 +1,9 @@
 package com.ctrlhub.core.assets.vehicles
 
-import com.ctrlhub.core.api.ApiException
-import com.ctrlhub.core.api.ApiResourcePayload
-import com.ctrlhub.core.assets.vehicles.payload.VehicleInspectionPayload
-import com.ctrlhub.core.assets.vehicles.response.VehicleInspection
+import com.ctrlhub.core.assets.vehicles.resource.VehicleInspection
 import com.ctrlhub.core.router.Router
 import com.ctrlhub.core.router.request.RequestParameters
 import io.ktor.client.*
-import io.ktor.http.*
 
 /**
  * A router that interacts with the vehicle inspections realm of the Ctrl Hub API
@@ -64,21 +60,13 @@ class VehicleInspectionsRouter(httpClient: HttpClient) : Router(httpClient) {
      *
      * @return A result representing the outcome of this operation
      */
-    suspend fun create(organisationId: String, vehicleId: String, payload: VehicleInspectionPayload): VehicleInspection {
+    suspend fun create(organisationId: String, vehicleId: String, payload: VehicleInspection): VehicleInspection {
         val endpoint = "/v3/orgs/$organisationId/assets/vehicles/$vehicleId/inspections"
 
-        val response = performPost(
-            endpoint, body = ApiResourcePayload(
-                type = resourceType,
-                data = payload
-            )
+        return postJsonApiResource(
+            endpoint = endpoint,
+            requestBody = payload
         )
-
-        if (response.status !== HttpStatusCode.Created) {
-            throw ApiException("Unable to create vehicle inspection")
-        }
-
-        return fetchJsonApiResource(response)
     }
 }
 

src/main/kotlin/com/ctrlhub/core/assets/vehicles/payload/VehicleInspectionPayload.kt

@@ -0,0 +1,71 @@
+package com.ctrlhub.core.assets.vehicles.resource
+
+import com.ctrlhub.core.serializer.JacksonLocalDateTimeSerializer
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+import com.fasterxml.jackson.databind.annotation.JsonSerialize
+import com.github.jasminb.jsonapi.StringIdHandler
+import com.github.jasminb.jsonapi.annotations.Id
+import com.github.jasminb.jsonapi.annotations.Type
+import kotlinx.serialization.SerialName
+import java.time.LocalDateTime
+
+@Type("vehicle-inspections")
+@JsonIgnoreProperties(ignoreUnknown = true)
+class VehicleInspection @JsonCreator constructor(
+    @JsonProperty("id") @Id(StringIdHandler::class) var id: String = "",
+    @JsonProperty("checks") var checks: VehicleInspectionChecks? = null,
+    @SerialName("inspected_at") @JsonProperty("inspected_at") var inspectedAt: LocalDateTime? = null
+) {
+    constructor() : this(
+        id = "",
+        checks = null,
+        inspectedAt = null
+    )
+}
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class VehicleInspectionChecks @JsonCreator constructor(
+    @JsonProperty("visible_damage") var visibleDamage: Boolean? = null,
+    @JsonProperty("tyres") var tyres: Boolean? = null,
+    @JsonProperty("washers_and_wipers") var washersAndWipers: Boolean? = null,
+    @JsonProperty("windscreen") var windscreen: Boolean? = null,
+    @JsonProperty("number_plate") var numberPlate: Boolean? = null,
+    @JsonProperty("security") var security: Boolean? = null,
+    @JsonProperty("accessories") var accessories: Boolean? = null,
+    @JsonProperty("spare_number_plate") var spareNumberPlate: Boolean? = null,
+    @JsonProperty("safe_access") var safeAccess: Boolean? = null,
+    @JsonProperty("reversing_alarm") var reversingAlarm: Boolean? = null,
+    @JsonProperty("beacons") var beacons: Boolean? = null,
+    @JsonProperty("chemicals_and_fuel") var chemicalsAndFuel: Boolean? = null,
+    @JsonProperty("storage") var storage: Boolean? = null,
+    @JsonProperty("lights_and_indicators") var lightsAndIndicators: Boolean? = null,
+    @JsonProperty("engine_warning_lights") var engineWarningLights: Boolean? = null,
+    @JsonProperty("servicing") var servicing: Boolean? = null,
+    @JsonProperty("levels") var levels: Boolean? = null,
+    @JsonProperty("cleanliness") var cleanliness: Boolean? = null,
+    @JsonProperty("driver_checks") var driverChecks: Boolean? = null
+) {
+    constructor() : this(
+        visibleDamage = null,
+        tyres = null,
+        washersAndWipers = null,
+        windscreen = null,
+        numberPlate = null,
+        security = null,
+        accessories = null,
+        spareNumberPlate = null,
+        safeAccess = null,
+        reversingAlarm = null,
+        beacons = null,
+        chemicalsAndFuel = null,
+        storage = null,
+        lightsAndIndicators = null,
+        engineWarningLights = null,
+        servicing = null,
+        levels = null,
+        cleanliness = null,
+        driverChecks = null
+    )
+}

src/main/kotlin/com/ctrlhub/core/assets/vehicles/resource/VehicleInspection.kt

@@ -1,7 +1,6 @@
 package com.ctrlhub.core.assets.vehicles.response
 
 import com.ctrlhub.core.api.Assignable
-import com.ctrlhub.core.iam.response.User
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties
 import com.fasterxml.jackson.annotation.JsonProperty
 import com.github.jasminb.jsonapi.StringIdHandler

src/main/kotlin/com/ctrlhub/core/assets/vehicles/response/VehicleInspection.kt

@@ -3,8 +3,13 @@ package com.ctrlhub.core.router
 import com.ctrlhub.core.api.ApiClientException
 import com.ctrlhub.core.api.ApiException
 import com.ctrlhub.core.api.UnauthorizedException
+import com.ctrlhub.core.serializer.JacksonLocalDateTimeDeserializer
+import com.ctrlhub.core.serializer.JacksonLocalDateTimeSerializer
+import com.fasterxml.jackson.module.kotlin.kotlinModule
 import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.databind.module.SimpleModule
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule
+import com.github.jasminb.jsonapi.JSONAPIDocument
 import com.github.jasminb.jsonapi.ResourceConverter
 import com.github.jasminb.jsonapi.SerializationFeature
 import io.ktor.client.*
@@ -13,6 +18,7 @@ import io.ktor.client.plugins.ClientRequestException
 import io.ktor.client.request.*
 import io.ktor.client.statement.*
 import io.ktor.http.*
+import java.time.LocalDateTime
 
 abstract class Router(val httpClient: HttpClient) {
     protected suspend fun performGet(endpoint: String, queryString: Map<String, String> = emptyMap()): HttpResponse {
@@ -23,11 +29,15 @@ abstract class Router(val httpClient: HttpClient) {
         }
     }
 
-    protected suspend inline fun <reified T> performPost(endpoint: String, body: T, queryString: Map<String, String> = emptyMap()): HttpResponse {
+    protected suspend inline fun <reified T> performPost(
+        endpoint: String,
+        body: T,
+        queryParameters: Map<String, String> = emptyMap()
+    ): HttpResponse {
         return httpClient.post(endpoint) {
             contentType(ContentType.Application.Json)
             url {
-                queryString.forEach { key, value -> parameters.append(key, value) }
+                queryParameters.forEach { key, value -> parameters.append(key, value) }
             }
             setBody(body)
         }
@@ -125,8 +135,50 @@ abstract class Router(val httpClient: HttpClient) {
     }
 
     fun getObjectMapper(): ObjectMapper {
+        val module = SimpleModule().apply {
+            addSerializer(LocalDateTime::class.java, JacksonLocalDateTimeSerializer())
+            addDeserializer(LocalDateTime::class.java, JacksonLocalDateTimeDeserializer())
+        }
+
         return ObjectMapper().apply {
             registerModule(JavaTimeModule())
+            registerModule(module)
+            registerModule(kotlinModule())
+        }
+    }
+
+    protected suspend inline fun <reified T> postJsonApiResource(
+        endpoint: String,
+        requestBody: T,
+        queryParameters: Map<String, String> = emptyMap(),
+        vararg includedClasses: Class<*>
+    ): T {
+        return try {
+            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java, *includedClasses).apply {
+                enableSerializationOption(SerializationFeature.INCLUDE_RELATIONSHIP_ATTRIBUTES)
+            }
+
+            val jsonApiRequestDocument = JSONAPIDocument(requestBody)
+            val jsonApiRequest = resourceConverter.writeDocument(jsonApiRequestDocument)
+
+            val response: HttpResponse = performPost(
+                endpoint = endpoint,
+                body = jsonApiRequest,
+                queryParameters = queryParameters
+            )
+
+            val jsonApiResponse = resourceConverter.readDocument<T>(
+                response.body<ByteArray>(), T::class.java
+            )
+
+            jsonApiResponse.get() ?: throw ApiException("Failed to parse JSON:API response for $endpoint", Exception())
+        } catch (e: ClientRequestException) {
+            if (e.response.status == HttpStatusCode.Unauthorized) {
+                throw UnauthorizedException("Unauthorized action: $endpoint", e.response, e)
+            }
+            throw ApiClientException("Request failed: $endpoint", e.response, e)
+        } catch (e: Exception) {
+            throw ApiException("Request failed: $endpoint", e)
         }
     }
 }

src/main/kotlin/com/ctrlhub/core/assets/vehicles/response/VehiclesResponse.kt

@@ -1,8 +1,7 @@
 package com.ctrlhub.core.assets.vehicles
 
-import com.ctrlhub.core.assets.vehicles.payload.VehicleInspectionChecksPayload
-import com.ctrlhub.core.assets.vehicles.payload.VehicleInspectionPayload
-import com.ctrlhub.core.assets.vehicles.response.VehicleInspection
+import com.ctrlhub.core.assets.vehicles.resource.VehicleInspection
+import com.ctrlhub.core.assets.vehicles.resource.VehicleInspectionChecks
 import com.ctrlhub.core.configureForTest
 import io.ktor.client.*
 import io.ktor.client.engine.mock.*
@@ -14,7 +13,6 @@ import java.nio.file.Paths
 import java.time.LocalDateTime
 import kotlin.test.assertIs
 import kotlin.test.assertNotNull
-import kotlin.test.assertTrue
 
 class VehicleInspectionsRouterTest {
     @Test
@@ -89,8 +87,8 @@ class VehicleInspectionsRouterTest {
             val result = vehicleInspectionsRouter.create(
                 organisationId = "org-123",
                 vehicleId = "vehicle-123",
-                payload = VehicleInspectionPayload(
-                    checks = VehicleInspectionChecksPayload(
+                payload = VehicleInspection(
+                    checks = VehicleInspectionChecks(
                         accessories = listOf(true, false, null).random(),
                         beacons = listOf(true, false, null).random(),
                         chemicalsAndFuel = listOf(true, false, null).random(),