fix: return vehicle inspection resource on create

Author: jwilkinson87

src/main/kotlin/com/ctrlhub/core/api/ApiException.kt

@@ -5,7 +5,10 @@ import io.ktor.client.statement.*
 /**
  * Represents an exception that occurred when interacting with the API
  */
-open class ApiException(message: String, e: Throwable) : Exception(message, e)
+open class ApiException : Exception {
+    constructor(message: String, e: Throwable) : super(message, e)
+    constructor(message: String) : super(message)
+}
 
 /**
  * Represents an authorized error that occurs when interacting with the API.

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

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

src/main/kotlin/com/ctrlhub/core/router/Router.kt

@@ -73,6 +73,30 @@ abstract class Router(val httpClient: HttpClient) {
         }
     }
 
+    protected suspend inline fun <reified T> fetchJsonApiResource(
+        response: HttpResponse,
+        vararg includedClasses: Class<*>
+    ): T {
+        return try {
+            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java, *includedClasses).apply {
+                enableSerializationOption(SerializationFeature.INCLUDE_RELATIONSHIP_ATTRIBUTES)
+            }
+
+            val jsonApiResponse = resourceConverter.readDocument<T>(
+                response.body<ByteArray>(), T::class.java
+            )
+
+            jsonApiResponse.get() ?: throw ApiException("Failed to parse response", Exception())
+        } catch (e: ClientRequestException) {
+            if (e.response.status == HttpStatusCode.Unauthorized) {
+                throw UnauthorizedException("Unauthorized action", e.response, e)
+            }
+            throw ApiClientException("Request failed", e.response, e)
+        } catch (e: Exception) {
+            throw ApiException("Request failed", e)
+        }
+    }
+
     protected suspend inline fun <reified T> fetchJsonApiResources(
         endpoint: String,
         queryParameters: Map<String, String> = emptyMap(),

src/test/kotlin/com/ctrlhub/core/assets/vehicles/VehicleInspectionsRouterTest.kt

@@ -11,6 +11,7 @@ import kotlinx.coroutines.runBlocking
 import org.junit.jupiter.api.Test
 import java.nio.file.Files
 import java.nio.file.Paths
+import java.time.LocalDateTime
 import kotlin.test.assertIs
 import kotlin.test.assertNotNull
 import kotlin.test.assertTrue
@@ -71,9 +72,12 @@ class VehicleInspectionsRouterTest {
 
     @Test
     fun `can create a vehicle inspection`() {
+        val jsonFilePath = Paths.get("src/test/resources/assets/vehicles/one-vehicle-inspection-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
         val mockEngine = MockEngine { request ->
             respond(
-                content = "",
+                content = jsonContent,
                 status = HttpStatusCode.Created,
                 headers = headersOf(HttpHeaders.ContentType, "application/json")
             )
@@ -105,11 +109,12 @@ class VehicleInspectionsRouterTest {
                         visibleDamage = listOf(true, false, null).random(),
                         washersAndWipers = listOf(true, false, null).random(),
                         windscreen = listOf(true, false, null).random()
-                    )
+                    ),
+                    inspectedAt = LocalDateTime.now()
                 )
             )
 
-            assertTrue(result.isSuccess)
+            assertNotNull(result.id)
         }
     }
 }