MPT-14889: Implement E2E Tests and Enhance Document Handling

- Added end-to-end tests for catalog/product document workflows
- Refactored document service to improve usability and interface consistency
- Introduced support for both URL-based and file-based document uploads
- Updated download logic to include Accept header and retrieve it from the resource when required
- Enabled follow_redirects on the http client

Author: albertsola

e2e_config.test.json

@@ -3,6 +3,7 @@
   "accounts.seller.id": "SEL-7310-3075",
   "catalog.product.parameter_group.id": "PGR-7255-3950-0001",
   "catalog.product.parameter.id": "PAR-7255-3950-0016",
+  "catalog.product.document.id": "PDC-7255-3950-0001",
   "accounts.account.id": "ACC-9042-0088",
   "accounts.buyer.account.id": "ACC-1086-6867",
   "accounts.buyer.id": "BUY-1591-2112",

mpt_api_client/http/async_client.py

@@ -53,6 +53,7 @@ def __init__(
             headers=base_headers,
             timeout=timeout,
             transport=AsyncHTTPTransport(retries=retries),
+            follow_redirects=True,
         )
 
     async def request(  # noqa: WPS211

mpt_api_client/http/async_service.py

@@ -1,5 +1,6 @@
 from urllib.parse import urljoin
 
+from mpt_api_client.constants import APPLICATION_JSON
 from mpt_api_client.http.async_client import AsyncHTTPClient
 from mpt_api_client.http.base_service import ServiceBase
 from mpt_api_client.http.types import QueryParam, Response
@@ -69,6 +70,11 @@ async def _resource_action(
             query_params: Additional query parameters.
         """
         response = await self._resource_do_request(
-            resource_id, method, action, json=json, query_params=query_params
+            resource_id,
+            method,
+            action,
+            json=json,
+            query_params=query_params,
+            headers={"Accept": APPLICATION_JSON},
         )
         return self._model_class.from_response(response)

mpt_api_client/http/client.py

@@ -55,6 +55,7 @@ def __init__(
             headers=base_headers,
             timeout=timeout,
             transport=HTTPTransport(retries=retries),
+            follow_redirects=True,
         )
 
     def request(  # noqa: WPS211

mpt_api_client/http/mixins.py

@@ -4,6 +4,7 @@
 from urllib.parse import urljoin
 
 from mpt_api_client.constants import APPLICATION_JSON
+from mpt_api_client.exceptions import MPTError
 from mpt_api_client.http.query_state import QueryState
 from mpt_api_client.http.types import FileTypes, Response
 from mpt_api_client.models import Collection, FileModel, ResourceData
@@ -60,7 +61,32 @@ def update(self, resource_id: str, resource_data: ResourceData) -> Model:
         return self._resource_action(resource_id, "PUT", json=resource_data)  # type: ignore[attr-defined, no-any-return]
 
 
-class FileOperationsMixin[Model]:
+class DownloadFileMixin[Model]:
+    """Download file mixin."""
+
+    def download(self, resource_id: str, accept: str | None = None) -> FileModel:
+        """Download the file for the given resource ID.
+
+        Args:
+            resource_id: Resource ID.
+            accept: The content type expected for the file.
+                If not provided, the content type will be fetched from the resource.
+
+        Returns:
+            File model containing the downloaded file.
+        """
+        if not accept:
+            resource: Model = self._resource_action(resource_id, method="GET")  # type: ignore[attr-defined]
+            accept = resource.content_type  # type: ignore[attr-defined]
+            if not accept:
+                raise MPTError("Unable to download file. Content type not found in resource")
+        response: Response = self._resource_do_request(  # type: ignore[attr-defined]
+            resource_id, method="GET", headers={"Accept": accept}
+        )
+        return FileModel(response)
+
+
+class FilesOperationsMixin[Model](DownloadFileMixin[Model]):
     """Mixin that provides create and download methods for file-based resources."""
 
     def create(
@@ -91,20 +117,6 @@ def create(
 
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
-    def download(self, resource_id: str) -> FileModel:
-        """Download the file for the given resource ID.
-
-        Args:
-            resource_id: Resource ID.
-
-        Returns:
-            File model containing the downloaded file.
-        """
-        response: Response = self._resource_do_request(  # type: ignore[attr-defined]
-            resource_id, method="GET", headers={"Accept": "*"}
-        )
-        return FileModel(response)
-
 
 class CreateWithIconMixin[Model]:
     """Create resource with icon mixin."""
@@ -221,7 +233,32 @@ async def update(self, resource_id: str, resource_data: ResourceData) -> Model:
         return await self._resource_action(resource_id, "PUT", json=resource_data)  # type: ignore[attr-defined, no-any-return]
 
 
-class AsyncFileOperationsMixin[Model]:
+class AsyncDownloadFileMixin[Model]:
+    """Download file mixin."""
+
+    async def download(self, resource_id: str, accept: str | None = None) -> FileModel:
+        """Download the file for the given resource ID.
+
+        Args:
+            resource_id: Resource ID.
+            accept: The content type expected for the file.
+                If not provided, the content type will be fetched from the resource.
+
+        Returns:
+            File model containing the downloaded file.
+        """
+        if not accept:
+            resource: Model = await self._resource_action(resource_id, method="GET")  # type: ignore[attr-defined]
+            accept = resource.content_type  # type: ignore[attr-defined]
+            if not accept:
+                raise MPTError("Unable to download file. Content type not found in resource")
+        response = await self._resource_do_request(  # type: ignore[attr-defined]
+            resource_id, method="GET", headers={"Accept": accept}
+        )
+        return FileModel(response)
+
+
+class AsyncFilesOperationsMixin[Model](AsyncDownloadFileMixin[Model]):
     """Async mixin that provides create and download methods for file-based resources."""
 
     async def create(
@@ -253,20 +290,6 @@ async def create(
 
         return self._model_class.from_response(response)  # type: ignore[attr-defined, no-any-return]
 
-    async def download(self, resource_id: str) -> FileModel:
-        """Download the file for the given resource ID.
-
-        Args:
-            resource_id: Resource ID.
-
-        Returns:
-            File model containing the downloaded file.
-        """
-        response = await self._resource_do_request(  # type: ignore[attr-defined]
-            resource_id, method="GET", headers={"Accept": "*"}
-        )
-        return FileModel(response)
-
 
 class AsyncCreateWithIconMixin[Model]:
     """Create resource with icon mixin."""

mpt_api_client/http/service.py

@@ -1,5 +1,6 @@
 from urllib.parse import urljoin
 
+from mpt_api_client.constants import APPLICATION_JSON
 from mpt_api_client.http.base_service import ServiceBase
 from mpt_api_client.http.client import HTTPClient
 from mpt_api_client.http.types import QueryParam, Response
@@ -74,6 +75,6 @@ def _resource_action(
             action,
             json=json,
             query_params=query_params,
-            headers={"Accept": "application/json"},
+            headers={"Accept": APPLICATION_JSON},
         )
         return self._model_class.from_response(response)

mpt_api_client/resources/billing/credit_memo_attachments.py

@@ -1,10 +1,10 @@
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncFileOperationsMixin,
+    AsyncFilesOperationsMixin,
     AsyncModifiableResourceMixin,
     CollectionMixin,
-    FileOperationsMixin,
+    FilesOperationsMixin,
     ModifiableResourceMixin,
 )
 from mpt_api_client.models import Model
@@ -23,7 +23,7 @@ class CreditMemoAttachmentsServiceConfig:
 
 
 class CreditMemoAttachmentsService(
-    FileOperationsMixin[CreditMemoAttachment],
+    FilesOperationsMixin[CreditMemoAttachment],
     ModifiableResourceMixin[CreditMemoAttachment],
     CollectionMixin[CreditMemoAttachment],
     Service[CreditMemoAttachment],
@@ -33,7 +33,7 @@ class CreditMemoAttachmentsService(
 
 
 class AsyncCreditMemoAttachmentsService(
-    AsyncFileOperationsMixin[CreditMemoAttachment],
+    AsyncFilesOperationsMixin[CreditMemoAttachment],
     AsyncModifiableResourceMixin[CreditMemoAttachment],
     AsyncCollectionMixin[CreditMemoAttachment],
     AsyncService[CreditMemoAttachment],

mpt_api_client/resources/billing/custom_ledger_attachments.py

@@ -1,10 +1,10 @@
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncFileOperationsMixin,
+    AsyncFilesOperationsMixin,
     AsyncModifiableResourceMixin,
     CollectionMixin,
-    FileOperationsMixin,
+    FilesOperationsMixin,
     ModifiableResourceMixin,
 )
 from mpt_api_client.models import Model
@@ -23,7 +23,7 @@ class CustomLedgerAttachmentsServiceConfig:
 
 
 class CustomLedgerAttachmentsService(
-    FileOperationsMixin[CustomLedgerAttachment],
+    FilesOperationsMixin[CustomLedgerAttachment],
     ModifiableResourceMixin[CustomLedgerAttachment],
     CollectionMixin[CustomLedgerAttachment],
     Service[CustomLedgerAttachment],
@@ -33,7 +33,7 @@ class CustomLedgerAttachmentsService(
 
 
 class AsyncCustomLedgerAttachmentsService(
-    AsyncFileOperationsMixin[CustomLedgerAttachment],
+    AsyncFilesOperationsMixin[CustomLedgerAttachment],
     AsyncModifiableResourceMixin[CustomLedgerAttachment],
     AsyncCollectionMixin[CustomLedgerAttachment],
     AsyncService[CustomLedgerAttachment],

mpt_api_client/resources/billing/custom_ledger_upload.py

@@ -1,5 +1,5 @@
 from mpt_api_client.http import AsyncService, Service
-from mpt_api_client.http.mixins import AsyncFileOperationsMixin, FileOperationsMixin
+from mpt_api_client.http.mixins import AsyncFilesOperationsMixin, FilesOperationsMixin
 from mpt_api_client.models import Model
 
 
@@ -16,15 +16,15 @@ class CustomLedgerUploadServiceConfig:
 
 
 class CustomLedgerUploadService(
-    FileOperationsMixin[CustomLedgerUpload],
+    FilesOperationsMixin[CustomLedgerUpload],
     Service[CustomLedgerUpload],
     CustomLedgerUploadServiceConfig,
 ):
     """Custom Ledger Upload service."""
 
 
 class AsyncCustomLedgerUploadService(
-    AsyncFileOperationsMixin[CustomLedgerUpload],
+    AsyncFilesOperationsMixin[CustomLedgerUpload],
     AsyncService[CustomLedgerUpload],
     CustomLedgerUploadServiceConfig,
 ):

mpt_api_client/resources/billing/invoice_attachments.py

@@ -1,10 +1,10 @@
 from mpt_api_client.http import AsyncService, Service
 from mpt_api_client.http.mixins import (
     AsyncCollectionMixin,
-    AsyncFileOperationsMixin,
+    AsyncFilesOperationsMixin,
     AsyncModifiableResourceMixin,
     CollectionMixin,
-    FileOperationsMixin,
+    FilesOperationsMixin,
     ModifiableResourceMixin,
 )
 from mpt_api_client.models import Model
@@ -23,7 +23,7 @@ class InvoiceAttachmentsServiceConfig:
 
 
 class InvoiceAttachmentsService(
-    FileOperationsMixin[InvoiceAttachment],
+    FilesOperationsMixin[InvoiceAttachment],
     ModifiableResourceMixin[InvoiceAttachment],
     CollectionMixin[InvoiceAttachment],
     Service[InvoiceAttachment],
@@ -33,7 +33,7 @@ class InvoiceAttachmentsService(
 
 
 class AsyncInvoiceAttachmentsService(
-    AsyncFileOperationsMixin[InvoiceAttachment],
+    AsyncFilesOperationsMixin[InvoiceAttachment],
     AsyncModifiableResourceMixin[InvoiceAttachment],
     AsyncCollectionMixin[InvoiceAttachment],
     AsyncService[InvoiceAttachment],