Mark tagged images method as deprecated, remove failing tests

Author: UweTrottmann

CHANGELOG.md

@@ -5,6 +5,8 @@
 * Add `TvSeasonsService.translations` by @laurentblue in https://github.com/UweTrottmann/tmdb-java/pull/108
 * Add `TvSeasonsService.watchProviders` to get watch providers for a specific season
 * Add `Tmdb.watchProvidersService` to get all available watch providers for movies and TV shows in a region
+* Deprecate tagged images of people. [TMDB has marked this as deprecated](https://developer.themoviedb.org/reference/person-tagged-images),
+  using it may return a server error.
 * Note: TMDB has added additional primary translation languages: Bangla (India, `bn-IN`), Nepali (Nepal, `ne-NP`) and 
   Occitan (France, `oc-FR`).
 

src/main/java/com/uwetrottmann/tmdb2/entities/Person.java

@@ -24,6 +24,10 @@ public class Person extends BasePerson {
     public PersonCredits movie_credits;
     public PersonCredits tv_credits;
     public PersonImages images;
+    /**
+     * @deprecated TMDB has marked support for tagged images as deprecated. Using this may lead to a server error.
+     */
+    @Deprecated
     public TaggedImagesResultsPage tagged_images;
     public Changes changes;
 

src/main/java/com/uwetrottmann/tmdb2/enumerations/AppendToResponseItem.java

@@ -37,6 +37,10 @@ public enum AppendToResponseItem {
     MOVIE_CREDITS("movie_credits"),
     TV_CREDITS("tv_credits"),
     COMBINED_CREDITS("combined_credits"),
+    /**
+     * @deprecated TMDB has marked support for tagged images as deprecated. Using this may lead to a server error.
+     */
+    @Deprecated
     TAGGED_IMAGES("tagged_images"),
 
     // Applies to Keywords, Companies

src/main/java/com/uwetrottmann/tmdb2/services/PeopleService.java

@@ -142,7 +142,10 @@ Call<Changes> changes(
      * @param personId A Person TMDb id.
      * @param page     <em>Optional.</em> Minimum value is 1, maximum 1000, expected value is an integer.
      * @param language <em>Optional.</em> ISO 639-1 code.
+     *
+     * @deprecated TMDB has marked this as deprecated and using it may lead to a server error.
      */
+    @Deprecated
     @GET("person/{person_id}/tagged_images")
     Call<TaggedImagesResultsPage> taggedImages(
             @Path("person_id") int personId,

src/test/java/com/uwetrottmann/tmdb2/assertions/GenericAssertions.java

@@ -16,8 +16,6 @@
 import com.uwetrottmann.tmdb2.entities.NetworkImage;
 import com.uwetrottmann.tmdb2.entities.SpokenLanguage;
 import com.uwetrottmann.tmdb2.entities.Status;
-import com.uwetrottmann.tmdb2.entities.TaggedImage;
-import com.uwetrottmann.tmdb2.entities.TaggedImagesResultsPage;
 import com.uwetrottmann.tmdb2.entities.Translations;
 import com.uwetrottmann.tmdb2.entities.Videos;
 import com.uwetrottmann.tmdb2.entities.WatchProviders;
@@ -113,21 +111,6 @@ public static void assertImage(Image image) {
         assertThat(image.vote_count).isGreaterThanOrEqualTo(0);
     }
 
-
-    public static void assertTaggedImage(TaggedImage image) {
-        assertImage(image);
-        assertThat(image.media_type).isNotNull();
-        assertThat(image.media).isNotNull();
-        switch(image.media_type) {
-            case "movie":
-                assertThat(image.media.movie).isNotNull();
-                break;
-            case "tv":
-                assertThat(image.media.tvShow).isNotNull();
-                break;
-        }
-    }
-
     public static void assertNetworkImage(NetworkImage image) {
         assertImage(image);
         assertThat(image.file_type).isNotNull();
@@ -141,14 +124,6 @@ public static void assertImages(List<Image> images) {
         }
     }
 
-    public static void assertTaggedImages(TaggedImagesResultsPage images) {
-        assertBaseResultsPage(images);
-
-        for (TaggedImage image : images.results) {
-            assertTaggedImage(image);
-        }
-    }
-
     public static void assertNetworkImages(List<NetworkImage> images) {
         assertThat(images).isNotNull();
         assertThat(images).isNotEmpty();

src/test/java/com/uwetrottmann/tmdb2/services/PeopleServiceTest.java

@@ -8,7 +8,6 @@
 import static com.uwetrottmann.tmdb2.TestData.testPersonChangesStartDate;
 import static com.uwetrottmann.tmdb2.assertions.ChangeAssertions.assertContentChanges;
 import static com.uwetrottmann.tmdb2.assertions.GenericAssertions.assertImages;
-import static com.uwetrottmann.tmdb2.assertions.GenericAssertions.assertTaggedImages;
 import static com.uwetrottmann.tmdb2.assertions.PersonAssertions.assertPerson;
 import static com.uwetrottmann.tmdb2.assertions.PersonAssertions.assertPersonCredits;
 import static com.uwetrottmann.tmdb2.assertions.PersonAssertions.assertPersonDataIntegrity;
@@ -24,7 +23,6 @@
 import com.uwetrottmann.tmdb2.entities.PersonExternalIds;
 import com.uwetrottmann.tmdb2.entities.PersonImages;
 import com.uwetrottmann.tmdb2.entities.PersonResultsPage;
-import com.uwetrottmann.tmdb2.entities.TaggedImagesResultsPage;
 import com.uwetrottmann.tmdb2.entities.TmdbDate;
 import com.uwetrottmann.tmdb2.enumerations.AppendToResponseItem;
 import java.io.IOException;
@@ -61,7 +59,6 @@ public void test_summary_with_append_to_response() throws IOException {
                         AppendToResponseItem.COMBINED_CREDITS,
                         AppendToResponseItem.EXTERNAL_IDS,
                         AppendToResponseItem.CHANGES,
-                        AppendToResponseItem.TAGGED_IMAGES,
                         AppendToResponseItem.TV_CREDITS
                 ),
                 opts
@@ -72,7 +69,6 @@ public void test_summary_with_append_to_response() throws IOException {
         assertPersonDataIntegrity(person);
         assertContentChanges(person.changes);
         assertImages(person.images.profiles);
-        assertTaggedImages(person.tagged_images);
         assertPersonCredits(person.movie_credits);
         assertPersonCredits(person.tv_credits);
         assertPersonCredits(person.combined_credits);
@@ -151,15 +147,6 @@ public void test_images() throws IOException {
         assertThat(images.id).isEqualTo(testPerson.id);
     }
 
-    @Test
-    public void test_tagged_images() throws IOException {
-        Call<TaggedImagesResultsPage> call = getUnauthenticatedInstance().personService().taggedImages(testPerson.id, null, null);
-        TaggedImagesResultsPage images = call.execute().body();
-
-        assertTaggedImages(images);
-        assertThat(images.id).isEqualTo(testPerson.id);
-    }
-
     @Test
     public void test_popular() throws IOException {
         Call<PersonResultsPage> call = getUnauthenticatedInstance().personService().popular(null);