feat: Enhance TimeBand router to support organisation-specific endpoints and add tests

Author: jwilkinson87

src/main/kotlin/com/ctrlhub/core/settings/timebands/TimeBandsRouter.kt

@@ -20,10 +20,11 @@ class TimeBandsRouter(httpClient: HttpClient) : Router(httpClient) {
      * @return A list of all time bands
      */
     suspend fun all(
+        organisationId: String,
         requestParameters: TimeBandsRequestParameters = TimeBandsRequestParameters()
-    ): java.util.List<TimeBand> {
-        val endpoint = "/settings/time-bands"
-        return fetchJsonApiResource(endpoint, requestParameters.toMap())
+    ): List<TimeBand> {
+        val endpoint = "/orgs/$organisationId/settings/time-bands"
+        return fetchJsonApiResources(endpoint, requestParameters.toMap())
     }
 
     /**
@@ -33,10 +34,11 @@ class TimeBandsRouter(httpClient: HttpClient) : Router(httpClient) {
      * @return The time band with the given ID
      */
     suspend fun one(
+        organisationId: String,
         timeBandId: String,
         requestParameters: TimeBandsRequestParameters = TimeBandsRequestParameters()
     ): TimeBand {
-        val endpoint = "/settings/time-bands/$timeBandId"
+        val endpoint = "/orgs/$organisationId/settings/time-bands/$timeBandId"
         return fetchJsonApiResource(endpoint, requestParameters.toMap(), TimeBand::class.java)
     }
 }

src/main/kotlin/com/ctrlhub/core/settings/timebands/response/TimeBand.kt

@@ -3,14 +3,15 @@ package com.ctrlhub.core.settings.timebands.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
 
 @Type("time-bands")
 @JsonIgnoreProperties(ignoreUnknown = true)
 data class TimeBand @JsonCreator constructor(
-    @Id var id: String = "",
+    @Id(StringIdHandler::class) var id: String = "",
     @JsonProperty("end") var end: String = "",
     @JsonProperty("name") var name: String = "",
     @JsonProperty("start") var start: String = "",

src/test/kotlin/com/ctrlhub/core/settings/timebands/TimeBandsRouterTest.kt

@@ -0,0 +1,63 @@
+package com.ctrlhub.core.settings.timebands
+
+import com.ctrlhub.core.configureForTest
+import com.ctrlhub.core.settings.timebands.response.TimeBand
+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.assertIs
+import kotlin.test.assertNotNull
+
+class TimeBandsRouterTest {
+    @Test
+    fun `can retrieve all time bands`() {
+        val jsonFilePath = Paths.get("src/test/resources/settings/time-bands/all-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine { request ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val router = TimeBandsRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val response = router.all("org-123")
+            assertIs<java.util.List<TimeBand>>(response)
+            assertEquals(3, response.size)
+            assertNotNull(response[0].id)
+            assertNotNull(response[0].name)
+        }
+    }
+
+    @Test
+    fun `can retrieve a single time band`() {
+        val jsonFilePath = Paths.get("src/test/resources/settings/time-bands/one-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine { request ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val router = TimeBandsRouter(httpClient = HttpClient(mockEngine).configureForTest())
+
+        runBlocking {
+            val response = router.one("org-123", "b1a1a111-1111-1111-1111-111111111111")
+            assertIs<TimeBand>(response)
+            assertEquals("b1a1a111-1111-1111-1111-111111111111", response.id)
+            assertNotNull(response.name)
+        }
+    }
+}

src/test/resources/settings/time-bands/all-response.json

@@ -0,0 +1,50 @@
+{
+  "data": [
+    {
+      "id": "b1a1a111-1111-1111-1111-111111111111",
+      "type": "time-bands",
+      "attributes": {
+        "end": "11:00+0000",
+        "name": "Lorem",
+        "start": "07:00+0000"
+      },
+      "meta": {
+        "created_at": "2025-01-01T00:00:00.000Z",
+        "updated_at": "2025-01-01T00:00:00.000Z",
+        "modified_at": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": "b2a2a222-2222-2222-2222-222222222222",
+      "type": "time-bands",
+      "attributes": {
+        "end": "15:00+0000",
+        "name": "Ipsum",
+        "start": "11:00+0000"
+      },
+      "meta": {
+        "created_at": "2025-01-01T00:00:00.000Z",
+        "updated_at": "2025-01-01T00:00:00.000Z",
+        "modified_at": "2025-01-01T00:00:00.000Z"
+      }
+    },
+    {
+      "id": "b3a3a333-3333-3333-3333-333333333333",
+      "type": "time-bands",
+      "attributes": {
+        "end": "07:00+0000",
+        "name": "Dolor",
+        "start": "15:00+0000"
+      },
+      "meta": {
+        "created_at": "2025-01-01T00:00:00.000Z",
+        "updated_at": "2025-01-01T00:00:00.000Z",
+        "modified_at": "2025-01-01T00:00:00.000Z"
+      }
+    }
+  ],
+  "jsonapi": {
+    "version": "1.0"
+  }
+}
+

src/test/resources/settings/time-bands/one-response.json

@@ -0,0 +1,20 @@
+{
+  "data": {
+    "id": "b1a1a111-1111-1111-1111-111111111111",
+    "type": "time-bands",
+    "attributes": {
+      "end": "11:00+0000",
+      "name": "Lorem",
+      "start": "07:00+0000"
+    },
+    "meta": {
+      "created_at": "2025-01-01T00:00:00.000Z",
+      "updated_at": "2025-01-01T00:00:00.000Z",
+      "modified_at": "2025-01-01T00:00:00.000Z"
+    }
+  },
+  "jsonapi": {
+    "version": "1.0"
+  }
+}
+