feat: get current user's saved episodes.

Author: eleonora2687

.idea/.gitignore

@@ -215,9 +215,12 @@ This is the most recent coverage in the repository. The marked endpoints may not
 - - [x] Get Current User's Saved Albums
 - - [x] Get User's Saved Shows
 - - [x] Get Current User's Saved Tracks
+- - [x] Get Current User's Saved Episodes
 - - [x] Save Albums for Current User
 - - [x] Save Shows for Current User
 - - [x] Save Tracks for Current User
+- [x] Markets
+- - [x] Get Available Markets
 - [x] Personalization
 - - [x] Get User's Top Artists and Tracks
 - [x] Player

.idea/inspectionProfiles/Project_Default.xml

@@ -9,6 +9,7 @@
 import spotify.exceptions.HttpRequestFailedException;
 import spotify.factories.RetrofitHttpServiceFactory;
 import spotify.models.albums.SavedAlbumFull;
+import spotify.models.episodes.SavedEpisodeFull;
 import spotify.models.paging.Paging;
 import spotify.models.shows.SavedShowSimplified;
 import spotify.models.tracks.SavedTrackFull;
@@ -127,6 +128,29 @@ public Paging<SavedAlbumFull> getSavedAlbums(Map<String, String> options) {
         }
     }
 
+    @Override
+    public Paging<SavedEpisodeFull> getSavedEpisodes(Map<String, String> options) {
+        options = ValidatorUtil.optionsValueCheck(options);
+
+        logger.trace("Constructing HTTP call to fetch current user's saved episodes");
+        Call<Paging<SavedEpisodeFull>> httpCall = libraryService.getSavedEpisodes("Bearer " + this.accessToken, options);
+
+        try {
+            logger.info("Executing HTTP call to fetch current user's saved episodes");
+            logger.debug("Fetching current user's saved episodes with the following values: {}.", options);
+            LoggingUtil.logHttpCall(logger, httpCall);
+            Response<Paging<SavedEpisodeFull>> response = httpCall.execute();
+
+            ResponseChecker.throwIfRequestHasNotBeenFulfilledCorrectly(response, HttpStatusCode.OK);
+
+            logger.info("Saved episodes have been successfully fetched");
+            return response.body();
+        } catch (IOException ex) {
+            logger.error("HTTP request to fetch saved episodes has failed.");
+            throw new HttpRequestFailedException(ex.getMessage());
+        }
+    }
+
     @Override
     public Paging<SavedShowSimplified> getSavedShows(Map<String, String> options) {
         options = ValidatorUtil.optionsValueCheck(options);

.idea/misc.xml

@@ -1,6 +1,7 @@
 package spotify.api.interfaces;
 
 import spotify.models.albums.SavedAlbumFull;
+import spotify.models.episodes.SavedEpisodeFull;
 import spotify.models.paging.Paging;
 import spotify.models.shows.SavedShowSimplified;
 import spotify.models.tracks.SavedTrackFull;
@@ -32,4 +33,6 @@ public interface LibraryApi {
     void deleteShows(List<String> listOfShowIds, Map<String, String> options);
 
     void deleteTracks(List<String> listOfTrackIds);
+
+    Paging<SavedEpisodeFull> getSavedEpisodes(Map<String, String> options);
 }

.idea/vcs.xml

@@ -19,6 +19,7 @@
 import spotify.models.episodes.EpisodeFull;
 import spotify.models.episodes.EpisodeFullCollection;
 import spotify.models.episodes.EpisodeSimplified;
+import spotify.models.episodes.SavedEpisodeFull;
 import spotify.models.generic.Image;
 import spotify.models.markets.MarketFull;
 import spotify.models.paging.CursorBasedPaging;
@@ -264,6 +265,11 @@ public Paging<SavedAlbumFull> getSavedAlbums(Map<String, String> options) {
         return libraryApi.getSavedAlbums(options);
     }
 
+    public Paging<SavedEpisodeFull> getSavedEpisodes(Map<String, String> options) {
+        logger.info("Requesting to fetch current user's saved episodes");
+        return libraryApi.getSavedEpisodes(options);
+    }
+
     public Paging<SavedShowSimplified> getSavedShows(Map<String, String> options) {
         logger.info("Requesting to fetch current user's saved shows");
         return libraryApi.getSavedShows(options);

README.md

@@ -3,6 +3,7 @@
 import retrofit2.Call;
 import retrofit2.http.*;
 import spotify.models.albums.SavedAlbumFull;
+import spotify.models.episodes.SavedEpisodeFull;
 import spotify.models.paging.Paging;
 import spotify.models.shows.SavedShowSimplified;
 import spotify.models.tracks.SavedTrackFull;
@@ -23,6 +24,9 @@ public interface LibraryService {
     @GET("me/albums")
     Call<Paging<SavedAlbumFull>> getSavedAlbums(@Header("Authorization") String accessToken, @QueryMap Map<String, String> options);
 
+    @GET("me/episodes")
+    Call<Paging<SavedEpisodeFull>> getSavedEpisodes(@Header("Authorization") String accessToken, @QueryMap Map<String, String> options);
+
     @GET("me/shows")
     Call<Paging<SavedShowSimplified>> getSavedShows(@Header("Authorization") String accessToken, @QueryMap Map<String, String> options);
 

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

@@ -13,6 +13,7 @@
 import spotify.exceptions.HttpRequestFailedException;
 import spotify.exceptions.SpotifyActionFailedException;
 import spotify.models.albums.SavedAlbumFull;
+import spotify.models.episodes.SavedEpisodeFull;
 import spotify.models.paging.Paging;
 import spotify.models.shows.SavedShowSimplified;
 import spotify.models.tracks.SavedTrackFull;
@@ -45,6 +46,8 @@ public class LibraryApiRetrofitTest extends AbstractApiRetrofitTest {
     @Mock
     private Call<Paging<SavedTrackFull>> mockedSavedTrackFullPagingCall;
     @Mock
+    private Call<Paging<SavedEpisodeFull>> mockedSavedEpisodeFullPagingCall;
+    @Mock
     private Call<Void> mockedVoidCall;
 
     @BeforeEach
@@ -57,6 +60,7 @@ void setup() {
         when(mockedLibraryService.hasSavedShows(fakeAccessTokenWithBearer, fakeShowIds)).thenReturn(mockedListOfBooleanCall);
         when(mockedLibraryService.hasSavedTracks(fakeAccessTokenWithBearer, fakeTrackIds)).thenReturn(mockedListOfBooleanCall);
         when(mockedLibraryService.getSavedAlbums(fakeAccessTokenWithBearer, fakeOptionalParameters)).thenReturn(mockedSavedAlbumFullPagingCall);
+        when(mockedLibraryService.getSavedEpisodes(fakeAccessTokenWithBearer, fakeOptionalParameters)).thenReturn(mockedSavedEpisodeFullPagingCall);
         when(mockedLibraryService.getSavedShows(fakeAccessTokenWithBearer, fakeOptionalParameters)).thenReturn(mockedSavedAShowSimplifiedPagingCall);
         when(mockedLibraryService.getSavedTracks(fakeAccessTokenWithBearer, fakeOptionalParameters)).thenReturn(mockedSavedTrackFullPagingCall);
         when(mockedLibraryService.saveAlbums(fakeAccessTokenWithBearer, fakeAlbumIds)).thenReturn(mockedVoidCall);
@@ -69,6 +73,7 @@ void setup() {
         when(mockedVoidCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
         when(mockedListOfBooleanCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
         when(mockedSavedAlbumFullPagingCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
+        when(mockedSavedEpisodeFullPagingCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
         when(mockedSavedAShowSimplifiedPagingCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
         when(mockedSavedTrackFullPagingCall.request()).thenReturn(new Request.Builder().url(fakeUrl).build());
     }
@@ -217,6 +222,15 @@ void getSavedAlbumsUsesCorrectValuesToCreateHttpCall() throws IOException {
         verify(mockedLibraryService).getSavedAlbums(fakeAccessTokenWithBearer, fakeOptionalParameters);
     }
 
+    @Test
+    void getSavedEpisodesUsesCorrectValuesToCreateHttpCall() throws IOException {
+        when(mockedSavedEpisodeFullPagingCall.execute()).thenReturn(Response.success(new Paging<>()));
+
+        sut.getSavedEpisodes(fakeOptionalParameters);
+
+        verify(mockedLibraryService).getSavedEpisodes(fakeAccessTokenWithBearer, fakeOptionalParameters);
+    }
+
     @Test
     void getSavedAlbumsExecutesHttpCall() throws IOException {
         when(mockedSavedAlbumFullPagingCall.execute()).thenReturn(Response.success(new Paging<>()));
@@ -226,6 +240,15 @@ void getSavedAlbumsExecutesHttpCall() throws IOException {
         verify(mockedSavedAlbumFullPagingCall).execute();
     }
 
+    @Test
+    void getSavedEpisodesExecutesHttpCall() throws IOException {
+        when(mockedSavedEpisodeFullPagingCall.execute()).thenReturn(Response.success(new Paging<>()));
+
+        sut.getSavedEpisodes(fakeOptionalParameters);
+
+        verify(mockedSavedEpisodeFullPagingCall).execute();
+    }
+
     @Test
     void getSavedAlbumsThrowsSpotifyActionFailedExceptionWhenError() throws IOException {
         when(mockedSavedAlbumFullPagingCall.execute())
@@ -239,20 +262,47 @@ void getSavedAlbumsThrowsSpotifyActionFailedExceptionWhenError() throws IOExcept
         Assertions.assertThrows(SpotifyActionFailedException.class, () -> sut.getSavedAlbums(fakeOptionalParameters));
     }
 
+    @Test
+    void getSavedEpisodesThrowsSpotifyActionFailedExceptionWhenError() throws IOException {
+        when(mockedSavedEpisodeFullPagingCall.execute())
+                .thenReturn(
+                        Response.error(
+                                400,
+                                ResponseBody.create(MediaType.get("application/json"), getJson("error.json"))
+                        )
+                );
+
+        Assertions.assertThrows(SpotifyActionFailedException.class, () -> sut.getSavedEpisodes(fakeOptionalParameters));
+    }
+
     @Test
     void getSavedAlbumsThrowsHttpRequestFailedWhenHttpFails() throws IOException {
         when(mockedSavedAlbumFullPagingCall.execute()).thenThrow(IOException.class);
 
         Assertions.assertThrows(HttpRequestFailedException.class, () -> sut.getSavedAlbums(fakeOptionalParameters));
     }
 
+    @Test
+    void getSavedEpisodesThrowsHttpRequestFailedWhenHttpFails() throws IOException {
+        when(mockedSavedEpisodeFullPagingCall.execute()).thenThrow(IOException.class);
+
+        Assertions.assertThrows(HttpRequestFailedException.class, () -> sut.getSavedEpisodes(fakeOptionalParameters));
+    }
+
     @Test
     void getSavedAlbumsReturnsSavedAlbumFullPagingWhenSuccessful() throws IOException {
         when(mockedSavedAlbumFullPagingCall.execute()).thenReturn(Response.success(new Paging<>()));
 
         Assertions.assertNotNull(sut.getSavedAlbums(fakeOptionalParameters));
     }
 
+    @Test
+    void getSavedEpisodesReturnsSavedEpisodeFullPagingWhenSuccessful() throws IOException {
+        when(mockedSavedEpisodeFullPagingCall.execute()).thenReturn(Response.success(new Paging<>()));
+
+        Assertions.assertNotNull(sut.getSavedEpisodes(fakeOptionalParameters));
+    }
+
     @Test
     void getSavedShowsUsesCorrectValuesToCreateHttpCall() throws IOException {
         when(mockedSavedAShowSimplifiedPagingCall.execute()).thenReturn(Response.success(new Paging<>()));