feat: support creating a form submission

Author: jwilkinson87

src/main/kotlin/com/ctrlhub/core/assets/equipment/exposures/EquipmentExposuresRouter.kt

@@ -9,6 +9,7 @@ import com.ctrlhub.core.router.request.FilterOption
 import com.ctrlhub.core.router.request.JsonApiIncludes
 import com.ctrlhub.core.router.request.RequestParametersWithIncludes
 import io.ktor.client.HttpClient
+import io.ktor.http.ContentType
 
 enum class EquipmentExposureIncludes(val value: String) : JsonApiIncludes {
     Equipment("equipment"),
@@ -92,6 +93,7 @@ class EquipmentExposuresRouter(httpClient: HttpClient) : Router(httpClient) {
         val request = EquipmentExposureRequestParameters()
         return postJsonApiResource(
             "/v3/orgs/$organisationId/assets/equipment/$equipmentId/exposures", resource, request.toMap(),
+            contentType = ContentType.Application.Json,
             EquipmentItem::class.java
         )
     }

src/main/kotlin/com/ctrlhub/core/datacapture/FormSubmissionsRouter.kt

@@ -0,0 +1,25 @@
+package com.ctrlhub.core.datacapture
+
+import com.ctrlhub.core.Api
+import com.ctrlhub.core.datacapture.resource.FormSubmissionVersion
+import com.ctrlhub.core.datacapture.response.FormSchema
+import com.ctrlhub.core.router.Router
+import io.ktor.client.HttpClient
+import io.ktor.http.ContentType
+
+class FormSubmissionsRouter(httpClient: HttpClient) : Router(httpClient) {
+    suspend fun create(organisationId: String, formId: String, schemaId: String, payload: Map<String, Any>): FormSubmissionVersion {
+        return postJsonApiResource("/v3/orgs/$organisationId/data-capture/forms/$formId/submissions", requestBody = FormSubmissionVersion(
+            payload = payload,
+            id = "",
+            schema = FormSchema(
+                id = schemaId,
+                rawSchema = null,
+            )
+        ), queryParameters = emptyMap(), contentType = ContentType.parse("application/vnd.api+json"), FormSubmissionVersion::class.java,
+            FormSchema::class.java)
+    }
+}
+
+val Api.formSubmissions
+    get() = FormSubmissionsRouter(httpClient = httpClient)

src/main/kotlin/com/ctrlhub/core/datacapture/resource/FormSubmissionVersion.kt

@@ -0,0 +1,26 @@
+package com.ctrlhub.core.datacapture.resource
+
+import com.ctrlhub.core.datacapture.response.FormSchema
+import com.fasterxml.jackson.annotation.JsonCreator
+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.Relationship
+import com.github.jasminb.jsonapi.annotations.Type
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+@Type("form-submission-versions")
+data class FormSubmissionVersion @JsonCreator constructor(
+    @Id(StringIdHandler::class)
+    var id: String = "",
+
+    @JsonProperty("payload")
+    var payload: Map<String, Any>? = null,
+
+    @JsonProperty("iteration")
+    var iteration: Int = 0,
+
+    @Relationship("schema")
+    var schema: FormSchema? = null,
+)

src/main/kotlin/com/ctrlhub/core/datacapture/response/FormSchema.kt

@@ -4,12 +4,15 @@ import com.fasterxml.jackson.annotation.JsonCreator
 import com.fasterxml.jackson.annotation.JsonIgnore
 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.Meta
 import com.github.jasminb.jsonapi.annotations.Type
 import java.time.LocalDateTime
 
 @Type("form-schemas")
 data class FormSchema(
+    @Id(StringIdHandler::class)
     val id: String? = null,
     @JsonIgnore val rawSchema: String? = null,
     @Meta

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

@@ -38,10 +38,11 @@ abstract class Router(val httpClient: HttpClient) {
     protected suspend inline fun <reified T> performPost(
         endpoint: String,
         body: T,
-        queryParameters: Map<String, String> = emptyMap()
+        queryParameters: Map<String, String> = emptyMap(),
+        contentType: ContentType = ContentType.Application.Json
     ): HttpResponse {
         return httpClient.post(endpoint) {
-            contentType(ContentType.Application.Json)
+            contentType(contentType)
             url {
                 queryParameters.forEach { key, value -> parameters.append(key, value) }
             }
@@ -188,6 +189,7 @@ abstract class Router(val httpClient: HttpClient) {
         endpoint: String,
         requestBody: T,
         queryParameters: Map<String, String> = emptyMap(),
+        contentType: ContentType = ContentType.Application.Json,
         vararg includedClasses: Class<*>
     ): T {
         return try {
@@ -201,6 +203,7 @@ abstract class Router(val httpClient: HttpClient) {
             val response: HttpResponse = performPost(
                 endpoint = endpoint,
                 body = jsonApiRequest,
+                contentType = contentType,
                 queryParameters = queryParameters
             )
 

src/test/kotlin/com/ctrlhub/core/datacapture/FormSubmissionsRouterTest.kt

@@ -0,0 +1,45 @@
+package com.ctrlhub.core.datacapture
+
+import com.ctrlhub.core.configureForTest
+import com.ctrlhub.core.datacapture.resource.FormSubmissionVersion
+import io.ktor.client.*
+import io.ktor.client.engine.mock.*
+import io.ktor.http.*
+import kotlinx.coroutines.runBlocking
+import org.junit.jupiter.api.Test
+import java.nio.file.Files
+import java.nio.file.Paths
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+import kotlin.test.assertIs
+
+class FormSubmissionsRouterTest {
+
+    @Test
+    fun `can create form submission`() {
+        val jsonFilePath = Paths.get("src/test/resources/datacapture/form-submission-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine { request ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.Created,
+                headers = headersOf(HttpHeaders.ContentType, "application/vnd.api+json")
+            )
+        }
+
+        val formSubmissionsRouter = FormSubmissionsRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val result = formSubmissionsRouter.create(
+                organisationId = "org-123",
+                formId = "form-456",
+                schemaId = "schema-789",
+                payload = mapOf("Test" to "value")
+            )
+
+            assertIs<FormSubmissionVersion>(result)
+            assertNotNull(result.id)
+        }
+    }
+}

src/test/resources/datacapture/form-submission-response.json

@@ -0,0 +1,19 @@
+{
+  "data": {
+    "type": "form-submission-versions",
+    "id": "submission-123",
+    "attributes": {
+      "payload": {
+        "Test": "value"
+      }
+    },
+    "relationships": {
+      "schema": {
+        "data": {
+          "type": "form-schema",
+          "id": "schema-789"
+        }
+      }
+    }
+  }
+}