birkeh/api-themoviedb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

AppendToResponse: TV Methods

Browse Source
This commit is contained in:
Stuart Boston
2015-03-13 21:25:40 +00:00
parent 99896ca027
commit c2887f2f8c
4 changed files with 194 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/com/omertron/themoviedbapi/methods/TmdbTV.java
+6 -10
View File
@@ -96,8 +96,8 @@ public class TmdbTV extends AbstractMethod {
}
/**
* This method lets users get the status of whether or not the TV show has
* been rated or added to their favourite or watch lists.
* This method lets users get the status of whether or not the TV show has been rated or added to their favourite or watch
* lists.
*
* A valid session id is required.
*
@@ -317,8 +317,7 @@ public class TmdbTV extends AbstractMethod {
}
/**
* Get the list of translations that exist for a TV series. These
* translations cascade down to the episode level.
* Get the list of translations that exist for a TV series. These translations cascade down to the episode level.
*
* @param tvID
* @return
@@ -342,8 +341,7 @@ public class TmdbTV extends AbstractMethod {
}
/**
* Get the videos that have been added to a TV series (trailers, opening
* credits, etc...)
* Get the videos that have been added to a TV series (trailers, opening credits, etc...)
*
* @param tvID
* @param language
@@ -388,8 +386,7 @@ public class TmdbTV extends AbstractMethod {
/**
* Get the list of TV shows that are currently on the air.
*
* This query looks for any TV show that has an episode with an air date in
* the next 7 days.
* This query looks for any TV show that has an episode with an air date in the next 7 days.
*
* @param page
* @param language
@@ -431,8 +428,7 @@ public class TmdbTV extends AbstractMethod {
/**
* Get the list of top rated TV shows.
*
* By default, this list will only include TV shows that have 2 or more
* votes.
* By default, this list will only include TV shows that have 2 or more votes.
*
* This list refreshes every day.
*
src/main/java/com/omertron/themoviedbapi/model/tv/TVInfo.java
+144
View File
@@ -20,12 +20,30 @@
package com.omertron.themoviedbapi.model.tv;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.omertron.themoviedbapi.enumeration.TVMethod;
import com.omertron.themoviedbapi.model.Genre;
import com.omertron.themoviedbapi.model.artwork.Artwork;
import com.omertron.themoviedbapi.model.change.ChangeKeyItem;
import com.omertron.themoviedbapi.model.keyword.Keyword;
import com.omertron.themoviedbapi.model.media.AlternativeTitle;
import com.omertron.themoviedbapi.model.media.MediaCreditList;
import com.omertron.themoviedbapi.model.media.Translation;
import com.omertron.themoviedbapi.model.media.Video;
import com.omertron.themoviedbapi.model.movie.ProductionCompany;
import com.omertron.themoviedbapi.model.network.Network;
import com.omertron.themoviedbapi.model.person.ContentRating;
import com.omertron.themoviedbapi.model.person.ExternalID;
import com.omertron.themoviedbapi.model.person.PersonBasic;
import com.omertron.themoviedbapi.results.WrapperChanges;
import com.omertron.themoviedbapi.results.WrapperGenericList;
import com.omertron.themoviedbapi.results.WrapperImages;
import com.omertron.themoviedbapi.results.WrapperTranslations;
import java.io.Serializable;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
/**
*
@@ -67,7 +85,21 @@ public class TVInfo extends TVBasic implements Serializable {
private String status;
@JsonProperty("type")
private String type;
// AppendToResponse
private final Set<TVMethod> methods = EnumSet.noneOf(TVMethod.class);
// AppendToResponse Properties
private List<AlternativeTitle> alternativeTitles = Collections.emptyList();
private List<ChangeKeyItem> changes = Collections.emptyList();
private List<ContentRating> contentRatings = Collections.emptyList();
private MediaCreditList credits = new MediaCreditList();
private ExternalID externalIDs = new ExternalID();
private List<Artwork> images = Collections.emptyList();
private List<Keyword> keywords = Collections.emptyList();
private List<Translation> translations = Collections.emptyList();
private List<TVInfo> similarTV = Collections.emptyList();
private List<Video> videos = Collections.emptyList();
//<editor-fold defaultstate="collapsed" desc="Getters and Setters">
public List<PersonBasic> getCreatedBy() {
return createdBy;
}
@@ -195,5 +227,117 @@ public class TVInfo extends TVBasic implements Serializable {
public void setType(String type) {
this.type = type;
}
//</editor-fold>
private void addMethod(TVMethod method) {
methods.add(method);
}
public boolean hasMethod(TVMethod method) {
return methods.contains(method);
}
//<editor-fold defaultstate="collapsed" desc="AppendToResponse Setters">
@JsonSetter("alternative_titles")
public void setAlternativeTitles(WrapperGenericList<AlternativeTitle> alternativeTitles) {
this.alternativeTitles = alternativeTitles.getResults();
addMethod(TVMethod.ALTERNATIVE_TITLES);
}
@JsonSetter("changes")
public void setChanges(WrapperChanges changes) {
this.changes = changes.getChangedItems();
addMethod(TVMethod.CHANGES);
}
@JsonSetter("content_ratings")
public void setContentRatings(WrapperGenericList<ContentRating> contentRatings) {
this.contentRatings = contentRatings.getResults();
addMethod(TVMethod.CONTENT_RATINGS);
}
@JsonSetter("credits")
public void setCredits(MediaCreditList credits) {
this.credits = credits;
addMethod(TVMethod.CREDITS);
}
@JsonSetter("external_ids")
public void setExternalIDs(ExternalID externalIDs) {
this.externalIDs = externalIDs;
addMethod(TVMethod.EXTERNAL_IDS);
}
@JsonSetter("images")
public void setImages(WrapperImages images) {
this.images = images.getAll();
addMethod(TVMethod.IMAGES);
}
@JsonSetter("keywords")
public void setKeywords(WrapperGenericList<Keyword> keywords) {
this.keywords = keywords.getResults();
addMethod(TVMethod.KEYWORDS);
}
@JsonSetter("translations")
public void setTranslations(WrapperTranslations translations) {
this.translations = translations.getTranslations();
addMethod(TVMethod.TRANSLATIONS);
}
@JsonSetter("similar")
public void setSimilarTV(WrapperGenericList<TVInfo> similarTV) {
this.similarTV = similarTV.getResults();
addMethod(TVMethod.SIMILAR);
}
@JsonSetter("videos")
public void setVideos(WrapperGenericList<Video> videos) {
this.videos = videos.getResults();
addMethod(TVMethod.VIDEOS);
}
//</editor-fold>
//<editor-fold defaultstate="collapsed" desc="AppendToResponse Getters">
public List<AlternativeTitle> getAlternativeTitles() {
return alternativeTitles;
}
public List<ChangeKeyItem> getChanges() {
return changes;
}
public List<ContentRating> getContentRatings() {
return contentRatings;
}
public MediaCreditList getCredits() {
return credits;
}
public ExternalID getExternalIDs() {
return externalIDs;
}
public List<Artwork> getImages() {
return images;
}
public List<Keyword> getKeywords() {
return keywords;
}
public List<Translation> getTranslations() {
return translations;
}
public List<TVInfo> getSimilarTV() {
return similarTV;
}
public List<Video> getVideos() {
return videos;
}
//</editor-fold>
}
src/test/java/com/omertron/themoviedbapi/TestSuite.java
-1
View File
@@ -133,7 +133,6 @@ public class TestSuite {
public static void test(ExternalID test) {
String message = test.getClass().getSimpleName();
assertTrue(message + ": Missing ID", test.getId() > 0);
assertTrue(message + ": Missing IMDB ID", StringUtils.isNotBlank(test.getImdbId()));
boolean found = false;
found |= StringUtils.isNotBlank(test.getFreebaseId());
src/test/java/com/omertron/themoviedbapi/methods/TmdbTVTest.java
+44
View File
@@ -25,6 +25,7 @@ import com.omertron.themoviedbapi.MovieDbException;
import com.omertron.themoviedbapi.TestID;
import com.omertron.themoviedbapi.TestSuite;
import com.omertron.themoviedbapi.enumeration.ArtworkType;
import com.omertron.themoviedbapi.enumeration.TVMethod;
import com.omertron.themoviedbapi.model.StatusCode;
import com.omertron.themoviedbapi.model.artwork.Artwork;
import com.omertron.themoviedbapi.model.change.ChangeKeyItem;
@@ -78,6 +79,49 @@ public class TmdbTVTest extends AbstractTests {
TV_IDS.add(new TestID("The Big Bang Theory", "tt0898266", 1418, "Kaley Cuoco"));
}
/**
* Test of Append_To_Response method, of class TmdbTV.
*
* @throws com.omertron.themoviedbapi.MovieDbException
*/
@Test
public void testAppendToResponse() throws MovieDbException {
LOG.info("appendToResponse");
String language = LANGUAGE_DEFAULT;
boolean first = true;
StringBuilder appendToResponse = new StringBuilder();
for (TVMethod method : TVMethod.values()) {
if (first) {
first = false;
} else {
appendToResponse.append(",");
}
appendToResponse.append(method.getPropertyString());
}
for (TestID test : TV_IDS) {
// Just test Waling Dead
if (test.getTmdb() != 1402) {
continue;
}
TVInfo result = instance.getTVInfo(test.getTmdb(), language, appendToResponse.toString());
TestSuite.test(result);
TestSuite.test(result.getAlternativeTitles(), "Alt titles");
TestSuite.test(result.getContentRatings(), "Content Ratings");
TestSuite.test(result.getCredits());
TestSuite.test(result.getExternalIDs());
TestSuite.test(result.getImages(), "Images");
TestSuite.test(result.getKeywords(), "Keywords");
TestSuite.test(result.getVideos(), "Videos");
TestSuite.test(result.getTranslations(), "Translations");
TestSuite.test(result.getSimilarTV(), "Similar");
// There are rarely any changes, so skip this test
}
}
/**
* Test of getTVInfo method, of class TmdbTV.
*