Handle more HTTP-related errors

Use JustWatchHttpError for all HTTP-related errors, not just error status codes.

Author: Electronic-Mango

docs/usage.md

@@ -33,9 +33,8 @@ Examples of parsed responses are in the GitHub repository in
 
 Each function can raise two exceptions:
 
- - [`JustWatchHttpError`](#http-errors) - JustWatch API responded with non-`2xx` code.
- - [`JustWatchApiError`](#api-errors) - JSON response from JustWatch API contains
-    errors.
+ - [`JustWatchHttpError`](#http-errors) - HTTP-related error occurred.
+ - [`JustWatchApiError`](#api-errors) - JSON response contains errors.
 
 You can check [Exceptions](API Reference/exceptions.md) page for more details.
 
@@ -279,7 +278,8 @@ Example function call and its output is in
 ### HTTP errors
 
 [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError]{data-preview}
-is raised when JustWatch API responds with non-`2xx` status code.
+is raised when HTTP-related error occurs, e.g., JustWatch API responds with
+non-`2xx` status code.
 
 Non-`2xx` response status codes can happen when trying to use incorrect type for
 parameters, e.g., trying to use a non-numeric string for `count`:
@@ -290,8 +290,7 @@ from simplejustwatchapi import search, JustWatchHttpError
 try:
     results = search("The Matrix", count="five")
 except JustWatchHttpError as e:
-    print(e.code, e.message)
-    # In this case "e.message" is a JSON, but handled as a regular string.
+    print(str(e))
 ```
 
 !!! note "Numeric strings instead of `int`"
@@ -309,8 +308,7 @@ except JustWatchHttpError as e:
 ### API errors
 
 [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]{data-preview} is
-raised when JustWatch API **does** respond with `2xx` status code, but the internal JSON
-response contain errors.
+raised when no HTTP-related errors occur, but the internal JSON response contain errors.
 
 API errors can occur for invalid country code:
 ```python

src/simplejustwatchapi/exceptions.py

@@ -4,14 +4,7 @@
 All exceptions inherit from [`JustWatchError`]
 [simplejustwatchapi.exceptions.JustWatchError] for easier catching.
 
-Specific exceptions are raised for non-`2xx` HTTP response status codes and GraphQL
-API response errors.
-
-Each exception includes relevant information for why it was raised, but not always in
-any particular parsed format. For example, [`JustWatchApiError`]
-[simplejustwatchapi.exceptions.JustWatchApiError] includes the list of errors from the
-API response, but stored as a `dict`/JSON, as it was received from the API.
-
+Specific exceptions are raised for HTTP-related errors and GraphQL API response errors.
 """
 
 
@@ -23,7 +16,7 @@ class JustWatchApiError(JustWatchError):
     """
     Raised when JustWatch API returned errors in JSON response.
 
-    If this error is raised, then API responded with status code `2xx`, but there are
+    If this error is raised, then no HTTP-related error occurred, but there are
     listed errors in the internal JSON response. It can happen for too high complexity
     of request, invalid node ID in functions like [`details`]
     [simplejustwatchapi.justwatch.details], or invalid country or language codes.
@@ -43,18 +36,8 @@ def __init__(self, errors: list[dict]) -> None:
 
 class JustWatchHttpError(JustWatchError):
     """
-    Raised when JustWatch API returned a non-`2xx` status code.
-
-    Any additional verification is not performed, ony the status code is checked.
-
-    Attributes:
-        code (int): HTTP status code returned by the API.
-        message (str): HTTP message response from the API.
+    Raised when HTTP-related error occurs.
 
+    This is a general exception for any HTTP-related errors, such as non-`2xx` status
+    codes, network errors, timeouts, etc.
     """
-
-    def __init__(self, code: int, message: str) -> None:
-        """Init JustWatchHttpError with status code and message from response."""
-        super().__init__(f"HTTP code {code}: {message}")
-        self.code = code
-        self.message = message

src/simplejustwatchapi/justwatch.py

@@ -41,13 +41,13 @@
 | Exception | Cause |
 |-----------|-------|
 | [`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError] | \
-    JustWatch API responded with non-`2xx` code. |
+    HTTP error occurred, e.g., JustWatch API responded with non-`2xx` status code. |
 | [`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError] | \
-    JSON response from JustWatch API contains errors (e.g., due to invalid language or \
-    country code). If this exception is raised, then API responded with `2xx` code. |
+    JSON response from JustWatch API contains errors, e.g., due to invalid language or \
+    country code. |
 """
 
-from httpx import post
+from httpx import HTTPError, post
 
 from simplejustwatchapi.exceptions import JustWatchHttpError
 from simplejustwatchapi.query import (
@@ -154,7 +154,8 @@ def search(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_search_request(
@@ -238,7 +239,8 @@ def popular(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_popular_request(
@@ -307,7 +309,8 @@ def details(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_details_request(node_id, country, language, best_only)
@@ -355,7 +358,8 @@ def seasons(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_seasons_request(show_id, country, language, best_only)
@@ -404,7 +408,8 @@ def episodes(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_episodes_request(season_id, country, language, best_only)
@@ -472,7 +477,8 @@ def offers_for_countries(
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     if not countries:
@@ -506,7 +512,8 @@ def providers(country: str = "US") -> list[OfferPackage]:
     Raises:
         exceptions.JustWatchApiError: JSON response from API has internal errors, e.g.,
             due to invalid language or country code.
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP error occurred, e.g., JustWatch API
+            responded with non-`2xx` status code.
 
     """
     request = prepare_providers_request(country)
@@ -525,10 +532,12 @@ def _post_to_jw_graphql_api(request_json: dict) -> dict:
         (dict): JSON response from the API.
 
     Raises:
-        exceptions.JustWatchHttpError: JustWatch API didn't respond with `2xx` code.
+        exceptions.JustWatchHttpError: HTTP-related error occurred.
 
     """
-    response = post(_GRAPHQL_API_URL, json=request_json)
-    if not response.is_success:
-        raise JustWatchHttpError(response.status_code, response.text)
+    try:
+        response = post(_GRAPHQL_API_URL, json=request_json)
+        response.raise_for_status()
+    except HTTPError as e:
+        raise JustWatchHttpError(str(e)) from e
     return response.json()

src/simplejustwatchapi/query.py

@@ -4,7 +4,7 @@
 Functions are prepared in pairs - prepare request and parse response for specific
 operation. "Request" functions do no verification of input data; "parse" functions check
 if returned JSON/`dict` contain `error` key. In such case a [`JustWatchApiError`]
-[simplejustwatchapi.erxceptions.JustWatchApiError] is raised.
+[simplejustwatchapi.exceptions.JustWatchApiError] is raised.
 
 All "parse" functions convert JSON returned by API into request-specific Python
 [`NamedTuple`][typing.NamedTuple].

src/simplejustwatchapi/tuples.py

@@ -24,7 +24,7 @@ class OfferPackage(NamedTuple):
     function to return data about all available providers.
 
     Attributes:
-        id (str): ID of the provider/plaform for this offer.
+        id (str): ID of the provider/platform for this offer.
         package_id (int): Package ID. I'm not sure how it's different from regular `id`.
         name (str): Name of the platform in format suited to display for users.
         technical_name (str): Technical name of the platform,

test/simplejustwatchapi/test_justwatch.py

@@ -1,5 +1,6 @@
 from unittest.mock import MagicMock, patch
 
+from httpx import Request, RequestError, Response
 from pytest import fixture, mark, raises
 
 from simplejustwatchapi.exceptions import JustWatchHttpError
@@ -31,15 +32,27 @@
 def post_mock_success(mocker):
     post_mock = mocker.patch("simplejustwatchapi.justwatch.post")
     post_mock.return_value.json.return_value = DUMMY_RESPONSE
-    post_mock.return_value.is_success = True
     yield post_mock
     post_mock.assert_called_with(JUSTWATCH_GRAPHQL_URL, json=REQUEST)
 
 
 @fixture
-def post_mock_failure(mocker):
+def post_mock_request_error(mocker):
     post_mock = mocker.patch("simplejustwatchapi.justwatch.post")
-    post_mock.return_value.is_success = False
+    post_mock.side_effect = RequestError("HTTP request error")
+    mock_request = Request(method="POST", url=JUSTWATCH_GRAPHQL_URL)
+    post_mock.return_value = Response(status_code=200, request=mock_request)
+    # Technically setting the return value is not necessary, since the side effect will
+    # be raised before the return value is used, but it can be useful for debugging if
+    # the test fails due to the side effect not being raised for some reason.
+    return post_mock
+
+
+@fixture
+def post_mock_status_error(mocker):
+    post_mock = mocker.patch("simplejustwatchapi.justwatch.post")
+    mock_request = Request(method="POST", url=JUSTWATCH_GRAPHQL_URL)
+    post_mock.return_value = Response(status_code=420, request=mock_request)
     return post_mock
 
 
@@ -143,7 +156,25 @@ def test_providers(requests_mock, parser_mock, post_mock_success):
         ("prepare_providers_request", providers, (PROVIDERS_INPUT,)),
     ],
 )
-def test_search_raises_http_error(prepare_name, function, inputs, post_mock_failure):
+def test_http_request_error(prepare_name, function, inputs, post_mock_request_error):
+    full_mock_name = f"simplejustwatchapi.justwatch.{prepare_name}"
+    with patch(full_mock_name), raises(JustWatchHttpError):
+        function(*inputs)
+
+
+@mark.parametrize(
+    argnames=("prepare_name", "function", "inputs"),
+    argvalues=[
+        ("prepare_search_request", search, SEARCH_INPUT),
+        ("prepare_popular_request", popular, POPULAR_INPUT),
+        ("prepare_details_request", details, DETAILS_INPUT),
+        ("prepare_seasons_request", seasons, DETAILS_INPUT),
+        ("prepare_episodes_request", episodes, DETAILS_INPUT),
+        ("prepare_offers_for_countries_request", offers_for_countries, OFFERS_INPUT),
+        ("prepare_providers_request", providers, (PROVIDERS_INPUT,)),
+    ],
+)
+def test_http_status_error(prepare_name, function, inputs, post_mock_status_error):
     full_mock_name = f"simplejustwatchapi.justwatch.{prepare_name}"
     with patch(full_mock_name), raises(JustWatchHttpError):
         function(*inputs)