fixed search unit test

Author: adamint

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/pub/SearchApi.kt

@@ -87,7 +87,18 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
      *
      * **[Api Reference](https://developer.spotify.com/documentation/web-api/reference/search/search/)**
      *
-     * @param query Search query keywords and optional field filters and operators.
+     * @param query Search query keywords and optional field filters and operators. You can narrow down your search using field filters. The available filters are album, artist, track, year, upc, tag:hipster, tag:new, isrc, and genre. Each field filter only applies to certain result types.
+
+    The artist filter can be used while searching albums, artists or tracks.
+    The album and year filters can be used while searching albums or tracks. You can filter on a single year or a range (e.g. 1955-1960).
+    The genre filter can be use while searching tracks and artists.
+    The isrc and track filters can be used while searching tracks.
+    The upc, tag:new and tag:hipster filters can only be used while searching albums. The tag:new filter will return albums released in the past two weeks and tag:hipster can be used to return only albums with the lowest 10% popularity.
+
+    You can also use the NOT operator to exclude keywords from your search.
+
+    Example value:
+    "remaster%20track:Doxy+artist:Miles%20Davis"
      * @param searchTypes A list of item types to search across. Search results include hits from all the specified item types.
      * @param limit Maximum number of results to return.
     Default: 20
@@ -103,7 +114,10 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
     - Playlist results are not affected by the market parameter.
     - If market is set to from_token, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned.
     - Users can view the country that is associated with their account in the account settings. A user must grant access to the [SpotifyScope.USER_READ_PRIVATE] scope prior to when the access token is issued.
+     **Note**: episodes will not be returned if this is NOT specified
      * @param includeExternal If true, the response will include any relevant audio content that is hosted externally. By default external content is filtered out from responses.
+     *
+     * @throws IllegalArgumentException if no search types are provided, or if [SearchType.EPISODE] is provided but [market] is not
      */
     public suspend fun search(
         query: String,
@@ -114,6 +128,10 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
         includeExternal: Boolean? = null
     ): SpotifySearchResult {
         require(searchTypes.isNotEmpty()) { "At least one search type must be provided" }
+        if (SearchType.EPISODE in searchTypes) {
+            requireNotNull(market) { "Market must be provided when SearchType.EPISODE is requested"}
+        }
+
         val jsonString = get(build(query, market, limit, offset, *searchTypes, includeExternal = includeExternal))
         val map = json.decodeFromString(MapSerializer(String.serializer(), JsonObject.serializer()), jsonString)
 
@@ -184,6 +202,8 @@ public open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint(api) {
     - Playlist results are not affected by the market parameter.
     - If market is set to from_token, and a valid access token is specified in the request header, only content playable in the country associated with the user account, is returned.
     - Users can view the country that is associated with their account in the account settings. A user must grant access to the [SpotifyScope.USER_READ_PRIVATE] scope prior to when the access token is issued.
+
+     **Note**: episodes will not be returned if this is NOT specified
      * @param includeExternal If true, the response will include any relevant audio content that is hosted externally. By default external content is filtered out from responses.
      */
     public fun searchRestAction(

src/commonMain/kotlin/com.adamratzman.spotify/utils/Market.kt

@@ -1,6 +1,8 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+import com.adamratzman.spotify.SpotifyAppApi
+
 /*
  * Copyright (C) 2012-2019 Neo Visionaries Inc.
  *
@@ -20,81 +22,7 @@ package com.adamratzman.spotify.utils
 /**
  * [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) country code.
  *
- *
- *
- * Enum names of this enum themselves are represented by
- * [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
- * code (2-letter upper-case alphabets). There are instance methods to get the
- * country name ([.getName]), the
- * [ISO 3166-1 alpha-3](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
- * code ([.getAlpha3]) and the
- * [ISO 3166-1 numeric](http://en.wikipedia.org/wiki/ISO_3166-1_numeric)
- * code ([.getNumeric]).
- * In addition, there are static methods to get a `Market` instance that
- * corresponds to a given alpha-2/alpha-3/numeric code ([.getByCode],
- * [.getByCode]).
- *
- *
- * <pre style="background-color: #EEEEEE; margin-left: 2em; margin-right: 2em; border: 1px solid black; padding: 0.5em;">
- * <span style="color: darkgreen;">// List all the country codes.</span>
- * for (Market code : Market.values())
- * {
- * <span style="color: darkgreen;">// For example, "[US] United States" is printed.</span>
- * System.out.format(<span style="color: darkred;">"[%s] %s\n"</span>, code, code.[.getName]);
- * }
- *
- * <span style="color: darkgreen;">// Get a Market instance by ISO 3166-1 code.</span>
- * Market code = Market.[getByCode][.getByCode](<span style="color: darkred;">"JP"</span>);
- *
- * <span style="color: darkgreen;">// Print all the information. Output will be:</span>
- * <span style="color: darkgreen;">//</span>
- * <span style="color: darkgreen;">//     Country name            = Japan</span>
- * <span style="color: darkgreen;">//     ISO 3166-1 alpha-2 code = JP</span>
- * <span style="color: darkgreen;">//     ISO 3166-1 alpha-3 code = JPN</span>
- * <span style="color: darkgreen;">//     ISO 3166-1 numeric code = 392</span>
- * <span style="color: darkgreen;">//     Assignment state        = OFFICIALLY_ASSIGNED</span>
- * <span style="color: darkgreen;">//</span>
- * System.out.println(<span style="color: darkred;">"Country name            = "</span> + code.[.getName]);
- * System.out.println(<span style="color: darkred;">"ISO 3166-1 alpha-2 code = "</span> + code.[.getAlpha2]);
- * System.out.println(<span style="color: darkred;">"ISO 3166-1 alpha-3 code = "</span> + code.[.getAlpha3]);
- * System.out.println(<span style="color: darkred;">"ISO 3166-1 numeric code = "</span> + code.[.getNumeric]);
- * System.out.println(<span style="color: darkred;">"Assignment state        = "</span> + code.[.getAssignment]);
- *
- * <span style="color: darkgreen;">// Convert to a Locale instance.</span>
- *
- * <span style="color: darkgreen;">// Get a Market by a Locale instance.</span>
- * code = Market.[getByLocale][.getByLocale](locale);
- *
- * <span style="color: darkgreen;">// Get the currency of the country.</span>
- *
- * <span style="color: darkgreen;">// Get a list by a regular expression for names.
- * //
- * // The list will contain:
- * //
- * //     Market.AE ed Arab Emirates
- * //     Market.GB ed Kingdom
- * //     Market.TZ : Tanzania, United Republic of
- * //     Market.UK ed Kingdom
- * //     Market.UM ed States Minor Outlying Islands
- * //     Market.US ed States
- * //</span>
- * List&lt;Market&gt; list = Market.[findByName][.findByName](<span style="color: darkred;">".*United.*"</span>);
- *
- * <span style="color: darkgreen;">
- * // For backward compatibility for older versions than 1.16, some
- * // 4-letter ISO 3166-3 codes are accepted by getByCode(String, boolean)
- * // and its variants. To be concrete:
- * //
- * //     [ANHH](https://en.wikipedia.org/wiki/ISO_3166-3#ANHH) : Market.AN
- * //     [BUMM](https://en.wikipedia.org/wiki/ISO_3166-3#BUMM) : Market.BU
- * //     [CSXX](https://en.wikipedia.org/wiki/ISO_3166-3#CSXX) : Market.CS
- * //     [NTHH](https://en.wikipedia.org/wiki/ISO_3166-3#NTHH) : Market.NT
- * //     [TPTL](https://en.wikipedia.org/wiki/ISO_3166-3#TPTL) : Market.TP
- * //     [YUCS](https://en.wikipedia.org/wiki/ISO_3166-3#YUCS) : Market.YU
- * //     [ZRCD](https://en.wikipedia.org/wiki/ISO_3166-3#ZRCD) : Market.ZR
- * //</span>
- * code = Market.[getByCode][.getByCode](<span style="color: darkred;">"ANHH"</span>);
-</pre> *
+ * **Note**: Use [Market.FROM_TOKEN] if you want to use the client's locale. This should not be used with [SpotifyAppApi]
  *
  * @author Takahiko Kawasaki (https://github.com/TakahikoKawasaki/nv-i18n)
  */

src/commonTest/kotlin/com.adamratzman/spotify/pub/PublicPlaylistsApiTest.kt

@@ -39,7 +39,7 @@ class PublicPlaylistsApiTest : AbstractTest<GenericSpotifyApi>() {
             assertEquals("run2", api!!.playlists.getPlaylist("78eWnYKwDksmCHAjOUNPEj")?.name)
             assertNull(api!!.playlists.getPlaylist("nope"))
             assertTrue(api!!.playlists.getPlaylist("78eWnYKwDksmCHAjOUNPEj")!!.tracks.isNotEmpty())
-            val playlistWithLocalAndNonLocalTracks = api!!.playlists.getPlaylist("0vzdw0N41qZLbRDqyx2cE0")!!.tracks
+            val playlistWithLocalAndNonLocalTracks = api!!.playlists.getPlaylist("627gNjNzj3sOrSiDm5acc2")!!.tracks
             assertEquals(LocalTrack::class, playlistWithLocalAndNonLocalTracks[0].track!!::class)
             assertEquals(Track::class, playlistWithLocalAndNonLocalTracks[1].track!!::class)
 
@@ -57,7 +57,7 @@ class PublicPlaylistsApiTest : AbstractTest<GenericSpotifyApi>() {
             if (!testPrereq()) return@runBlockingTest else api!!
 
             assertTrue(api!!.playlists.getPlaylistTracks("78eWnYKwDksmCHAjOUNPEj").items.isNotEmpty())
-            val playlist = api!!.playlists.getPlaylistTracks("0vzdw0N41qZLbRDqyx2cE0")
+            val playlist = api!!.playlists.getPlaylistTracks("627gNjNzj3sOrSiDm5acc2")
             assertEquals(LocalTrack::class, playlist[0].track!!::class)
             assertEquals(Track::class, playlist[1].track!!::class)
             assertFailsWith<SpotifyException.BadRequestException> { api!!.playlists.getPlaylistTracks("adskjfjkasdf") }

src/commonTest/kotlin/com.adamratzman/spotify/pub/SearchApiTest.kt

@@ -18,7 +18,7 @@ class SearchApiTest : AbstractTest<GenericSpotifyApi>() {
         return runBlockingTest {
             super.build<GenericSpotifyApi>()
             if (!testPrereq()) return@runBlockingTest else api!!
-            val query = api!!.search.search("lo", *SearchApi.SearchType.values())
+            val query = api!!.search.search("lo", *SearchApi.SearchType.values(), market = Market.US)
             assertTrue(
                 query.albums?.items?.isNotEmpty() == true && query.tracks?.items?.isNotEmpty() == true && query.artists?.items?.isNotEmpty() == true &&
                         query.playlists?.items?.isNotEmpty() == true && query.shows?.items?.isNotEmpty() == true && query.episodes?.items?.isNotEmpty() == true
@@ -28,7 +28,7 @@ class SearchApiTest : AbstractTest<GenericSpotifyApi>() {
                 query2.albums == null && query2.tracks == null && query2.shows == null && query2.episodes == null &&
                         query2.artists?.items?.isNotEmpty() == true && query2.playlists?.items?.isNotEmpty() == true
             )
-            val query3 = api!!.search.search("lo", SearchApi.SearchType.SHOW, SearchApi.SearchType.EPISODE)
+            val query3 = api!!.search.search("lo", SearchApi.SearchType.SHOW, SearchApi.SearchType.EPISODE, market = Market.US)
             assertTrue(query3.episodes?.items?.isNotEmpty() == true && query3.shows?.items?.isNotEmpty() == true)
         }
     }