Merge pull request #161 from ssk910/feature/unit_test-for-integrations-api

Added unit tests for integrations api

Author: denizkilic

api/src/main/java/com/messagebird/MessageBirdClient.java

@@ -46,9 +46,9 @@
 import com.messagebird.objects.conversations.ConversationWebhookCreateRequest;
 import com.messagebird.objects.conversations.ConversationWebhookList;
 import com.messagebird.objects.conversations.ConversationWebhookUpdateRequest;
-import com.messagebird.objects.integrations.WhatsAppTemplate;
-import com.messagebird.objects.integrations.WhatsAppTemplateList;
-import com.messagebird.objects.integrations.WhatsAppTemplateResponse;
+import com.messagebird.objects.integrations.Template;
+import com.messagebird.objects.integrations.TemplateList;
+import com.messagebird.objects.integrations.TemplateResponse;
 import com.messagebird.objects.voicecalls.RecordingResponse;
 import com.messagebird.objects.voicecalls.TranscriptionResponse;
 import com.messagebird.objects.voicecalls.VoiceCall;
@@ -122,7 +122,7 @@ public class MessageBirdClient {
     private static final String CONVERSATION_SEND_PATH = "/send";
     private static final String CONVERSATION_MESSAGE_PATH = "/messages";
     private static final String CONVERSATION_WEBHOOK_PATH = "/webhooks";
-    private static final String INTEGRATIONS_WHATSAPP_PATH = "/platforms/whatsapp";
+    static final String INTEGRATIONS_WHATSAPP_PATH = "/platforms/whatsapp";
     static final String VOICECALLSPATH = "/calls";
     static final String LEGSPATH = "/legs";
     static final String RECORDINGPATH = "/recordings";
@@ -1862,13 +1862,14 @@ public String downloadFile(String id, String filename, String basePath) throws G
     /**
      * Create a WhatsApp message template through messagebird.
      *
-     * @param template {@link WhatsAppTemplate} object to be created
-     * @return {@link WhatsAppTemplateResponse} response object
-     * @throws UnauthorizedException if client is unauthorized
-     * @throws GeneralException      general exception or invalid template format
+     * @param template {@link Template} object to be created
+     * @return {@link TemplateResponse} response object
+     * @throws UnauthorizedException    if client is unauthorized
+     * @throws GeneralException         general exception
+     * @throws IllegalArgumentException invalid template format
      */
-    public WhatsAppTemplateResponse createWhatsAppTemplate(final WhatsAppTemplate template)
-        throws UnauthorizedException, GeneralException {
+    public TemplateResponse createWhatsAppTemplate(final Template template)
+        throws UnauthorizedException, GeneralException, IllegalArgumentException {
         template.validate();
 
         String url = String.format(
@@ -1877,7 +1878,7 @@ public WhatsAppTemplateResponse createWhatsAppTemplate(final WhatsAppTemplate te
             INTEGRATIONS_WHATSAPP_PATH,
             TEMPLATES_PATH
         );
-        return messageBirdService.sendPayLoad(url, template, WhatsAppTemplateResponse.class);
+        return messageBirdService.sendPayLoad(url, template, TemplateResponse.class);
     }
 
     /**
@@ -1889,15 +1890,15 @@ public WhatsAppTemplateResponse createWhatsAppTemplate(final WhatsAppTemplate te
      * @throws UnauthorizedException if client is unauthorized
      * @throws GeneralException      general exception
      */
-    public WhatsAppTemplateList listWhatsAppTemplates(final int offset, final int limit)
+    public TemplateList listWhatsAppTemplates(final int offset, final int limit)
         throws UnauthorizedException, GeneralException {
         String url = String.format(
             "%s%s%s",
             INTEGRATIONS_BASE_URL_V3,
             INTEGRATIONS_WHATSAPP_PATH,
             TEMPLATES_PATH
         );
-        return messageBirdService.requestList(url, offset, limit, WhatsAppTemplateList.class);
+        return messageBirdService.requestList(url, offset, limit, TemplateList.class);
     }
 
     /**
@@ -1907,7 +1908,7 @@ public WhatsAppTemplateList listWhatsAppTemplates(final int offset, final int li
      * @throws UnauthorizedException if client is unauthorized
      * @throws GeneralException      general exception
      */
-    public WhatsAppTemplateList listWhatsAppTemplates() throws UnauthorizedException, GeneralException {
+    public TemplateList listWhatsAppTemplates() throws UnauthorizedException, GeneralException {
         final int offset = 0;
         final int limit = 10;
 
@@ -1923,7 +1924,7 @@ public WhatsAppTemplateList listWhatsAppTemplates() throws UnauthorizedException
      * @throws GeneralException      general exception
      * @throws NotFoundException     if template name is not found
      */
-    public List<WhatsAppTemplateResponse> getWhatsAppTemplatesBy(final String templateName)
+    public List<TemplateResponse> getWhatsAppTemplatesBy(final String templateName)
         throws GeneralException, UnauthorizedException, NotFoundException {
         if (templateName == null) {
             throw new IllegalArgumentException("Template name must be specified.");
@@ -1936,8 +1937,7 @@ public List<WhatsAppTemplateResponse> getWhatsAppTemplatesBy(final String templa
             TEMPLATES_PATH
         );
 
-        final WhatsAppTemplateResponse[] templateResponses = messageBirdService.requestByID(url, templateName, WhatsAppTemplateResponse[].class);
-        return Arrays.asList(templateResponses);
+        return messageBirdService.requestByIdAsList(url, templateName, TemplateResponse.class);
     }
 
   /**
@@ -1951,7 +1951,7 @@ public List<WhatsAppTemplateResponse> getWhatsAppTemplatesBy(final String templa
      * @throws GeneralException      general exception
      * @throws NotFoundException     if template name and language are not found
      */
-    public WhatsAppTemplateResponse fetchWhatsAppTemplateBy(final String templateName, final String language)
+    public TemplateResponse fetchWhatsAppTemplateBy(final String templateName, final String language)
         throws GeneralException, UnauthorizedException, NotFoundException {
         if (templateName == null || language == null) {
             throw new IllegalArgumentException("Template name and language must be specified.");
@@ -1965,7 +1965,7 @@ public WhatsAppTemplateResponse fetchWhatsAppTemplateBy(final String templateNam
             templateName,
             language
         );
-        return messageBirdService.request(url, WhatsAppTemplateResponse.class);
+        return messageBirdService.request(url, TemplateResponse.class);
     }
 
 

api/src/main/java/com/messagebird/MessageBirdService.java

@@ -4,6 +4,7 @@
 import com.messagebird.exceptions.NotFoundException;
 import com.messagebird.exceptions.UnauthorizedException;
 import com.messagebird.objects.PagedPaging;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -38,6 +39,20 @@ public interface MessageBirdService {
 
     <R> R requestByID(String request, String id, Map<String, Object> params, Class<R> clazz) throws UnauthorizedException, GeneralException, NotFoundException;
 
+    /**
+     * Execute a object by ID request. It will add the id to the request parameter and retrieve a list of an object E back.
+     *
+     * @author ssk910
+     * @param request       path to the request, for example "/messages"
+     * @param id            id of the object to request. id can be null in case request's that don't need a id, for example /balance
+     * @param elementClass  Class type of List to return
+     * @return new list of elementClass
+     * @throws UnauthorizedException if client is unauthorized
+     * @throws GeneralException general exception
+     * @throws NotFoundException
+     */
+    <E> List<E> requestByIdAsList(String request, String id, Class<E> elementClass) throws UnauthorizedException, GeneralException, NotFoundException;
+
     /**
      * Delete a object by ID.
      *

api/src/main/java/com/messagebird/MessageBirdServiceImpl.java

@@ -1,6 +1,7 @@
 package com.messagebird;
 
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.MapperFeature;
@@ -27,6 +28,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
@@ -138,6 +140,17 @@ public <R> R requestByID(String request, String id, Map<String, Object> params,
         return getJsonData(request + path + queryParams, null, "GET", clazz);
     }
 
+    @Override
+    public <E> List<E> requestByIdAsList(String request, String id, Class<E> elementClass)
+        throws UnauthorizedException, GeneralException, NotFoundException {
+        String path = "";
+        if (id != null) {
+            path = "/" + id;
+        }
+
+        return getJsonDataAsList(request + path, null, "GET", elementClass);
+    }
+
     @Override
     public void deleteByID(String request, String id) throws UnauthorizedException, GeneralException, NotFoundException {
         getJsonData(request + "/" + id, null, "DELETE", null);
@@ -234,6 +247,10 @@ public <T, P> T getJsonData(final String request, final P payload, final String
         return getJsonData(request, payload, requestType, new HashMap<>(), clazz);
     }
 
+    public <P, E> List<E> getJsonDataAsList(final String request, final P payload, final String requestType, final Class<E> elementClass) throws UnauthorizedException, GeneralException, NotFoundException {
+        return getJsonDataAsList(request, payload, requestType, new HashMap<>(), elementClass);
+    }
+
     public <T, P> T getJsonData(final String request, final P payload, final String requestType, final Map<String, String> headers, final Class<T> clazz) throws UnauthorizedException, GeneralException, NotFoundException {
         if (request == null) {
             throw new IllegalArgumentException(REQUEST_VALUE_MUST_BE_SPECIFIED);
@@ -260,7 +277,7 @@ public <T, P> T getJsonData(final String request, final P payload, final String
                 // Prevents mismatched exception when clazz is null
                 return clazz == null
                     ? null
-                    : mapper.readValue(body, clazz);
+                    : this.readValue(mapper, body, clazz);
             } catch (IOException ioe) {
                 throw new GeneralException(ioe);
             }
@@ -271,6 +288,54 @@ public <T, P> T getJsonData(final String request, final P payload, final String
         return null;
     }
 
+    // todo: need to refactor for duplicated code.
+    public <P, E> List<E> getJsonDataAsList(final String request,
+        final P payload, final String requestType, final Map<String, String> headers, final Class<E> elementClass)
+        throws UnauthorizedException, GeneralException, NotFoundException {
+        if (request == null) {
+            throw new IllegalArgumentException(REQUEST_VALUE_MUST_BE_SPECIFIED);
+        }
+
+        String url = request;
+        if (!isURLAbsolute(url)) {
+            url = serviceUrl + url;
+        }
+        final APIResponse apiResponse = doRequest(requestType, url, headers, payload);
+
+        final String body = apiResponse.getBody();
+        final int status = apiResponse.getStatus();
+
+        if (status == HttpURLConnection.HTTP_OK || status == HttpURLConnection.HTTP_CREATED || status == HttpURLConnection.HTTP_ACCEPTED) {
+            try {
+                final ObjectMapper mapper = new ObjectMapper();
+                // If we as new properties, we don't want the system to fail, we rather want to ignore them
+                mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
+                // Enable case insensitivity to avoid parsing errors if parameters' case in api response doesn't match sdk's
+                mapper.enable(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES);
+                mapper.enable(MapperFeature.ACCEPT_CASE_INSENSITIVE_ENUMS);
+
+                // Prevents mismatched exception when clazz is null
+                return this.readValueAsList(mapper, body, elementClass);
+            } catch (IOException ioe) {
+                throw new GeneralException(ioe);
+            }
+        } else if (status == HttpURLConnection.HTTP_NO_CONTENT) {
+            return Collections.emptyList(); // no content doesn't mean an error
+        }
+        handleHttpFailStatuses(status, body);
+        return Collections.emptyList();
+    }
+
+    private <T> T readValue(ObjectMapper mapper, String content, Class<T> clazz)
+        throws JsonProcessingException {
+        return mapper.readValue(content, clazz);
+    }
+
+    private <E> List<E> readValueAsList(ObjectMapper mapper, String content, final Class<E> elementClass)
+        throws JsonProcessingException {
+        return mapper.readValue(content, mapper.getTypeFactory().constructCollectionType(List.class, elementClass));
+    }
+
     private void handleHttpFailStatuses(final int status, String body) throws UnauthorizedException, NotFoundException, GeneralException {
         if (status == HttpURLConnection.HTTP_UNAUTHORIZED) {
             final List<ErrorReport> errorReport = getErrorReportOrNull(body);

api/src/main/java/com/messagebird/objects/integrations/HSMComponent.java

@@ -1,6 +1,5 @@
 package com.messagebird.objects.integrations;
 
-import com.messagebird.exceptions.GeneralException;
 import java.util.List;
 
 /**
@@ -71,19 +70,19 @@ public String toString() {
   /**
    * Check if this component is valid.
    *
-   * @throws GeneralException Occurs when validation is not passed.
+   * @throws IllegalArgumentException Occurs when validation is not passed.
    */
-  public void validateComponent() throws GeneralException {
+  public void validateComponent() throws IllegalArgumentException {
     this.validateButtons();
     this.validateComponentExample();
   }
 
   /**
    * Check if button list is valid.
    *
-   * @throws GeneralException Occurs when validation is not passed.
+   * @throws IllegalArgumentException Occurs when validation is not passed.
    */
-  private void validateButtons() throws GeneralException {
+  private void validateButtons() throws IllegalArgumentException {
     if (this.buttons == null) {
       return;
     }
@@ -96,9 +95,9 @@ private void validateButtons() throws GeneralException {
   /**
    * Check for header_text and header_url.
    *
-   * @throws GeneralException Occurs when {@code header_text} or {@code header_url} is not able to use.
+   * @throws IllegalArgumentException Occurs when {@code header_text} or {@code header_url} is not able to use.
    */
-  private void validateComponentExample() throws GeneralException {
+  private void validateComponentExample() throws IllegalArgumentException {
     final boolean isExampleNotNull = this.example != null;
     final boolean isHeaderTextNotEmpty =
         isExampleNotNull && !(this.example.getHeader_text() == null || this.example.getHeader_text()
@@ -119,26 +118,26 @@ private void validateComponentExample() throws GeneralException {
   /**
    * Check if header_text is able to use.
    *
-   * @throws GeneralException Occurs when type is not {@code HEADER} and format is not {@code TEXT}.
+   * @throws IllegalArgumentException Occurs when type is not {@code HEADER} and format is not {@code TEXT}.
    */
-  private void checkHeaderText() throws GeneralException {
+  private void checkHeaderText() throws IllegalArgumentException {
     if (!(type.equals(HSMComponentType.HEADER)
         && format.equals(HSMComponentFormat.TEXT))
     ) {
-      throw new GeneralException("\"header_text\" is available for only HEADER type and TEXT format.");
+      throw new IllegalArgumentException("\"header_text\" is available for only HEADER type and TEXT format.");
     }
   }
 
   /**
    * Check if header_url is able to use.
    *
-   * @throws GeneralException Occurs when type is not {@code HEADER} and format is not {@code IMAGE}.
+   * @throws IllegalArgumentException Occurs when type is not {@code HEADER} and format is not {@code IMAGE}.
    */
-  private void checkHeaderUrl() throws GeneralException {
+  private void checkHeaderUrl() throws IllegalArgumentException {
     if (!(type.equals(HSMComponentType.HEADER)
         && format.equals(HSMComponentFormat.IMAGE))
     ) {
-      throw new GeneralException("\"header_url\" is available for only HEADER type and IMAGE format.");
+      throw new IllegalArgumentException("\"header_url\" is available for only HEADER type and IMAGE format.");
     }
   }
 }

api/src/main/java/com/messagebird/objects/integrations/HSMComponentButton.java

@@ -1,6 +1,5 @@
 package com.messagebird.objects.integrations;
 
-import com.messagebird.exceptions.GeneralException;
 import java.util.List;
 
 /**
@@ -71,9 +70,9 @@ public String toString() {
   /**
    * Check if example field is able to use.
    *
-   * @throws GeneralException Occurs if button type is not {@code URL} or {@code QUICK_REPLY}.
+   * @throws IllegalArgumentException Occurs if button type is not {@code URL} or {@code QUICK_REPLY}.
    */
-  public void validateButtonExample() throws GeneralException {
+  public void validateButtonExample() throws IllegalArgumentException {
     final boolean isExampleEmpty = this.example == null || this.example.isEmpty();
     final boolean isNotProperType = !(this.type.equals(HSMComponentButtonType.URL)
         || this.type.equals(HSMComponentButtonType.QUICK_REPLY));
@@ -83,7 +82,7 @@ public void validateButtonExample() throws GeneralException {
     }
 
     if (isNotProperType) {
-      throw new GeneralException("An example field in HSMComponentButton is available for only URL or QUICK_REPLY button types.");
+      throw new IllegalArgumentException("An example field in HSMComponentButton is available for only URL or QUICK_REPLY button types.");
     }
   }
 }