def test_request_json__post_parameters(mock_request):
mock_request.side_effect = Session().request
data = {"apple": "pie", "orange": None}
request_json(url="http://google.com", body=data, parameters=data)
_, kwargs = mock_request.call_args
assert kwargs["method"] == "POST"
assert kwargs["params"] == d2l(clean_dict(data))
def test_request_json__post_body(mock_request):
data = {"apple": "pie"}
mock_request.side_effect = Session().request
request_json(url="http://google.com", body=data)
_, kwargs = mock_request.call_args
assert kwargs["method"] == "POST"
assert data == kwargs["json"]
def test_request_json__get_parameters(mock_request):
test_parameters = {"apple": "pie"}
mock_request.side_effect = Session().request
request_json(url="http://google.com", parameters=test_parameters)
_, kwargs = mock_request.call_args
assert kwargs["method"] == "GET"
assert kwargs["params"] == d2l(test_parameters)
def test_request_json__post_headers(mock_request):
mock_request.side_effect = Session().request
data = {"apple": "pie", "orange": None}
request_json(url="http://google.com", body=data, headers=data)
_, kwargs = mock_request.call_args
assert kwargs["method"] == "POST"
assert "apple" in kwargs["headers"]
assert "orange" not in kwargs["headers"]
def test_request_json__get_headers(mock_request):
mock_request.side_effect = Session().request
request_json(url="http://google.com",
headers={
"apple": "pie",
"orange": None
})
_, kwargs = mock_request.call_args
assert kwargs["method"] == "GET"
assert len(kwargs["headers"]) == 2
assert kwargs["headers"]["apple"] == "pie"
assert "user-agent" in kwargs["headers"]
def omdb_search(api_key, query, year=None, media_type=None, page=1, cache=True):
"""
Search for media using the Open Movie Database.
Online docs: http://www.omdbapi.com/#parameters.
"""
if media_type and media_type not in OMDB_MEDIA_TYPES:
raise MapiProviderException(
"media_type must be one of %s" % ",".join(OMDB_MEDIA_TYPES)
)
if 1 > page > 100:
raise MapiProviderException("page must be between 1 and 100")
url = "http://www.omdbapi.com"
parameters = {
"apikey": api_key,
"s": query,
"y": year,
"type": media_type,
"page": page,
}
parameters = clean_dict(parameters)
status, content = request_json(url, parameters, cache=cache)
if status == 401:
raise MapiProviderException("invalid API key")
elif content and not content.get("totalResults"):
raise MapiNotFoundException()
elif not content or status != 200: # pragma: no cover
raise MapiNetworkException("OMDb down or unavailable?")
return content
def tmdb_search_movies(
api_key, title, year=None, adult=False, region=None, page=1, cache=True
):
"""
Search for movies using The Movie Database.
Online docs: developers.themoviedb.org/3/search/search-movies.
"""
url = "https://api.themoviedb.org/3/search/movie"
try:
if year:
year = int(year)
except ValueError:
raise MapiProviderException("year must be numeric")
parameters = {
"api_key": api_key,
"query": title,
"page": page,
"include_adult": adult,
"region": region,
"year": year,
}
status, content = request_json(url, parameters, cache=cache)
if status == 401:
raise MapiProviderException("invalid API key")
elif status != 200 or not any(content.keys()): # pragma: no cover
raise MapiNetworkException("TMDb down or unavailable?")
elif status == 404 or status == 422 or not content.get("total_results"):
raise MapiNotFoundException
return content
def tvdb_episodes_id(token, id_tvdb, lang="en", cache=True):
"""
Returns the full information for a given episode id.
Online docs: https://api.thetvdb.com/swagger#!/Episodes.
"""
if lang not in TVDB_LANGUAGE_CODES:
raise MapiProviderException(
"'lang' must be one of %s" % ",".join(TVDB_LANGUAGE_CODES)
)
try:
url = "https://api.thetvdb.com/episodes/%d" % int(id_tvdb)
except ValueError:
raise MapiProviderException("id_tvdb must be numeric")
headers = {"Accept-Language": lang, "Authorization": "Bearer %s" % token}
status, content = request_json(url, headers=headers, cache=cache)
if status == 401:
raise MapiProviderException("invalid token")
elif status == 404:
raise MapiNotFoundException
elif status == 200 and "invalidLanguage" in content.get("errors", {}):
raise MapiNotFoundException
elif status != 200 or not content.get("data"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content
def tvdb_series_id_episodes_query(
token, id_tvdb, episode=None, season=None, page=1, lang="en", cache=True
):
"""
Allows the user to query against episodes for the given series.
Note: Paginated with 100 results per page; omitted imdbId-- when would you
ever need to query against both tvdb and imdb series ids?
Online docs: api.thetvdb.com/swagger#!/Series/get_series_id_episodes_query.
"""
if lang not in TVDB_LANGUAGE_CODES:
raise MapiProviderException(
"'lang' must be one of %s" % ",".join(TVDB_LANGUAGE_CODES)
)
try:
url = "https://api.thetvdb.com/series/%d/episodes/query" % int(id_tvdb)
except ValueError:
raise MapiProviderException("id_tvdb must be numeric")
headers = {"Accept-Language": lang, "Authorization": "Bearer %s" % token}
parameters = {"airedSeason": season, "airedEpisode": episode, "page": page}
status, content = request_json(
url, parameters, headers=headers, cache=cache
)
if status == 401:
raise MapiProviderException("invalid token")
elif status == 404:
raise MapiNotFoundException
elif status != 200 or not content.get("data"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content
def tvdb_series_id_episodes(token, id_tvdb, page=1, lang="en", cache=True):
"""
All episodes for a given series.
Note: Paginated with 100 results per page.
Online docs: api.thetvdb.com/swagger#!/Series/get_series_id_episodes.
"""
if lang not in TVDB_LANGUAGE_CODES:
raise MapiProviderException(
"'lang' must be one of %s" % ",".join(TVDB_LANGUAGE_CODES)
)
try:
url = "https://api.thetvdb.com/series/%d/episodes" % int(id_tvdb)
except ValueError:
raise MapiProviderException("id_tvdb must be numeric")
headers = {"Accept-Language": lang, "Authorization": "Bearer %s" % token}
parameters = {"page": page}
status, content = request_json(
url, parameters, headers=headers, cache=cache
)
if status == 401:
raise MapiProviderException("invalid token")
elif status == 404:
raise MapiNotFoundException
elif status != 200 or not content.get("data"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content
def tvdb_search_series(
token, series=None, id_imdb=None, id_zap2it=None, lang="en", cache=True
):
"""
Allows the user to search for a series based on the following parameters.
Online docs: https://api.thetvdb.com/swagger#!/Search/get_search_series
Note: results a maximum of 100 entries per page, no option for pagination.
"""
if lang not in TVDB_LANGUAGE_CODES:
raise MapiProviderException(
"'lang' must be one of %s" % ",".join(TVDB_LANGUAGE_CODES)
)
url = "https://api.thetvdb.com/search/series"
parameters = {"name": series, "imdbId": id_imdb, "zap2itId": id_zap2it}
headers = {"Accept-Language": lang, "Authorization": "Bearer %s" % token}
status, content = request_json(
url, parameters, headers=headers, cache=cache
)
if status == 401:
raise MapiProviderException("invalid token")
elif status == 405:
raise MapiProviderException(
"series, id_imdb, id_zap2it parameters are mutually exclusive"
)
elif status == 404: # pragma: no cover
raise MapiNotFoundException
elif status != 200 or not content.get("data"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content
def tvdb_refresh_token(token):
"""
Refreshes JWT token.
Online docs: api.thetvdb.com/swagger#!/Authentication/get_refresh_token.
"""
url = "https://api.thetvdb.com/refresh_token"
headers = {"Authorization": "Bearer %s" % token}
status, content = request_json(url, headers=headers, cache=False)
if status == 401:
raise MapiProviderException("invalid token")
elif status != 200 or not content.get("token"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content["token"]
def tvdb_login(api_key):
"""
Logs into TVDb using the provided api key.
Note: You can register for a free TVDb key at thetvdb.com/?tab=apiregister
Online docs: api.thetvdb.com/swagger#!/Authentication/post_login.
"""
url = "https://api.thetvdb.com/login"
body = {"apikey": api_key}
status, content = request_json(url, body=body, cache=False)
if status == 401:
raise MapiProviderException("invalid api key")
elif status != 200 or not content.get("token"): # pragma: no cover
raise MapiNetworkException("TVDb down or unavailable?")
return content["token"]
def test_request_json__xml_data(mock_request):
xml_data = """
<?xml version="1.0" encoding="UTF-8" ?>
<status>true</status>
<data>
<title>The Matrix</title>
<year>1999</year>
<genre />
</data>
"""
mock_response = MockRequestResponse(200, xml_data)
mock_request.return_value = mock_response
status, content = request_json("http://...", cache=False)
assert status == 500
assert content is None
def omdb_title(
api_key,
id_imdb=None,
media_type=None,
title=None,
season=None,
episode=None,
year=None,
plot=None,
cache=True,
):
"""
Lookup media using the Open Movie Database.
Online docs: http://www.omdbapi.com/#parameters
"""
if (not title and not id_imdb) or (title and id_imdb):
raise MapiProviderException("either id_imdb or title must be specified")
elif media_type and media_type not in OMDB_MEDIA_TYPES:
raise MapiProviderException(
"media_type must be one of %s" % ",".join(OMDB_MEDIA_TYPES)
)
elif plot and plot not in OMDB_PLOT_TYPES:
raise MapiProviderException(
"plot must be one of %s" % ",".join(OMDB_PLOT_TYPES)
)
url = "http://www.omdbapi.com"
parameters = {
"apikey": api_key,
"i": id_imdb,
"t": title,
"y": year,
"season": season,
"episode": episode,
"type": media_type,
"plot": plot,
}
parameters = clean_dict(parameters)
status, content = request_json(url, parameters, cache=cache)
error = content.get("Error") if isinstance(content, dict) else None
if status == 401:
raise MapiProviderException("invalid API key")
elif status != 200 or not isinstance(content, dict):
raise MapiNetworkException("OMDb down or unavailable?")
elif error:
raise MapiNotFoundException(error)
return content
def test_request_json__html_data(mock_request):
html_data = """
<!DOCTYPE html>
<html>
<body>
<h1>Data</h1>
<ul>
<li>Title: The Matrix</li>
<li>Year: 1999</li>
<li>Genre: ???</li>
</ul>
</body>
</html>
"""
mock_response = MockRequestResponse(200, html_data)
mock_request.return_value = mock_response
status, content = request_json("http://...", cache=False)
assert status == 500
assert content is None
def tmdb_movies(api_key, id_tmdb, language="en-US", cache=True):
"""
Lookup a movie item using The Movie Database.
Online docs: developers.themoviedb.org/3/movies.
"""
try:
url = "https://api.themoviedb.org/3/movie/%d" % int(id_tmdb)
except ValueError:
raise MapiProviderException("id_tmdb must be numeric")
parameters = {"api_key": api_key, "language": language}
status, content = request_json(url, parameters, cache=cache)
if status == 401:
raise MapiProviderException("invalid API key")
elif status == 404:
raise MapiNotFoundException
elif status != 200 or not any(content.keys()): # pragma: no cover
raise MapiNetworkException("TMDb down or unavailable?")
return content
def test_request_json__json_data(mock_request):
json_data = """{
"status": true,
"data": {
"title": "The Matrix",
"year": 1999,
"genre": null
}
}"""
json_dict = {
"status": True,
"data": {
"title": "The Matrix",
"year": 1999,
"genre": None
},
}
mock_response = MockRequestResponse(200, json_data)
mock_request.return_value = mock_response
status, content = request_json("http://...", cache=False)
assert status == 200
assert content == json_dict
def tmdb_find(
api_key, external_source, external_id, language="en-US", cache=True
):
"""
Search for The Movie Database objects using another DB's foreign key.
Note: language codes aren't checked on this end or by TMDb, so if you
enter an invalid language code your search itself will succeed, but
certain fields like synopsis will just be empty.
Online docs: developers.themoviedb.org/3/find.
"""
sources = ["imdb_id", "freebase_mid", "freebase_id", "tvdb_id", "tvrage_id"]
if external_source not in sources:
raise MapiProviderException("external_source must be in %s" % sources)
if external_source == "imdb_id" and not match(r"tt\d+", external_id):
raise MapiProviderException("invalid imdb tt-const value")
url = "https://api.themoviedb.org/3/find/" + external_id or ""
parameters = {
"api_key": api_key,
"external_source": external_source,
"language": language,
}
keys = [
"movie_results",
"person_results",
"tv_episode_results",
"tv_results",
"tv_season_results",
]
status, content = request_json(url, parameters, cache=cache)
if status == 401:
raise MapiProviderException("invalid API key")
elif status != 200 or not any(content.keys()): # pragma: no cover
raise MapiNetworkException("TMDb down or unavailable?")
elif status == 404 or not any(content.get(k, {}) for k in keys):
raise MapiNotFoundException
return content
def test_request_json__status(mock_request, code):
mock_response = MockRequestResponse(code, "{}")
mock_request.return_value = mock_response
status, _ = request_json("http://...", cache=False)
assert status == code
def test_request_json__data(mock_request, code, truthy):
mock_response = MockRequestResponse(code, '{"status":true}')
mock_request.return_value = mock_response
_, content = request_json("http://...", cache=False)
assert content if truthy else not content
def test_request_json__get_invalid_url():
status, content = request_json("mapi rulez", cache=False)
assert status == 500
assert content is None
def test_request_json__failure(mock_request):
mock_request.side_effect = Exception
status, content = request_json(url="http://google.com")
assert status == 500
assert content is None
