Refactored to emphasise detection of the public IP address.

Author: garethpwright1

src/wiley_tdm/ip_utils.py

@@ -6,7 +6,7 @@
 
 # Standard library imports
 import logging
-from typing import Final, List
+from typing import Final, List, Optional
 
 # Third-party imports
 import requests
@@ -19,7 +19,6 @@ class IPUtils:
     _logger = logging.getLogger(__name__)
 
     # IP Configuration
-    DEFAULT_IP: Final[str] = "127.0.0.1"
     IP_APIS: Final[List[str]] = [
         "https://api.ipify.org",
         "https://api.my-ip.io/ip",
@@ -31,11 +30,11 @@ class IPUtils:
     API_READ_TIMEOUT: Final[int] = 3  # seconds
 
     @staticmethod
-    def get_ip_address() -> str:
+    def get_ip_address() -> Optional[str]:
         """Get the public IP address by trying multiple API endpoints.
 
         Returns:
-            str: Public IP address or DEFAULT_IP if all attempts fail
+            Optional[str]: Public IP address if successful, or None if all attempts fail.
         """
         for api_url in IPUtils.IP_APIS:
             try:
@@ -52,4 +51,4 @@ def get_ip_address() -> str:
                 continue
 
         IPUtils._logger.error("All IP detection attempts failed")
-        return IPUtils.DEFAULT_IP
+        return None

src/wiley_tdm/tdm_client.py

@@ -118,11 +118,13 @@ def __init__(
 
         self._validate_api_token(api_token)
         self._create_api_session()
-        self._my_ip_address: str = IPUtils.get_ip_address()
+        self._client_public_ip: Optional[str] = IPUtils.get_ip_address()
 
-        self.logger.info(
-            "Your IP address, used to check entitlements: %s", self._my_ip_address
-        )
+        if self._client_public_ip:
+            self.logger.info(
+                "Your public IP address, (only) used to check entitlements: %s",
+                self._client_public_ip,
+            )
 
     def _validate_api_token(self, api_token: Optional[str]) -> None:
         """Initialize the TDM API token.
@@ -368,7 +370,7 @@ def _handle_api_error(
             return DownloadResult(
                 doi,
                 DownloadStatus.ACCESS_DENIED,
-                f"TDM access denied from IP {self._my_ip_address}. Try manually: {pdf_url}",
+                f"TDM access denied from IP {self._client_public_ip}. Try manually: {pdf_url}",
                 api_status=status,
             )
         if status == HTTPStatus.NOT_FOUND:

tests/test_ip_utils.py

@@ -3,13 +3,6 @@
 Tests public IP detection and fallback behavior with mocked responses.
 """
 
-# Standard library imports
-import socket
-from unittest.mock import patch
-
-# Third-party imports
-import requests
-
 # Local imports
 from wiley_tdm.ip_utils import IPUtils
 
@@ -22,11 +15,3 @@ def test_get_ip_address_success():
     parts = ip.split(".")
     assert len(parts) == 4
     assert all(0 <= int(p) <= 255 for p in parts)
-
-
-def test_get_ip_address_fallback():
-    """Test fallback to DEFAULT_IP when detection fails."""
-    with patch("requests.get", side_effect=requests.RequestException):
-        with patch("socket.gethostbyname", side_effect=socket.error):
-            ip = IPUtils.get_ip_address()
-            assert ip == IPUtils.DEFAULT_IP