Adding support for extraction of a Ticket's comments via Ticket.comments().

markfinger · markfinger · commit 34c08bb2dc91 · 2014-06-08T15:08:27.000+10:00
Fixes markfinger#23
diff --git a/README.md b/README.md
@@ -72,6 +72,7 @@ methods and properties:
     - [milestone()](#ticketmilestone)
     - [user()](#ticketuser)
     - [component()](#ticketcomponent)
+    - [comments()](#ticketcomments)
     - [write()](#ticketwrite)
     - [delete()](#ticketdelete)
 - [User](#user)
@@ -209,6 +210,9 @@ Returns an instance of the [User](#user) that the Ticket is assigned to.
 ###Ticket.component()
 An instance of the [Component](#component) that the Ticket is assigned to.
 
+###Ticket.comments()
+Returns a list of the [Ticket Comment](#ticket-comment) instances relating to the Ticket.
+
 ###Ticket.write()
 Calling Ticket.write() sends the ticket back to Assembla. The ticket object must have a `space` attribute
 set to the corresponding [Space](#space) object.
@@ -224,6 +228,12 @@ Calling Ticket.delete() deletes the ticket from Assembla. The ticket object must
 set to the corresponding [Space](#space) object.
 
 
+Ticket Comment
+--------------------------------------------------
+
+See the [Ticket Comment object field reference](http://api-doc.assembla.com/content/ref/ticket_comments_fields.html#fields)
+for field names and explanations.
+
 
 User
 --------------------------------------------------
diff --git a/assembla/api.py b/assembla/api.py
@@ -452,6 +452,31 @@ def component(self, extra_params=None):
             if components:
                 return components[0]
 
+    @assembla_filter
+    def comments(self, extra_params=None):
+        """
+        All Comments in this Ticket
+        """
+
+        # Default params
+        params = {
+            'per_page': settings.MAX_PER_PAGE,
+        }
+
+        if extra_params:
+            params.update(extra_params)
+
+        return self.api._get_json(
+            TicketComment,
+            space=self,
+            rel_path=self.space._build_rel_path(
+                'tickets/%s/ticket_comments' % self['number']
+            ),
+            extra_params=params,
+            get_all=True,  # Retrieve all comments in the ticket
+        )
+
+
     def write(self):
         """
         Create or update the Ticket on Assembla
@@ -484,6 +509,10 @@ def delete(self):
         )
 
 
+class TicketComment(AssemblaObject):
+    pass
+
+
 class User(AssemblaObject):
     @assembla_filter
     def tickets(self, extra_params=None):
diff --git a/assembla/lib.py b/assembla/lib.py
@@ -24,13 +24,19 @@ def get(self, *args, **kwargs):
         return self.data.get(*args, **kwargs)
 
     def __repr__(self):
+        # Most objects
         for field in ('menu_name', 'page_name', 'name',):
             if field in self.data:
                 return '<%s: %s>' % (type(self).__name__, self.data[field])
 
+        # Tickets
         if ('number' in self.data) and ('summary' in self.data):
             return "<%s: #%s - %s>" % (type(self).__name__, self.data['number'], self.data['summary'])
 
+        # Ticket Comments
+        if 'id' in self.data:
+            return "<%s: #%s>" % (type(self).__name__, self.data['id'])
+
         return super(AssemblaObject, self).__repr__()
 
 
