feat: support data capture forms endpoint

Author: jwilkinson87

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

@@ -0,0 +1,19 @@
+package com.ctrlhub.core.datacapture
+
+import com.ctrlhub.core.Api
+import com.ctrlhub.core.datacapture.response.Form
+import com.ctrlhub.core.router.Router
+import io.ktor.client.HttpClient
+
+class FormsRouter(httpClient: HttpClient) : Router(httpClient) {
+    suspend fun all(organisationId: String): List<Form> {
+        return fetchJsonApiResources("/v3/orgs/${organisationId}/data-capture/forms", emptyMap(), Form::class.java)
+    }
+
+    suspend fun one(organisationId: String, formId: String): Form {
+        return fetchJsonApiResource("/v3/orgs/${organisationId}/data-capture-forms/${formId}")
+    }
+}
+
+val Api.forms: FormsRouter
+    get() = FormsRouter(httpClient)

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

@@ -0,0 +1,32 @@
+package com.ctrlhub.core.datacapture.response
+
+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.Meta
+import com.github.jasminb.jsonapi.annotations.Type
+import java.time.LocalDateTime
+
+@Type("forms")
+@JsonIgnoreProperties(ignoreUnknown = true)
+class Form @JsonCreator constructor(
+    @Id(StringIdHandler::class) var id: String = "",
+    @JsonProperty("name") var name: String = "",
+    @JsonProperty("status") var status: String = "",
+    @Meta
+    var meta: FormMeta? = null
+) {
+    constructor(): this(
+        id = "",
+        name = "",
+        status = ""
+    )
+}
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class FormMeta @JsonCreator constructor(
+    @JsonProperty("created_at") var createdAt: LocalDateTime,
+    @JsonProperty("updated_at") var updatedAt: LocalDateTime
+)

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

@@ -0,0 +1,46 @@
+package com.ctrlhub.core.datacapture
+
+import com.ctrlhub.core.configureForTest
+import io.ktor.client.HttpClient
+import io.ktor.client.engine.mock.MockEngine
+import io.ktor.client.engine.mock.respond
+import io.ktor.http.HttpHeaders
+import io.ktor.http.HttpStatusCode
+import io.ktor.http.headersOf
+import io.ktor.utils.io.ByteReadChannel
+import kotlinx.coroutines.runBlocking
+import java.nio.file.Files
+import java.nio.file.Paths
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class FormsRouterTest {
+
+    @Test
+    fun `test can get all forms successfully`() {
+        // Load mocked JSON response
+        val jsonFilePath = Paths.get("src/test/resources/datacapture/all-forms-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        // Create a mock engine to intercept HTTP calls
+        val mockEngine = MockEngine { request ->
+            respond(
+                content = ByteReadChannel(jsonContent),
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val formsRouter = FormsRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val organisationId = "test-org-id"
+            val response = formsRouter.all(organisationId)
+
+            // Assuming the mock response includes 1 form as in your earlier example
+            assertEquals(1, response.size)
+            assertEquals("Form 3", response[0].name)
+            assertEquals("active", response[0].status)
+        }
+    }
+}

src/test/resources/datacapture/all-forms-response.json

@@ -0,0 +1,43 @@
+{
+  "data": [
+    {
+      "id": "2fa82b8b-6fc3-4c0b-8e47-196b3b67f3b9",
+      "type": "forms",
+      "attributes": {
+        "description": "...",
+        "name": "Form 3",
+        "status": "active"
+      },
+      "relationships": {
+        "categories": {
+          "data": [
+            {
+              "id": "0f99ec15-9172-4994-bb5a-ff22e0185a47",
+              "type": "form-categories"
+            }
+          ]
+        },
+        "organisation": {
+          "data": {
+            "id": "705adf65-e1cf-4b45-97b0-f3d055245b56",
+            "type": "organisations"
+          }
+        },
+        "schemas": {
+          "data": []
+        }
+      },
+      "meta": {
+        "created_at": "2025-05-07T07:31:52.473Z",
+        "updated_at": "2025-05-12T11:49:20.536Z",
+        "counts": {
+          "schemas": 0,
+          "categories": 1
+        }
+      }
+    }
+  ],
+  "jsonapi": {
+    "version": "1.0"
+  }
+}