refactor: introduce interface for postmarkClient

melistik · melistik · commit 26825725ec39 · 2024-05-23T10:11:30.000+02:00
diff --git a/src/main/java/io/rocketbase/mail/DefaultPostmarkClient.java b/src/main/java/io/rocketbase/mail/DefaultPostmarkClient.java
@@ -0,0 +1,96 @@
+package io.rocketbase.mail;
+
+import io.rocketbase.mail.config.PostmarkProperties;
+import io.rocketbase.mail.dto.EmailAttachment;
+import io.rocketbase.mail.dto.Message;
+import io.rocketbase.mail.dto.MessageResponse;
+import io.rocketbase.mail.dto.MessageWithTemplate;
+import io.rocketbase.mail.util.MessageJsonWriter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.core.ParameterizedTypeReference;
+import org.springframework.core.io.FileSystemResource;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.client.RestTemplate;
+import org.springframework.web.util.UriComponentsBuilder;
+
+import java.io.File;
+import java.util.List;
+
+@RequiredArgsConstructor
+public class DefaultPostmarkClient implements PostmarkClient {
+
+    private final PostmarkProperties postmarkProperties;
+
+    protected RestTemplate restTemplate;
+
+    protected RestTemplate getRestTemplate() {
+        if (restTemplate == null) {
+            restTemplate = new RestTemplate();
+        }
+        return restTemplate;
+    }
+
+    @Override
+    public MessageResponse deliverMessage(Message msg) {
+        ResponseEntity<MessageResponse> response = getRestTemplate().exchange(createUriBuilder().path("/email/")
+                        .toUriString(),
+                HttpMethod.POST,
+                new HttpEntity<>(msg, buildHeaders()),
+                MessageResponse.class);
+        return response.getBody();
+    }
+
+    @Override
+    public MessageResponse deliverMessage(Message msg, EmailAttachment... emailAttachments) {
+        ResponseEntity<MessageResponse> response = null;
+        File json = null;
+        try {
+            json = new MessageJsonWriter().writeMessageFile(msg, emailAttachments);
+            response = getRestTemplate().exchange(createUriBuilder().path("/email/")
+                            .toUriString(),
+                    HttpMethod.POST,
+                    new HttpEntity<>(new FileSystemResource(json), buildHeaders()),
+                    MessageResponse.class);
+        } finally {
+            if (json != null) {
+                json.delete();
+            }
+        }
+        return response.getBody();
+    }
+
+    @Override
+    public List<MessageResponse> deliverMessage(List<Message> messages) {
+        ResponseEntity<List<MessageResponse>> response = getRestTemplate().exchange(createUriBuilder().path("/email/batch")
+                        .toUriString(),
+                HttpMethod.POST,
+                new HttpEntity<>(messages, buildHeaders()),
+                new ParameterizedTypeReference<List<MessageResponse>>() {
+                });
+        return response.getBody();
+    }
+
+    @Override
+    public MessageResponse deliverMessageWithTemplate(MessageWithTemplate msg) {
+        ResponseEntity<MessageResponse> response = getRestTemplate().exchange(createUriBuilder().path("/email/withTemplate")
+                        .toUriString(),
+                HttpMethod.POST,
+                new HttpEntity<>(msg, buildHeaders()),
+                MessageResponse.class);
+        return response.getBody();
+    }
+
+    protected UriComponentsBuilder createUriBuilder() {
+        return UriComponentsBuilder.fromUriString(postmarkProperties.getApi().getUrl());
+    }
+
+    protected HttpHeaders buildHeaders() {
+        HttpHeaders headers = new HttpHeaders();
+        headers.add(postmarkProperties.getApi().getHeader(), postmarkProperties.getToken());
+        return headers;
+    }
+
+}
diff --git a/src/main/java/io/rocketbase/mail/PostmarkClient.java b/src/main/java/io/rocketbase/mail/PostmarkClient.java
@@ -1,92 +1,19 @@
 package io.rocketbase.mail;
 
-import io.rocketbase.mail.config.PostmarkProperties;
 import io.rocketbase.mail.dto.EmailAttachment;
 import io.rocketbase.mail.dto.Message;
 import io.rocketbase.mail.dto.MessageResponse;
 import io.rocketbase.mail.dto.MessageWithTemplate;
-import io.rocketbase.mail.util.MessageJsonWriter;
-import lombok.RequiredArgsConstructor;
-import org.springframework.core.ParameterizedTypeReference;
-import org.springframework.core.io.FileSystemResource;
-import org.springframework.http.HttpEntity;
-import org.springframework.http.HttpHeaders;
-import org.springframework.http.HttpMethod;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.client.RestTemplate;
-import org.springframework.web.util.UriComponentsBuilder;
 
-import java.io.File;
 import java.util.List;
 
-@RequiredArgsConstructor
-public class PostmarkClient {
+public interface PostmarkClient {
 
-    private final PostmarkProperties postmarkProperties;
+    MessageResponse deliverMessage(Message msg);
 
-    protected RestTemplate restTemplate;
+    MessageResponse deliverMessage(Message msg, EmailAttachment... emailAttachments);
 
-    protected RestTemplate getRestTemplate() {
-        if (restTemplate == null) {
-            restTemplate = new RestTemplate();
-        }
-        return restTemplate;
-    }
-
-    public MessageResponse deliverMessage(Message msg) {
-        ResponseEntity<MessageResponse> response = getRestTemplate().exchange(createUriBuilder().path("/email/")
-                        .toUriString(),
-                HttpMethod.POST,
-                new HttpEntity<>(msg, buildHeaders()),
-                MessageResponse.class);
-        return response.getBody();
-    }
-
-    public MessageResponse deliverMessage(Message msg, EmailAttachment... emailAttachments) {
-        ResponseEntity<MessageResponse> response = null;
-        File json = null;
-        try {
-            json = new MessageJsonWriter().writeMessageFile(msg, emailAttachments);
-            response = getRestTemplate().exchange(createUriBuilder().path("/email/")
-                            .toUriString(),
-                    HttpMethod.POST,
-                    new HttpEntity<>(new FileSystemResource(json), buildHeaders()),
-                    MessageResponse.class);
-        } finally {
-            if (json != null) {
-                json.delete();
-            }
-        }
-        return response.getBody();
-    }
-
-    public List<MessageResponse> deliverMessage(List<Message> messages) {
-        ResponseEntity<List<MessageResponse>> response = getRestTemplate().exchange(createUriBuilder().path("/email/batch")
-                        .toUriString(),
-                HttpMethod.POST,
-                new HttpEntity<>(messages, buildHeaders()),
-                new ParameterizedTypeReference<List<MessageResponse>>() {
-                });
-        return response.getBody();
-    }
-
-    public MessageResponse deliverMessageWithTemplate(MessageWithTemplate msg) {
-        ResponseEntity<MessageResponse> response = getRestTemplate().exchange(createUriBuilder().path("/email/withTemplate")
-                        .toUriString(),
-                HttpMethod.POST,
-                new HttpEntity<>(msg, buildHeaders()),
-                MessageResponse.class);
-        return response.getBody();
-    }
-
-    protected UriComponentsBuilder createUriBuilder() {
-        return UriComponentsBuilder.fromUriString(postmarkProperties.getApi().getUrl());
-    }
-
-    protected HttpHeaders buildHeaders() {
-        HttpHeaders headers = new HttpHeaders();
-        headers.add(postmarkProperties.getApi().getHeader(), postmarkProperties.getToken());
-        return headers;
-    }
+    List<MessageResponse> deliverMessage(List<Message> messages);
 
+    MessageResponse deliverMessageWithTemplate(MessageWithTemplate msg);
 }
diff --git a/src/main/java/io/rocketbase/mail/config/PostmarkAutoConfiguration.java b/src/main/java/io/rocketbase/mail/config/PostmarkAutoConfiguration.java
@@ -1,6 +1,7 @@
 package io.rocketbase.mail.config;
 
 import io.rocketbase.mail.PostmarkClient;
+import io.rocketbase.mail.DefaultPostmarkClient;
 import lombok.RequiredArgsConstructor;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@@ -21,7 +22,7 @@ public class PostmarkAutoConfiguration implements Serializable {
     @ConditionalOnMissingBean
     @ConditionalOnProperty(name = "postmark.enabled", matchIfMissing = true)
     public PostmarkClient postmarkClient() {
-        return new PostmarkClient(postmarkProperties);
+        return new DefaultPostmarkClient(postmarkProperties);
     }
 
 }
diff --git a/src/main/java/io/rocketbase/mail/dto/MessageResponse.java b/src/main/java/io/rocketbase/mail/dto/MessageResponse.java
@@ -1,7 +1,11 @@
 package io.rocketbase.mail.dto;
 
+import lombok.Data;
+import lombok.Getter;
+
 import java.util.Date;
 
+@Data
 public class MessageResponse {
 
     private String to;
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/BounceWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/BounceWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import io.rocketbase.mail.dto.webhook.sub.BounceType;
@@ -10,7 +9,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -55,7 +53,7 @@ public WebhookRecordType getRecordType() {
     private boolean canActivate;
 
     @JsonProperty("BouncedAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant bouncedAt;
 
 
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/ClickWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/ClickWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import io.rocketbase.mail.dto.webhook.sub.ClickLocation;
@@ -12,7 +11,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -45,7 +43,7 @@ public WebhookRecordType getRecordType() {
     private ClickLocation clickLocation;
 
     @JsonProperty("ReceivedAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant receivedAt;
 
     @JsonProperty("Client")
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/DeliveryWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/DeliveryWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import lombok.AllArgsConstructor;
@@ -9,7 +8,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -33,7 +31,7 @@ public WebhookRecordType getRecordType() {
     private String tag;
 
     @JsonProperty("DeliveredAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant deliveredAt;
 
     @JsonProperty("Details")
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/OpenWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/OpenWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import io.rocketbase.mail.dto.webhook.sub.Client;
@@ -12,7 +11,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -42,7 +40,7 @@ public WebhookRecordType getRecordType() {
     private Map<String, Object> metadata;
 
     @JsonProperty("ReceivedAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant receivedAt;
 
     @JsonProperty("Client")
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/PostmarkInstantDeserializer.java b/src/main/java/io/rocketbase/mail/dto/webhook/PostmarkInstantDeserializer.java
@@ -9,7 +9,7 @@
 import java.time.Instant;
 import java.time.format.DateTimeParseException;
 
-public class PostmarkInstantDeserialzer extends JsonDeserializer<Instant> {
+public class PostmarkInstantDeserializer extends JsonDeserializer<Instant> {
 
     @Override
     public Instant deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/SpamComplaintWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/SpamComplaintWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import lombok.AllArgsConstructor;
@@ -9,7 +8,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -33,7 +31,7 @@ public WebhookRecordType getRecordType() {
     private String tag;
 
     @JsonProperty("BouncedAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant bouncedAt;
 
     @JsonProperty("Subject")
diff --git a/src/main/java/io/rocketbase/mail/dto/webhook/SubscriptionChangeWebhookMessage.java b/src/main/java/io/rocketbase/mail/dto/webhook/SubscriptionChangeWebhookMessage.java
@@ -1,6 +1,5 @@
 package io.rocketbase.mail.dto.webhook;
 
-import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import io.rocketbase.mail.dto.webhook.sub.SuppressionReason;
@@ -10,7 +9,6 @@
 import lombok.NoArgsConstructor;
 
 import java.time.Instant;
-import java.util.Date;
 import java.util.Map;
 
 @Data
@@ -34,7 +32,7 @@ public WebhookRecordType getRecordType() {
     private String origin;
 
     @JsonProperty("ChangedAt")
-    @JsonDeserialize(using = PostmarkInstantDeserialzer.class)
+    @JsonDeserialize(using = PostmarkInstantDeserializer.class)
     private Instant changedAt;
 
     @JsonProperty("Tag")
diff --git a/src/test/java/io/rocketbase/mail/PostmarkClientTest.java b/src/test/java/io/rocketbase/mail/PostmarkClientTest.java
@@ -23,7 +23,7 @@ public class PostmarkClientTest {
     @Test
     public void testDeliverMessage() {
         // given
-        PostmarkClient client = new PostmarkClient(new PostmarkProperties("--"));
+        PostmarkClient client = new DefaultPostmarkClient(new PostmarkProperties("--"));
         Message message = new Message(new EmailAddress("info@rocketbase.io"),
                 new EmailAddress("marten@rocketbase.io", "Marten Prieß"), "Postmark Spring-Client",
                 "<h1>My little Text</h2><p>Great to hear...</p><p><a href=\"http://www.rocketbase.io\">Link</a>",
@@ -52,7 +52,7 @@ public void testDeliverMessageWithTemplate() {
         templateObject.put("task_name", "task-name");
         templateObject.put("message", "Had some issues...\nplease take a look");
 
-        PostmarkClient client = new PostmarkClient(new PostmarkProperties("--"));
+        PostmarkClient client = new DefaultPostmarkClient(new PostmarkProperties("--"));
         MessageWithTemplate message = new MessageWithTemplate(new EmailAddress("info@rocketbase.io"),
                 new EmailAddress("marten@rocketbase.io", "Marten Prieß"), "application-error", templateObject);
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package io.rocketbase.mail.config;`
`2`	`2`
`3`	`3`	`import io.rocketbase.mail.PostmarkClient;`
	`4`	`+import io.rocketbase.mail.DefaultPostmarkClient;`
`4`	`5`	`import lombok.RequiredArgsConstructor;`
`5`	`6`	`import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;`
`6`	`7`	`import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;`
`@@ -21,7 +22,7 @@ public class PostmarkAutoConfiguration implements Serializable {`
`21`	`22`	`@ConditionalOnMissingBean`
`22`	`23`	`@ConditionalOnProperty(name = "postmark.enabled", matchIfMissing = true)`
`23`	`24`	`public PostmarkClient postmarkClient() {`
`24`		`- return new PostmarkClient(postmarkProperties);`
	`25`	`+ return new DefaultPostmarkClient(postmarkProperties);`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`}`