add user agent tracking

Author: HungKNguyen

src/nutrient_dws/__init__.py

@@ -11,6 +11,13 @@
     NutrientError,
     ValidationError,
 )
+from nutrient_dws.inputs import (
+    is_remote_file_input,
+    process_file_input,
+    process_remote_file_input,
+    validate_file_input,
+)
+from nutrient_dws.utils import get_library_version, get_user_agent
 
 __all__ = [
     "APIError",
@@ -19,4 +26,10 @@
     "NutrientClient",
     "NutrientError",
     "ValidationError",
+    "get_library_version",
+    "get_user_agent",
+    "is_remote_file_input",
+    "process_file_input",
+    "process_remote_file_input",
+    "validate_file_input",
 ]

src/nutrient_dws/http.py

@@ -27,6 +27,7 @@
 )
 from nutrient_dws.types.redact_data import RedactData
 from nutrient_dws.types.sign_request import CreateDigitalSignature
+from nutrient_dws.utils import get_user_agent
 
 
 class BuildRequestData(TypedDict):
@@ -515,6 +516,7 @@ async def send_request(
 
         headers = config.get("headers") or {}
         headers["Authorization"] = f"Bearer {api_key}"
+        headers["User-Agent"] = get_user_agent()
 
         # Prepare request configuration
         request_config: dict[str, Any] = {

src/nutrient_dws/utils/__init__.py

@@ -0,0 +1,3 @@
+from .version import get_library_version, get_user_agent
+
+__all__ = ["get_library_version", "get_user_agent"]

src/nutrient_dws/utils/version.py

@@ -0,0 +1,17 @@
+from importlib.metadata import PackageNotFoundError, version
+
+
+def get_library_version() -> str:
+    """Gets the current version of the Nutrient DWS Python Client library."""
+    try:
+        return version("nutrient-dws")
+    except PackageNotFoundError:
+        # fallback for when running from source (not installed yet)
+        from importlib.metadata import metadata
+
+        return metadata("nutrient-dws")["Version"]
+
+
+def get_user_agent() -> str:
+    """Creates a User-Agent string for HTTP requests."""
+    return f"nutrient-dws/{get_library_version()}"

tests/conftest.py

@@ -0,0 +1,82 @@
+import os
+from unittest.mock import AsyncMock
+
+import pytest
+from dotenv import load_dotenv
+from nutrient_dws import NutrientClient
+from tests.helpers import TestDocumentGenerator
+
+load_dotenv()  # Load environment variables
+
+@pytest.fixture
+def mock_workflow_instance():
+    """Create a mock workflow instance for testing."""
+    mock_output_stage = AsyncMock()
+    mock_output_stage.execute.return_value = {
+        "success": True,
+        "output": {
+            "buffer": b"test-buffer",
+            "mimeType": "application/pdf",
+            "filename": "output.pdf",
+        },
+    }
+    mock_output_stage.dry_run.return_value = {"success": True}
+
+    mock_workflow = AsyncMock()
+    mock_workflow.add_file_part.return_value = mock_workflow
+    mock_workflow.add_html_part.return_value = mock_workflow
+    mock_workflow.add_new_page.return_value = mock_workflow
+    mock_workflow.add_document_part.return_value = mock_workflow
+    mock_workflow.apply_actions.return_value = mock_workflow
+    mock_workflow.apply_action.return_value = mock_workflow
+    mock_workflow.output_pdf.return_value = mock_output_stage
+    mock_workflow.output_pdfa.return_value = mock_output_stage
+    mock_workflow.output_pdfua.return_value = mock_output_stage
+    mock_workflow.output_image.return_value = mock_output_stage
+    mock_workflow.output_office.return_value = mock_output_stage
+    mock_workflow.output_html.return_value = mock_output_stage
+    mock_workflow.output_markdown.return_value = mock_output_stage
+    mock_workflow.output_json.return_value = mock_output_stage
+
+    return mock_workflow
+
+
+@pytest.fixture
+def valid_client_options():
+    """Valid client options for testing."""
+    return {"apiKey": "test-api-key", "baseUrl": "https://api.test.com/v1"}
+
+@pytest.fixture(scope="class")
+def client():
+    """Create client instance for testing."""
+    options = {
+        "apiKey": os.getenv("NUTRIENT_API_KEY", ""),
+        "baseUrl": os.getenv("NUTRIENT_BASE_URL", "https://api.nutrient.io"),
+    }
+    return NutrientClient(options)
+
+
+@pytest.fixture
+def test_table_pdf():
+    """Generate PDF with table for annotation tests."""
+    return TestDocumentGenerator.generate_pdf_with_table()
+
+@pytest.fixture
+def test_xfdf_content():
+    """Generate XFDF content for testing."""
+    return TestDocumentGenerator.generate_xfdf_content()
+
+@pytest.fixture
+def test_instant_json_content():
+    """Generate Instant JSON content for testing."""
+    return TestDocumentGenerator.generate_instant_json_content()
+
+@pytest.fixture
+def test_sensitive_pdf():
+    """Generate PDF with sensitive data for redaction testing."""
+    return TestDocumentGenerator.generate_pdf_with_sensitive_data()
+
+@pytest.fixture
+def test_html_content():
+    """Generate HTML content for testing."""
+    return TestDocumentGenerator.generate_html_content()