Fix validation issues

Author: ChristianJStarr

projectx_sdk/utils/validators.py

@@ -3,6 +3,13 @@
 import re
 from typing import Any, Dict, Optional, Type, TypeVar
 
+
+class ValidationError(ValueError):
+    """Exception raised for validation errors in the ProjectX SDK."""
+
+    pass
+
+
 T = TypeVar("T")
 
 
@@ -18,10 +25,10 @@ def validate_not_none(value: Optional[Any], name: str) -> Any:
         The validated value
 
     Raises:
-        ValueError: If the value is None
+        ValidationError: If the value is None
     """
     if value is None:
-        raise ValueError(f"{name} must not be None")
+        raise ValidationError(f"{name} must not be None")
     return value
 
 
@@ -41,19 +48,37 @@ def validate_int_range(
         The validated integer
 
     Raises:
-        ValueError: If the value is outside the specified range
+        ValidationError: If the value is outside the specified range
     """
-    validate_not_none(value, name)
+    if value is None:
+        raise ValidationError(f"{name} cannot be None")
 
     if min_value is not None and value < min_value:
-        raise ValueError(f"{name} must be at least {min_value}")
+        raise ValidationError(f"{name} must be at least {min_value}")
 
     if max_value is not None and value > max_value:
-        raise ValueError(f"{name} must be at most {max_value}")
+        raise ValidationError(f"{name} must be at most {max_value}")
 
     return value
 
 
+def validate_non_negative(value: int, name: str) -> int:
+    """
+    Validate that an integer is non-negative (>= 0).
+
+    Args:
+        value: The integer to validate
+        name: The name of the parameter (for error message)
+
+    Returns:
+        The validated integer
+
+    Raises:
+        ValidationError: If the value is negative
+    """
+    return validate_int_range(value, name, min_value=0)
+
+
 def validate_string_not_empty(value: Optional[str], name: str) -> str:
     """
     Validate that a string is not empty.
@@ -66,12 +91,12 @@ def validate_string_not_empty(value: Optional[str], name: str) -> str:
         The validated string
 
     Raises:
-        ValueError: If the string is None or empty
+        ValidationError: If the string is None or empty
     """
     validate_not_none(value, name)
 
     if not value:
-        raise ValueError(f"{name} must not be empty")
+        raise ValidationError(f"{name} must not be empty")
 
     return value
 
@@ -87,15 +112,19 @@ def validate_contract_id_format(contract_id: str) -> str:
         The validated contract ID
 
     Raises:
-        ValueError: If the contract ID has an invalid format
+        ValidationError: If the contract ID has an invalid format
     """
-    validate_string_not_empty(contract_id, "contract_id")
+    if contract_id is None:
+        raise ValidationError("Contract ID cannot be None or empty")
+
+    if not contract_id:
+        raise ValidationError("contract_id must not be empty")
 
     # Example pattern for contract IDs: "CON.F.US.EP.H24"
     pattern = r"^CON\.[A-Z]\.[A-Z]{2}\.[A-Z0-9]{1,5}\.[A-Z0-9]{1,5}$"
 
     if not re.match(pattern, contract_id):
-        raise ValueError(
+        raise ValidationError(
             f"Invalid contract ID format: {contract_id}. "
             "Expected format: CON.<type>.<region>.<symbol>.<month/year>"
         )
@@ -115,9 +144,15 @@ def validate_model(value: Dict[str, Any], model_class: Type[T]) -> T:
         An instance of the model
 
     Raises:
-        ValueError: If the dictionary cannot be converted to the model
+        ValidationError: If the dictionary cannot be converted to the model
     """
     try:
-        return model_class.model_validate(value)
+        # Try model_validate (Pydantic v2) first, then parse_obj (Pydantic v1)
+        if hasattr(model_class, "model_validate"):
+            result: T = model_class.model_validate(value)  # type: ignore
+            return result
+        else:
+            result: T = model_class.parse_obj(value)  # type: ignore
+            return result
     except Exception as e:
-        raise ValueError(f"Invalid {model_class.__name__} data: {e}")
+        raise ValidationError(f"Invalid {model_class.__name__} data: {e}")

tests/conftest.py

@@ -40,7 +40,12 @@ def auth_token():
     Returns:
         str: A mock JWT token.
     """
-    return "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTUxNjIzOTAyMn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+    # JWT token split across lines to avoid line length limit
+    return (
+        "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9."
+        "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgVXNlciIsImlhdCI6MTUxNjIzOTAyMn0."
+        "SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+    )
 
 
 @pytest.fixture
@@ -56,12 +61,7 @@ def mock_api_key_auth(mock_responses, api_base_url, auth_token):
     Returns:
         dict: A dictionary with the mock auth response.
     """
-    auth_response = {
-        "token": auth_token,
-        "success": True,
-        "errorCode": 0,
-        "errorMessage": None
-    }
+    auth_response = {"token": auth_token, "success": True, "errorCode": 0, "errorMessage": None}
 
     # Mock the login endpoint
     mock_responses.add(

tests/test_auth.py

@@ -1,7 +1,6 @@
 """Tests for the authentication module."""
 
 from datetime import datetime, timedelta
-from unittest.mock import Mock
 
 import pytest
 
@@ -221,11 +220,11 @@ def test_get_auth_header_expiring_soon(self, auth_token):
 
         # Mock the validate_token method with a spy
         validate_called = [False]  # Use a list to be mutable in the inner function
-        
+
         def spy_validate_token():
             validate_called[0] = True
             return True
-            
+
         auth.validate_token = spy_validate_token
 
         # Get the header - should trigger a token validation

tests/test_client.py

@@ -5,11 +5,7 @@
 import pytest
 
 from projectx_sdk import ProjectXClient
-from projectx_sdk.exceptions import (
-    AuthenticationError,
-    ProjectXError,
-    ResourceNotFoundError,
-)
+from projectx_sdk.exceptions import AuthenticationError, ProjectXError, ResourceNotFoundError
 
 
 class TestProjectXClient:

tests/test_validators.py

@@ -1,9 +1,10 @@
-"""Tests for the validation utilities."""
+"""Tests for validator functions."""
 
 import pytest
 from pydantic import BaseModel
 
 from projectx_sdk.utils.validators import (
+    ValidationError,
     validate_contract_id_format,
     validate_int_range,
     validate_model,
@@ -51,8 +52,8 @@ def test_validate_int_range(self):
 
         # Test with None
         with pytest.raises(ValueError) as excinfo:
-            validate_int_range(None, "value", 0, 10)
-        assert "value must not be None" in str(excinfo.value)
+            validate_int_range(None, "value", 0, 10)  # type: ignore
+        assert "value cannot be None" in str(excinfo.value)
 
     def test_validate_string_not_empty(self):
         """Test validating non-empty strings."""
@@ -97,12 +98,11 @@ def test_validate_contract_id_format(self):
 
         # Test with None
         with pytest.raises(ValueError) as excinfo:
-            validate_contract_id_format(None)
-        assert "must not be None" in str(excinfo.value)
+            validate_contract_id_format(None)  # type: ignore
+        assert "Contract ID cannot be None or empty" in str(excinfo.value)
 
     def test_validate_model(self):
         """Test validating model conversion."""
-
         # Create a test model
         class TestModel(BaseModel):
             id: int
@@ -129,13 +129,13 @@ def test_validate_contract_id_format_invalid_none(self):
         with pytest.raises(ValidationError) as excinfo:
             # Explicitly cast None to string for mypy
             validate_contract_id_format(None)  # type: ignore
-            
+
         assert "Contract ID cannot be None or empty" in str(excinfo.value)
 
     def test_validate_int_range_none(self):
         """Test validating a None value for int range."""
         with pytest.raises(ValidationError) as excinfo:
             # Explicitly cast None to int for mypy
-            validate_int_range(None, 1, 10, "test_field")  # type: ignore
-            
+            validate_int_range(None, "test_field", 1, 10)  # type: ignore
+
         assert "test_field cannot be None" in str(excinfo.value)