task: implement iam router with new test

jwilkinson87 · jwilkinson87 · commit 3ce509f57bda · 2025-01-08T15:30:12.000Z
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -9,6 +9,10 @@ version = "1.0-SNAPSHOT"
 
 repositories {
     mavenCentral()
+
+    maven {
+        url = uri("https://maven.scijava.org/content/repositories/public/")
+    }
 }
 
 dependencies {
@@ -18,6 +22,7 @@ dependencies {
     implementation(libs.ktor.serialization.kotlinx.json)
     implementation(libs.ktor.client.content.negotiation)
     implementation(libs.jetbrains.kotlinx.serialization.json)
+    implementation(libs.jsonapi.converter)
 
     testImplementation(kotlin("test"))
     testImplementation(libs.mockk)
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -3,6 +3,7 @@ kotlin = "2.0.21"
 ktor = "3.0.3"
 kotlinSerialization = "1.7.3"
 mockk = "1.9.3"
+jsonapi = "0.14"
 
 [libraries]
 ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
@@ -12,4 +13,5 @@ ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx
 ktor-client-mock = { module = "io.ktor:ktor-client-mock", version.ref = "ktor" }
 kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }
 jetbrains-kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinSerialization" }
-mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
+mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
+jsonapi-converter = { module = "com.github.jasminb:jsonapi-converter", version.ref = "jsonapi" }
diff --git a/src/main/kotlin/com/ctrlhub/core/Api.kt b/src/main/kotlin/com/ctrlhub/core/Api.kt
@@ -2,9 +2,11 @@ package com.ctrlhub.core
 
 import com.ctrlhub.core.api.KtorApiClient
 import com.ctrlhub.core.auth.AuthRouter
+import com.ctrlhub.core.iam.IamRouter
 
 class Api private constructor(apiClient: KtorApiClient) {
     val auth: AuthRouter = AuthRouter(apiClient)
+    val iam: IamRouter = IamRouter(apiClient)
 
     companion object {
         fun create(): Api {
diff --git a/src/main/kotlin/com/ctrlhub/core/api/ApiException.kt b/src/main/kotlin/com/ctrlhub/core/api/ApiException.kt
@@ -1,6 +1,6 @@
 package com.ctrlhub.core.api
 
-import io.ktor.client.statement.HttpResponse
+import io.ktor.client.statement.*
 
 open class ApiException(message: String, e: Throwable) : Exception(message, e)
 
diff --git a/src/main/kotlin/com/ctrlhub/core/api/KtorApiClient.kt b/src/main/kotlin/com/ctrlhub/core/api/KtorApiClient.kt
@@ -6,9 +6,9 @@ import io.ktor.client.plugins.*
 import io.ktor.client.plugins.contentnegotiation.*
 import io.ktor.client.request.*
 import io.ktor.client.statement.*
-import io.ktor.http.HttpHeaders
+import io.ktor.http.*
 import io.ktor.serialization.kotlinx.json.*
-import io.ktor.util.appendIfNameAbsent
+import io.ktor.util.*
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
 
diff --git a/src/main/kotlin/com/ctrlhub/core/auth/AuthRouter.kt b/src/main/kotlin/com/ctrlhub/core/auth/AuthRouter.kt
@@ -8,9 +8,9 @@ import com.ctrlhub.core.auth.payload.LoginPayload
 import com.ctrlhub.core.auth.response.AuthFlowResponse
 import com.ctrlhub.core.auth.response.CompleteResponse
 import com.ctrlhub.core.router.Router
-import io.ktor.client.call.body
-import io.ktor.client.plugins.ClientRequestException
-import io.ktor.http.HttpStatusCode
+import io.ktor.client.call.*
+import io.ktor.client.plugins.*
+import io.ktor.http.*
 
 class AuthRouter(apiClient: KtorApiClient) : Router(apiClient = apiClient) {
     suspend fun initiate(): AuthFlowResponse {
diff --git a/src/main/kotlin/com/ctrlhub/core/iam/IamRouter.kt b/src/main/kotlin/com/ctrlhub/core/iam/IamRouter.kt
@@ -0,0 +1,27 @@
+package com.ctrlhub.core.iam
+
+import com.ctrlhub.core.api.ApiClientException
+import com.ctrlhub.core.api.ApiException
+import com.ctrlhub.core.api.KtorApiClient
+import com.ctrlhub.core.iam.response.User
+import com.ctrlhub.core.router.Router
+import com.github.jasminb.jsonapi.ResourceConverter
+import io.ktor.client.call.*
+import io.ktor.client.plugins.*
+
+class IamRouter(apiClient: KtorApiClient) : Router(apiClient) {
+
+    suspend fun whoami(sessionToken: String): User {
+        return try {
+            val rawResponse = apiClient.get("/v3/iam/whoami", mapOf("X-Session-Token" to sessionToken))
+            val resourceConverter = ResourceConverter(User::class.java)
+            val jsonApiResponse = resourceConverter.readDocument<User>(rawResponse.body<ByteArray>(), User::class.java)
+
+            jsonApiResponse.get()!!
+        } catch (e: ClientRequestException) {
+            throw ApiClientException("Whoami request failed", e.response, e)
+        } catch (e: Exception) {
+            throw ApiException("Whoami request failed", e)
+        }
+    }
+}
diff --git a/src/main/kotlin/com/ctrlhub/core/iam/response/WhoamiResponse.kt b/src/main/kotlin/com/ctrlhub/core/iam/response/WhoamiResponse.kt
@@ -0,0 +1,70 @@
+package com.ctrlhub.core.iam.response
+
+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 {
+    @Id(StringIdHandler::class)
+    lateinit var id: String
+    lateinit var email: String
+    lateinit var profile: Profile
+    lateinit var identities: List<Identity>
+}
+
+class Identity {
+    val platform: String? = null
+    val id: String? = null
+    val meta: IdentityMeta? = null
+}
+
+class IdentityMeta {
+    @JsonProperty("organisation_id") val organisationId: String? = null
+}
+
+class Profile {
+    lateinit var address: ProfileAddress
+    lateinit var contact: ProfileContact
+    lateinit var personal: ProfilePersonal
+    lateinit var settings: ProfileSettings
+    lateinit var work: ProfileWork
+}
+
+class ProfileAddress {
+    lateinit var area: String
+    @JsonProperty("country_code") lateinit var countryCode: String
+    lateinit var county: String
+    lateinit var name: String
+    lateinit var number: String
+    lateinit var postcode: String
+    lateinit var street: String
+    lateinit var town: String
+    lateinit var what3words: String
+}
+
+class ProfileContact {
+    lateinit var landline: String
+    lateinit var mobile: String
+}
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+class ProfilePersonal {
+    lateinit var dob: String
+    @JsonProperty("first_name") lateinit var firstName: String
+    @JsonProperty("last_name") lateinit var lastName: String
+}
+
+class ProfileSettings {
+    @JsonProperty("preferred_language") lateinit var preferredLanguage: String
+    lateinit var timezone: String
+}
+
+class ProfileWork {
+    lateinit var cscs: String
+    lateinit var eusr: String
+    lateinit var occupation: String
+    @JsonProperty("start_date") lateinit var startDate: String
+}
diff --git a/src/main/kotlin/com/ctrlhub/core/router/Router.kt b/src/main/kotlin/com/ctrlhub/core/router/Router.kt
@@ -1,6 +1,5 @@
 package com.ctrlhub.core.router
 
-import com.ctrlhub.core.Config
 import com.ctrlhub.core.api.KtorApiClient
 
 abstract class Router(val apiClient: KtorApiClient)
diff --git a/src/main/kotlin/com/ctrlhub/core/serializer/LocalDateSerializer.kt b/src/main/kotlin/com/ctrlhub/core/serializer/LocalDateSerializer.kt
@@ -0,0 +1,32 @@
+package com.ctrlhub.core.serializer
+
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializer
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+
+@Serializer(forClass = LocalDate::class)
+class LocalDateSerializer : KSerializer<LocalDate?> {
+    private val formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd")
+
+    @OptIn(ExperimentalSerializationApi::class)
+    override fun serialize(encoder: Encoder, value: LocalDate?) {
+        if (value == null) {
+            encoder.encodeNull()
+        } else {
+            encoder.encodeString(value.format(formatter))
+        }
+    }
+
+    override fun deserialize(decoder: Decoder): LocalDate? {
+        val stringValue = decoder.decodeString()
+        return if (stringValue.isEmpty()) {
+            null
+        } else {
+            LocalDate.parse(stringValue, formatter)
+        }
+    }
+}
diff --git a/src/test/kotlin/com/ctrlhub/core/auth/AuthRouterTest.kt b/src/test/kotlin/com/ctrlhub/core/auth/AuthRouterTest.kt
@@ -1,32 +1,31 @@
-package com.ctrlhub.core.router
+package com.ctrlhub.core.auth
 
 import com.ctrlhub.core.api.ApiException
 import com.ctrlhub.core.api.KtorApiClient
 import com.ctrlhub.core.auth.payload.LoginPayload
-import com.ctrlhub.core.auth.AuthRouter
 import io.ktor.client.*
 import io.ktor.client.engine.mock.*
 import io.ktor.http.*
 import io.ktor.utils.io.*
 import kotlinx.coroutines.runBlocking
-import kotlin.test.Test
+import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFailsWith
 
 class AuthRouterTest {
 
     @Test
     fun `test initiate auth success`() {
-        val mockEngine = MockEngine { request ->
+        val mockEngine = MockEngine.Companion { request ->
             respond(
                 content = ByteReadChannel("""{"id": "test-123"}"""),
-                status = HttpStatusCode.OK,
+                status = HttpStatusCode.Companion.OK,
                 headers = headersOf(HttpHeaders.ContentType, "application/json")
             )
         }
 
         val authRouter = AuthRouter(
-            apiClient = KtorApiClient.create(HttpClient(mockEngine))
+            apiClient = KtorApiClient.Companion.create(HttpClient(mockEngine))
         )
 
         runBlocking {
@@ -37,16 +36,16 @@ class AuthRouterTest {
 
     @Test
     fun `test exception thrown when auth initiate fails`() {
-        val mockEngine = MockEngine { request ->
+        val mockEngine = MockEngine.Companion { request ->
             respond(
                 content = ByteReadChannel("""{}"""),
-                status = HttpStatusCode.InternalServerError,
+                status = HttpStatusCode.Companion.InternalServerError,
                 headers = headersOf(HttpHeaders.ContentType, "application/json")
             )
         }
 
         val authRouter = AuthRouter(
-            apiClient = KtorApiClient.create(HttpClient(mockEngine))
+            apiClient = KtorApiClient.Companion.create(HttpClient(mockEngine))
         )
 
         runBlocking {
@@ -58,24 +57,26 @@ class AuthRouterTest {
 
     @Test
     fun `test can complete auth successfully`() {
-        val mockEngine = MockEngine { request ->
+        val mockEngine = MockEngine.Companion { request ->
             respond(
                 content = ByteReadChannel("""{"session_token": "ses-123"}"""),
-                status = HttpStatusCode.OK,
+                status = HttpStatusCode.Companion.OK,
                 headers = headersOf(HttpHeaders.ContentType, "application/json")
             )
         }
 
         val authRouter = AuthRouter(
-            apiClient = KtorApiClient.create(HttpClient(mockEngine))
+            apiClient = KtorApiClient.Companion.create(HttpClient(mockEngine))
         )
 
         runBlocking {
-            val response = authRouter.complete("test-123", LoginPayload(
-                identifier = "test@example.com",
-                password = "password",
-                method = "password"
-            ))
+            val response = authRouter.complete(
+                "test-123", LoginPayload(
+                    identifier = "test@example.com",
+                    password = "password",
+                    method = "password"
+                )
+            )
 
             assertEquals("ses-123", response.sessionToken)
         }
diff --git a/src/test/kotlin/com/ctrlhub/core/iam/IamRouterTest.kt b/src/test/kotlin/com/ctrlhub/core/iam/IamRouterTest.kt
@@ -0,0 +1,43 @@
+package com.ctrlhub.core.iam
+
+import com.ctrlhub.core.api.KtorApiClient
+import com.ctrlhub.core.iam.response.User
+import io.ktor.client.*
+import io.ktor.client.engine.mock.*
+import io.ktor.http.*
+import kotlinx.coroutines.runBlocking
+import java.nio.file.Files
+import java.nio.file.Paths
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertIs
+
+class IamRouterTest {
+
+    @Test
+    fun `test retrieve whoami user`() {
+        val jsonFilePath = Paths.get("src/test/resources/iam/whoami-response.json")
+        val jsonContent = Files.readString(jsonFilePath)
+
+        val mockEngine = MockEngine.Companion { request ->
+            respond(
+                content = jsonContent,
+                status = HttpStatusCode.OK,
+                headers = headersOf(HttpHeaders.ContentType, "application/json")
+            )
+        }
+
+        val iamRouter = IamRouter(
+            apiClient = KtorApiClient.create(HttpClient(mockEngine))
+        )
+
+        runBlocking {
+            val response = iamRouter.whoami(sessionToken = "test-token")
+            assertIs<User>(response)
+            assertEquals("00000000-0000-0000-0000-000000000000", response.id)
+            assertEquals("user@example.com", response.email)
+            assertEquals("Test", response.profile.personal.firstName)
+            assertEquals("User", response.profile.personal.lastName)
+        }
+    }
+}
diff --git a/src/test/resources/iam/whoami-response.json b/src/test/resources/iam/whoami-response.json
