fix: allow assignee of vehicles to be returned

Author: jwilkinson87

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

@@ -0,0 +1,7 @@
+package com.ctrlhub.core.api
+
+/**
+ * An interface that represents any entity that can be assigned
+ * to something such as a vehicle or equipment
+ */
+interface Assignable

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

@@ -3,6 +3,7 @@ package com.ctrlhub.core.assets.vehicles
 import com.ctrlhub.core.Api
 import com.ctrlhub.core.assets.vehicles.VehicleRequestParameters
 import com.ctrlhub.core.assets.vehicles.response.Vehicle
+import com.ctrlhub.core.iam.response.User
 import com.ctrlhub.core.router.Router
 import com.ctrlhub.core.router.request.FilterOption
 import com.ctrlhub.core.router.request.JsonApiIncludes
@@ -51,15 +52,23 @@ class VehiclesRouter(httpClient: HttpClient) : Router(httpClient) {
         organisationId: String,
         requestParameters: VehicleRequestParameters = VehicleRequestParameters()
     ): List<Vehicle> {
-        return fetchJsonApiResources("/v3/orgs/$organisationId/assets/vehicles", requestParameters.toMap())
+        return fetchJsonApiResources(
+            "/v3/orgs/$organisationId/assets/vehicles",
+            requestParameters.toMap(),
+            User::class.java
+        )
     }
 
     suspend fun one(
         organisationId: String,
         vehicleId: String,
         requestParameters: VehicleRequestParameters = VehicleRequestParameters()
     ): Vehicle {
-        return fetchJsonApiResource("/v3/orgs/$organisationId/assets/vehicles/$vehicleId", requestParameters.toMap())
+        return fetchJsonApiResource(
+            "/v3/orgs/$organisationId/assets/vehicles/$vehicleId",
+            requestParameters.toMap(),
+            User::class.java
+        )
     }
 }
 

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

@@ -1,5 +1,7 @@
 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
@@ -19,6 +21,9 @@ class Vehicle {
 
     @Relationship("specification")
     var specification: VehicleSpecification? = null
+
+    @Relationship("assignee")
+    var assignee: Assignable? = null
 }
 
 @Type("vehicle-categories")

src/main/kotlin/com/ctrlhub/core/iam/response/WhoamiResponse.kt

@@ -1,13 +1,14 @@
 package com.ctrlhub.core.iam.response
 
+import com.ctrlhub.core.api.Assignable
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties
 import com.fasterxml.jackson.annotation.JsonProperty
 import com.github.jasminb.jsonapi.StringIdHandler
 import com.github.jasminb.jsonapi.annotations.Id
 import com.github.jasminb.jsonapi.annotations.Type
 
 @Type("users")
-class User {
+class User : Assignable {
     @Id(StringIdHandler::class)
     lateinit var id: String
     lateinit var email: String

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

@@ -46,40 +46,54 @@ abstract class Router(val httpClient: HttpClient) {
         }
     }
 
-    protected suspend inline fun <reified T> fetchJsonApiResource(endpoint: String, queryParameters: Map<String, String> = emptyMap()): T {
+    protected suspend inline fun <reified T> fetchJsonApiResource(
+        endpoint: String,
+        queryParameters: Map<String, String> = emptyMap(),
+        vararg includedClasses: Class<*>
+    ): T {
         return try {
             val rawResponse = performGet(endpoint, queryParameters)
-            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java).apply {
+
+            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java, *includedClasses).apply {
                 enableSerializationOption(SerializationFeature.INCLUDE_RELATIONSHIP_ATTRIBUTES)
             }
-            val jsonApiResponse = resourceConverter.readDocument<T>(rawResponse.body<ByteArray>(), T::class.java)
+
+            val jsonApiResponse = resourceConverter.readDocument<T>(
+                rawResponse.body<ByteArray>(), T::class.java
+            )
 
             jsonApiResponse.get() ?: throw ApiException("Failed to parse response for $endpoint", Exception())
         } catch (e: ClientRequestException) {
             if (e.response.status == HttpStatusCode.Unauthorized) {
-                throw UnauthorizedException("Unauthorised action: $endpoint", e.response, e)
+                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)
         }
     }
 
-    protected suspend inline fun <reified T> fetchJsonApiResources(endpoint: String, queryParameters: Map<String, String> = emptyMap()): List<T> {
+    protected suspend inline fun <reified T> fetchJsonApiResources(
+        endpoint: String,
+        queryParameters: Map<String, String> = emptyMap(),
+        vararg includedClasses: Class<*>
+    ): List<T> {
         return try {
             val rawResponse = performGet(endpoint, queryParameters)
-            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java).apply {
+
+            val resourceConverter = ResourceConverter(getObjectMapper(), T::class.java, *includedClasses).apply {
                 enableSerializationOption(SerializationFeature.INCLUDE_RELATIONSHIP_ATTRIBUTES)
             }
-            val jsonApiResponse = resourceConverter.readDocumentCollection<T>(rawResponse.body<ByteArray>(), T::class.java)
+
+            val jsonApiResponse = resourceConverter.readDocumentCollection<T>(
+                rawResponse.body<ByteArray>(), T::class.java
+            )
 
             jsonApiResponse.get() ?: throw ApiException("Failed to parse response for $endpoint", Exception())
         } catch (e: ClientRequestException) {
             if (e.response.status == HttpStatusCode.Unauthorized) {
-                throw UnauthorizedException("Unauthorised action: $endpoint", e.response, e)
+                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)