Merge pull request cloudbees-oss#61 from tandrup/improve-collaborators

Improve collaborators handling

Author: stephenc

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

@@ -214,6 +214,11 @@ public List<Ticket> getTicketIncidents(long id) {
                 handleList(Ticket.class, "tickets")));
     }
 
+    public List<User> getTicketCollaborators(long id) {
+        return complete(submit(req("GET", tmpl("/tickets/{id}/collaborators.json").set("id", id)),
+                handleList(User.class, "users")));
+    }
+
     public void deleteTicket(Ticket ticket) {
         checkHasId(ticket);
         deleteTicket(ticket.getId());

src/main/java/org/zendesk/client/v2/model/Collaborator.java

@@ -0,0 +1,38 @@
+package org.zendesk.client.v2.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class Collaborator {
+    private String name;
+    private String email;
+
+    public Collaborator() {
+    }
+
+    protected Collaborator(String name) {
+        this.name = name;
+        this.email = email;
+    }
+
+    public Collaborator(String name, String email) {
+        this.name = name;
+        this.email = email;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
+}

src/main/java/org/zendesk/client/v2/model/Ticket.java

@@ -20,6 +20,7 @@ public class Ticket extends Request implements SearchResultEntity {
     private Long assigneeId;
     private Long groupId;
     private List<Long> collaboratorIds;
+    private List<Collaborator> collaborators;
     private Long forumTopicId;
     private Long problemId;
     private boolean hasIncidents;
@@ -65,6 +66,15 @@ public void setCollaboratorIds(List<Long> collaboratorIds) {
         this.collaboratorIds = collaboratorIds;
     }
 
+    @JsonProperty("collaborators")
+    private List<Collaborator> getCollaborators() {
+        return collaborators;
+    }
+
+    public void setCollaborators(List<Collaborator> collaborators) {
+        this.collaborators = collaborators;
+    }
+
     @JsonProperty("custom_fields")
     public List<CustomFieldValue> getCustomFields() {
         return customFields;

src/main/java/org/zendesk/client/v2/model/User.java

@@ -12,10 +12,9 @@
  * @author stephenc
  * @since 05/04/2013 15:32
  */
-public class User implements SearchResultEntity {
+public class User extends Collaborator implements SearchResultEntity {
     private Long id;
     private String url;
-    private String name;
     private String externalId;
     private String alias;
     private Date createdAt;
@@ -26,7 +25,6 @@ public class User implements SearchResultEntity {
     private Long localeId;
     private String timeZone;
     private Date lastLoginAt;
-    private String email;
     private String phone;
     private String signature;
     private String details;
@@ -48,35 +46,33 @@ public User() {
     }
 
     public User(Boolean verified, String name, String email) {
-        this.name = name;
-        this.email = email;
+        super(name, email);
         this.verified = verified;
     }
 
     public User(Boolean verified, String name, List<Identity> identities) {
+        super(name);
         this.verified = verified;
-        this.name = name;
         this.identities = identities;
     }
 
     public User(Boolean verified, String name, Identity... identities) {
+        super(name);
         this.verified = verified;
-        this.name = name;
         this.identities = new ArrayList<Identity>(Arrays.asList(identities));
     }
 
     public User(String name, String email) {
-        this.name = name;
-        this.email = email;
+        super(name, email);
     }
 
     public User(String name, List<Identity> identities) {
-        this.name = name;
+        super(name);
         this.identities = identities;
     }
 
     public User(String name, Identity... identities) {
-        this.name = name;
+        super(name);
         this.identities = new ArrayList<Identity>(Arrays.asList(identities));
     }
 
@@ -130,14 +126,6 @@ public void setDetails(String details) {
         this.details = details;
     }
 
-    public String getEmail() {
-        return email;
-    }
-
-    public void setEmail(String email) {
-        this.email = email;
-    }
-
     @JsonProperty("external_id")
     public String getExternalId() {
         return externalId;
@@ -181,14 +169,6 @@ public void setModerator(Boolean moderator) {
         this.moderator = moderator;
     }
 
-    public String getName() {
-        return name;
-    }
-
-    public void setName(String name) {
-        this.name = name;
-    }
-
     public String getNotes() {
         return notes;
     }

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

@@ -5,6 +5,7 @@
 import org.junit.Ignore;
 import org.junit.Test;
 import org.zendesk.client.v2.model.Audit;
+import org.zendesk.client.v2.model.Collaborator;
 import org.zendesk.client.v2.model.Comment;
 import org.zendesk.client.v2.model.Field;
 import org.zendesk.client.v2.model.Group;
@@ -27,6 +28,7 @@
 import java.util.Properties;
 import java.util.UUID;
 
+import static org.hamcrest.CoreMatchers.anyOf;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.not;
 import static org.hamcrest.CoreMatchers.notNullValue;
@@ -242,20 +244,26 @@ public void createDeleteTicket() throws Exception {
         Ticket t = new Ticket(
                 new Ticket.Requester(config.getProperty("requester.name"), config.getProperty("requester.email")),
                 "This is a test", new Comment("Please ignore this ticket"));
+        t.setCollaborators(Arrays.asList(new Collaborator("Bob Example", "[email protected]"), new Collaborator("Alice Example", "[email protected]")));
         Ticket ticket = instance.createTicket(t);
         System.out.println(ticket.getId() + " -> " + ticket.getUrl());
         assertThat(ticket.getId(), notNullValue());
         try {
             Ticket t2 = instance.getTicket(ticket.getId());
             assertThat(t2, notNullValue());
             assertThat(t2.getId(), is(ticket.getId()));
+
+            List<User> ticketCollaborators = instance.getTicketCollaborators(ticket.getId());
+            assertThat("Collaborators", ticketCollaborators.size(), is(2));
+            assertThat("First Collaborator", ticketCollaborators.get(0).getEmail(), anyOf(is("[email protected]"), is("[email protected]")));
         } finally {
             instance.deleteTicket(ticket.getId());
         }
         assertThat(ticket.getSubject(), is(t.getSubject()));
         assertThat(ticket.getRequester(), nullValue());
         assertThat(ticket.getRequesterId(), notNullValue());
         assertThat(ticket.getDescription(), is(t.getComment().getBody()));
+        assertThat("Collaborators", ticket.getCollaboratorIds().size(), is(2));
         assertThat(instance.getTicket(ticket.getId()), nullValue());
     }