feat: create InsufficientCreditError to handle credit paywall (#5318)

* feat: create `InsufficientCreditError` to handle credit paywall

* chore: update `lock` file

* fix: failing `tests`

* fix: address pr `feedback`

Author: Jabolol

uv.lock

@@ -9,4 +9,4 @@
 
 from .analytics import DataAnalytics
 from .client import Client, ClientConfig, QueryResponse
-from .exceptions import HTTPError, OsoError
+from .exceptions import HTTPError, InsufficientCreditError, OsoError

warehouse/pyoso/pyoso/__init__.py

@@ -9,7 +9,7 @@
 from pydantic import BaseModel
 from pyoso.analytics import DataAnalytics, DataStatus
 from pyoso.constants import DEFAULT_BASE_URL, OSO_API_KEY
-from pyoso.exceptions import OsoError, OsoHTTPError
+from pyoso.exceptions import InsufficientCreditError, OsoError, OsoHTTPError
 from pyoso.semantic import create_registry
 from sqlglot import parse
 
@@ -182,6 +182,9 @@ def _make_sql_request(
                 response.iter_lines(chunk_size=None)
             )
         except requests.HTTPError as e:
+            if e.response.status_code == 402:
+                error_message = e.response.json()["error"]
+                raise InsufficientCreditError(error_message) from None
             raise OsoHTTPError(e, response=e.response) from None
 
     def to_pandas(self, query: str):

warehouse/pyoso/pyoso/client.py

@@ -10,3 +10,7 @@ def __str__(self):
         str = super().__str__()
         response = self.response.json()
         return f"{str} - {response['error'] if response['error'] else response}"
+
+
+class InsufficientCreditError(OsoError):
+    """Raised when the user has insufficient credits to execute a query."""

warehouse/pyoso/pyoso/exceptions.py

@@ -1,6 +1,6 @@
 [project]
 name = "pyoso"
-version = "0.7.0"
+version = "0.7.1"
 description = ""
 readme = "README.md"
 requires-python = ">=3.8"

warehouse/pyoso/pyproject.toml

@@ -96,7 +96,10 @@ def test_to_pandas_with_default_api_key(
     def test_to_pandas_http_error(self, mock_post: mock.Mock, mock_registry: mock.Mock):
         mock_registry.return_value = Registry()
         mock_response = mock.Mock()
-        mock_response.raise_for_status.side_effect = requests.HTTPError("HTTP Error")
+        mock_response.status_code = 500
+        http_error = requests.HTTPError("HTTP Error")
+        http_error.response = mock_response
+        mock_response.raise_for_status.side_effect = http_error
         mock_post.return_value = mock_response
 
         client = Client(api_key=self.CUSTOM_API_KEY)