Merge branch 'master' into dynamic_content

Author: aheritier

.dependabot/config.yml

@@ -0,0 +1,5 @@
+version: 1
+update_configs:
+  - package_manager: "java:maven"
+    directory: "/"
+    update_schedule: "weekly"

pom.xml

@@ -20,7 +20,7 @@
   <parent>
     <groupId>com.cloudbees</groupId>
     <artifactId>cloudbees-oss-parent</artifactId>
-    <version>8</version>
+    <version>9</version>
   </parent>
 
   <groupId>com.cloudbees.thirdparty</groupId>
@@ -98,7 +98,7 @@
       <dependency>
         <groupId>com.fasterxml.jackson</groupId>
         <artifactId>jackson-bom</artifactId>
-        <version>2.9.3</version>
+        <version>2.10.1</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -109,12 +109,12 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
-      <version>1.7.25</version>
+      <version>1.7.29</version>
     </dependency>
     <dependency>
       <groupId>org.asynchttpclient</groupId>
       <artifactId>async-http-client</artifactId>
-      <version>2.3.0</version>
+      <version>2.10.4</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
@@ -127,7 +127,7 @@
     <dependency>
       <groupId>com.damnhandy</groupId>
       <artifactId>handy-uri-templates</artifactId>
-      <version>2.1.6</version>
+      <version>2.1.8</version>
     </dependency>
     <dependency>
       <groupId>junit</groupId>
@@ -144,7 +144,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
-      <version>1.7.25</version>
+      <version>1.7.29</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -154,7 +154,14 @@
       <plugins>
         <plugin>
           <artifactId>maven-enforcer-plugin</artifactId>
-          <version>3.0.0-M1</version>
+          <version>3.0.0-M2</version>
+        </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-surefire-plugin</artifactId>
+          <configuration>
+            <rerunFailingTestsCount>3</rerunFailingTestsCount>
+          </configuration>
         </plugin>
       </plugins>
     </pluginManagement>
@@ -201,12 +208,12 @@
           <dependency>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>animal-sniffer-enforcer-rule</artifactId>
-            <version>1.14</version>
+            <version>1.18</version>
           </dependency>
           <dependency>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>extra-enforcer-rules</artifactId>
-            <version>1.0-beta-6</version>
+            <version>1.2</version>
           </dependency>
         </dependencies>
       </plugin>

src/main/java/org/zendesk/client/v2/SortOrder.java

@@ -0,0 +1,15 @@
+package org.zendesk.client.v2;
+
+public enum SortOrder {
+    ASCENDING("asc"), DESCENDING("desc");
+
+    private String queryParameter;
+
+    SortOrder(String queryParameter) {
+        this.queryParameter = queryParameter;
+    }
+
+    public String getQueryParameter() {
+        return queryParameter;
+    }
+}

src/main/java/org/zendesk/client/v2/Zendesk.java

@@ -1050,8 +1050,15 @@ public Iterable<Comment> getRequestComments(long id) {
     }
 
     public Iterable<Comment> getTicketComments(long id) {
-        return new PagedIterable<>(tmpl("/tickets/{id}/comments.json").set("id", id),
-                handleList(Comment.class, "comments"));
+        return getTicketComments(id, SortOrder.ASCENDING);
+    }
+
+    public Iterable<Comment> getTicketComments(long id, SortOrder order) {
+        return new PagedIterable<>(
+              tmpl("/tickets/{id}/comments.json?sort_order={order}")
+                .set("id", id)
+                .set("order", order.getQueryParameter()),
+              handleList(Comment.class, "comments"));
     }
 
     public Comment getRequestComment(org.zendesk.client.v2.model.Request request, Comment comment) {

src/test/java/org/zendesk/client/v2/RealSmokeTest.java

@@ -4,6 +4,8 @@
 import org.junit.BeforeClass;
 import org.junit.Ignore;
 import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.zendesk.client.v2.model.AgentRole;
 import org.zendesk.client.v2.model.Audit;
 import org.zendesk.client.v2.model.Brand;
@@ -43,13 +45,16 @@
 import java.util.List;
 import java.util.Properties;
 import java.util.UUID;
+import java.util.stream.StreamSupport;
 
 import static org.hamcrest.CoreMatchers.anyOf;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.not;
 import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.hamcrest.CoreMatchers.nullValue;
+import static org.hamcrest.Matchers.greaterThan;
 import static org.hamcrest.Matchers.lessThanOrEqualTo;
+import static org.hamcrest.core.StringContains.containsString;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNotNull;
@@ -63,6 +68,8 @@
  */
 public class RealSmokeTest {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(RealSmokeTest.class);
+
     // TODO: Find a better way to manage our test environment (this is the PUBLIC_FORM_ID of the cloudbees org)
     private static final long CLOUDBEES_ORGANIZATION_ID = 360507899132L;
     private static final long PUBLIC_FORM_ID = 360000434032L;
@@ -579,10 +586,25 @@ public void showUserComplianceDeletionStatusExpectValidCompletionStatus() throws
 
         instance.permanentlyDeleteUser(user);
 
-        final Iterable<ComplianceDeletionStatus> complianceDeletionStatuses = instance.getComplianceDeletionStatuses(user.getId());
+        // https://developer.zendesk.com/rest_api/docs/support/users#show-compliance-deletion-statuses
+        // The deletion is going through different states ( request_deletion -> started -> complete )
+        // for different applications and they are described in compliance_deletion_statuses
+
+        final Iterable<ComplianceDeletionStatus> complianceDeletionStatuses =
+                instance.getComplianceDeletionStatuses(user.getId());
+
+        // Let's validate
+
+        assertThat("There is at least one entry",
+                StreamSupport.stream(complianceDeletionStatuses.spliterator(), false).count(), greaterThan(0L));
+
+        assertTrue("There is at least an entry for the application \"all\"",
+                StreamSupport.stream(complianceDeletionStatuses.spliterator(), false)
+                        .anyMatch(complianceDeletionStatus -> "all".equals(complianceDeletionStatus.getApplication())));
+
         complianceDeletionStatuses.forEach(status -> {
-            assertThat(status.getAction(), is("request_deletion"));
-            assertThat(status.getApplication(), is("all"));
+            LOGGER.info("Compliance Deletion Status : {}", status);
+            // All entries are about this user
             assertThat(status.getUserId(), is(user.getId()));
         });
     }
@@ -861,7 +883,8 @@ public void getArticleTranslations() throws Exception {
             for (Translation t : instance.getArticleTranslations(art.getId())) {
                 assertNotNull(t.getId());
                 assertNotNull(t.getTitle());
-                assertNotNull(t.getBody());
+                // body is not mandatory <https://developer.zendesk.com/rest_api/docs/help_center/translations.html>
+                //assertNotNull(t.getBody());
                 if (++translationCount > 3) {
                     return;
                 }
@@ -1119,4 +1142,54 @@ public void getDynamicContentItems() throws Exception {
             }
         }
     }
+
+    @Test
+    public void getTicketCommentsShouldBeAscending() throws Exception {
+        createClientWithTokenOrPassword();
+
+        Ticket t = new Ticket(
+              new Ticket.Requester(config.getProperty("requester.name"), config.getProperty("requester.email")),
+              "This is an automated test ticket", new Comment("1"));
+        Ticket ticket = null;
+        try {
+            ticket = instance.createTicket(t);
+            instance.createComment(ticket.getId(), new Comment("2"));
+            Iterable<Comment> ticketCommentsIt = instance.getTicketComments(ticket.getId());
+            List<Comment> comments = new ArrayList<>();
+            ticketCommentsIt.forEach(comments::add);
+
+            assertThat(comments.size(), is(2));
+            assertThat(comments.get(0).getBody(), containsString("1"));
+            assertThat(comments.get(1).getBody(), containsString("2"));
+        } finally {
+            if (ticket != null) {
+                instance.deleteTicket(ticket.getId());
+            }
+        }
+    }
+
+    @Test
+    public void getTicketCommentsDescending() throws Exception {
+        createClientWithTokenOrPassword();
+
+        Ticket t = new Ticket(
+              new Ticket.Requester(config.getProperty("requester.name"), config.getProperty("requester.email")),
+              "This is an automated test ticket", new Comment("1"));
+        Ticket ticket = null;
+        try {
+            ticket = instance.createTicket(t);
+            instance.createComment(ticket.getId(), new Comment("2"));
+            Iterable<Comment> ticketCommentsIt = instance.getTicketComments(ticket.getId(), SortOrder.DESCENDING);
+            List<Comment> comments = new ArrayList<>();
+            ticketCommentsIt.forEach(comments::add);
+
+            assertThat(comments.size(), is(2));
+            assertThat(comments.get(0).getBody(), containsString("2"));
+            assertThat(comments.get(1).getBody(), containsString("1"));
+        } finally {
+            if (ticket != null) {
+                instance.deleteTicket(ticket.getId());
+            }
+        }
+    }
 }