Add support for fetching songs by identifier

stevesoltys · Dec 11, 2024 · e01baa5 · e01baa5
1 parent cc0ee1f
commit e01baa5
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 0 deletions.
diff --git a/src/main/kotlin/com/stevesoltys/applemusic/AppleMusic.kt b/src/main/kotlin/com/stevesoltys/applemusic/AppleMusic.kt
@@ -9,6 +9,7 @@ import com.stevesoltys.applemusic.model.album.library.LibraryAlbumResponse
 import com.stevesoltys.applemusic.model.artist.library.LibraryArtistResponse
 import com.stevesoltys.applemusic.model.search.SearchResponse
 import com.stevesoltys.applemusic.model.search.SearchResultType
+import com.stevesoltys.applemusic.model.track.song.SongResponse
 import com.stevesoltys.applemusic.model.track.song.library.LibrarySongResponse
 import com.stevesoltys.applemusic.net.AppleMusicHttpException
 import com.stevesoltys.applemusic.net.AppleMusicRetrofitBuilder
@@ -172,6 +173,29 @@ class AppleMusic(
     )
   }
 
+  /**
+   * Get a set of songs by their identifiers.
+   */
+  fun getSongsById(
+    ids: Array<String>? = null,
+    isrcIds: Array<String>? = null,
+    include: Array<String>? = null,
+    localization: String? = null,
+    extend: Array<String>? = null
+  ): SongResponse {
+
+    return call(
+      appleMusicService.getSongsById(
+        storefront = configuration.storefront,
+        ids = ids,
+        isrcIds = isrcIds,
+        include = include,
+        localization = localization,
+        extend = extend
+      )
+    )
+  }
+
   /**
    * Get all albums for a given artist.
    */

diff --git a/src/main/kotlin/com/stevesoltys/applemusic/net/AppleMusicService.kt b/src/main/kotlin/com/stevesoltys/applemusic/net/AppleMusicService.kt
@@ -6,6 +6,7 @@ import com.stevesoltys.applemusic.model.chart.ChartResponse
 import com.stevesoltys.applemusic.model.album.library.LibraryAlbumResponse
 import com.stevesoltys.applemusic.model.artist.library.LibraryArtistResponse
 import com.stevesoltys.applemusic.model.search.SearchResponse
+import com.stevesoltys.applemusic.model.track.song.SongResponse
 import com.stevesoltys.applemusic.model.track.song.library.LibrarySongResponse
 import retrofit2.Call
 import retrofit2.http.GET
@@ -73,6 +74,25 @@ interface AppleMusicService {
     @Query("limit") limit: Int? = null
   ): Call<AlbumResponse>
 
+  @GET("catalog/{storefront}/songs")
+  fun getSongsById(
+    @Path("storefront") storefront: String,
+    @Query("ids") ids: Array<String>? = null,
+    @Query("filter[isrc]") isrcIds: Array<String>? = null,
+    @Query("include") include: Array<String>? = null,
+    @Query("l") localization: String? = null,
+    @Query("extend") extend: Array<String>? = null
+  ): Call<SongResponse>
+
+  @GET("catalog/{storefront}/songs")
+  fun getSongsByIsrcId(
+    @Path("storefront") storefront: String,
+    @Query("ids") ids: Array<String>,
+    @Query("include") include: Array<String>? = null,
+    @Query("l") localization: String? = null,
+    @Query("extend") extend: Array<String>? = null
+  ): Call<SongResponse>
+
   @GET("me/library/artists")
   fun getLibraryArtists(
     @Header("Music-User-Token") userToken: String,

diff --git a/src/test/kotlin/com/stevesoltys/applemusic/AppleMusicE2ETest.kt b/src/test/kotlin/com/stevesoltys/applemusic/AppleMusicE2ETest.kt
@@ -111,6 +111,15 @@ class AppleMusicE2ETest {
     artistAttributes.name shouldBe TEST_ALBUM_NAME
   }
 
+  @Test
+  fun `can get songs by ISRC`() {
+    val result = appleMusic.getSongsById(
+      isrcIds = arrayOf("USQE92100257")
+    )
+
+    result.data.shouldNotBeNull().shouldHaveSize(1)
+  }
+
   @Test
   fun `can get top 100 album charts`() {
     val result = appleMusic.getCatalogCharts(