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

Remove unsupported SearchList function

Browse Source
master
Stuart Boston 9 years ago
parent c5a1a85a2a
commit b91dac2c9d
3 changed files with 80 additions and 196 deletions
Show Stats Download Patch File Download Diff File

238
src/main/java/com/omertron/themoviedbapi/TheMovieDbApi.java
Unescape Escape View File

@ -100,8 +100,7 @@ import org.yamj.api.common.http.SimpleHttpClientBuilder;
/**
* The MovieInfo API
* <p>
* This is for version 3 of the API as specified here:
* http://help.themoviedb.org/kb/api/about-3
* This is for version 3 of the API as specified here: http://help.themoviedb.org/kb/api/about-3
*
* @author stuart.boston
*/
@ -185,8 +184,7 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Account">
/**
* Get the basic information for an account. You will need to have a valid
* session id.
* Get the basic information for an account. You will need to have a valid session id.
*
* @param sessionId
* @return
@ -352,16 +350,13 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Authentication">
/**
* This method is used to generate a valid request token for user based
* authentication.
* This method is used to generate a valid request token for user based authentication.
*
* A request token is required in order to request a session id.
*
* You can generate any number of request tokens but they will expire after
* 60 minutes.
* You can generate any number of request tokens but they will expire after 60 minutes.
*
* As soon as a valid session id has been created the token will be
* destroyed.
* As soon as a valid session id has been created the token will be destroyed.
*
* @return
* @throws MovieDbException
@ -371,8 +366,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to generate a session id for user based
* authentication.
* This method is used to generate a session id for user based authentication.
*
* A session id is required in order to use any of the write methods.
*
@ -385,8 +379,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to generate a session id for user based
* authentication. User must provide their username and password
* This method is used to generate a session id for user based authentication. User must provide their username and password
*
* A session id is required in order to use any of the write methods.
*
@ -403,18 +396,14 @@ public class TheMovieDbApi {
/**
* This method is used to generate a guest session id.
*
* A guest session can be used to rate movies without having a registered
* TMDb user account.
* A guest session can be used to rate movies without having a registered TMDb user account.
*
* You should only generate a single guest session per user (or device) as
* you will be able to attach the ratings to a TMDb user account in the
* future.
* You should only generate a single guest session per user (or device) as you will be able to attach the ratings to a TMDb user
* account in the future.
*
* There are also IP limits in place so you should always make sure it's the
* end user doing the guest session actions.
* There are also IP limits in place so you should always make sure it's the end user doing the guest session actions.
*
* If a guest session is not used for the first time within 24 hours, it
* will be automatically discarded.
* If a guest session is not used for the first time within 24 hours, it will be automatically discarded.
*
* @return
* @throws MovieDbException
@ -450,8 +439,7 @@ public class TheMovieDbApi {
/**
* Get a list of Movie IDs that have been edited.
*
* You can then use the movie changes API to get the actual data that has
* been changed.
* You can then use the movie changes API to get the actual data that has been changed.
*
* @param page
* @param startDate the start date of the changes, optional
@ -466,8 +454,7 @@ public class TheMovieDbApi {
/**
* Get a list of TV IDs that have been edited.
*
* You can then use the TV changes API to get the actual data that has been
* changed.
* You can then use the TV changes API to get the actual data that has been changed.
*
* @param page
* @param startDate the start date of the changes, optional
@ -482,8 +469,7 @@ public class TheMovieDbApi {
/**
* Get a list of PersonInfo IDs that have been edited.
*
* You can then use the person changes API to get the actual data that has
* been changed.
* You can then use the person changes API to get the actual data that has been changed.
*
* @param page
* @param startDate the start date of the changes, optional
@ -498,11 +484,9 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Collections">
/**
* This method is used to retrieve all of the basic information about a
* movie collection.
* This method is used to retrieve all of the basic information about a movie collection.
*
* You can get the ID needed for this method by making a getMovieInfo
* request for the belongs_to_collection.
* You can get the ID needed for this method by making a getMovieInfo request for the belongs_to_collection.
*
* @param collectionId
* @param language
@ -528,8 +512,7 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Companies">
/**
* This method is used to retrieve the basic information about a production
* company on TMDb.
* This method is used to retrieve the basic information about a production company on TMDb.
*
* @param companyId
* @return
@ -542,8 +525,7 @@ public class TheMovieDbApi {
/**
* This method is used to retrieve the movies associated with a company.
*
* These movies are returned in order of most recently released to oldest.
* The default response will return 20 movies per page.
* These movies are returned in order of most recently released to oldest. The default response will return 20 movies per page.
*
* @param companyId
* @param language
@ -590,8 +572,7 @@ public class TheMovieDbApi {
}
/**
* Get the list of supported timezones for the API methods that support
* them.
* Get the list of supported timezones for the API methods that support them.
*
* @return @throws MovieDbException
*/
@ -605,15 +586,12 @@ public class TheMovieDbApi {
* Get the detailed information about a particular credit record.
* <p>
* This is currently only supported with the new credit model found in TV.
* <br/>
* These IDs can be found from any TV credit response as well as the
* TV_credits and combined_credits methods for people. <br/>
* The episodes object returns a list of episodes and are generally going to
* be guest stars. <br/>
* The season array will return a list of season numbers. <br/>
* Season credits are credits that were marked with the "add to every
* season" option in the editing interface and are assumed to be "season
* regulars".
*
* These IDs can be found from any TV credit response as well as the TV_credits and combined_credits methods for people.<br>
* The episodes object returns a list of episodes and are generally going to be guest stars. <br>
* The season array will return a list of season numbers. <br>
* Season credits are credits that were marked with the "add to every season" option in the editing interface and are assumed to
* be "season regulars".
*
* @param creditId
* @param language
@ -627,8 +605,7 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Discover">
/**
* Discover movies by different types of data like average rating, number of
* votes, genres and certifications.
* Discover movies by different types of data like average rating, number of votes, genres and certifications.
*
* @param discover A discover object containing the search criteria required
* @return
@ -639,8 +616,7 @@ public class TheMovieDbApi {
}
/**
* Discover movies by different types of data like average rating, number of
* votes, genres and certifications.
* Discover movies by different types of data like average rating, number of votes, genres and certifications.
*
* @param discover A discover object containing the search criteria required
* @return
@ -653,18 +629,16 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="Find">
/**
* You con use this method to find movies, tv series or persons using
* external ids.
* You con use this method to find movies, tv series or persons using external ids.
*
* Supported query ids are
* <ul>
* <li>Movies: imdb_id</li>
* <li>People: imdb_id, freebase_mid, freebase_id, tvrage_id</li>
* <li>TV Series: imdb_id, freebase_mid, freebase_id, tvdb_id,
* tvrage_id</li>
* <li>TV Series: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id</li>
* <li>TV Seasons: freebase_mid, freebase_id, tvdb_id, tvrage_id</li>
* <li>TV Episodes: imdb_id, freebase_mid, freebase_id, tvdb_id,
* tvrage_idimdb_id, freebase_mid, freebase_id, tvrage_id, tvdb_id.
* <li>TV Episodes: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_idimdb_id, freebase_mid, freebase_id, tvrage_id,
* tvdb_id.
* </ul>
*
* For details see http://docs.themoviedb.apiary.io/#find
@ -706,11 +680,9 @@ public class TheMovieDbApi {
/**
* Get a list of movies per genre.
*
* It is important to understand that only movies with more than 10 votes
* get listed.
* It is important to understand that only movies with more than 10 votes get listed.
*
* This prevents movies from 1 10/10 rating from being listed first and for
* the first 5 pages.
* This prevents movies from 1 10/10 rating from being listed first and for the first 5 pages.
*
* @param genreId
* @param language
@ -777,8 +749,7 @@ public class TheMovieDbApi {
}
/**
* This method lets users delete a list that they created. A valid session
* id is required.
* This method lets users delete a list that they created. A valid session id is required.
*
* @param sessionId
* @param listId
@ -838,8 +809,7 @@ public class TheMovieDbApi {
*
* It will return the single highest rated poster and backdrop.
*
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies
* found.
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
*
* @param movieId
* @param language
@ -856,8 +826,7 @@ public class TheMovieDbApi {
*
* It will return the single highest rated poster and backdrop.
*
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies
* found.
* ApiExceptionType.MOVIE_ID_NOT_FOUND will be thrown if there are no movies found.
*
* @param imdbId
* @param language
@ -870,8 +839,8 @@ public class TheMovieDbApi {
}
/**
* This method lets a user get the status of whether or not the movie has
* been rated or added to their favourite or movie watch list.
* This method lets a user get the status of whether or not the movie has been rated or added to their favourite or movie watch
* list.
*
* A valid session id is required.
*
@ -885,8 +854,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve all of the alternative titles we have for
* a particular movie.
* This method is used to retrieve all of the alternative titles we have for a particular movie.
*
* @param movieId
* @param country
@ -909,8 +877,7 @@ public class TheMovieDbApi {
}
/**
* This method should be used when you’re wanting to retrieve all of the
* images for a particular movie.
* This method should be used when you’re wanting to retrieve all of the images for a particular movie.
*
* @param movieId
* @param language
@ -922,8 +889,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve all of the keywords that have been added
* to a particular movie.
* This method is used to retrieve all of the keywords that have been added to a particular movie.
*
* Currently, only English keywords exist.
*
@ -936,8 +902,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve all of the release and certification data
* we have for a specific movie.
* This method is used to retrieve all of the release and certification data we have for a specific movie.
*
* @param movieId
* @param language
@ -949,8 +914,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve all of the trailers for a particular
* movie.
* This method is used to retrieve all of the trailers for a particular movie.
*
* Supported sites are YouTube and QuickTime.
*
@ -964,8 +928,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve a list of the available translations for
* a specific movie.
* This method is used to retrieve a list of the available translations for a specific movie.
*
* @param movieId
* @return
@ -976,11 +939,9 @@ public class TheMovieDbApi {
}
/**
* The similar movies method will let you retrieve the similar movies for a
* particular movie.
* The similar movies method will let you retrieve the similar movies for a particular movie.
*
* This data is created dynamically but with the help of users votes on
* TMDb.
* This data is created dynamically but with the help of users votes on TMDb.
*
* The data is much better with movies that have more keywords
*
@ -1027,8 +988,7 @@ public class TheMovieDbApi {
*
* By default, only the last 24 hours of changes are returned.
*
* The maximum number of days that can be returned in a single request is
* 14.
* The maximum number of days that can be returned in a single request is 14.
*
* The language is present on fields that are translatable.
*
@ -1087,8 +1047,7 @@ public class TheMovieDbApi {
/**
* This method is used to retrieve the movies currently in theatres.
*
* This is a curated list that will normally contain 100 movies. The default
* response will return 20 movies.
* This is a curated list that will normally contain 100 movies. The default response will return 20 movies.
*
* @param language
* @param page
@ -1114,8 +1073,7 @@ public class TheMovieDbApi {
}
/**
* This method is used to retrieve the top rated movies that have over 10
* votes on TMDb.
* This method is used to retrieve the top rated movies that have over 10 votes on TMDb.
*
* The default response will return 20 movies.
*
@ -1172,11 +1130,9 @@ public class TheMovieDbApi {
/**
* Get the TV credits for a specific person id.
*
* To get the expanded details for each record, call the /credit method with
* the provided credit_id.
* To get the expanded details for each record, call the /credit method with the provided credit_id.
*
* This will provide details about which episode and/or season the credit is
* for.
* This will provide details about which episode and/or season the credit is for.
*
* @param personId
* @param language
@ -1190,11 +1146,9 @@ public class TheMovieDbApi {
/**
* Get the combined (movie and TV) credits for a specific person id.
*
* To get the expanded details for each TV record, call the /credit method
* with the provided credit_id.
* To get the expanded details for each TV record, call the /credit method with the provided credit_id.
*
* This will provide details about which episode and/or season the credit is
* for.
* This will provide details about which episode and/or season the credit is for.
*
* @param personId
* @param language
@ -1230,8 +1184,7 @@ public class TheMovieDbApi {
/**
* Get the images that have been tagged with a specific person id.
*
* We return all of the image results with a media object mapped for each
* image.
* We return all of the image results with a media object mapped for each image.
*
* @param personId
* @param page
@ -1250,8 +1203,7 @@ public class TheMovieDbApi {
*
* By default, only the last 24 hours of changes are returned.
*
* The maximum number of days that can be returned in a single request is
* 14.
* The maximum number of days that can be returned in a single request is 14.
*
* The language is present on fields that are translatable.
*
@ -1304,8 +1256,8 @@ public class TheMovieDbApi {
/**
* Search Companies.
*
* You can use this method to search for production companies that are part
* of TMDb. The company IDs will map to those returned on movie calls.
* You can use this method to search for production companies that are part of TMDb. The company IDs will map to those returned
* on movie calls.
*
* http://help.themoviedb.org/kb/api/search-companies
*
@ -1344,29 +1296,13 @@ public class TheMovieDbApi {
}
/**
* Search for lists by name and description.
*
* @param query
* @param includeAdult
* @param page
* @return
* @throws MovieDbException
*/
public ResultList<UserList> searchList(String query, Integer page, Boolean includeAdult) throws MovieDbException {
return tmdbSearch.searchList(query, page, includeAdult);
}
/**
* Search Movies This is a good starting point to start finding movies on
* TMDb.
* Search Movies This is a good starting point to start finding movies on TMDb.
*
* @param query
* @param searchYear Limit the search to the provided year. Zero (0) will
* get all years
* @param searchYear Limit the search to the provided year. Zero (0) will get all years
* @param language The language to include. Can be blank/null.
* @param includeAdult true or false to include adult titles in the search
* @param page The page of results to return. 0 to get the default (first
* page)
* @param page The page of results to return. 0 to get the default (first page)
* @param primaryReleaseYear
* @param searchType
* @return
@ -1385,11 +1321,9 @@ public class TheMovieDbApi {
/**
* Search the movie, tv show and person collections with a single query.
*
* Each item returned in the result array has a media_type field that maps
* to either movie, tv or person.
* Each item returned in the result array has a media_type field that maps to either movie, tv or person.
*
* Each mapped result is the same response you would get from each
* independent search
* Each mapped result is the same response you would get from each independent search
*
* @param query
* @param page
@ -1405,8 +1339,7 @@ public class TheMovieDbApi {
/**
* This is a good starting point to start finding people on TMDb.
*
* The idea is to be a quick and light method so you can iterate through
* people quickly.
* The idea is to be a quick and light method so you can iterate through people quickly.
*
* @param query
* @param includeAdult
@ -1450,8 +1383,8 @@ public class TheMovieDbApi {
}
/**
* 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.
*
@ -1577,8 +1510,7 @@ public class TheMovieDbApi {
}
/**
* 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
@ -1589,8 +1521,7 @@ public class TheMovieDbApi {
}
/**
* 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
@ -1614,8 +1545,7 @@ public class TheMovieDbApi {
/**
* 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
@ -1644,8 +1574,7 @@ public class TheMovieDbApi {
/**
* 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.
*
@ -1700,8 +1629,7 @@ public class TheMovieDbApi {
}
/**
* This method lets users get the status of whether or not the TV episodes
* of a season have been rated.
* This method lets users get the status of whether or not the TV episodes of a season have been rated.
*
* A valid session id is required.
*
@ -1727,8 +1655,7 @@ public class TheMovieDbApi {
}
/**
* Get the external ids that we have stored for a TV season by season
* number.
* Get the external ids that we have stored for a TV season by season number.
*
* @param tvID
* @param seasonNumber
@ -1755,8 +1682,7 @@ public class TheMovieDbApi {
}
/**
* Get the videos that have been added to a TV season (trailers, teasers,
* etc...)
* Get the videos that have been added to a TV season (trailers, teasers, etc...)
*
* @param tvID
* @param seasonNumber
@ -1771,8 +1697,7 @@ public class TheMovieDbApi {
//<editor-fold defaultstate="collapsed" desc="TV Episodes">
/**
* Get the primary information about a TV episode by combination of a season
* and episode number.
* Get the primary information about a TV episode by combination of a season and episode number.
*
* @param tvID
* @param seasonNumber
@ -1800,8 +1725,7 @@ public class TheMovieDbApi {
}
/**
* This method lets users get the status of whether or not the TV episode
* has been rated.
* This method lets users get the status of whether or not the TV episode has been rated.
*
* A valid session id is required.
*
@ -1830,8 +1754,7 @@ public class TheMovieDbApi {
}
/**
* Get the external ids for a TV episode by comabination of a season and
* episode number.
* Get the external ids for a TV episode by comabination of a season and episode number.
*
* @param tvID
* @param seasonNumber
@ -1845,8 +1768,7 @@ public class TheMovieDbApi {
}
/**
* Get the images (episode stills) for a TV episode by combination of a
* season and episode number.
* Get the images (episode stills) for a TV episode by combination of a season and episode number.
*
* @param tvID
* @param seasonNumber
@ -1859,8 +1781,7 @@ public class TheMovieDbApi {
}
/**
* This method lets users rate a TV episode. A valid session id or guest
* session id is required.
* This method lets users rate a TV episode. A valid session id or guest session id is required.
*
* @param tvID
* @param seasonNumber
@ -1876,8 +1797,7 @@ public class TheMovieDbApi {
}
/**
* Get the videos that have been added to a TV episode (teasers, clips,
* etc...)
* Get the videos that have been added to a TV episode (teasers, clips, etc...)
*
* @param tvID
* @param seasonNumber

21
src/main/java/com/omertron/themoviedbapi/methods/TmdbSearch.java
Unescape Escape View File

@ -25,7 +25,6 @@ import static com.omertron.themoviedbapi.methods.AbstractMethod.MAPPER;
import com.omertron.themoviedbapi.model.collection.Collection;
import com.omertron.themoviedbapi.model.company.Company;
import com.omertron.themoviedbapi.model.keyword.Keyword;
import com.omertron.themoviedbapi.model.list.UserList;
import com.omertron.themoviedbapi.model.media.MediaBasic;
import com.omertron.themoviedbapi.model.movie.MovieInfo;
import com.omertron.themoviedbapi.model.person.PersonFind;
@ -121,26 +120,6 @@ public class TmdbSearch extends AbstractMethod {
return wrapper.getResultsList();
}
/**
* Search for lists by name and description.
*
* @param query
* @param includeAdult
* @param page
* @return
* @throws MovieDbException
*/
public ResultList<UserList> searchList(String query, Integer page, Boolean includeAdult) throws MovieDbException {
TmdbParameters parameters = new TmdbParameters();
parameters.add(Param.QUERY, query);
parameters.add(Param.PAGE, page);
parameters.add(Param.INCLUDE_ADULT, includeAdult);
URL url = new ApiUrl(apiKey, MethodBase.SEARCH).subMethod(MethodSub.LIST).buildUrl(parameters);
WrapperGenericList<UserList> wrapper = processWrapper(getTypeReference(UserList.class), url, "list");
return wrapper.getResultsList();
}
/**
* Search Movies This is a good starting point to start finding movies on TMDb.
*

17
src/test/java/com/omertron/themoviedbapi/methods/TmdbSearchTest.java
Unescape Escape View File

@ -27,7 +27,6 @@ import com.omertron.themoviedbapi.enumeration.SearchType;
import com.omertron.themoviedbapi.model.collection.Collection;
import com.omertron.themoviedbapi.model.company.Company;
import com.omertron.themoviedbapi.model.keyword.Keyword;
import com.omertron.themoviedbapi.model.list.UserList;
import com.omertron.themoviedbapi.model.media.MediaBasic;
import com.omertron.themoviedbapi.model.movie.MovieInfo;
import com.omertron.themoviedbapi.model.person.PersonFind;
@ -91,21 +90,7 @@ public class TmdbSearchTest extends AbstractTests {
int page = 0;
ResultList<Keyword> result = instance.searchKeyword(query, page);
TestSuite.test(result, "Keyword");
TestSuite.testId(result, 207600, "Keyword");
}
/**
* Test of searchList method, of class TheMovieDbApi.
*
* @throws MovieDbException
*/
@Test
public void testSearchList() throws MovieDbException {
LOG.info("searchList");
String query = "watch";
int page = 0;
ResultList<UserList> result = instance.searchList(query, page, null);
TestSuite.test(result, "List");
TestSuite.testId(result, 210313, "Keyword");
}
/**

Write Preview
Loading…
Cancel
Save