release 1.0.4

Author: szagr

CHANGELOG.md

@@ -5,6 +5,10 @@ All _notable_ changes to this project will be documented in this file.
 The format is based on _[Keep a Changelog][keepachangelog]_, and this project
 adheres to _[Semantic Versioning][semver]_.
 
+## [1.0.4] (released: 2022-10-10)
+### Added
+- add FormData attachment support.
+- add default AsyncClient.
 
 ## [1.0.3] (released: 2022-09-23)
 ### Added
@@ -34,6 +38,8 @@ adheres to _[Semantic Versioning][semver]_.
 - Add Import a list of bounces from CSV file API
 
 
+[1.0.4]: https://github.com/mailgun/mailgun-java/compare/release/1.0.3...release/1.0.4
+[1.0.3]: https://github.com/mailgun/mailgun-java/compare/release/1.0.2...release/1.0.3
 [1.0.2]: https://github.com/mailgun/mailgun-java/compare/release/1.0.1...release/1.0.2
 [1.0.1]: https://github.com/mailgun/mailgun-java/compare/release/1.0.0...release/1.0.1
 

README.md

@@ -85,7 +85,7 @@ Add the following to your `pom.xml`:
 Gradle Groovy DSL .
 
 ```xml
-implementation 'com.mailgun:mailgun-java:1.0.2'
+implementation 'com.mailgun:mailgun-java:1.0.4'
 ```
 
 
@@ -253,10 +253,13 @@ More information:
 - [Methods](#methods)
   - [Messages](#messages)
     - [Set up MailgunMessagesApi](#Set-up-MailgunMessagesApi)
-    - [Send email(s)](#send-emails)
+    - [Send email](#send-email)
+    - [Send email(name with email)](#send-email-name-with-email)
+    - [Send emails](#send-emails)
     - [Async send email(s)](#async-send-emails)
     - [Send email (html example)](#send-email-html-example)
     - [Send email (attachments example)](#send-email-attachments-example)
+    - [Send email (attachment FormData example)](#send-email-attachment-FormData-example)
     - [Send email (inline multiple files example)](#send-email-inline-multiple-files-example)
     - [Send email (delay example)](#send-email-delay-example)
     - [Send email (reply-to example)](#send-email-reply-to-example)
@@ -433,11 +436,47 @@ When you submit messages for delivery, Mailgun places them in a message queue.
 ```
 
 
+#### Send email
+```java
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(USER_EMAIL)
+                .subject(SUBJECT)
+                .text(TEXT)
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+
+#### Send email (name with email)
+```java
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(EmailUtil.nameWithEmail(USER_NAME, USER_EMAIL))
+                .subject(SUBJECT)
+                .text(TEXT)
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+
 #### Send email(s)
 ```java
         Message message = Message.builder()
                 .from(EMAIL_FROM)
-                .to(EmailUtil.emailWithName(USER_NAME, USER_EMAIL)
+                .to(Arrays.asList(USER_EMAIL_1, USER_EMAIL_2))
+                .subject(SUBJECT)
+                .text(TEXT)
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+or
+```java
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(USER_EMAIL_1)
+                .to(USER_EMAIL_2)
                 .subject(SUBJECT)
                 .text(TEXT)
                 .build();
@@ -453,7 +492,7 @@ Asynchronously send email(s).
 
         Message message = Message.builder()
                 .from(EMAIL_FROM)
-                .to(EmailUtil.emailWithName(USER_NAME, USER_EMAIL)
+                .to(USER_EMAIL)
                 .subject(SUBJECT)
                 .text(TEXT)
                 .build();
@@ -494,6 +533,19 @@ Asynchronously send email(s).
         MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
 ```
 
+#### Send email (attachment FormData example)
+```java
+        Message message = Message.builder()
+                .from(EMAIL_FROM)
+                .to(EMAIL_TO)
+                .subject(SUBJECT)
+                .text(TEXT)
+                .formData(new FormData("image/png", "filename.png", myDataAsByteArray))
+                .build();
+
+        MessageResponse messageResponse = mailgunMessagesApi.sendMessage(DOMAIN, message);
+```
+
 #### Send email (inline multiple files example)
 ```java
         Message message = Message.builder()

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.mailgun</groupId>
     <artifactId>mailgun-java</artifactId>
-    <version>1.0.4-SNAPSHOT</version>
+    <version>1.0.4</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

src/main/java/com/mailgun/client/MailgunClient.java

@@ -1,12 +1,15 @@
 package com.mailgun.client;
 
+import java.util.concurrent.Executors;
+
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.mailgun.api.MailgunApi;
 import com.mailgun.util.ConsoleLogger;
 import com.mailgun.util.MailgunApiUtil;
 import com.mailgun.util.ObjectMapperUtil;
 import feign.AsyncClient;
 import feign.AsyncFeign;
+import feign.Client;
 import feign.Feign;
 import feign.Logger;
 import feign.Request;
@@ -68,7 +71,10 @@ public static class MailgunClientBuilder {
         private Logger logger = new ConsoleLogger();
         private ErrorDecoder errorDecoder = new ErrorDecoder.Default();
         private Request.Options options = new Request.Options();
-        private AsyncClient<Object> client = null;
+        private AsyncClient<Object> client = new AsyncClient.Default<>(
+            new Client.Default(null, null),
+            Executors.newSingleThreadExecutor()
+        );
 
         private String baseUrl = DEFAULT_BASE_URL_US_REGION;
         private final String apiKey;

src/main/java/com/mailgun/model/message/Message.java

@@ -5,6 +5,7 @@
 import com.mailgun.util.CollectionUtil;
 import com.mailgun.util.DateTimeUtil;
 import com.mailgun.util.StringUtil;
+import feign.form.FormData;
 import feign.form.FormProperty;
 import lombok.Builder;
 import lombok.EqualsAndHashCode;
@@ -17,6 +18,7 @@
 import java.time.ZonedDateTime;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
 
 import static com.mailgun.util.Constants.FIELD_CANNOT_BE_NULL_OR_EMPTY;
@@ -91,6 +93,14 @@ public class Message {
      */
     Set<File> attachment;
 
+    /**
+     * <p>
+     * File attachment in form of {@link FormData}.
+     * </p>
+     */
+    @FormProperty("attachment")
+    FormData formData;
+
     /**
      * <p>
      * Attachment with inline disposition.
@@ -285,6 +295,10 @@ public Message build() {
                     .findFirst()
                     .orElseThrow(() -> new IllegalArgumentException(String.format(FIELD_CANNOT_BE_NULL_OR_EMPTY, "to")));
 
+            if (CollectionUtils.isNotEmpty(super.attachment) && Objects.nonNull(super.formData)) {
+                throw new IllegalArgumentException("You cannot use 'attachment' and 'formData' together");
+            }
+
             return super.build();
         }
     }

src/test/java/com/mailgun/integration/MailgunMessagesIntegrationTest.java

@@ -1,13 +1,16 @@
 package com.mailgun.integration;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.time.ZonedDateTime;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
@@ -20,6 +23,7 @@
 import com.mailgun.util.ObjectMapperUtil;
 import feign.Request;
 import feign.Response;
+import feign.form.FormData;
 
 import static com.mailgun.constants.IntegrationTestConstants.EMAIL_FROM;
 import static com.mailgun.constants.IntegrationTestConstants.EMAIL_TO;
@@ -204,6 +208,27 @@ void message_Attachment_Test() {
         assertEquals(EMAIL_RESPONSE_MESSAGE, result.getMessage());
     }
 
+    @Test
+    void message_Attachment_FormData_Test() throws IOException {
+//        Emulate InputStream
+        InputStream inputStream = new FileInputStream("src/test/resources/mailgun_awesomeness.txt");
+        byte[] bytes = IOUtils.toByteArray(inputStream);
+        FormData formData = new FormData("text/plain", "mailgun_awesomeness.txt", bytes);
+
+        Message message = Message.builder()
+            .from(EMAIL_FROM)
+            .to(EMAIL_TO)
+            .subject("FormData attachment example.")
+            .text(TEST_EMAIL_TEXT)
+            .formData(formData)
+            .build();
+
+
+        MessageResponse result = mailgunMessagesApi.sendMessage(MAIN_DOMAIN, message);
+
+        assertEquals(EMAIL_RESPONSE_MESSAGE, result.getMessage());
+    }
+
     @Test
     void message_Inline_Simple_Test() {
         File mailgunLogo = new File("src/test/resources/mailgun_logo.png");

src/test/java/com/mailgun/integration/MailgunTemplatesIntegrationTest.java

@@ -42,6 +42,7 @@
 import static com.mailgun.constants.IntegrationTestConstants.MAIN_DOMAIN;
 import static com.mailgun.constants.IntegrationTestConstants.PRIVATE_API_KEY;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -210,7 +211,7 @@ void getAllTemplateVersionsSuccessTest() {
         assertNotNull(templateWithVersions.getName());
         assertNotNull(templateWithVersions.getDescription());
         List<TemplateVersions> versions = templateWithVersions.getVersions();
-        assertTrue(versions.size() > 1);
+        assertFalse(versions.isEmpty());
         TemplateVersions version = versions.get(0);
         assertNotNull(version.getId());
         assertNotNull(version.getActive());

src/test/java/com/mailgun/model/message/MessageTest.java

@@ -3,11 +3,16 @@
 import com.mailgun.enums.YesNo;
 import com.mailgun.enums.YesNoHtml;
 import com.mailgun.util.EmailUtil;
+import feign.form.FormData;
+
+import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -232,6 +237,25 @@ void messageFieldToEmptyExceptionTest() {
         assertEquals(String.format(FIELD_CANNOT_BE_NULL_OR_EMPTY, "to"), exception.getMessage());
     }
 
+
+    @Test
+    void messageAttachmentAndFromDataTogetherExceptionTest() throws IOException {
+        File file = getTempFile("temp.1");
+        InputStream inputStream = new FileInputStream(getTempFile("temp.2"));
+        byte[] txtBytes = IOUtils.toByteArray(inputStream);
+        FormData formData = new FormData("text/plain", "temp.txt", txtBytes);
+
+        Message.MessageBuilder messageBuilder = Message.builder()
+            .from(TEST_EMAIL_1)
+            .to(TEST_EMAIL_2)
+            .attachment(file)
+            .formData(formData);
+
+        Exception exception = assertThrows(IllegalArgumentException.class, messageBuilder::build);
+
+        assertEquals("You cannot use 'attachment' and 'formData' together", exception.getMessage());
+    }
+
     private File getTempFile(String prefix) throws IOException {
         File file = File.createTempFile(prefix, ".tmp", new File("src/test/java/com/mailgun/utils"));
         file.deleteOnExit();

src/test/java/com/mailgun/util/EmailUtilTest.java

@@ -9,7 +9,7 @@
 class EmailUtilTest {
 
     @Test
-    void emailWithNameTest() {
+    void nameWithEmailTest() {
         String result = EmailUtil.nameWithEmail(TEST_USER_NAME, TEST_EMAIL_1);
 
         assertEquals("Zarathustra <[email protected]>", result);