feat(api): api call to fetch recommendations

Author: Jiankai Zheng

src/main/java/spotify/api/impl/BrowseApiRetrofit.java

@@ -10,14 +10,17 @@
 import spotify.exceptions.HttpRequestFailedException;
 import spotify.exceptions.ResponseChecker;
 import spotify.factories.RetrofitClientFactory;
+import spotify.models.albums.AlbumSimplifiedPaging;
 import spotify.models.categories.CategoryFull;
 import spotify.models.categories.CategoryFullPaging;
 import spotify.models.playlists.FeaturedPlaylistCollection;
 import spotify.models.playlists.PlaylistSimplifiedPaging;
+import spotify.models.recommendations.RecommendationCollection;
 import spotify.retrofit.services.BrowseService;
 import spotify.utils.ValidatorUtil;
 
 import java.io.IOException;
+import java.util.List;
 import java.util.Map;
 
 public class BrowseApiRetrofit implements BrowseApi {
@@ -122,6 +125,72 @@ public FeaturedPlaylistCollection getFeaturedPlaylists(Map<String, String> optio
         }
     }
 
+    @Override
+    public AlbumSimplifiedPaging getNewReleases(Map<String, String> options) {
+        options = ValidatorUtil.optionsValueCheck(options);
+
+        logger.trace("Constructing HTTP call to fetch new releases.");
+        Call<AlbumSimplifiedPaging> httpCall = browseService.getNewReleases("Bearer " + this.accessToken, options);
+
+        try {
+            logger.info("Executing HTTP call to fetch new releases.");
+            logger.debug(String.format("Fetching new releases with following values: %s", options));
+            logger.debug(String.format("%s / %s", httpCall.request().method(), httpCall.request().url().toString()));
+            Response<AlbumSimplifiedPaging> response = httpCall.execute();
+
+            ResponseChecker.throwIfRequestHasNotBeenFulfilledCorrectly(response.errorBody());
+
+            logger.info("New releases have been successfully fetched.");
+            return response.body();
+        } catch (IOException ex) {
+            logger.error("HTTP request to fetch new releases has failed.");
+            throw new HttpRequestFailedException(ex.getMessage());
+        }
+    }
+
+    @Override
+    public RecommendationCollection getRecommendations(List<String> listOfSeedArtists, List<String> listOfSeedGenres, List<String> listOfSeedTracks, Map<String, String> options) {
+        options = ValidatorUtil.optionsValueCheck(options);
+
+        mapSeedParameters(listOfSeedArtists, listOfSeedGenres, listOfSeedTracks, options);
+
+        logger.trace("Constructing HTTP call to fetch recommendations.");
+        Call<RecommendationCollection> httpCall = browseService.getRecommendations("Bearer " + this.accessToken, options);
+
+        try {
+            logger.info("Executing HTTP call to fetch recommendations.");
+            logger.debug(String.format("Fetching recommendations with following values: %s", options));
+            logger.debug(String.format("%s / %s", httpCall.request().method(), httpCall.request().url().toString()));
+            Response<RecommendationCollection> response = httpCall.execute();
+
+            ResponseChecker.throwIfRequestHasNotBeenFulfilledCorrectly(response.errorBody());
+
+            logger.info("Recommendations have been successfully fetched.");
+            return response.body();
+        } catch (IOException ex) {
+            logger.error("HTTP request to fetch recommendations has failed.");
+            throw new HttpRequestFailedException(ex.getMessage());
+        }
+    }
+
+    private void mapSeedParameters(List<String> listOfSeedArtists, List<String> listOfSeedGenres, List<String> listOfSeedTracks, Map<String, String> options) {
+        final String artistSeedIds = String.join(",", listOfSeedArtists);
+        final String genreSeedIds = String.join(",", listOfSeedGenres);
+        final String trackSeedIds = String.join(",", listOfSeedTracks);
+
+        if (!artistSeedIds.isEmpty()) {
+            options.put("seed_artists", artistSeedIds);
+        }
+
+        if (!genreSeedIds.isEmpty()) {
+            options.put("seed_genres", genreSeedIds);
+        }
+
+        if (!trackSeedIds.isEmpty()) {
+            options.put("seed_tracks", trackSeedIds);
+        }
+    }
+
     private void setup() {
         logger.trace("Requesting Retrofit HTTP client.");
         Retrofit httpClient = RetrofitClientFactory.getRetrofitClient(ApiUrl.API_URL_HTTPS + ApiUrl.VERSION);

src/main/java/spotify/api/interfaces/BrowseApi.java

@@ -1,10 +1,13 @@
 package spotify.api.interfaces;
 
+import spotify.models.albums.AlbumSimplifiedPaging;
 import spotify.models.categories.CategoryFull;
 import spotify.models.categories.CategoryFullPaging;
 import spotify.models.playlists.FeaturedPlaylistCollection;
 import spotify.models.playlists.PlaylistSimplifiedPaging;
+import spotify.models.recommendations.RecommendationCollection;
 
+import java.util.List;
 import java.util.Map;
 
 public interface BrowseApi {
@@ -15,4 +18,8 @@ public interface BrowseApi {
     CategoryFullPaging getCategories(Map<String, String> options);
 
     FeaturedPlaylistCollection getFeaturedPlaylists(Map<String, String> options);
+
+    AlbumSimplifiedPaging getNewReleases(Map<String, String> options);
+
+    RecommendationCollection getRecommendations(List<String> listOfSeedArtists, List<String> listOfSeedGenres, List<String> listOfSeedTracks, Map<String, String> options);
 }

src/main/java/spotify/api/spotify/SpotifyApi.java

@@ -7,6 +7,7 @@
 import spotify.api.interfaces.*;
 import spotify.models.albums.AlbumFull;
 import spotify.models.albums.AlbumFullCollection;
+import spotify.models.albums.AlbumSimplifiedPaging;
 import spotify.models.artists.ArtistFull;
 import spotify.models.artists.ArtistFullCollection;
 import spotify.models.artists.ArtistSimplified;
@@ -21,6 +22,7 @@
 import spotify.models.paging.Paging;
 import spotify.models.playlists.FeaturedPlaylistCollection;
 import spotify.models.playlists.PlaylistSimplifiedPaging;
+import spotify.models.recommendations.RecommendationCollection;
 import spotify.models.shows.ShowFull;
 import spotify.models.shows.ShowSimplifiedCollection;
 import spotify.models.tracks.TrackFull;
@@ -172,6 +174,16 @@ public FeaturedPlaylistCollection getFeaturedPlaylists(Map<String, String> optio
         return browseApi.getFeaturedPlaylists(options);
     }
 
+    public AlbumSimplifiedPaging getNewReleases(Map<String, String> options) {
+        logger.info("Requesting new releases");
+        return browseApi.getNewReleases(options);
+    }
+
+    public RecommendationCollection getRecommendations(List<String> listOfSeedArtists, List<String> listOfSeedGenres, List<String> listOfSeedTracks, Map<String, String> options) {
+        logger.info("Requesting recommendations");
+        return browseApi.getRecommendations(listOfSeedArtists, listOfSeedGenres, listOfSeedTracks, options);
+    }
+
     private void setup(String accessToken) {
         logger.trace("Constructing Retrofit APIs");
         this.trackApi = new TrackApiRetrofit(accessToken);