Fix issue #28: Rename resource methods for MessagesApi

Author: Ihor Bilous

examples/testing/messages.py

@@ -53,24 +53,24 @@ def get_html_analysis(inbox_id: int, message_id: str) -> AnalysisReport:
     return messages_api.get_html_analysis(inbox_id=inbox_id, message_id=message_id)
 
 
-def get_text_body(inbox_id: int, message_id: str) -> str:
-    return messages_api.get_text_body(inbox_id=inbox_id, message_id=message_id)
+def get_text_message(inbox_id: int, message_id: str) -> str:
+    return messages_api.get_text_message(inbox_id=inbox_id, message_id=message_id)
 
 
-def get_raw_body(inbox_id: int, message_id: str) -> str:
-    return messages_api.get_raw_body(inbox_id=inbox_id, message_id=message_id)
+def get_raw_message(inbox_id: int, message_id: str) -> str:
+    return messages_api.get_raw_message(inbox_id=inbox_id, message_id=message_id)
 
 
 def get_html_source(inbox_id: int, message_id: str) -> str:
     return messages_api.get_html_source(inbox_id=inbox_id, message_id=message_id)
 
 
-def get_html_body(inbox_id: int, message_id: str) -> str:
-    return messages_api.get_html_body(inbox_id=inbox_id, message_id=message_id)
+def get_html_message(inbox_id: int, message_id: str) -> str:
+    return messages_api.get_html_message(inbox_id=inbox_id, message_id=message_id)
 
 
-def get_eml_body(inbox_id: int, message_id: str) -> str:
-    return messages_api.get_eml_body(inbox_id=inbox_id, message_id=message_id)
+def get_message_as_eml(inbox_id: int, message_id: str) -> str:
+    return messages_api.get_message_as_eml(inbox_id=inbox_id, message_id=message_id)
 
 
 def get_mail_headers(inbox_id: int, message_id: str) -> str:

mailtrap/api/resources/messages.py

@@ -107,13 +107,13 @@ def get_html_analysis(self, inbox_id: int, message_id: int) -> AnalysisReport:
         response = self._client.get(f"{self._api_path(inbox_id, message_id)}/analyze")
         return AnalysisReportResponse(**response).report
 
-    def get_text_body(self, inbox_id: int, message_id: int) -> str:
+    def get_text_message(self, inbox_id: int, message_id: int) -> str:
         """Get text email body, if it exists."""
         return cast(
             str, self._client.get(f"{self._api_path(inbox_id, message_id)}/body.txt")
         )
 
-    def get_raw_body(self, inbox_id: int, message_id: int) -> str:
+    def get_raw_message(self, inbox_id: int, message_id: int) -> str:
         """Get raw email body."""
         return cast(
             str, self._client.get(f"{self._api_path(inbox_id, message_id)}/body.raw")
@@ -126,13 +126,13 @@ def get_html_source(self, inbox_id: int, message_id: int) -> str:
             self._client.get(f"{self._api_path(inbox_id, message_id)}/body.htmlsource"),
         )
 
-    def get_html_body(self, inbox_id: int, message_id: int) -> str:
+    def get_html_message(self, inbox_id: int, message_id: int) -> str:
         """Get formatted HTML email body. Not applicable for plain text emails."""
         return cast(
             str, self._client.get(f"{self._api_path(inbox_id, message_id)}/body.html")
         )
 
-    def get_eml_body(self, inbox_id: int, message_id: int) -> str:
+    def get_message_as_eml(self, inbox_id: int, message_id: int) -> str:
         """Get email message in .eml format."""
         return cast(
             str, self._client.get(f"{self._api_path(inbox_id, message_id)}/body.eml")

tests/unit/api/testing/test_messages.py

@@ -571,7 +571,7 @@ def test_get_html_analysis_should_return_analysis_report(
         ],
     )
     @responses.activate
-    def test_get_text_body_should_raise_api_errors(
+    def test_get_text_message_should_raise_api_errors(
         self,
         client: MessagesApi,
         status_code: int,
@@ -588,12 +588,14 @@ def test_get_text_body_should_raise_api_errors(
         )
 
         with pytest.raises(APIError) as exc_info:
-            client.get_text_body(INBOX_ID, MESSAGE_ID)
+            client.get_text_message(INBOX_ID, MESSAGE_ID)
 
         assert expected_error_message in str(exc_info.value)
 
     @responses.activate
-    def test_get_text_body_should_return_text_content(self, client: MessagesApi) -> None:
+    def test_get_text_message_should_return_text_content(
+        self, client: MessagesApi
+    ) -> None:
         url = f"{BASE_MESSAGES_URL}/{MESSAGE_ID}/body.txt"
         text_content = "Congrats for sending test email with Mailtrap!"
         responses.get(
@@ -603,7 +605,7 @@ def test_get_text_body_should_return_text_content(self, client: MessagesApi) ->
             content_type="text/plain",
         )
 
-        result = client.get_text_body(INBOX_ID, MESSAGE_ID)
+        result = client.get_text_message(INBOX_ID, MESSAGE_ID)
 
         assert result == text_content
 
@@ -631,7 +633,7 @@ def test_get_text_body_should_return_text_content(self, client: MessagesApi) ->
         ],
     )
     @responses.activate
-    def test_get_html_body_should_raise_api_errors(
+    def test_get_html_message_should_raise_api_errors(
         self,
         client: MessagesApi,
         status_code: int,
@@ -648,12 +650,14 @@ def test_get_html_body_should_raise_api_errors(
         )
 
         with pytest.raises(APIError) as exc_info:
-            client.get_html_body(INBOX_ID, MESSAGE_ID)
+            client.get_html_message(INBOX_ID, MESSAGE_ID)
 
         assert expected_error_message in str(exc_info.value)
 
     @responses.activate
-    def test_get_html_body_should_return_html_content(self, client: MessagesApi) -> None:
+    def test_get_html_message_should_return_html_content(
+        self, client: MessagesApi
+    ) -> None:
         url = f"{BASE_MESSAGES_URL}/{MESSAGE_ID}/body.html"
         html_content = "<html><body>Test HTML content</body></html>"
         responses.get(
@@ -663,7 +667,7 @@ def test_get_html_body_should_return_html_content(self, client: MessagesApi) ->
             content_type="text/html",
         )
 
-        result = client.get_html_body(INBOX_ID, MESSAGE_ID)
+        result = client.get_html_message(INBOX_ID, MESSAGE_ID)
 
         assert result == html_content
 
@@ -691,7 +695,7 @@ def test_get_html_body_should_return_html_content(self, client: MessagesApi) ->
         ],
     )
     @responses.activate
-    def test_get_raw_body_should_raise_api_errors(
+    def test_get_raw_message_should_raise_api_errors(
         self,
         client: MessagesApi,
         status_code: int,
@@ -708,12 +712,12 @@ def test_get_raw_body_should_raise_api_errors(
         )
 
         with pytest.raises(APIError) as exc_info:
-            client.get_raw_body(INBOX_ID, MESSAGE_ID)
+            client.get_raw_message(INBOX_ID, MESSAGE_ID)
 
         assert expected_error_message in str(exc_info.value)
 
     @responses.activate
-    def test_get_raw_body_should_return_raw_content(self, client: MessagesApi) -> None:
+    def test_get_raw_message_should_return_raw_content(self, client: MessagesApi) -> None:
         url = f"{BASE_MESSAGES_URL}/{MESSAGE_ID}/body.raw"
         raw_content = (
             "From: [email protected]\nTo: [email protected]\n"
@@ -726,7 +730,7 @@ def test_get_raw_body_should_return_raw_content(self, client: MessagesApi) -> No
             content_type="text/plain",
         )
 
-        result = client.get_raw_body(INBOX_ID, MESSAGE_ID)
+        result = client.get_raw_message(INBOX_ID, MESSAGE_ID)
 
         assert result == raw_content
 
@@ -814,7 +818,7 @@ def test_get_html_source_should_return_html_source(self, client: MessagesApi) ->
         ],
     )
     @responses.activate
-    def test_get_eml_body_should_raise_api_errors(
+    def test_get_message_as_eml_should_raise_api_errors(
         self,
         client: MessagesApi,
         status_code: int,
@@ -831,12 +835,14 @@ def test_get_eml_body_should_raise_api_errors(
         )
 
         with pytest.raises(APIError) as exc_info:
-            client.get_eml_body(INBOX_ID, MESSAGE_ID)
+            client.get_message_as_eml(INBOX_ID, MESSAGE_ID)
 
         assert expected_error_message in str(exc_info.value)
 
     @responses.activate
-    def test_get_eml_body_should_return_eml_content(self, client: MessagesApi) -> None:
+    def test_get_message_as_eml_should_return_eml_content(
+        self, client: MessagesApi
+    ) -> None:
         url = f"{BASE_MESSAGES_URL}/{MESSAGE_ID}/body.eml"
         eml_content = (
             "From: [email protected]\nTo: [email protected]\n"
@@ -849,7 +855,7 @@ def test_get_eml_body_should_return_eml_content(self, client: MessagesApi) -> No
             content_type="message/rfc822",
         )
 
-        result = client.get_eml_body(INBOX_ID, MESSAGE_ID)
+        result = client.get_message_as_eml(INBOX_ID, MESSAGE_ID)
 
         assert result == eml_content