Fix issue #29: Split Mailtrap client into current and new

Ihor Bilous · Ihor Bilous · commit 1f3ff3ace314 · 2025-08-06T00:01:30.000+03:00
diff --git a/examples/testing/projects.py b/examples/testing/projects.py
@@ -1,8 +1,8 @@
 import logging
 from typing import Optional
 
-from mailtrap import MailtrapClient
-from mailtrap.schemas.projects import Project
+from mailtrap import MailtrapApiClient
+from mailtrap.models.projects import Project
 
 logging.basicConfig(
     level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
@@ -21,7 +21,7 @@ def find_project_by_name(project_name: str, projects: list[Project]) -> Optional
 
 logging.info("Starting Mailtrap Testing API example...")
 
-client = MailtrapClient(token=API_TOKEN)
+client = MailtrapApiClient(token=API_TOKEN)
 testing_api = client.get_testing_api(ACCOUNT_ID)
 projects_api = testing_api.projects
 
diff --git a/mailtrap/__init__.py b/mailtrap/__init__.py
@@ -1,3 +1,4 @@
+from .client import MailtrapApiClient
 from .client import MailtrapClient
 from .exceptions import APIError
 from .exceptions import AuthorizationError
diff --git a/mailtrap/api/resources/projects.py b/mailtrap/api/resources/projects.py
@@ -1,7 +1,6 @@
 from mailtrap.http import HttpClient
-from mailtrap.schemas.base import DeletedObject
-from mailtrap.schemas.projects import Project
-from mailtrap.schemas.projects import ProjectInput
+from mailtrap.models.base import DeletedObject
+from mailtrap.models.projects import Project
 
 
 class ProjectsApi:
@@ -20,15 +19,13 @@ def get_by_id(self, project_id: int) -> Project:
         return Project(**response)
 
     def create(self, project_name: str) -> Project:
-        ProjectInput(name=project_name)
         response = self.client.post(
             f"/api/accounts/{self.account_id}/projects",
             json={"project": {"name": project_name}},
         )
         return Project(**response)
 
     def update(self, project_id: int, project_name: str) -> Project:
-        ProjectInput(name=project_name)
         response = self.client.patch(
             f"/api/accounts/{self.account_id}/projects/{project_id}",
             json={"project": {"name": project_name}},
diff --git a/mailtrap/client.py b/mailtrap/client.py
@@ -5,7 +5,7 @@
 import requests
 
 from mailtrap.api.testing import TestingApi
-from mailtrap.config import MAILTRAP_HOST
+from mailtrap.config import GENERAL_ENDPOINT
 from mailtrap.exceptions import APIError
 from mailtrap.exceptions import AuthorizationError
 from mailtrap.exceptions import ClientConfigurationError
@@ -37,15 +37,9 @@ def __init__(
 
         self._validate_itself()
 
-    def get_testing_api(self, account_id: str) -> TestingApi:
-        http_client = HttpClient(host=MAILTRAP_HOST, headers=self.get_headers())
-        return TestingApi(
-            account_id=account_id, inbox_id=self.inbox_id, client=http_client
-        )
-
     def send(self, mail: BaseMail) -> dict[str, Union[bool, list[str]]]:
         response = requests.post(
-            self.api_send_url, headers=self.get_headers(), json=mail.api_data
+            self.api_send_url, headers=self.headers, json=mail.api_data
         )
 
         if response.ok:
@@ -66,7 +60,8 @@ def api_send_url(self) -> str:
 
         return url
 
-    def get_headers(self) -> dict[str, str]:
+    @property
+    def headers(self) -> dict[str, str]:
         return {
             "Authorization": f"Bearer {self.token}",
             "Content-Type": "application/json",
@@ -106,3 +101,21 @@ def _validate_itself(self) -> None:
 
         if self.bulk and self.sandbox:
             raise ClientConfigurationError("bulk mode is not allowed in sandbox mode")
+
+
+class MailtrapApiClient:
+    def __init__(self, token: str) -> None:
+        self.token = token
+
+    def testing_api(self, account_id: str, inbox_id: str) -> TestingApi:
+        http_client = HttpClient(host=GENERAL_ENDPOINT, headers=self.get_headers())
+        return TestingApi(account_id=account_id, inbox_id=inbox_id, client=http_client)
+
+    def get_headers(self) -> dict[str, str]:
+        return {
+            "Authorization": f"Bearer {self.token}",
+            "Content-Type": "application/json",
+            "User-Agent": (
+                "mailtrap-python (https://github.com/railsware/mailtrap-python)"
+            ),
+        }
diff --git a/mailtrap/config.py b/mailtrap/config.py
@@ -1,3 +1,3 @@
-MAILTRAP_HOST = "mailtrap.io"
+GENERAL_ENDPOINT = "mailtrap.io"
 
 DEFAULT_REQUEST_TIMEOUT = 30  # in seconds
diff --git a/mailtrap/http.py b/mailtrap/http.py
@@ -1,7 +1,6 @@
 from typing import Any
 from typing import NoReturn
 from typing import Optional
-from typing import TypeVar
 
 from requests import Response
 from requests import Session
@@ -10,8 +9,6 @@
 from mailtrap.exceptions import APIError
 from mailtrap.exceptions import AuthorizationError
 
-T = TypeVar("T")
-
 
 class HttpClient:
     def __init__(
@@ -42,52 +39,38 @@ def _handle_failed_response(self, response: Response) -> NoReturn:
 
         raise APIError(status_code, errors=errors)
 
-    def _process_response(self, response: Response, expected_type: type[T]) -> T:
+    def _process_response(self, response: Response) -> Any:
         if not response.ok:
             self._handle_failed_response(response)
-        data = response.json()
-        if not isinstance(data, expected_type):
-            raise APIError(
-                response.status_code,
-                errors=[f"Expected response type {expected_type.__name__}"],
-            )
-        return data
-
-    def _process_response_dict(self, response: Response) -> dict[str, Any]:
-        return self._process_response(response, dict)
-
-    def _process_response_list(self, response: Response) -> list[dict[str, Any]]:
-        return self._process_response(response, list)
+        return response.json()
 
-    def get(self, path: str, params: Optional[dict[str, Any]] = None) -> dict[str, Any]:
+    def get(self, path: str, params: Optional[dict[str, Any]] = None) -> Any:
         response = self._session.get(
             self._url(path), params=params, timeout=self._timeout
         )
-        return self._process_response_dict(response)
+        return self._process_response(response)
 
-    def list(
-        self, path: str, params: Optional[dict[str, Any]] = None
-    ) -> list[dict[str, Any]]:
+    def list(self, path: str, params: Optional[dict[str, Any]] = None) -> Any:
         response = self._session.get(
             self._url(path), params=params, timeout=self._timeout
         )
-        return self._process_response_list(response)
+        return self._process_response(response)
 
-    def post(self, path: str, json: Optional[dict[str, Any]] = None) -> dict[str, Any]:
+    def post(self, path: str, json: Optional[dict[str, Any]] = None) -> Any:
         response = self._session.post(self._url(path), json=json, timeout=self._timeout)
-        return self._process_response_dict(response)
+        return self._process_response(response)
 
-    def put(self, path: str, json: Optional[dict[str, Any]] = None) -> dict[str, Any]:
+    def put(self, path: str, json: Optional[dict[str, Any]] = None) -> Any:
         response = self._session.put(self._url(path), json=json, timeout=self._timeout)
-        return self._process_response_dict(response)
+        return self._process_response(response)
 
-    def patch(self, path: str, json: Optional[dict[str, Any]] = None) -> dict[str, Any]:
+    def patch(self, path: str, json: Optional[dict[str, Any]] = None) -> Any:
         response = self._session.patch(self._url(path), json=json, timeout=self._timeout)
-        return self._process_response_dict(response)
+        return self._process_response(response)
 
-    def delete(self, path: str) -> dict[str, Any]:
+    def delete(self, path: str) -> Any:
         response = self._session.delete(self._url(path), timeout=self._timeout)
-        return self._process_response_dict(response)
+        return self._process_response(response)
 
 
 def _extract_errors(data: dict[str, Any]) -> list[str]:
diff --git a/mailtrap/models/__init__.py b/mailtrap/models/__init__.py
diff --git a/mailtrap/models/base.py b/mailtrap/models/base.py
diff --git a/mailtrap/models/inboxes.py b/mailtrap/models/inboxes.py
@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel
 
-from mailtrap.schemas.permissions import Permissions
+from mailtrap.models.permissions import Permissions
 
 
 class Inbox(BaseModel):
diff --git a/mailtrap/models/permissions.py b/mailtrap/models/permissions.py
diff --git a/mailtrap/models/projects.py b/mailtrap/models/projects.py
@@ -1,8 +1,8 @@
 from pydantic import BaseModel
 from pydantic import Field
 
-from mailtrap.schemas.inboxes import Inbox
-from mailtrap.schemas.permissions import Permissions
+from mailtrap.models.inboxes import Inbox
+from mailtrap.models.permissions import Permissions
 
 
 class ShareLinks(BaseModel):
@@ -16,7 +16,3 @@ class Project(BaseModel):
     share_links: ShareLinks
     inboxes: list[Inbox]
     permissions: Permissions
-
-
-class ProjectInput(BaseModel):
-    name: str = Field(min_length=2, max_length=100)
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,6 +19,7 @@ classifiers = [
 requires-python = ">=3.9"
 dependencies = [
     "requests>=2.26.0",
+    "pydantic>=2.11.7",
 ]
 
 [project.urls]
diff --git a/tests/unit/api/test_projects.py b/tests/unit/api/test_projects.py
@@ -2,23 +2,22 @@
 
 import pytest
 import responses
-from pydantic import ValidationError
 
 from mailtrap.api.resources.projects import ProjectsApi
-from mailtrap.config import MAILTRAP_HOST
+from mailtrap.config import GENERAL_ENDPOINT
 from mailtrap.exceptions import APIError
 from mailtrap.http import HttpClient
-from mailtrap.schemas.base import DeletedObject
-from mailtrap.schemas.projects import Project
+from mailtrap.models.base import DeletedObject
+from mailtrap.models.projects import Project
 
 ACCOUNT_ID = "321"
 PROJECT_ID = 123
-BASE_PROJECTS_URL = f"https://{MAILTRAP_HOST}/api/accounts/{ACCOUNT_ID}/projects"
+BASE_PROJECTS_URL = f"https://{GENERAL_ENDPOINT}/api/accounts/{ACCOUNT_ID}/projects"
 
 
 @pytest.fixture
 def client() -> ProjectsApi:
-    return ProjectsApi(account_id=ACCOUNT_ID, client=HttpClient(MAILTRAP_HOST))
+    return ProjectsApi(account_id=ACCOUNT_ID, client=HttpClient(GENERAL_ENDPOINT))
 
 
 @pytest.fixture
@@ -159,27 +158,6 @@ def test_create_should_raise_api_errors(
 
         assert expected_error_message in str(exc_info.value)
 
-    @pytest.mark.parametrize(
-        "project_name, expected_errors",
-        [
-            (None, ["Input should be a valid string"]),
-            ("", ["String should have at least 2 characters"]),
-            ("a", ["String should have at least 2 characters"]),
-            ("a" * 101, ["String should have at most 100 characters"]),
-        ],
-    )
-    def test_create_should_raise_validation_error_on_pydantic_validation(
-        self, client: ProjectsApi, project_name: str, expected_errors: list[str]
-    ) -> None:
-        with pytest.raises(ValidationError) as exc_info:
-            client.create(project_name=project_name)
-
-        errors = exc_info.value.errors()
-        error_messages = [err["msg"] for err in errors]
-
-        for expected_msg in expected_errors:
-            assert any(expected_msg in actual_msg for actual_msg in error_messages)
-
     @responses.activate
     def test_create_should_return_new_project(
         self, client: ProjectsApi, sample_project_dict: dict
@@ -225,27 +203,6 @@ def test_update_should_raise_api_errors(
 
         assert expected_error_message in str(exc_info.value)
 
-    @pytest.mark.parametrize(
-        "project_name, expected_errors",
-        [
-            (None, ["Input should be a valid string"]),
-            ("", ["String should have at least 2 characters"]),
-            ("a", ["String should have at least 2 characters"]),
-            ("a" * 101, ["String should have at most 100 characters"]),
-        ],
-    )
-    def test_update_should_raise_validation_error_on_pydantic_validation(
-        self, client: ProjectsApi, project_name: str, expected_errors: list[str]
-    ) -> None:
-        with pytest.raises(ValidationError) as exc_info:
-            client.update(project_id=PROJECT_ID, project_name=project_name)
-
-        errors = exc_info.value.errors()
-        error_messages = [err["msg"] for err in errors]
-
-        for expected_msg in expected_errors:
-            assert any(expected_msg in actual_msg for actual_msg in error_messages)
-
     @responses.activate
     def test_update_should_return_updated_project(
         self, client: ProjectsApi, sample_project_dict: dict
diff --git a/tests/unit/test_client.py b/tests/unit/test_client.py
@@ -83,7 +83,7 @@ def test_api_send_url_should_return_default_sending_url(
     def test_headers_should_return_appropriate_dict(self) -> None:
         client = self.get_client()
 
-        assert client.get_headers() == {
+        assert client.headers == {
             "Authorization": "Bearer fake_token",
             "Content-Type": "application/json",
             "User-Agent": (
@@ -103,7 +103,7 @@ def test_send_should_handle_success_response(self, mail: mt.BaseMail) -> None:
         assert result == response_body
         assert len(responses.calls) == 1
         request = responses.calls[0].request  # type: ignore
-        assert request.headers.items() >= client.get_headers().items()
+        assert request.headers.items() >= client.headers.items()
         assert request.body == json.dumps(mail.api_data).encode()
 
     @responses.activate
@@ -142,3 +142,20 @@ def test_send_should_raise_api_error_for_500_status_code(
 
         with pytest.raises(mt.APIError):
             client.send(mail)
+
+
+class TestMailtrapApiClient:
+    @pytest.fixture
+    def api_client(self):
+        return mt.MailtrapApiClient(token="fake_token")
+
+    def test_headers_should_return_appropriate_dict(
+        self, api_client: mt.MailtrapApiClient
+    ) -> None:
+        assert api_client.get_headers() == {
+            "Authorization": "Bearer fake_token",
+            "Content-Type": "application/json",
+            "User-Agent": (
+                "mailtrap-python (https://github.com/railsware/mailtrap-python)"
+            ),
+        }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+from .client import MailtrapApiClient`
`1`	`2`	`from .client import MailtrapClient`
`2`	`3`	`from .exceptions import APIError`
`3`	`4`	`from .exceptions import AuthorizationError`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-MAILTRAP_HOST = "mailtrap.io"`
	`1`	`+GENERAL_ENDPOINT = "mailtrap.io"`
`2`	`2`
`3`	`3`	`DEFAULT_REQUEST_TIMEOUT = 30 # in seconds`