feat: form schemas with raw JSON content associated with them

Author: jwilkinson87

src/main/kotlin/com/ctrlhub/core/Util.kt

@@ -0,0 +1,40 @@
+package com.ctrlhub.core
+
+import com.ctrlhub.core.api.response.CountsMeta
+import com.ctrlhub.core.api.response.OffsetsMeta
+import com.ctrlhub.core.api.response.PageMeta
+import com.ctrlhub.core.api.response.PaginationMeta
+import com.ctrlhub.core.api.response.RequestedMeta
+import kotlinx.serialization.json.*
+
+fun extractPaginationFromMeta(json: JsonObject): PaginationMeta {
+    val pagination = json["meta"]?.jsonObject?.get("pagination")?.jsonObject
+        ?: throw IllegalStateException("Missing pagination metadata")
+
+    val currentPage = pagination["current_page"]?.jsonPrimitive?.intOrNull ?: 1
+
+    val countsJson = pagination["counts"]?.jsonObject ?: JsonObject(emptyMap())
+    val counts = CountsMeta(
+        resources = countsJson["resources"]?.jsonPrimitive?.intOrNull ?: 0,
+        pages = countsJson["pages"]?.jsonPrimitive?.intOrNull ?: 1
+    )
+
+    val requestedJson = pagination["requested"]?.jsonObject ?: JsonObject(emptyMap())
+    val requested = RequestedMeta(
+        offset = requestedJson["offset"]?.jsonPrimitive?.intOrNull,
+        limit = requestedJson["limit"]?.jsonPrimitive?.intOrNull
+    )
+
+    val offsetsJson = pagination["offsets"]?.jsonObject ?: JsonObject(emptyMap())
+    val offsets = OffsetsMeta(
+        previous = offsetsJson["previous"]?.jsonPrimitive?.intOrNull,
+        next = offsetsJson["next"]?.jsonPrimitive?.intOrNull
+    )
+
+    return PaginationMeta(
+        page = PageMeta(currentPage = currentPage),
+        counts = counts,
+        requested = requested,
+        offsets = offsets
+    )
+}

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

@@ -2,26 +2,69 @@ package com.ctrlhub.core.datacapture
 
 import com.ctrlhub.core.api.response.PaginatedList
 import com.ctrlhub.core.datacapture.response.FormSchema
+import com.ctrlhub.core.extractPaginationFromMeta
 import com.ctrlhub.core.router.Router
 import com.ctrlhub.core.router.request.RequestParameters
 import io.ktor.client.HttpClient
+import io.ktor.client.call.body
+import kotlinx.serialization.json.*
 
-/**
- * A router that interacts with the form schemas realm of the Ctrl Hub API
- */
-class FormSchemasRouter(httpClient: HttpClient): Router(httpClient) {
-
-    /**
-     * Get all form schemas for a given form and organisation
-     *
-     * @param organisationId String The organisation ID to retrieve all for schemas for
-     * @param formId String The form ID to retrieve all schemas for
-     *
-     * @return A paginated response of all form schemas
-     */
-    suspend fun all(organisationId: String, formId: String, requestParameters: RequestParameters = RequestParameters()): PaginatedList<FormSchema> {
+class FormSchemasRouter(httpClient: HttpClient) : Router(httpClient) {
+
+    suspend fun all(
+        organisationId: String,
+        formId: String,
+        requestParameters: RequestParameters = RequestParameters()
+    ): PaginatedList<FormSchema> {
         val endpoint = "/v3/orgs/${organisationId}/data-capture/forms/{$formId}/schemas"
 
-        return fetchPaginatedJsonApiResources(endpoint, requestParameters.toMap(), FormSchema::class.java)
+        val response = performGet(endpoint, requestParameters.toMap())
+        val jsonContent = Json.parseToJsonElement(response.body<String>()).jsonObject
+
+        val dataArray = jsonContent["data"]?.jsonArray ?: JsonArray(emptyList())
+        val formSchemas = dataArray.mapNotNull { item ->
+            item.jsonObjectOrNull()?.let { instantiateFormSchemaFromJson(it) }
+        }
+
+        return PaginatedList(
+            data = formSchemas,
+            pagination = extractPaginationFromMeta(jsonContent)
+        )
     }
+
+    suspend fun one(
+        organisationId: String,
+        formId: String,
+        schemaId: String,
+        requestParameters: RequestParameters = RequestParameters()
+    ): FormSchema {
+        val endpoint = "/v3/orgs/$organisationId/data-capture/forms/$formId/schemas/$schemaId"
+
+        val response = performGet(endpoint, requestParameters.toMap())
+        val jsonContent = Json.parseToJsonElement(response.body<String>()).jsonObject
+
+        val dataObject = jsonContent["data"]?.jsonObject
+            ?: throw IllegalStateException("Missing data object")
+
+        return instantiateFormSchemaFromJson(dataObject)
+    }
+
+    private fun instantiateFormSchemaFromJson(json: JsonObject): FormSchema {
+        val id = json["id"]?.jsonPrimitive?.content
+            ?: throw IllegalStateException("Missing id")
+
+        val attributes = json["attributes"]?.jsonObject ?: JsonObject(emptyMap())
+        val model = attributes["model"]?.jsonObjectOrNull()
+        val views = attributes["views"]?.jsonObjectOrNull()
+
+        return FormSchema(
+            id = id,
+            modelConfig = model,
+            viewsConfig = views,
+            modelConfigStr = model?.toString() ?: "",
+            viewsConfigStr = views?.toString() ?: ""
+        )
+    }
+
+    private fun JsonElement.jsonObjectOrNull(): JsonObject? = this as? JsonObject
 }

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

@@ -1,22 +1,14 @@
 package com.ctrlhub.core.datacapture.response
 
-import com.fasterxml.jackson.annotation.JsonCreator
-import com.fasterxml.jackson.annotation.JsonProperty
-import com.fasterxml.jackson.databind.JsonNode
-import com.github.jasminb.jsonapi.StringIdHandler
-import com.github.jasminb.jsonapi.annotations.Id
 import com.github.jasminb.jsonapi.annotations.Type
+import kotlinx.serialization.json.JsonObject
 
 @Type("form-schemas")
-data class FormSchema @JsonCreator constructor(
-    @Id(StringIdHandler::class) val id: String = "",
-
-    @JsonProperty("model")
-    private val modelNode: JsonNode,
-
-    @JsonProperty("views")
-    private val viewsNode: JsonNode?
-) {
-    val model: String = modelNode.toString()
-    val views: String? = viewsNode?.toString()
-}
+data class FormSchema (
+    val id: String,
+    val modelConfigStr: String,
+    val viewsConfigStr: String,
+
+    val modelConfig: JsonObject?,
+    val viewsConfig: JsonObject?,
+)

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

@@ -43,7 +43,8 @@ class FormSchemasRouterTest {
             assertEquals(1, response.data.size)
             val formSchema = response.data[0]
             assertEquals("1.0.0", formSchema.id)
-            assertTrue(formSchema.model.contains("properties"))
+            assertTrue(formSchema.modelConfigStr.isNotEmpty())
+            assertTrue(formSchema.viewsConfigStr.isNotEmpty())
         }
     }
 }

src/test/resources/datacapture/all-form-schemas-response.json

@@ -16,7 +16,9 @@
           },
           "type": "object"
         },
-        "views": null
+        "views": {
+          "test": true
+        }
       },
       "relationships": {
         "form": {