Send Authorized API Requests (#10)

* Use email & password for GCD authentication
* Add docs for new args

grayven/grand_comics_database.py

@@ -29,17 +29,23 @@ class GrandComicsDatabase:
     """Class with functionality to request GCD API endpoints.
 
     Args:
+      email: The user's GCD email address, which is used for authentication.
+      password: The user's GCD password, which is used for authentication.
       timeout: Set how long requests will wait for a response (in seconds).
       cache: SQLiteCache to use if set.
     """
 
     API_URL = "https://www.comics.org/api"
 
-    def __init__(self, timeout: int = 30, cache: Optional[SQLiteCache] = None):
+    def __init__(
+        self, email: str, password: str, timeout: int = 30, cache: Optional[SQLiteCache] = None
+    ):
         self.headers = {
             "Accept": "application/json",
             "User-Agent": f"Grayven/{__version__}/{platform.system()}: {platform.release()}",
         }
+        self.email = email
+        self.password = password
         self.timeout = timeout
         self.cache = cache
 
@@ -64,7 +70,13 @@ def _perform_get_request(
             params = {}
 
         try:
-            response = get(url, params=params, headers=self.headers, timeout=self.timeout)
+            response = get(
+                url,
+                params=params,
+                headers=self.headers,
+                auth=(self.email, self.password),
+                timeout=self.timeout,
+            )
             response.raise_for_status()
             return response.json()
         except RequestError as err:

tests/conftest.py

@@ -3,6 +3,7 @@
 This module contains pytest fixtures.
 """
 
+import os
 from pathlib import Path
 
 import pytest
@@ -12,8 +13,23 @@
 
 
 @pytest.fixture(scope="session")
-def session() -> GrandComicsDatabase:
+def gcd_email() -> str:
+    """Email address for testing."""
+    return os.getenv("GCD_EMAIL", "<EMAIL>")
+
+
+@pytest.fixture(scope="session")
+def gcd_password() -> str:
+    """Password for testing."""
+    return os.getenv("GCD_PASSWORD", "passwrd")
+
+
+@pytest.fixture(scope="session")
+def session(gcd_email: str, gcd_password: str) -> GrandComicsDatabase:
     """Set the GrandComicsDatabase session fixture."""
     return GrandComicsDatabase(
-        cache=SQLiteCache(path=Path("tests/cache.sqlite"), expiry=None), timeout=5
+        email=gcd_email,
+        password=gcd_password,
+        cache=SQLiteCache(path=Path("tests/cache.sqlite"), expiry=None),
+        timeout=5,
     )

tests/exceptions_test.py

@@ -15,8 +15,8 @@ def test_not_found(session: GrandComicsDatabase) -> None:
         session._get_request(endpoint="/invalid")  # noqa: SLF001
 
 
-def test_timeout() -> None:
+def test_timeout(gcd_email: str, gcd_password: str) -> None:
     """Test a TimeoutError for slow responses."""
-    session = GrandComicsDatabase(timeout=1, cache=None)
+    session = GrandComicsDatabase(gcd_email, gcd_password, timeout=1, cache=None)
     with pytest.raises(ServiceError):
         session.get_publisher(id=1)

tests/issue_test.py

@@ -40,9 +40,13 @@ def issue_no_page_json() -> dict[str, any]:
     }
 
 
-def test_issue_no_page(httpx_mock: HTTPXMock, issue_no_page_json: dict[str, any]) -> None:
+def test_issue_no_page(
+    gcd_email: str, gcd_password: str, httpx_mock: HTTPXMock, issue_no_page_json: dict[str, any]
+) -> None:
     """Test issue with no page count."""
-    session = GrandComicsDatabase()  # We don't want to cache these results
+    session = GrandComicsDatabase(
+        email=gcd_email, password=gcd_password
+    )  # We don't want to cache these results
     httpx_mock.add_response(json=issue_no_page_json)
     result = session.get_issue(2698986)
     assert isinstance(result, Issue)
@@ -63,9 +67,10 @@ def test_issue(session: GrandComicsDatabase) -> None:
     assert result.publication_date == "July 2005"
     assert result.price == "3.50 USD; 4.75 CAD"
     assert result.page_count == Decimal("48")
-    assert (
-        result.editing
-        == "Peter J. Tomasi (credited as  Peter Tomasi) (editor); Harvey Richards (credited) (assistant editor); Dan DiDio (credited) (executive editor); Paul Levitz (credited) (publisher)"  # noqa: E501
+    assert result.editing == (
+        "Peter J. Tomasi (credited as  Peter Tomasi) (editor); Harvey Richards "
+        "(credited) (assistant editor); Dan DiDio (credited) (executive editor); "
+        "Paul Levitz (credited) (publisher)"
     )
     assert result.indicia_publisher == "DC Comics"
     assert result.brand == "DC [bullet]"