Merge pull request #21 from railsware/feature/improvements

vitalii-t · web-flow · commit 9cd7f676a2f1 · 2024-12-10T20:11:21.000+02:00
SDK improvements
diff --git a/README.md b/README.md
@@ -55,6 +55,7 @@ public class MailtrapJavaSDKTest {
     private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
     private static final String SENDER_EMAIL = "sender@domain.com";
     private static final String RECIPIENT_EMAIL = "recipient@domain.com";
+    private static final String REPLY_TO_EMAIL = "reply_to@domain.com";
 
     public static void main(String[] args) {
         final MailtrapConfig config = new MailtrapConfig.Builder()
@@ -66,6 +67,7 @@ public class MailtrapJavaSDKTest {
         final MailtrapMail mail = MailtrapMail.builder()
                 .from(new Address(SENDER_EMAIL))
                 .to(List.of(new Address(RECIPIENT_EMAIL)))
+                .replyTo(new Address(REPLY_TO_EMAIL, "Vincent Vega"))
                 .subject("Hello from Mailtrap Sending!")
                 .text("Welcome to Mailtrap Sending!")
                 .build();
diff --git a/examples/java/io/mailtrap/examples/sending/Everything.java b/examples/java/io/mailtrap/examples/sending/Everything.java
@@ -17,6 +17,7 @@ public class Everything {
     private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
     private static final String SENDER_EMAIL = "sender@domain.com";
     private static final String RECIPIENT_EMAIL = "recipient@domain.com";
+    private static final String REPLY_TO_EMAIL = "reply_to@domain.com";
 
     public static void main(String[] args) {
         final MailtrapConfig config = new MailtrapConfig.Builder()
@@ -36,6 +37,7 @@ public static void main(String[] args) {
                 ))
                 .from(new Address(SENDER_EMAIL))
                 .to(List.of(new Address(RECIPIENT_EMAIL)))
+                .replyTo(new Address(REPLY_TO_EMAIL, "Reply To"))
                 .subject("Hello from Mailtrap!")
                 .html("""
                         <!doctype html>
diff --git a/src/main/java/io/mailtrap/model/AccessLevel.java b/src/main/java/io/mailtrap/model/AccessLevel.java
@@ -8,6 +8,7 @@ public enum AccessLevel {
 
     OWNER(1000, "owner"),
     ADMIN(100, "admin"),
+    VIEWER_PLUS(50, "viewer+"),
     VIEWER(10, "viewer"),
     INDETERMINATE(1, "indeterminate");
 
diff --git a/src/main/java/io/mailtrap/model/ResourceType.java b/src/main/java/io/mailtrap/model/ResourceType.java
@@ -8,8 +8,7 @@ public enum ResourceType {
     BILLING("billing"),
     PROJECT("project"),
     INBOX("inbox"),
-    MAILSEND_DOMAIN("mailsend_domain"),
-    //TODO clarify name and rename enum value
+    SENDING_DOMAIN("sending_domain"),
     EMAIL_CAMPAIGN_PERMISSION_SCOPE("email_campaign_permission_scope");
 
     private final String value;
diff --git a/src/main/java/io/mailtrap/model/request/emails/MailtrapMail.java b/src/main/java/io/mailtrap/model/request/emails/MailtrapMail.java
@@ -31,6 +31,9 @@ public class MailtrapMail extends AbstractModel {
 
     private List<Address> bcc;
 
+    @JsonProperty("reply_to")
+    private Address replyTo;
+
     @Valid
     private List<EmailAttachment> attachments;
 
diff --git a/src/main/java/io/mailtrap/model/response/account_accesses/UserSpecifier.java b/src/main/java/io/mailtrap/model/response/account_accesses/UserSpecifier.java
@@ -1,5 +1,6 @@
 package io.mailtrap.model.response.account_accesses;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -11,4 +12,6 @@ public class UserSpecifier extends Specifier {
 
     private String name;
 
+    @JsonProperty("two_factor_authentication_enabled")
+    private boolean twoFactorAuthenticationEnabled;
 }
diff --git a/src/main/java/io/mailtrap/model/response/messages/BlacklistReportInfoResult.java b/src/main/java/io/mailtrap/model/response/messages/BlacklistReportInfoResult.java
@@ -0,0 +1,31 @@
+package io.mailtrap.model.response.messages;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+public enum BlacklistReportInfoResult {
+    SUCCESS("success"),
+    PENDING("pending"),
+    ERROR("error");
+
+    private final String value;
+
+    BlacklistReportInfoResult(String value) {
+        this.value = value;
+    }
+
+    @JsonValue
+    public String getValue() {
+        return value;
+    }
+
+    @JsonCreator
+    public static BlacklistReportInfoResult fromValue(Object value) {
+        for (BlacklistReportInfoResult level : BlacklistReportInfoResult.values()) {
+            if (level.value.equalsIgnoreCase((String) value)) {
+                return level;
+            }
+        }
+        throw new IllegalArgumentException("Unknown value: " + value);
+    }
+}
diff --git a/src/main/java/io/mailtrap/model/response/messages/BlacklistsReportInfo.java b/src/main/java/io/mailtrap/model/response/messages/BlacklistsReportInfo.java
@@ -0,0 +1,17 @@
+package io.mailtrap.model.response.messages;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class BlacklistsReportInfo {
+
+    private BlacklistReportInfoResult result;
+
+    private String domain;
+
+    private String ip;
+
+    private List<Report> report;
+}
diff --git a/src/main/java/io/mailtrap/model/response/messages/BlacklistsReportInfoWrapper.java b/src/main/java/io/mailtrap/model/response/messages/BlacklistsReportInfoWrapper.java
@@ -0,0 +1,22 @@
+package io.mailtrap.model.response.messages;
+
+import lombok.Getter;
+
+@Getter
+public class BlacklistsReportInfoWrapper {
+    private Boolean booleanValue;
+    private BlacklistsReportInfo objectValue;
+
+    public BlacklistsReportInfoWrapper(Boolean booleanValue) {
+        this.booleanValue = booleanValue;
+    }
+
+    public BlacklistsReportInfoWrapper(BlacklistsReportInfo objectValue) {
+        this.objectValue = objectValue;
+    }
+
+    public boolean isBoolean() {
+        return booleanValue != null;
+    }
+
+}
diff --git a/src/main/java/io/mailtrap/model/response/messages/MessageResponse.java b/src/main/java/io/mailtrap/model/response/messages/MessageResponse.java
@@ -1,6 +1,8 @@
 package io.mailtrap.model.response.messages;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import io.mailtrap.serialization.BlacklistsReportInfoDeserializer;
 import lombok.Data;
 
 import java.time.OffsetDateTime;
@@ -69,7 +71,8 @@ public class MessageResponse {
     private String htmlSourcePath;
 
     @JsonProperty("blacklists_report_info")
-    private boolean blacklistsReportInfo;
+    @JsonDeserialize(using = BlacklistsReportInfoDeserializer.class)
+    private BlacklistsReportInfoWrapper blacklistsReportInfoWrapper;
 
     @JsonProperty("smtp_information")
     private SmtpInformation smtpInformation;
diff --git a/src/main/java/io/mailtrap/model/response/messages/Report.java b/src/main/java/io/mailtrap/model/response/messages/Report.java
@@ -0,0 +1,15 @@
+package io.mailtrap.model.response.messages;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.Data;
+
+@Data
+public class Report {
+
+    private String name;
+
+    private String url;
+
+    @JsonProperty("in_black_list")
+    private boolean inBlackList;
+}
diff --git a/src/main/java/io/mailtrap/serialization/BlacklistsReportInfoDeserializer.java b/src/main/java/io/mailtrap/serialization/BlacklistsReportInfoDeserializer.java
@@ -0,0 +1,28 @@
+package io.mailtrap.serialization;
+
+import com.fasterxml.jackson.core.JacksonException;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.mailtrap.model.response.messages.BlacklistsReportInfo;
+import io.mailtrap.model.response.messages.BlacklistsReportInfoWrapper;
+
+import java.io.IOException;
+
+public class BlacklistsReportInfoDeserializer extends JsonDeserializer<BlacklistsReportInfoWrapper> {
+
+    @Override
+    public BlacklistsReportInfoWrapper deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JacksonException {
+        JsonNode node = jsonParser.getCodec().readTree(jsonParser);
+
+        if (node.isBoolean()) {
+            return new BlacklistsReportInfoWrapper(node.asBoolean());
+        } else {
+            ObjectMapper mapper = (ObjectMapper) jsonParser.getCodec();
+            return new BlacklistsReportInfoWrapper(mapper.convertValue(node, BlacklistsReportInfo.class));
+        }
+    }
+
+}
diff --git a/src/test/java/io/mailtrap/api/account_accesses/AccountAccessesImplTest.java b/src/test/java/io/mailtrap/api/account_accesses/AccountAccessesImplTest.java
@@ -51,6 +51,7 @@ void test_listUserAndInviteAccountAccesses() {
         assertEquals(accountAccessResponse.getId(), accountAccessId);
         assertEquals(SpecifierType.USER, accountAccessResponse.getSpecifierType());
         assertEquals(((UserSpecifier) accountAccessResponse.getSpecifier()).getName(), "Jack Sparrow");
+        assertTrue(((UserSpecifier) accountAccessResponse.getSpecifier()).isTwoFactorAuthenticationEnabled());
         assertEquals(accountAccessResponse.getResources().size(), 3);
     }
 
diff --git a/src/test/java/io/mailtrap/serialization/AccountAccessResponseDeserializerTest.java b/src/test/java/io/mailtrap/serialization/AccountAccessResponseDeserializerTest.java
@@ -85,7 +85,8 @@ void testUserSpecifierDeserialization() throws Exception {
                          "specifier": {
                            "id": 3,
                            "email": "user@example.com",
-                           "name": "John Doe"
+                           "name": "John Doe",
+                           "two_factor_authentication_enabled": false
                          },
                          "resources": [],
                          "permissions": {
@@ -104,6 +105,7 @@ void testUserSpecifierDeserialization() throws Exception {
         assertEquals(3, userSpecifier.getId());
         assertEquals("user@example.com", userSpecifier.getEmail());
         assertEquals("John Doe", userSpecifier.getName());
+        assertFalse(userSpecifier.isTwoFactorAuthenticationEnabled());
     }
 
     @Test
diff --git a/src/test/java/io/mailtrap/serialization/BlacklistsReportInfoDeserializerTest.java b/src/test/java/io/mailtrap/serialization/BlacklistsReportInfoDeserializerTest.java
@@ -0,0 +1,68 @@
+package io.mailtrap.serialization;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.mailtrap.Mapper;
+import io.mailtrap.model.response.messages.BlacklistReportInfoResult;
+import io.mailtrap.model.response.messages.BlacklistsReportInfo;
+import io.mailtrap.model.response.messages.MessageResponse;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class BlacklistsReportInfoDeserializerTest {
+
+    private final ObjectMapper mapper = Mapper.get();
+
+    @Test
+    void testApiTokenSpecifierDeserialization() throws Exception {
+        String json = """
+                    {
+                      "id": 3,
+                      "inbox_id": 2,
+                      "blacklists_report_info": false
+                    }
+                """;
+
+        MessageResponse message = mapper.readValue(json, MessageResponse.class);
+
+        assertEquals(3, message.getId());
+        assertEquals(2, message.getInboxId());
+        assertNotNull(message.getBlacklistsReportInfoWrapper());
+        assertTrue(message.getBlacklistsReportInfoWrapper().isBoolean());
+        assertFalse(message.getBlacklistsReportInfoWrapper().getBooleanValue());
+    }
+
+    @Test
+    void testApiTokenSpecifierDeserialization2() throws Exception {
+        String json = """
+                    {
+                      "id": 4,
+                      "inbox_id": 5,
+                      "blacklists_report_info": {
+                        "result": "success",
+                        "domain": "mailtrap.io",
+                        "ip": "192.168.1.10",
+                        "report": [
+                          {
+                            "name": "SpamCheck",
+                            "url": "https://blacklist.example.com/report/spamcheck",
+                            "in_black_list": false
+                          }
+                        ]
+                      }
+                    }
+                """;
+
+        MessageResponse message = mapper.readValue(json, MessageResponse.class);
+
+        assertEquals(4, message.getId());
+        assertEquals(5, message.getInboxId());
+        assertNotNull(message.getBlacklistsReportInfoWrapper());
+        assertFalse(message.getBlacklistsReportInfoWrapper().isBoolean());
+
+        BlacklistsReportInfo blacklistsReportInfo = message.getBlacklistsReportInfoWrapper().getObjectValue();
+        assertEquals(BlacklistReportInfoResult.SUCCESS, blacklistsReportInfo.getResult());
+        assertEquals(1, blacklistsReportInfo.getReport().size());
+    }
+
+}
diff --git a/src/test/resources/api/account_access/getAccountAccessResponse.json b/src/test/resources/api/account_access/getAccountAccessResponse.json
@@ -5,7 +5,8 @@
     "specifier": {
       "id": 0,
       "email": "user@example.com",
-      "name": "Jack Sparrow"
+      "name": "Jack Sparrow",
+      "two_factor_authentication_enabled": true
     },
     "resources": [
       {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package io.mailtrap.model.response.account_accesses;`
`2`	`2`
	`3`	`+import com.fasterxml.jackson.annotation.JsonProperty;`
`3`	`4`	`import lombok.Data;`
`4`	`5`	`import lombok.EqualsAndHashCode;`
`5`	`6`
`@@ -11,4 +12,6 @@ public class UserSpecifier extends Specifier {`
`11`	`12`
`12`	`13`	`private String name;`
`13`	`14`
	`15`	`+ @JsonProperty("two_factor_authentication_enabled")`
	`16`	`+ private boolean twoFactorAuthenticationEnabled;`
`14`	`17`	`}`