Skip to content

Commit a5a41ff

Browse files
vitalii-tvitalii-t
authored
Merge pull request #6 from railsware/feature/naming-updates
Updated names of classes and interfaces to correspond more to API documentation
2 parents 013bf74 + 5ab2c3e commit a5a41ff

14 files changed

+62
-62
lines changed

‎src/main/java/io/mailtrap/api/BulkSendingApiImpl.java renamed to ‎src/main/java/io/mailtrap/api/BulkEmailsImpl.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
import io.mailtrap.Constants;
44
import io.mailtrap.CustomValidator;
5-
import io.mailtrap.api.abstractions.BulkSendingApi;
5+
import io.mailtrap.api.abstractions.BulkEmails;
66
import io.mailtrap.api.abstractions.classes.SendApiResource;
77
import io.mailtrap.config.MailtrapConfig;
88
import io.mailtrap.http.RequestData;
99
import io.mailtrap.model.request.MailtrapMail;
1010
import io.mailtrap.model.response.SendResponse;
1111

1212
/**
13-
* Implementation of the {@link BulkSendingApi} interface for bulk sending emails.
13+
* Implementation of the {@link BulkEmails} interface for bulk sending emails.
1414
*/
15-
public class BulkSendingApiImpl extends SendApiResource implements BulkSendingApi {
15+
public class BulkEmailsImpl extends SendApiResource implements BulkEmails {
1616

17-
public BulkSendingApiImpl(MailtrapConfig config, CustomValidator customValidator) {
17+
public BulkEmailsImpl(MailtrapConfig config, CustomValidator customValidator) {
1818
super(config, customValidator);
1919
this.apiHost = Constants.BULK_SENDING_HOST;
2020
}

‎src/main/java/io/mailtrap/api/EmailSendingApiImpl.java renamed to ‎src/main/java/io/mailtrap/api/SendingEmailsImpl.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
import io.mailtrap.Constants;
44
import io.mailtrap.CustomValidator;
5-
import io.mailtrap.api.abstractions.EmailSendingApi;
5+
import io.mailtrap.api.abstractions.SendingEmails;
66
import io.mailtrap.api.abstractions.classes.SendApiResource;
77
import io.mailtrap.config.MailtrapConfig;
88
import io.mailtrap.http.RequestData;
99
import io.mailtrap.model.request.MailtrapMail;
1010
import io.mailtrap.model.response.SendResponse;
1111

1212
/**
13-
* Implementation of the {@link EmailSendingApi} interface for sending emails in the production environment.
13+
* Implementation of the {@link SendingEmails} interface for sending emails in the production environment.
1414
*/
15-
public class EmailSendingApiImpl extends SendApiResource implements EmailSendingApi {
15+
public class SendingEmailsImpl extends SendApiResource implements SendingEmails {
1616

17-
public EmailSendingApiImpl(MailtrapConfig config, CustomValidator customValidator) {
17+
public SendingEmailsImpl(MailtrapConfig config, CustomValidator customValidator) {
1818
super(config, customValidator);
1919
this.apiHost = Constants.EMAIL_SENDING_SEND_HOST;
2020
}

‎src/main/java/io/mailtrap/api/EmailTestingApiImpl.java renamed to ‎src/main/java/io/mailtrap/api/TestingEmailsImpl.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
import io.mailtrap.Constants;
44
import io.mailtrap.CustomValidator;
5-
import io.mailtrap.api.abstractions.EmailTestingApi;
5+
import io.mailtrap.api.abstractions.TestingEmails;
66
import io.mailtrap.api.abstractions.classes.SendApiResource;
77
import io.mailtrap.config.MailtrapConfig;
88
import io.mailtrap.http.RequestData;
99
import io.mailtrap.model.request.MailtrapMail;
1010
import io.mailtrap.model.response.SendResponse;
1111

1212
/**
13-
* Implementation of the {@link EmailTestingApi} interface for sending emails in the sandbox environment.
13+
* Implementation of the {@link TestingEmails} interface for sending emails in the sandbox environment.
1414
*/
15-
public class EmailTestingApiImpl extends SendApiResource implements EmailTestingApi {
15+
public class TestingEmailsImpl extends SendApiResource implements TestingEmails {
1616

17-
public EmailTestingApiImpl(MailtrapConfig config, CustomValidator customValidator) {
17+
public TestingEmailsImpl(MailtrapConfig config, CustomValidator customValidator) {
1818
super(config, customValidator);
1919
this.apiHost = Constants.EMAIL_TESTING_SEND_HOST;
2020
}

‎src/main/java/io/mailtrap/api/abstractions/BulkSendingApi.java renamed to ‎src/main/java/io/mailtrap/api/abstractions/BulkEmails.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/**
99
* Interface representing the Mailtrap Bulk Sending API for sending emails.
1010
*/
11-
public interface BulkSendingApi {
11+
public interface BulkEmails {
1212

1313
/**
1414
* Sends an email

‎src/main/java/io/mailtrap/api/abstractions/EmailSendingApi.java renamed to ‎src/main/java/io/mailtrap/api/abstractions/SendingEmails.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/**
99
* Interface representing the Mailtrap Sending API for sending emails.
1010
*/
11-
public interface EmailSendingApi {
11+
public interface SendingEmails {
1212

1313
/**
1414
* Sends an email

‎src/main/java/io/mailtrap/api/abstractions/EmailTestingApi.java renamed to ‎src/main/java/io/mailtrap/api/abstractions/TestingEmails.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/**
99
* Interface representing the Mailtrap Testing API for sending emails.
1010
*/
11-
public interface EmailTestingApi {
11+
public interface TestingEmails {
1212

1313
/**
1414
* Sends an email

‎src/main/java/io/mailtrap/client/MailtrapClient.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
package io.mailtrap.client;
22

3-
import io.mailtrap.client.layers.MailtrapBulkEmailSendingApiLayer;
4-
import io.mailtrap.client.layers.MailtrapEmailSendingApiLayer;
5-
import io.mailtrap.client.layers.MailtrapEmailTestingApiLayer;
3+
import io.mailtrap.client.layers.MailtrapBulkSendingApi;
4+
import io.mailtrap.client.layers.MailtrapEmailSendingApi;
5+
import io.mailtrap.client.layers.MailtrapEmailTestingApi;
66
import io.mailtrap.config.MailtrapConfig;
77
import io.mailtrap.model.request.MailtrapMail;
88
import io.mailtrap.model.response.SendResponse;
@@ -24,19 +24,19 @@ public class MailtrapClient {
2424
* API for Mailtrap.io Sending functionality
2525
*/
2626
@Getter
27-
private final MailtrapEmailSendingApiLayer sendingApi;
27+
private final MailtrapEmailSendingApi sendingApi;
2828

2929
/**
3030
* API for Mailtrap.io Testing functionality
3131
*/
3232
@Getter
33-
private final MailtrapEmailTestingApiLayer testingApi;
33+
private final MailtrapEmailTestingApi testingApi;
3434

3535
/**
3636
* API for Mailtrap.io Bulk Sending functionality
3737
*/
3838
@Getter
39-
private final MailtrapBulkEmailSendingApiLayer bulkSendingApi;
39+
private final MailtrapBulkSendingApi bulkSendingApi;
4040

4141
/**
4242
* Utility class which holds sending context (which API to use: Email Sending API, Bulk Sending API or

‎src/main/java/io/mailtrap/client/layers/MailtrapBulkEmailSendingApiLayer.java renamed to ‎src/main/java/io/mailtrap/client/layers/MailtrapBulkSendingApi.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.mailtrap.client.layers;
22

3-
import io.mailtrap.api.abstractions.BulkSendingApi;
3+
import io.mailtrap.api.abstractions.BulkEmails;
44
import lombok.Getter;
55
import lombok.RequiredArgsConstructor;
66
import lombok.experimental.Accessors;
@@ -11,6 +11,6 @@
1111
@Getter
1212
@Accessors(fluent = true)
1313
@RequiredArgsConstructor
14-
public class MailtrapBulkEmailSendingApiLayer {
15-
private final BulkSendingApi emails;
14+
public class MailtrapBulkSendingApi {
15+
private final BulkEmails emails;
1616
}

‎src/main/java/io/mailtrap/client/layers/MailtrapEmailSendingApiLayer.java renamed to ‎src/main/java/io/mailtrap/client/layers/MailtrapEmailSendingApi.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.mailtrap.client.layers;
22

3-
import io.mailtrap.api.abstractions.EmailSendingApi;
3+
import io.mailtrap.api.abstractions.SendingEmails;
44
import lombok.Getter;
55
import lombok.RequiredArgsConstructor;
66
import lombok.experimental.Accessors;
@@ -11,6 +11,6 @@
1111
@Getter
1212
@Accessors(fluent = true)
1313
@RequiredArgsConstructor
14-
public class MailtrapEmailSendingApiLayer {
15-
private final EmailSendingApi emails;
14+
public class MailtrapEmailSendingApi {
15+
private final SendingEmails emails;
1616
}

‎src/main/java/io/mailtrap/client/layers/MailtrapEmailTestingApiLayer.java renamed to ‎src/main/java/io/mailtrap/client/layers/MailtrapEmailTestingApi.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package io.mailtrap.client.layers;
22

3-
import io.mailtrap.api.abstractions.EmailTestingApi;
3+
import io.mailtrap.api.abstractions.TestingEmails;
44
import lombok.Getter;
55
import lombok.RequiredArgsConstructor;
66
import lombok.experimental.Accessors;
@@ -11,6 +11,6 @@
1111
@Getter
1212
@Accessors(fluent = true)
1313
@RequiredArgsConstructor
14-
public class MailtrapEmailTestingApiLayer {
15-
private final EmailTestingApi emails;
14+
public class MailtrapEmailTestingApi {
15+
private final TestingEmails emails;
1616
}

‎src/main/java/io/mailtrap/factory/MailtrapClientFactory.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
package io.mailtrap.factory;
22

33
import io.mailtrap.CustomValidator;
4-
import io.mailtrap.api.BulkSendingApiImpl;
5-
import io.mailtrap.api.EmailSendingApiImpl;
6-
import io.mailtrap.api.EmailTestingApiImpl;
4+
import io.mailtrap.api.BulkEmailsImpl;
5+
import io.mailtrap.api.SendingEmailsImpl;
6+
import io.mailtrap.api.TestingEmailsImpl;
77
import io.mailtrap.client.MailtrapClient;
8-
import io.mailtrap.client.layers.MailtrapBulkEmailSendingApiLayer;
9-
import io.mailtrap.client.layers.MailtrapEmailSendingApiLayer;
10-
import io.mailtrap.client.layers.MailtrapEmailTestingApiLayer;
8+
import io.mailtrap.client.layers.MailtrapBulkSendingApi;
9+
import io.mailtrap.client.layers.MailtrapEmailSendingApi;
10+
import io.mailtrap.client.layers.MailtrapEmailTestingApi;
1111
import io.mailtrap.config.MailtrapConfig;
1212
import io.mailtrap.util.SendingContextHolder;
1313
import jakarta.validation.Validation;
@@ -48,22 +48,22 @@ private static SendingContextHolder configureSendingContext(MailtrapConfig confi
4848
.build();
4949
}
5050

51-
private static MailtrapEmailSendingApiLayer createSendingApi(MailtrapConfig config, CustomValidator customValidator) {
52-
var emails = new EmailSendingApiImpl(config, customValidator);
51+
private static MailtrapEmailSendingApi createSendingApi(MailtrapConfig config, CustomValidator customValidator) {
52+
var emails = new SendingEmailsImpl(config, customValidator);
5353

54-
return new MailtrapEmailSendingApiLayer(emails);
54+
return new MailtrapEmailSendingApi(emails);
5555
}
5656

57-
private static MailtrapEmailTestingApiLayer createTestingApi(MailtrapConfig config, CustomValidator customValidator) {
58-
var emails = new EmailTestingApiImpl(config, customValidator);
57+
private static MailtrapEmailTestingApi createTestingApi(MailtrapConfig config, CustomValidator customValidator) {
58+
var emails = new TestingEmailsImpl(config, customValidator);
5959

60-
return new MailtrapEmailTestingApiLayer(emails);
60+
return new MailtrapEmailTestingApi(emails);
6161
}
6262

63-
private static MailtrapBulkEmailSendingApiLayer createBulkSendingApi(MailtrapConfig config, CustomValidator customValidator) {
64-
var emails = new BulkSendingApiImpl(config, customValidator);
63+
private static MailtrapBulkSendingApi createBulkSendingApi(MailtrapConfig config, CustomValidator customValidator) {
64+
var emails = new BulkEmailsImpl(config, customValidator);
6565

66-
return new MailtrapBulkEmailSendingApiLayer(emails);
66+
return new MailtrapBulkSendingApi(emails);
6767
}
6868

6969
/**

‎src/test/java/io/mailtrap/api/BulkSendingApiImplTest.java renamed to ‎src/test/java/io/mailtrap/api/BulkEmailsImplTest.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package io.mailtrap.api;
22

33
import io.mailtrap.Constants;
4-
import io.mailtrap.api.abstractions.BulkSendingApi;
4+
import io.mailtrap.api.abstractions.BulkEmails;
55
import io.mailtrap.config.MailtrapConfig;
66
import io.mailtrap.exception.InvalidRequestBodyException;
77
import io.mailtrap.factory.MailtrapClientFactory;
@@ -17,8 +17,8 @@
1717

1818
import static org.junit.jupiter.api.Assertions.*;
1919

20-
class BulkSendingApiImplTest extends BaseSendTest {
21-
private BulkSendingApi bulkSendingApi;
20+
class BulkEmailsImplTest extends BaseSendTest {
21+
private BulkEmails bulkEmails;
2222

2323
@BeforeEach
2424
public void init() {
@@ -41,7 +41,7 @@ public void init() {
4141
.bulk(true)
4242
.build();
4343

44-
bulkSendingApi = MailtrapClientFactory.createMailtrapClient(testConfig).bulkSendingApi().emails();
44+
bulkEmails = MailtrapClientFactory.createMailtrapClient(testConfig).bulkSendingApi().emails();
4545
}
4646

4747
@Test
@@ -50,7 +50,7 @@ void send_InvalidMailEmptyFromEmail_ThrowsInvalidRequestBodyException() {
5050
MailtrapMail mail = createInvalidTestMail();
5151

5252
// Assert
53-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(mail));
53+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
5454
assertEquals(INVALID_REQUEST_EMPTY_BODY_FROM_EMAIL, exception.getMessage());
5555
}
5656

@@ -60,7 +60,7 @@ void send_MailWithoutTemplateUuidAndTextAndHtml_ThrowsInvalidRequestBodyExceptio
6060
MailtrapMail mail = createTestMailWithoutTemplateUuidAndTextAndHtml();
6161

6262
// Assert
63-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(mail));
63+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
6464
assertEquals(TEMPLATE_UUID_OR_TEXT_OR_HTML_MUST_NOT_BE_EMPTY, exception.getMessage());
6565
}
6666

@@ -70,7 +70,7 @@ void send_MailWithTemplateUuidAndText_ThrowsInvalidRequestBodyException() {
7070
MailtrapMail mail = createTestMailWithTemplateUuidAndText();
7171

7272
// Assert
73-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(mail));
73+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
7474
assertEquals(TEMPLATE_UUID_IS_USED_TEXT_AND_HTML_SHOULD_BE_EMPTY, exception.getMessage());
7575
}
7676

@@ -80,7 +80,7 @@ void send_MailWithTemplateUuidAndHtml_ThrowsInvalidRequestBodyException() {
8080
MailtrapMail mail = createTestMailWithTemplateUuidAndHtml();
8181

8282
// Assert
83-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(mail));
83+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
8484
assertEquals(TEMPLATE_UUID_IS_USED_TEXT_AND_HTML_SHOULD_BE_EMPTY, exception.getMessage());
8585
}
8686

@@ -90,14 +90,14 @@ void send_MailWithTemplateVariablesAndHtml_ThrowsInvalidRequestBodyException() {
9090
MailtrapMail mail = createTestMailWithTemplateVariablesAndHtml();
9191

9292
// Assert
93-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(mail));
93+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(mail));
9494
assertEquals(TEMPLATE_VARIABLES_SHOULD_BE_USED_WITH_TEMPLATE_UUID, exception.getMessage());
9595
}
9696

9797
@Test
9898
void send_NullableMail_ThrowsInvalidRequestBodyException() {
9999
// Assert
100-
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkSendingApi.send(null));
100+
InvalidRequestBodyException exception = assertThrows(InvalidRequestBodyException.class, () -> bulkEmails.send(null));
101101
assertEquals(MAIL_MUST_NOT_BE_NULL, exception.getMessage());
102102
}
103103

@@ -107,7 +107,7 @@ void send_ValidMail_SuccessResponse() {
107107
var mail = createValidTestMail();
108108

109109
// Perform call
110-
SendResponse response = bulkSendingApi.send(mail);
110+
SendResponse response = bulkEmails.send(mail);
111111

112112
// Assert
113113
assertTrue(response.isSuccess());

‎src/test/java/io/mailtrap/api/EmailSendingApiImplTest.java renamed to ‎src/test/java/io/mailtrap/api/SendingEmailsImplTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package io.mailtrap.api;
22

33
import io.mailtrap.Constants;
4-
import io.mailtrap.api.abstractions.EmailSendingApi;
4+
import io.mailtrap.api.abstractions.SendingEmails;
55
import io.mailtrap.config.MailtrapConfig;
66
import io.mailtrap.exception.InvalidRequestBodyException;
77
import io.mailtrap.factory.MailtrapClientFactory;
@@ -17,9 +17,9 @@
1717

1818
import static org.junit.jupiter.api.Assertions.*;
1919

20-
class EmailSendingApiImplTest extends BaseSendTest {
20+
class SendingEmailsImplTest extends BaseSendTest {
2121

22-
private EmailSendingApi sendApi;
22+
private SendingEmails sendApi;
2323

2424
@BeforeEach
2525
public void init() {

‎src/test/java/io/mailtrap/api/EmailTestingApiImplTest.java renamed to ‎src/test/java/io/mailtrap/api/TestingEmailsImplTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package io.mailtrap.api;
22

33
import io.mailtrap.Constants;
4-
import io.mailtrap.api.abstractions.EmailTestingApi;
4+
import io.mailtrap.api.abstractions.TestingEmails;
55
import io.mailtrap.config.MailtrapConfig;
66
import io.mailtrap.exception.InvalidRequestBodyException;
77
import io.mailtrap.factory.MailtrapClientFactory;
@@ -17,9 +17,9 @@
1717

1818
import static org.junit.jupiter.api.Assertions.*;
1919

20-
class EmailTestingApiImplTest extends BaseSendTest {
20+
class TestingEmailsImplTest extends BaseSendTest {
2121

22-
private EmailTestingApi testingApi;
22+
private TestingEmails testingApi;
2323

2424
@BeforeEach
2525
public void init() {

0 commit comments

Comments
 (0)