refactor: Add ExistingResource base class

Author: SMadani

CHANGELOG.md

@@ -4,11 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.0-beta1] - 2024-09-??
+## [1.0.0-beta1] - 2024-09-02
 
 ### Added
 - Video API
 
+### Changed
+- Standardised `Existing*` classes to extend `ExistingResource` for consistency
+
 ## [0.9.0] - 2024-08-19
 
 ### Added

src/main/kotlin/com/vonage/client/kt/Application.kt

@@ -30,7 +30,7 @@ class Application internal constructor(private val client: ApplicationClient) {
 
     fun application(applicationId: UUID) = application(applicationId.toString())
 
-    inner class ExistingApplication internal constructor(val id: String) {
+    inner class ExistingApplication internal constructor(id: String): ExistingResource(id) {
         fun get(): Application = client.getApplication(id)
 
         fun update(properties: Application.Builder.() -> Unit): Application =

src/main/kotlin/com/vonage/client/kt/ExistingResource.kt

@@ -0,0 +1,35 @@
+/*
+ *   Copyright 2024 Vonage
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+package com.vonage.client.kt
+
+open class ExistingResource internal constructor(val id: String) {
+
+    @Override
+    override fun toString(): String = "${this::class.qualifiedName} {id=$id}"
+
+    @Override
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+        other as ExistingResource
+        return id == other.id
+    }
+
+    @Override
+    override fun hashCode(): Int {
+        return id.hashCode()
+    }
+}

src/main/kotlin/com/vonage/client/kt/Subaccounts.kt

@@ -33,15 +33,15 @@ class Subaccounts internal constructor(private val client: SubaccountsClient) {
 
     fun subaccount(subaccountKey: String): ExistingSubaccount = ExistingSubaccount(subaccountKey)
 
-    inner class ExistingSubaccount internal constructor(val key: String) {
+    inner class ExistingSubaccount internal constructor(key: String): ExistingResource(key) {
 
-        fun get(): Account = client.getSubaccount(key)
+        fun get(): Account = client.getSubaccount(id)
 
         fun suspended(suspend: Boolean): Account =
-            client.updateSubaccount(UpdateSubaccountRequest.builder(key).suspended(suspend).build())
+            client.updateSubaccount(UpdateSubaccountRequest.builder(id).suspended(suspend).build())
 
         fun update(name: String? = null, usePrimaryAccountBalance: Boolean? = null): Account {
-            val builder = UpdateSubaccountRequest.builder(key).name(name)
+            val builder = UpdateSubaccountRequest.builder(id).name(name)
             if (usePrimaryAccountBalance != null) {
                 builder.usePrimaryAccountBalance(usePrimaryAccountBalance)
             }

src/main/kotlin/com/vonage/client/kt/Users.kt

@@ -23,26 +23,13 @@ class Users internal constructor(private val client: UsersClient) {
 
     fun user(user: BaseUser): ExistingUser = ExistingUser(user.id)
 
-    inner class ExistingUser internal constructor(val id: String) {
+    inner class ExistingUser internal constructor(id: String): ExistingResource(id) {
         fun get(): User = client.getUser(id)
 
         fun update(properties: User.Builder.() -> Unit): User =
             client.updateUser(id, User.builder().apply(properties).build())
 
         fun delete(): Unit = client.deleteUser(id)
-
-        @Override
-        override fun equals(other: Any?): Boolean {
-            if (this === other) return true
-            if (javaClass != other?.javaClass) return false
-            other as ExistingUser
-            return id == other.id
-        }
-
-        @Override
-        override fun hashCode(): Int {
-            return id.hashCode()
-        }
     }
 
     fun create(properties: User.Builder.() -> Unit): User =

src/main/kotlin/com/vonage/client/kt/Verify.kt

@@ -27,14 +27,14 @@ class Verify(private val client: Verify2Client) {
         VerificationRequest.builder().brand(brand).apply(init).build()
     )
 
-    inner class ExistingRequest internal constructor(val id: UUID) {
+    inner class ExistingRequest internal constructor(private val uuid: UUID): ExistingResource(uuid.toString()) {
 
-        fun cancel(): Unit = client.cancelVerification(id)
+        fun cancel(): Unit = client.cancelVerification(uuid)
 
-        fun nextWorkflow(): Unit = client.nextWorkflow(id)
+        fun nextWorkflow(): Unit = client.nextWorkflow(uuid)
 
         fun checkVerificationCode(code: String): VerifyCodeResponse =
-            client.checkVerificationCode(id, code)
+            client.checkVerificationCode(uuid, code)
 
         fun isValidVerificationCode(code: String): Boolean {
             try {

src/main/kotlin/com/vonage/client/kt/VerifyLegacy.kt

@@ -32,7 +32,7 @@ class VerifyLegacy internal constructor(private val client: VerifyClient) {
 
     fun request(response: VerifyResponse): ExistingRequest = request(response.requestId)
 
-    inner class ExistingRequest internal constructor(val id: String) {
+    inner class ExistingRequest internal constructor(id: String): ExistingResource(id) {
 
         fun cancel(): ControlResponse = client.cancelVerification(id)
 
@@ -42,18 +42,6 @@ class VerifyLegacy internal constructor(private val client: VerifyClient) {
 
         fun search(): SearchVerifyResponse = client.search(id)
 
-        @Override
-        override fun equals(other: Any?): Boolean {
-            if (this === other) return true
-            if (javaClass != other?.javaClass) return false
-            other as ExistingRequest
-            return id == other.id
-        }
-
-        @Override
-        override fun hashCode(): Int {
-            return id.hashCode()
-        }
     }
 
 }

src/main/kotlin/com/vonage/client/kt/Video.kt

@@ -25,25 +25,25 @@ class Video(private val client: VideoClient) {
 
     fun session(sessionId: String): ExistingSession = ExistingSession(sessionId)
 
-    inner class ExistingSession internal constructor(val id: String) {
+    inner class ExistingSession internal constructor(id: String): ExistingResource(id) {
 
         fun stream(streamId: String): ExistingStream = ExistingStream(streamId)
 
-        inner class ExistingStream internal constructor(val streamId: String) {
+        inner class ExistingStream internal constructor(id: String): ExistingResource(id) {
 
-            fun info(): GetStreamResponse = client.getStream(id, streamId)
+            fun info(): GetStreamResponse = client.getStream(this@ExistingSession.id, id)
 
-            fun mute(): Unit = client.muteStream(id, streamId)
+            fun mute(): Unit = client.muteStream(this@ExistingSession.id, id)
 
             fun setLayout(vararg layoutClasses: String): Unit =
-                client.setStreamLayout(id,
-                    SessionStream.builder(streamId).layoutClassList(layoutClasses.toList()).build()
+                client.setStreamLayout(this@ExistingSession.id,
+                    SessionStream.builder(id).layoutClassList(layoutClasses.toList()).build()
                 )
         }
 
         fun connection(connectionId: String): ExistingConnection = ExistingConnection(connectionId)
 
-        inner class ExistingConnection internal constructor(val id: String) {
+        inner class ExistingConnection internal constructor(id: String): ExistingResource(id) {
 
             fun disconnect(): Unit = client.forceDisconnect(this@ExistingSession.id, id)
 
@@ -99,7 +99,7 @@ class Video(private val client: VideoClient) {
 
     fun archive(archiveId: String): ExistingArchive = ExistingArchive(archiveId)
 
-    inner class ExistingArchive internal constructor(val id: String) {
+    inner class ExistingArchive internal constructor(id: String): ExistingResource(id) {
 
         fun info(): Archive = client.getArchive(id)
 
@@ -128,7 +128,7 @@ class Video(private val client: VideoClient) {
 
     fun broadcast(broadcastId: String): ExistingBroadcast = ExistingBroadcast(broadcastId)
 
-    inner class ExistingBroadcast internal constructor(val id: String) {
+    inner class ExistingBroadcast internal constructor(id: String): ExistingResource(id) {
 
         fun info(): Broadcast = client.getBroadcast(id)
 
@@ -158,7 +158,7 @@ class Video(private val client: VideoClient) {
 
     fun render(renderId: String): ExistingRender = ExistingRender(renderId)
 
-    inner class ExistingRender internal constructor(val id: String) {
+    inner class ExistingRender internal constructor(id: String): ExistingResource(id) {
 
         fun info(): RenderResponse = client.getRender(id)
 

src/main/kotlin/com/vonage/client/kt/Voice.kt

@@ -25,7 +25,7 @@ class Voice internal constructor(private val client: VoiceClient) {
 
     fun call(callId: String): ExistingCall = ExistingCall(callId)
 
-    inner class ExistingCall internal constructor(val id: String) {
+    inner class ExistingCall internal constructor(id: String): ExistingResource(id) {
 
         fun info(): CallInfo = client.getCallDetails(id)
 

src/test/kotlin/com/vonage/client/kt/AccountTest.kt

@@ -60,7 +60,7 @@ class AccountTest : AbstractTest() {
             )
         )
 
-        val response = invocation.invoke(account)
+        val response = invocation(account)
         assertNotNull(response)
         assertEquals(moCallbackUrl, response.incomingSmsUrl)
         assertEquals(drCallbackUrl, response.deliveryReceiptUrl)
@@ -98,7 +98,7 @@ class AccountTest : AbstractTest() {
         )
         val invocation = { getSecretsObj(withApiKey).list() }
 
-        val response = invocation.invoke()
+        val response = invocation()
         assertNotNull(response)
         assertEquals(2, response.size)
         assertSecretResponse(response[0])
@@ -118,7 +118,7 @@ class AccountTest : AbstractTest() {
             expectedRequestParams = secretRequest,
             status = 201, expectedResponseParams = secretResponse
         )
-        assertSecretResponse(invocation.invoke())
+        assertSecretResponse(invocation())
         assert401ApiResponseException<AccountResponseException>(url, HttpMethod.POST, invocation)
     }
 
@@ -129,15 +129,15 @@ class AccountTest : AbstractTest() {
             expectedResponseParams = secretResponse
         )
         val invocation = { getSecretsObj(withApiKey).get(secretId) }
-        assertSecretResponse(invocation.invoke())
+        assertSecretResponse(invocation())
         assert401ApiResponseException<AccountResponseException>(url, HttpMethod.GET, invocation)
     }
 
     private fun assertDeleteSecret(withApiKey: Boolean) {
         val url = getSecretUrl(withApiKey)
         val invocation = { getSecretsObj(withApiKey).delete(secretId) }
         mockDelete(url, authType)
-        invocation.invoke()
+        invocation()
 
         mockRequest(HttpMethod.DELETE, expectedUrl = url, authType = authType)
             .mockReturn(status = errorCode, errorResponse)