Adding the get related artists api. (#10)

rubenquadros · Apr 26, 2024 · cc08f30 · cc08f30
1 parent 64eed54
commit cc08f30
Show file tree

Hide file tree

Showing 14 changed files with 903 additions and 0 deletions.
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/SpotifyService.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/SpotifyService.kt
@@ -11,6 +11,7 @@ import io.github.rubenquadros.kovibes.api.response.Genres
 import io.github.rubenquadros.kovibes.api.response.PlaylistTracks
 import io.github.rubenquadros.kovibes.api.response.Playlists
 import io.github.rubenquadros.kovibes.api.response.Recommendations
+import io.github.rubenquadros.kovibes.api.response.RelatedArtists
 import io.github.rubenquadros.kovibes.api.response.SpotifyApiResponse
 import io.github.rubenquadros.kovibes.api.response.Tracks
 
@@ -267,4 +268,14 @@ interface SpotifyService {
         id: String,
         market: String? = null
     ): SpotifyApiResponse<ArtistTopTracks, ErrorBody>
+
+    /**
+     * Get related artists API returns the artists similar to the given artist.
+     *
+     * See [Spotify doc](https://developer.spotify.com/documentation/web-api/reference/get-an-artists-related-artists).
+     *
+     * @param id
+     * @return [RelatedArtists] when success and [ErrorBody] when error.
+     */
+    suspend fun getRelatedArtists(id: String): SpotifyApiResponse<RelatedArtists, ErrorBody>
 }
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/SpotifyServiceImpl.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/SpotifyServiceImpl.kt
@@ -2,6 +2,7 @@ package io.github.rubenquadros.kovibes.api
 
 import io.github.rubenquadros.kovibes.api.artist.ArtistApi
 import io.github.rubenquadros.kovibes.api.artist.toArtistTopTracks
+import io.github.rubenquadros.kovibes.api.artist.toRelatedArtists
 import io.github.rubenquadros.kovibes.api.browse.BrowseApi
 import io.github.rubenquadros.kovibes.api.browse.toCategories
 import io.github.rubenquadros.kovibes.api.mapper.toAlbums
@@ -24,6 +25,7 @@ import io.github.rubenquadros.kovibes.api.response.Genres
 import io.github.rubenquadros.kovibes.api.response.PlaylistTracks
 import io.github.rubenquadros.kovibes.api.response.Playlists
 import io.github.rubenquadros.kovibes.api.response.Recommendations
+import io.github.rubenquadros.kovibes.api.response.RelatedArtists
 import io.github.rubenquadros.kovibes.api.response.SpotifyApiResponse
 import io.github.rubenquadros.kovibes.api.response.Tracks
 import io.github.rubenquadros.kovibes.api.search.SearchApi
@@ -164,4 +166,10 @@ internal class SpotifyServiceImpl(
 
         return response.getParsedApiResponse { it.toArtistTopTracks() }
     }
+
+    override suspend fun getRelatedArtists(id: String): SpotifyApiResponse<RelatedArtists, ErrorBody> {
+        val response = artistApi.getRelatedArtists(id)
+
+        return response.getParsedApiResponse { it.toRelatedArtists() }
+    }
 }
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApi.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApi.kt
@@ -2,6 +2,7 @@ package io.github.rubenquadros.kovibes.api.artist
 
 import io.github.rubenquadros.kovibes.api.ApiResponse
 import io.github.rubenquadros.kovibes.api.artist.models.GetArtistTopTracksResponse
+import io.github.rubenquadros.kovibes.api.artist.models.GetRelatedArtistsResponse
 import io.github.rubenquadros.kovibes.api.models.AlbumResponse
 import io.github.rubenquadros.kovibes.api.models.ArtistInfo
 import io.github.rubenquadros.kovibes.api.response.ErrorBody
@@ -51,4 +52,12 @@ internal interface ArtistApi {
         id: String,
         market: String?
     ): ApiResponse<GetArtistTopTracksResponse, ErrorBody>
+
+    /**
+     * Get related artists API returns the information about artists similar to the given artist.
+     *
+     * @param id
+     * @return [GetRelatedArtistsResponse] when success and [ErrorBody] when error.
+     */
+    suspend fun getRelatedArtists(id: String): ApiResponse<GetRelatedArtistsResponse, ErrorBody>
 }
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApiImpl.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApiImpl.kt
@@ -3,6 +3,7 @@ package io.github.rubenquadros.kovibes.api.artist
 import io.github.rubenquadros.kovibes.api.ApiResponse
 import io.github.rubenquadros.kovibes.api.KtorService
 import io.github.rubenquadros.kovibes.api.artist.models.GetArtistTopTracksResponse
+import io.github.rubenquadros.kovibes.api.artist.models.GetRelatedArtistsResponse
 import io.github.rubenquadros.kovibes.api.getParsedHttpResponse
 import io.github.rubenquadros.kovibes.api.models.AlbumResponse
 import io.github.rubenquadros.kovibes.api.models.ArtistInfo
@@ -84,4 +85,16 @@ internal class ArtistApiImpl(
 
         return response.getParsedHttpResponse()
     }
+
+    override suspend fun getRelatedArtists(id: String): ApiResponse<GetRelatedArtistsResponse, ErrorBody> {
+        val response = withContext(dispatcher) {
+            ktorService.client.get {
+                url {
+                    path("v1/artists/$id/related-artists")
+                }
+            }
+        }
+
+        return response.getParsedHttpResponse()
+    }
 }
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApiMapper.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/artist/ArtistApiMapper.kt
@@ -1,8 +1,11 @@
 package io.github.rubenquadros.kovibes.api.artist
 
 import io.github.rubenquadros.kovibes.api.artist.models.GetArtistTopTracksResponse
+import io.github.rubenquadros.kovibes.api.artist.models.GetRelatedArtistsResponse
+import io.github.rubenquadros.kovibes.api.mapper.toArtist
 import io.github.rubenquadros.kovibes.api.mapper.toTrack
 import io.github.rubenquadros.kovibes.api.response.ArtistTopTracks
+import io.github.rubenquadros.kovibes.api.response.RelatedArtists
 
 /**
  * @suppress
@@ -12,4 +15,14 @@ internal fun GetArtistTopTracksResponse.toArtistTopTracks(): ArtistTopTracks {
     return ArtistTopTracks(
         tracks = tracks.map { it.toTrack() }
     )
+}
+
+/**
+ * @suppress
+ * Map [GetRelatedArtistsResponse] to [RelatedArtists]
+ */
+internal fun GetRelatedArtistsResponse.toRelatedArtists(): RelatedArtists {
+    return RelatedArtists(
+        artists = artists.map { it.toArtist() }
+    )
 }
diff --git a/...Main/kotlin/io/github/rubenquadros/kovibes/api/artist/models/GetRelatedArtistsResponse.kt b/...Main/kotlin/io/github/rubenquadros/kovibes/api/artist/models/GetRelatedArtistsResponse.kt
@@ -0,0 +1,13 @@
+package io.github.rubenquadros.kovibes.api.artist.models
+
+import io.github.rubenquadros.kovibes.api.ExcludeFromCoverage
+import io.github.rubenquadros.kovibes.api.models.ArtistInfo
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@ExcludeFromCoverage
+@Serializable
+internal data class GetRelatedArtistsResponse(
+    @SerialName("artists")
+    val artists: List<ArtistInfo>
+)
diff --git a/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/response/RelatedArtists.kt b/kovibes/src/commonMain/kotlin/io/github/rubenquadros/kovibes/api/response/RelatedArtists.kt
@@ -0,0 +1,5 @@
+package io.github.rubenquadros.kovibes.api.response
+
+data class RelatedArtists(
+    val artists: List<Artist>
+)
diff --git a/...c/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/artist/ArtistApiMapperTest.kt b/...c/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/artist/ArtistApiMapperTest.kt
@@ -1,7 +1,9 @@
 package io.github.rubenquadros.kovibes.api.test.artist
 
 import io.github.rubenquadros.kovibes.api.artist.models.GetArtistTopTracksResponse
+import io.github.rubenquadros.kovibes.api.artist.models.GetRelatedArtistsResponse
 import io.github.rubenquadros.kovibes.api.artist.toArtistTopTracks
+import io.github.rubenquadros.kovibes.api.artist.toRelatedArtists
 import io.github.rubenquadros.kovibes.api.test.getExpectedResponse
 import kotlinx.serialization.json.Json
 import kotlin.test.Test
@@ -21,4 +23,17 @@ class ArtistApiMapperTest {
             artistTopTracksResponse.tracks.size == artistTopTracks.tracks.size
         }
     }
+
+    @Test
+    fun `related artists response is mapped to related artists`() {
+        val relatedArtistsResponse = Json.decodeFromString<GetRelatedArtistsResponse>(
+            getExpectedResponse("artist/related_artists.json")
+        )
+
+        val relatedArtists = relatedArtistsResponse.toRelatedArtists()
+
+        assertTrue {
+            relatedArtistsResponse.artists.size == relatedArtists.artists.size
+        }
+    }
 }
diff --git a/...bes/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/artist/ArtistApiTest.kt b/...bes/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/artist/ArtistApiTest.kt
@@ -79,6 +79,26 @@ class ArtistApiTest {
         response.assertApiResponseFailure()
     }
 
+    @Test
+    fun `when related artists spotify api responds success then result is received`() = runTest {
+        MockKtorService.isSuccess = true
+
+        val response = artistApi.getRelatedArtists(id = "567")
+
+        response.assertApiResponseSuccess(
+            { it.artists.isNotEmpty() }
+        )
+    }
+
+    @Test
+    fun `when related artists spotify api responds error then failure is received`() = runTest {
+        MockKtorService.isSuccess = false
+
+        val response = artistApi.getRelatedArtists(id = "567")
+
+        response.assertApiResponseFailure()
+    }
+
     private fun createMockArtistConfig() = mapOf(
         "artists/123" to MockResponse(
             expectedSuccessResponsePath = "artist/artist.json",
@@ -91,6 +111,10 @@ class ArtistApiTest {
         "artists/678/top-tracks" to MockResponse(
             expectedSuccessResponsePath = "artist/top_tracks.json",
             expectedErrorResponsePath = errorResponsePath
+        ),
+        "artists/567/related-artists" to MockResponse(
+            expectedSuccessResponsePath = "artist/related_artists.json",
+            expectedErrorResponsePath = errorResponsePath
         )
     )
 }
diff --git a/kovibes/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/error/ErrorTest.kt b/kovibes/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/error/ErrorTest.kt
@@ -0,0 +1,32 @@
+package io.github.rubenquadros.kovibes.api.test.error
+
+import io.github.rubenquadros.kovibes.api.browse.BrowseApiImpl
+import io.github.rubenquadros.kovibes.api.test.MockKtorService
+import io.github.rubenquadros.kovibes.api.test.MockResponse
+import io.github.rubenquadros.kovibes.api.test.assertApiResponseFailure
+import io.github.rubenquadros.kovibes.api.test.errorResponsePath
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class ErrorTest {
+
+    private val browseApi = BrowseApiImpl(
+        ktorService = MockKtorService.createMockKtorService(createMockBrowseConfig())
+    )
+
+    @Test
+    fun `when there is a parsing exception then error is received`() = runTest {
+        MockKtorService.isSuccess = true
+
+        val response = browseApi.getCategories(locale = "en_US", limit = 20, offset = 0)
+
+        response.assertApiResponseFailure()
+    }
+
+    private fun createMockBrowseConfig() = mapOf(
+        "browse/categories" to MockResponse(
+            expectedSuccessResponsePath = "invalid.json",
+            expectedErrorResponsePath = errorResponsePath
+        )
+    )
+}
diff --git a/...es/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/service/FakeArtistApi.kt b/...es/src/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/service/FakeArtistApi.kt
@@ -3,6 +3,7 @@ package io.github.rubenquadros.kovibes.api.test.service
 import io.github.rubenquadros.kovibes.api.ApiResponse
 import io.github.rubenquadros.kovibes.api.artist.ArtistApi
 import io.github.rubenquadros.kovibes.api.artist.models.GetArtistTopTracksResponse
+import io.github.rubenquadros.kovibes.api.artist.models.GetRelatedArtistsResponse
 import io.github.rubenquadros.kovibes.api.models.AlbumResponse
 import io.github.rubenquadros.kovibes.api.models.ArtistInfo
 import io.github.rubenquadros.kovibes.api.response.ErrorBody
@@ -41,4 +42,10 @@ internal class FakeArtistApi : ArtistApi {
             Json.decodeFromString(getExpectedResponse("artist/top_tracks.json"))
         }
     }
+
+    override suspend fun getRelatedArtists(id: String): ApiResponse<GetRelatedArtistsResponse, ErrorBody> {
+        return getApiResponse(isSuccess) {
+            Json.decodeFromString(getExpectedResponse("artist/related_artists.json"))
+        }
+    }
 }
diff --git a/...c/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/service/SpotifyServiceTest.kt b/...c/commonTest/kotlin/io/github/rubenquadros/kovibes/api/test/service/SpotifyServiceTest.kt
@@ -264,4 +264,24 @@ class SpotifyServiceTest {
 
         response.assertSpotifyApiError()
     }
+
+    @Test
+    fun `when get related artists responds success then response is received`() = runTest {
+        FakeArtistApi.isSuccess = true
+
+        val response = spotifyService.getRelatedArtists(id = "567")
+
+        response.assertSpotifyApiSuccess(
+            { it.artists.isNotEmpty() }
+        )
+    }
+
+    @Test
+    fun `when get related artists responds error then error is received`() = runTest {
+        FakeArtistApi.isSuccess = false
+
+        val response = spotifyService.getRelatedArtists(id = "567")
+
+        response.assertSpotifyApiError()
+    }
 }