[fixes #98][breaking change] Jobs results aren't including objects like tickets, users, orgs, ...

Add several new integration test cases to validate the behavior.

Author: aheritier

pom.xml

@@ -166,6 +166,12 @@
       <version>1.8</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.awaitility</groupId>
+      <artifactId>awaitility</artifactId>
+      <version>4.0.3</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>

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

@@ -203,25 +203,27 @@ public void close() {
     // Action methods
     //////////////////////////////////////////////////////////////////////
 
-    public <T> JobStatus<T> getJobStatus(JobStatus<T> status) {
+    public JobStatus getJobStatus(JobStatus status) {
         return complete(getJobStatusAsync(status));
     }
 
-    public <T> ListenableFuture<JobStatus<T>> getJobStatusAsync(JobStatus<T> status) {
-        return submit(req("GET", tmpl("/job_statuses/{id}.json").set("id", status.getId())), handleJobStatus(status.getResultsClass()));
+    public ListenableFuture<JobStatus> getJobStatusAsync(JobStatus status) {
+        return submit(req("GET", tmpl("/job_statuses/{id}.json").set("id", status.getId())),
+                handleJobStatus());
     }
 
-    public List<JobStatus<HashMap<String, Object>>> getJobStatuses(List<JobStatus> statuses) {
+    public List<JobStatus> getJobStatuses(List<JobStatus> statuses) {
         return complete(getJobStatusesAsync(statuses));
     }
 
-    public ListenableFuture<List<JobStatus<HashMap<String, Object>>>> getJobStatusesAsync(List<JobStatus> statuses) {
+    public ListenableFuture<List<JobStatus>> getJobStatusesAsync(List<JobStatus> statuses) {
         List<String> ids = new ArrayList<>(statuses.size());
         for (JobStatus status : statuses) {
             ids.add(status.getId());
         }
-        Class<JobStatus<HashMap<String, Object>>> clazz = (Class<JobStatus<HashMap<String, Object>>>)(Object)JobStatus.class;
-        return submit(req("GET", tmpl("/job_statuses/show_many.json{?ids}").set("ids", ids)), handleList(clazz, "job_statuses"));
+        Class<JobStatus> clazz = (Class<JobStatus>) (Object) JobStatus.class;
+        return submit(req("GET", tmpl("/job_statuses/show_many.json{?ids}").set("ids", ids)),
+                handleList(clazz, "job_statuses"));
     }
 
     public List<Brand> getBrands(){
@@ -250,17 +252,17 @@ JSON, json(Collections.singletonMap("ticket", ticketImport))),
                 handle(Ticket.class, "ticket")));
     }
 
-    public JobStatus<Ticket> importTickets(TicketImport... ticketImports) {
+    public JobStatus importTickets(TicketImport... ticketImports) {
         return importTickets(Arrays.asList(ticketImports));
     }
 
-    public JobStatus<Ticket> importTickets(List<TicketImport> ticketImports) {
+    public JobStatus importTickets(List<TicketImport> ticketImports) {
         return complete(importTicketsAsync(ticketImports));
     }
 
-    public ListenableFuture<JobStatus<Ticket>> importTicketsAsync(List<TicketImport> ticketImports) {
+    public ListenableFuture<JobStatus> importTicketsAsync(List<TicketImport> ticketImports) {
         return submit(req("POST", cnst("/imports/tickets/create_many.json"), JSON, json(
-                Collections.singletonMap("tickets", ticketImports))), handleJobStatus(Ticket.class));
+                Collections.singletonMap("tickets", ticketImports))), handleJobStatus());
     }
 
     public Ticket getTicket(long id) {
@@ -278,11 +280,6 @@ public List<User> getTicketCollaborators(long id) {
                 handleList(User.class, "users")));
     }
 
-    public JobStatus permanentlyDeleteTicket(Ticket ticket) {
-        checkHasId(ticket);
-        return permanentlyDeleteTicket(ticket.getId());
-    }
-
     /**
      * https://developer.zendesk.com/rest_api/docs/support/tickets#list-deleted-tickets
      */
@@ -309,17 +306,22 @@ public void deleteTicket(long id) {
         complete(submit(req("DELETE", tmpl("/tickets/{id}.json").set("id", id)), handleStatus()));
     }
 
+    public JobStatus permanentlyDeleteTicket(Ticket ticket) {
+        checkHasId(ticket);
+        return permanentlyDeleteTicket(ticket.getId());
+    }
+
     public JobStatus permanentlyDeleteTicket(long id) {
         return complete(submit(
                 req("DELETE", tmpl("/deleted_tickets/{id}.json").set("id", id)),
-                handleJobStatus(JobStatus.class))
+                handleJobStatus())
         );
     }
 
-    public ListenableFuture<JobStatus<Ticket>> queueCreateTicketAsync(Ticket ticket) {
+    public ListenableFuture<JobStatus> queueCreateTicketAsync(Ticket ticket) {
         return submit(req("POST", cnst("/tickets.json?async=true"),
                 JSON, json(Collections.singletonMap("ticket", ticket))),
-                handleJobStatus(Ticket.class));
+                handleJobStatus());
     }
 
     public ListenableFuture<Ticket> createTicketAsync(Ticket ticket) {
@@ -332,17 +334,17 @@ public Ticket createTicket(Ticket ticket) {
         return complete(createTicketAsync(ticket));
     }
 
-    public JobStatus<Ticket> createTickets(Ticket... tickets) {
+    public JobStatus createTickets(Ticket... tickets) {
         return createTickets(Arrays.asList(tickets));
     }
 
-    public JobStatus<Ticket> createTickets(List<Ticket> tickets) {
+    public JobStatus createTickets(List<Ticket> tickets) {
         return complete(createTicketsAsync(tickets));
     }
 
-    public ListenableFuture<JobStatus<Ticket>> createTicketsAsync(List<Ticket> tickets) {
+    public ListenableFuture<JobStatus> createTicketsAsync(List<Ticket> tickets) {
         return submit(req("POST", cnst("/tickets/create_many.json"), JSON, json(
-                Collections.singletonMap("tickets", tickets))), handleJobStatus(Ticket.class));
+                Collections.singletonMap("tickets", tickets))), handleJobStatus());
     }
 
     public Ticket updateTicket(Ticket ticket) {
@@ -352,17 +354,17 @@ JSON, json(Collections.singletonMap("ticket", ticket))),
                 handle(Ticket.class, "ticket")));
     }
 
-    public JobStatus<Ticket> updateTickets(Ticket... tickets) {
+    public JobStatus updateTickets(Ticket... tickets) {
         return updateTickets(Arrays.asList(tickets));
     }
 
-    public JobStatus<Ticket> updateTickets(List<Ticket> tickets) {
+    public JobStatus updateTickets(List<Ticket> tickets) {
         return complete(updateTicketsAsync(tickets));
     }
 
-    public ListenableFuture<JobStatus<Ticket>> updateTicketsAsync(List<Ticket> tickets) {
+    public ListenableFuture<JobStatus> updateTicketsAsync(List<Ticket> tickets) {
         return submit(req("PUT", cnst("/tickets/update_many.json"), JSON, json(
-                Collections.singletonMap("tickets", tickets))), handleJobStatus(Ticket.class));
+                Collections.singletonMap("tickets", tickets))), handleJobStatus());
     }
 
     public void markTicketAsSpam(Ticket ticket) {
@@ -380,11 +382,10 @@ public void deleteTickets(long id, long... ids) {
     }
 
     public JobStatus permanentlyDeleteTickets(long id, long... ids) {
-
         return complete(
                 submit(
                         req("DELETE", tmpl("/deleted_tickets/destroy_many.json{?ids}").set("ids", idArray(id, ids))),
-                        handleJobStatus(JobStatus.class))
+                        handleJobStatus())
         );
     }
 
@@ -817,35 +818,35 @@ public User createUser(User user) {
                 Collections.singletonMap("user", user))), handle(User.class, "user")));
     }
 
-    public JobStatus<User> createUsers(User... users) {
+    public JobStatus createUsers(User... users) {
         return createUsers(Arrays.asList(users));
     }
 
-    public JobStatus<User> createUsers(List<User> users) {
+    public JobStatus createUsers(List<User> users) {
         return complete(createUsersAsync(users));
     }
 
-    public ListenableFuture<JobStatus<User>> createUsersAsync(List<User> users) {
+    public ListenableFuture<JobStatus> createUsersAsync(List<User> users) {
         return submit(req("POST", cnst("/users/create_many.json"), JSON, json(
-                Collections.singletonMap("users", users))), handleJobStatus(User.class));
+                Collections.singletonMap("users", users))), handleJobStatus());
     }
 
     public User createOrUpdateUser(User user) {
         return complete(submit(req("POST", cnst("/users/create_or_update.json"), JSON, json(
                 Collections.singletonMap("user", user))), handle(User.class, "user")));
     }
 
-    public JobStatus<User> createOrUpdateUsers(User... users) {
+    public JobStatus createOrUpdateUsers(User... users) {
         return createOrUpdateUsers(Arrays.asList(users));
     }
 
-    public JobStatus<User> createOrUpdateUsers(List<User> users) {
+    public JobStatus createOrUpdateUsers(List<User> users) {
         return complete(createOrUpdateUsersAsync(users));
     }
 
-    public ListenableFuture<JobStatus<User>> createOrUpdateUsersAsync(List<User> users) {
+    public ListenableFuture<JobStatus> createOrUpdateUsersAsync(List<User> users) {
         return submit(req("POST", cnst("/users/create_or_update_many.json"), JSON, json(
-            Collections.singletonMap("users", users))), handleJobStatus(User.class));
+                Collections.singletonMap("users", users))), handleJobStatus());
     }
 
     public User updateUser(User user) {
@@ -854,17 +855,17 @@ public User updateUser(User user) {
                 Collections.singletonMap("user", user))), handle(User.class, "user")));
     }
 
-    public JobStatus<User> updateUsers(User... users) {
+    public JobStatus updateUsers(User... users) {
         return updateUsers(Arrays.asList(users));
     }
 
-    public JobStatus<User> updateUsers(List<User> users) {
+    public JobStatus updateUsers(List<User> users) {
         return complete(updateUsersAsync(users));
     }
 
-    public ListenableFuture<JobStatus<User>> updateUsersAsync(List<User> users) {
+    public ListenableFuture<JobStatus> updateUsersAsync(List<User> users) {
         return submit(req("PUT", cnst("/users/update_many.json"), JSON, json(
-                Collections.singletonMap("users", users))), handleJobStatus(User.class));
+                Collections.singletonMap("users", users))), handleJobStatus());
     }
 
     public void deleteUser(User user) {
@@ -1195,17 +1196,17 @@ public Organization createOrganization(Organization organization) {
                 Collections.singletonMap("organization", organization))), handle(Organization.class, "organization")));
     }
 
-    public JobStatus<Organization> createOrganizations(Organization... organizations) {
+    public JobStatus createOrganizations(Organization... organizations) {
         return createOrganizations(Arrays.asList(organizations));
     }
 
     public JobStatus createOrganizations(List<Organization> organizations) {
         return complete(createOrganizationsAsync(organizations));
     }
 
-    public ListenableFuture<JobStatus<Organization>> createOrganizationsAsync(List<Organization> organizations) {
+    public ListenableFuture<JobStatus> createOrganizationsAsync(List<Organization> organizations) {
         return submit(req("POST", cnst("/organizations/create_many.json"), JSON, json(
-                Collections.singletonMap("organizations", organizations))), handleJobStatus(Organization.class));
+                Collections.singletonMap("organizations", organizations))), handleJobStatus());
     }
 
     public Organization updateOrganization(Organization organization) {
@@ -1214,17 +1215,17 @@ public Organization updateOrganization(Organization organization) {
                 Collections.singletonMap("organization", organization))), handle(Organization.class, "organization")));
     }
 
-    public JobStatus<Organization> updateOrganizations(Organization... organizations) {
+    public JobStatus updateOrganizations(Organization... organizations) {
         return updateOrganizations(Arrays.asList(organizations));
     }
 
     public JobStatus updateOrganizations(List<Organization> organizations) {
         return complete(updateOrganizationsAsync(organizations));
     }
 
-    public ListenableFuture<JobStatus<Organization>> updateOrganizationsAsync(List<Organization> organizations) {
+    public ListenableFuture<JobStatus> updateOrganizationsAsync(List<Organization> organizations) {
         return submit(req("PUT", cnst("/organizations/update_many.json"), JSON, json(
-                Collections.singletonMap("organizations", organizations))), handleJobStatus(Organization.class));
+                Collections.singletonMap("organizations", organizations))), handleJobStatus());
     }
 
     public void deleteOrganization(Organization organization) {
@@ -1283,7 +1284,7 @@ public OrganizationMembership createOrganizationMembership(OrganizationMembershi
     /**
      * https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships
      */
-    public JobStatus<OrganizationMembership> createOrganizationMemberships(OrganizationMembership... organizationMemberships) {
+    public JobStatus createOrganizationMemberships(OrganizationMembership... organizationMemberships) {
         return createOrganizationMemberships(Arrays.asList(organizationMemberships));
     }
 
@@ -1297,9 +1298,10 @@ public JobStatus createOrganizationMemberships(List<OrganizationMembership> orga
     /**
      * https://developer.zendesk.com/rest_api/docs/support/organization_memberships#create-many-memberships
      */
-    public ListenableFuture<JobStatus<OrganizationMembership>> createOrganizationMembershipsAsync(List<OrganizationMembership> organizationMemberships) {
+    public ListenableFuture<JobStatus> createOrganizationMembershipsAsync(
+            List<OrganizationMembership> organizationMemberships) {
         return submit(req("POST", cnst("/organization_memberships/create_many.json"), JSON, json(
-                Collections.singletonMap("organization_memberships", organizationMemberships))), handleJobStatus(OrganizationMembership.class));
+                Collections.singletonMap("organization_memberships", organizationMemberships))), handleJobStatus());
     }
 
     public void deleteOrganizationMembership(long id) {
@@ -2413,17 +2415,16 @@ protected <T> ZendeskAsyncCompletionHandler<T> handle(final Class<T> clazz, fina
         return new BasicAsyncCompletionHandler<>(clazz, name, typeParams);
     }
 
-    protected <T> ZendeskAsyncCompletionHandler<JobStatus<T>> handleJobStatus(final Class<T> resultClass) {
-        return new BasicAsyncCompletionHandler<JobStatus<T>>(JobStatus.class, "job_status", resultClass) {
+    protected ZendeskAsyncCompletionHandler<JobStatus> handleJobStatus() {
+        return new BasicAsyncCompletionHandler<JobStatus>(JobStatus.class, "job_status") {
             @Override
-            public JobStatus<T> onCompleted(Response response) throws Exception {
-                JobStatus<T> result = super.onCompleted(response);
+            public JobStatus onCompleted(Response response) throws Exception {
+                JobStatus result = super.onCompleted(response);
                 if (result == null) {
                     // null is when we receive a 404 response.
                     // For an async job we trigger an error
                     throw new ZendeskResponseException(response);
                 }
-                result.setResultsClass(resultClass);
                 return result;
             }
         };