Merge pull request #787 from PierreBtz/pbeitz/search-with-export

Add support for the export API to search tickets

Author: PierreBtz

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

@@ -558,6 +558,18 @@ public Iterable<Ticket> getTicketsFromSearch(String searchTerm) {
         handleList(Ticket.class, "results"));
   }
 
+  public Iterable<Ticket> getTicketFromSearchWithExport(String searchTerm) {
+    return getTicketFromSearchWithExport(searchTerm, cbpPageSize);
+  }
+
+  public Iterable<Ticket> getTicketFromSearchWithExport(String searchTerm, int pageSize) {
+    return new PagedIterable<>(
+        tmpl(cbp("/search/export", true, pageSize).toString()
+                + "&filter[type]=ticket&query={query}")
+            .set("query", searchTerm + " type:ticket"),
+        handleList(Ticket.class, "results"));
+  }
+
   public Iterable<Article> getArticleFromSearch(String searchTerm) {
     return new PagedIterable<>(
         tmpl("/help_center/articles/search.json{?query}").set("query", searchTerm),
@@ -3862,11 +3874,16 @@ private TemplateUri tmpl(String template) {
   }
 
   private TemplateUri cbp(String path) {
+    return cbp(path, false, cbpPageSize);
+  }
+
+  private TemplateUri cbp(String path, boolean noDomain, int pageSize) {
     Objects.requireNonNull(path, "Path cannot be null");
     if (path.indexOf('?') != -1) {
       throw new IllegalArgumentException("Path cannot contain a query string");
     }
-    return new TemplateUri(url + path + "?page[size]={pageSize}").set("pageSize", cbpPageSize);
+    return new TemplateUri((noDomain ? "" : url) + path + "?page[size]={pageSize}")
+        .set("pageSize", pageSize);
   }
 
   private Uri cnst(String template) {

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

@@ -2798,6 +2798,36 @@ public void getTicketsFromSearch() throws Exception {
     }
   }
 
+  @Test
+  public void getTicketFromSearchWithExport() throws Exception {
+    createClientWithTokenOrPassword();
+
+    Ticket t = newTestTicket();
+    t.setRequester(new Ticket.Requester("a name", "email+alias@acme.org"));
+    Ticket ticket = null;
+    try {
+      ticket = instance.createTicket(t);
+      // according to the doc, it takes about 1 minute for the ticket to be indexed
+      // running several time, it seems that the actual value is around 30-40s
+      Awaitility.with()
+          .pollDelay(20, SECONDS)
+          .and()
+          .pollInterval(10, SECONDS)
+          .await()
+          .timeout(90, SECONDS)
+          .until(
+              () -> {
+                Iterable<Ticket> tickets =
+                    instance.getTicketFromSearchWithExport("requester:email+alias@acme.org");
+                return StreamSupport.stream(tickets.spliterator(), false).findAny().isPresent();
+              });
+    } finally {
+      if (ticket != null) {
+        instance.deleteTicket(ticket.getId());
+      }
+    }
+  }
+
   @Test
   public void getUnresolvedViewReturnsANewlyCreatedTicket() throws Exception {
     createClientWithTokenOrPassword();