feat: Add Voice.downloadRecording

Author: SMadani

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [1.0.0] - 2024-10-25 (expected)
 First stable GA release
 
+### Added
+- `Voice.downloadRecording(String, Path)` method
+
 ### Changed
 - `Sms.wasSuccessfullySent()` now an extension function rather than being part of the client
 - `Numbers.listOwned()` now returns `List<OwnedNumber>` instead of `ListNumbersResponse`

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

@@ -18,6 +18,7 @@ package com.vonage.client.kt
 import com.vonage.client.users.channels.Websocket
 import com.vonage.client.voice.*
 import com.vonage.client.voice.ncco.*
+import java.nio.file.Path
 import java.time.Instant
 import java.util.*
 
@@ -154,6 +155,15 @@ class Voice internal constructor(private val client: VoiceClient) {
      */
     fun createCall(properties: Call.Builder.() -> Unit): CallEvent =
         client.createCall(Call.builder().apply(properties).build())
+
+    /**
+     * Download a recording of a call and save it to a file.
+     *
+     * @param recordingUrl The URL of the recording to download.
+     * @param destination Absolute path to save the recording to.
+     */
+    fun downloadRecording(recordingUrl: String, destination: Path): Unit =
+        client.saveRecording(recordingUrl, destination)
 }
 
 /**

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

@@ -27,6 +27,7 @@ import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.assertThrows
 import com.fasterxml.jackson.databind.ObjectMapper
+import com.github.tomakehurst.wiremock.client.MappingBuilder
 import com.vonage.client.HttpWrapper
 import com.vonage.client.users.channels.Websocket
 import java.net.URI
@@ -105,7 +106,7 @@ abstract class AbstractTest {
     protected val fileUrl = "$exampleUrlBase/file.pdf"
 
     private val port = 8081
-    private val wmBaseUrl = "http://localhost:$port"
+    protected val wmBaseUrl = "http://localhost:$port"
     private val wiremock: WireMockServer = WireMockServer(
         options().port(port).notifier(ConsoleNotifier(false))
     )
@@ -168,28 +169,31 @@ abstract class AbstractTest {
 
     private fun Any.toJson(): String = ObjectMapper().writeValueAsString(this)
 
+    private fun MappingBuilder.withAuth(authType: AuthType?): MappingBuilder {
+        when (authType) {
+            AuthType.API_KEY_SECRET_QUERY_PARAMS -> {
+                withFormParam(apiKeyName, equalTo(apiKey))
+                    .withFormParam(apiSecretName, equalTo(apiSecret))
+            }
+            AuthType.JWT -> withHeader(authHeaderName, matching(jwtBearerPattern))
+            AuthType.ACCESS_TOKEN -> withHeader(authHeaderName, equalTo(accessTokenBearer))
+            AuthType.API_KEY_SECRET_HEADER -> withHeader(authHeaderName, equalTo(basicSecretEncodedHeader))
+            AuthType.API_KEY_SIGNATURE_SECRET -> withFormParam(apiKeyName, equalTo(apiKey))
+            null -> Unit
+        }
+        return this
+    }
+
     protected fun mockPostQueryParams(expectedUrl: String, expectedRequestParams: Map<String, Any>,
                                       authType: AuthType? = AuthType.API_KEY_SECRET_QUERY_PARAMS,
                                       contentType: Boolean = false, status: Int = 200,
                                       expectedResponseParams: Any? = null) {
 
-        val stub = post(urlPathEqualTo(expectedUrl))
+        val stub = post(urlPathEqualTo(expectedUrl)).withAuth(authType)
         if (contentType) {
             stub.withHeader(contentTypeHeaderName, equalTo(ContentType.FORM_URLENCODED.mime))
         }
 
-        when (authType) {
-            AuthType.API_KEY_SECRET_QUERY_PARAMS -> {
-                stub.withFormParam(apiKeyName, equalTo(apiKey))
-                    .withFormParam(apiSecretName, equalTo(apiSecret))
-            }
-            AuthType.JWT -> stub.withHeader(authHeaderName, matching(jwtBearerPattern))
-            AuthType.ACCESS_TOKEN -> stub.withHeader(authHeaderName, equalTo(accessTokenBearer))
-            AuthType.API_KEY_SECRET_HEADER -> stub.withHeader(authHeaderName, equalTo(basicSecretEncodedHeader))
-            AuthType.API_KEY_SIGNATURE_SECRET -> stub.withFormParam(apiKeyName, equalTo(apiKey))
-            null -> Unit
-        }
-
         expectedRequestParams.forEach {(k, v) -> stub.withFormParam(k, equalTo(v.toString()))}
 
         val response = aResponse().withStatus(status)
@@ -200,6 +204,13 @@ abstract class AbstractTest {
         wiremock.stubFor(stub)
     }
 
+    protected fun mockGetBinary(resourceUrl: String, body: ByteArray, authType: AuthType? = AuthType.JWT) {
+        wiremock.stubFor(
+            get(urlPathEqualTo(resourceUrl)).withAuth(authType)
+                .willReturn(aResponse().withBody(body).withStatus(200))
+        )
+    }
+
     protected fun mockRequest(
         httpMethod: HttpMethod,
         expectedUrl: String,
@@ -283,7 +294,6 @@ abstract class AbstractTest {
         mockRequest(HttpMethod.GET, expectedUrl, accept = ContentType.APPLICATION_JSON, authType = authType,
             expectedParams = expectedQueryParams).mockReturn(status, expectedResponseParams)
 
-
     protected fun BuildingStep.mockReturn(
             status: Int? = null, expectedBody: Map<String, Any>? = null): ReturnsStep =
         returns {

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

@@ -18,7 +18,12 @@ package com.vonage.client.kt
 import com.vonage.client.common.HttpMethod
 import com.vonage.client.voice.*
 import com.vonage.client.voice.ncco.*
+import org.junit.jupiter.api.Assertions.assertArrayEquals
+import java.nio.file.Files
 import java.util.*
+import kotlin.io.path.deleteExisting
+import kotlin.io.path.exists
+import kotlin.io.path.readBytes
 import kotlin.test.*
 
 class VoiceTest : AbstractTest() {
@@ -406,6 +411,28 @@ class VoiceTest : AbstractTest() {
         assertEqualsSampleCallsPage(client.listCalls())
     }
 
+    @Test
+    fun `download recording to temp file`() {
+        val fileName = "$randomUuidStr.wav"
+        val relativeUrl = "/api.nexmo.com/v1/files/$fileName"
+        val recordingUrl = wmBaseUrl + relativeUrl
+        var tempFile = Files.createTempFile(null, null)
+        tempFile.deleteExisting()
+        val content = "<110B1NARY0101;>".toByteArray(Charsets.UTF_8)
+        mockGetBinary(relativeUrl, content)
+
+        client.downloadRecording(recordingUrl, tempFile)
+        assertArrayEquals(content, tempFile.readBytes())
+        tempFile.deleteExisting()
+        assertFalse(tempFile.exists())
+
+        client.downloadRecording(recordingUrl, tempFile.parent)
+        tempFile = tempFile.parent.resolve(fileName)
+        assertTrue(tempFile.exists())
+        assertArrayEquals(content, tempFile.readBytes())
+        tempFile.deleteExisting()
+    }
+
     @Test
     fun `create TTS call with required parameters only`() {
         val ssmlText = "<speak><prosody rate='fast'>I can speak fast.</prosody></speak>"