Refactoring - moved API classes, models, added missing Javadoc, updated tests

Author: vitalii-t

README.md

@@ -43,9 +43,9 @@ implementation("io.mailtrap:mailtrap-java:1.0-SNAPSHOT")
 import io.mailtrap.client.MailtrapClient;
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.factory.MailtrapClientFactory;
-import io.mailtrap.model.request.Address;
-import io.mailtrap.model.request.Attachment;
-import io.mailtrap.model.request.MailtrapMail;
+import io.mailtrap.model.request.emails.Address;
+import io.mailtrap.model.request.emails.EmailAttachment;
+import io.mailtrap.model.request.emails.MailtrapMail;
 
 import java.util.List;
 import java.util.Map;
@@ -57,7 +57,7 @@ public class MailtrapJavaSDKTest {
 
         Address to = new Address("[email protected]");
 
-        Attachment attachment = Attachment.builder()
+        EmailAttachment attachment = EmailAttachment.builder()
                 .filename("attachment.txt")
                 .type("text/plain")
                 // Should the Base64 encoded content of the attachment

src/main/java/io/mailtrap/CustomValidator.java

@@ -16,6 +16,16 @@ public CustomValidator(Validator validator) {
         this.validator = validator;
     }
 
+    /**
+     * Validates the given object and returns a map of validation errors.
+     *
+     * <p>The map contains property names as keys and corresponding error messages as values.
+     * If the object has no validation errors, the map will be empty.
+     *
+     * @param <T>              the type of the object to validate
+     * @param objectToValidate the object to validate
+     * @return a map of validation errors, with property names as keys and error messages as values
+     */
     public <T> Map<String, String> validate(T objectToValidate) {
         final var violations = validator.validate(objectToValidate);
 
@@ -28,6 +38,16 @@ public <T> Map<String, String> validate(T objectToValidate) {
         return errors;
     }
 
+    /**
+     * Validates the given object and returns a string representation of the validation errors.
+     *
+     * <p>The returned string contains each validation error in the format "propertyName=errorMessage",
+     * with errors separated by semicolons. If there are no validation errors, an empty string is returned.
+     *
+     * @param <T>              the type of the object to validate
+     * @param objectToValidate the object to validate
+     * @return a string representation of the validation errors, or an empty string if there are no errors
+     */
     public <T> String validateAndGetViolationsAsString(T objectToValidate) {
         return this.validate(objectToValidate).entrySet().stream()
                 .map(violation -> violation.getKey() + "=" + violation.getValue())

src/main/java/io/mailtrap/api/abstractions/AccountAccesses.java renamed to src/main/java/io/mailtrap/api/account_accesses/AccountAccesses.java

@@ -1,6 +1,6 @@
-package io.mailtrap.api.abstractions;
+package io.mailtrap.api.account_accesses;
 
-import io.mailtrap.model.request.ListAccountAccessQueryParams;
+import io.mailtrap.model.request.account_accesses.ListAccountAccessQueryParams;
 import io.mailtrap.model.response.account_accesses.AccountAccessResponse;
 import io.mailtrap.model.response.account_accesses.RemoveAccountAccessResponse;
 

src/main/java/io/mailtrap/api/AccountAccessesImpl.java renamed to src/main/java/io/mailtrap/api/account_accesses/AccountAccessesImpl.java

@@ -1,11 +1,10 @@
-package io.mailtrap.api;
+package io.mailtrap.api.account_accesses;
 
 import io.mailtrap.Constants;
-import io.mailtrap.api.abstractions.AccountAccesses;
-import io.mailtrap.api.abstractions.classes.ApiResource;
+import io.mailtrap.api.api_resource.ApiResource;
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.http.RequestData;
-import io.mailtrap.model.request.ListAccountAccessQueryParams;
+import io.mailtrap.model.request.account_accesses.ListAccountAccessQueryParams;
 import io.mailtrap.model.response.account_accesses.AccountAccessResponse;
 import io.mailtrap.model.response.account_accesses.RemoveAccountAccessResponse;
 import lombok.NonNull;

src/main/java/io/mailtrap/api/abstractions/Accounts.java renamed to src/main/java/io/mailtrap/api/accounts/Accounts.java

@@ -1,6 +1,6 @@
-package io.mailtrap.api.abstractions;
+package io.mailtrap.api.accounts;
 
-import io.mailtrap.model.response.AccountsResponse;
+import io.mailtrap.model.response.accounts.AccountsResponse;
 
 import java.util.List;
 

src/main/java/io/mailtrap/api/AccountsImpl.java renamed to src/main/java/io/mailtrap/api/accounts/AccountsImpl.java

@@ -1,11 +1,10 @@
-package io.mailtrap.api;
+package io.mailtrap.api.accounts;
 
 import io.mailtrap.Constants;
-import io.mailtrap.api.abstractions.Accounts;
-import io.mailtrap.api.abstractions.classes.ApiResource;
+import io.mailtrap.api.api_resource.ApiResource;
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.http.RequestData;
-import io.mailtrap.model.response.AccountsResponse;
+import io.mailtrap.model.response.accounts.AccountsResponse;
 
 import java.util.List;
 

src/main/java/io/mailtrap/api/abstractions/classes/ApiResource.java renamed to src/main/java/io/mailtrap/api/api_resource/ApiResource.java

@@ -1,4 +1,4 @@
-package io.mailtrap.api.abstractions.classes;
+package io.mailtrap.api.api_resource;
 
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.http.CustomHttpClient;

src/main/java/io/mailtrap/api/abstractions/classes/ApiResourceWithValidation.java renamed to src/main/java/io/mailtrap/api/api_resource/ApiResourceWithValidation.java

@@ -1,4 +1,4 @@
-package io.mailtrap.api.abstractions.classes;
+package io.mailtrap.api.api_resource;
 
 import io.mailtrap.CustomValidator;
 import io.mailtrap.config.MailtrapConfig;

src/main/java/io/mailtrap/api/abstractions/classes/SendApiResource.java renamed to src/main/java/io/mailtrap/api/api_resource/SendApiResource.java

@@ -1,9 +1,9 @@
-package io.mailtrap.api.abstractions.classes;
+package io.mailtrap.api.api_resource;
 
 import io.mailtrap.CustomValidator;
 import io.mailtrap.config.MailtrapConfig;
 import io.mailtrap.exception.InvalidRequestBodyException;
-import io.mailtrap.model.request.MailtrapMail;
+import io.mailtrap.model.request.emails.MailtrapMail;
 import org.apache.commons.collections4.MapUtils;
 import org.apache.commons.lang3.StringUtils;
 
@@ -27,12 +27,14 @@ protected void validateRequestBodyOrThrowException(MailtrapMail mail) throws Inv
             throw new InvalidRequestBodyException("Mail must not be null");
         }
 
-        // All three fields can not be null - we should submit either text and/or html or templateUuid
-        if (StringUtils.isEmpty(mail.getText()) && StringUtils.isEmpty(mail.getHtml()) && StringUtils.isEmpty(mail.getTemplateUuid())) {
-            throw new InvalidRequestBodyException(String.format("Mail %s or %s or %s or %s and %s must not be null or empty",
+        // All three fields can not be null - we should submit either subject and text and/or html or templateUuid
+        if (StringUtils.isEmpty(mail.getSubject())
+                && StringUtils.isEmpty(mail.getText())
+                && StringUtils.isEmpty(mail.getHtml())
+                && StringUtils.isEmpty(mail.getTemplateUuid())) {
+            throw new InvalidRequestBodyException(String.format("Mail %s or %s and %s or %s or both must not be null or empty",
                     MailtrapMail.Fields.templateUuid,
-                    MailtrapMail.Fields.text,
-                    MailtrapMail.Fields.html,
+                    MailtrapMail.Fields.subject,
                     MailtrapMail.Fields.text,
                     MailtrapMail.Fields.html));
         }
@@ -55,6 +57,11 @@ protected void validateRequestBodyOrThrowException(MailtrapMail mail) throws Inv
                         MailtrapMail.Fields.templateVariables,
                         MailtrapMail.Fields.templateUuid));
             }
+            if(StringUtils.isEmpty(mail.getSubject())) {
+                throw new InvalidRequestBodyException(String.format("When %s is not set - the %s must be set",
+                        MailtrapMail.Fields.templateUuid,
+                        MailtrapMail.Fields.subject));
+            }
         }
 
         validateRequestBodyAndThrowException(mail);

src/main/java/io/mailtrap/api/abstractions/Attachments.java renamed to src/main/java/io/mailtrap/api/attachments/Attachments.java

@@ -1,6 +1,6 @@
-package io.mailtrap.api.abstractions;
+package io.mailtrap.api.attachments;
 
-import io.mailtrap.model.response.AttachmentResponse;
+import io.mailtrap.model.response.attachment.AttachmentResponse;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.List;