Remove GistComment dependence on BaseComment

sigmavirus24 · sigmavirus24 · commit 0751ee8fd70c · 2018-02-24T09:25:21.000-06:00
Update our example response for unit tests to make this more testable
and an accurate representation of what github3.py gets back.
diff --git a/github3/gists/comment.py b/github3/gists/comment.py
@@ -1,42 +1,102 @@
 # -*- coding: utf-8 -*-
-"""
-github3.gists.comment
----------------------
-
-Module containing the logic for a GistComment
-
-"""
+"""Module containing the logic for a GistComment."""
 from __future__ import unicode_literals
 
+from .. import decorators
+from .. import models
 from .. import users
-from ..models import BaseComment
 
 
-class GistComment(BaseComment):
+class GistComment(models.GitHubCore):
+    """Representation of a comment left on a :class:`~github3.gists.Gist`.
+
+    See also: http://developer.github.com/v3/gists/comments/
 
-    """This object represents a comment on a gist.
+    .. versionchanged:: 1.0.0
 
-    Two comment instances can be checked like so::
+        The ``links``, ``html_url``, and ``pull_request_url`` attributes were
+        removed as none of them exist in the response from GitHub.
 
-        c1 == c2
-        c1 != c2
+    This object has the following attributes:
 
-    And is equivalent to::
+    .. attribute:: author_association
 
-        c1.id == c2.id
-        c1.id != c2.id
+        The comment author's (:attr:`user`) association with this gist.
 
-    See also: http://developer.github.com/v3/gists/comments/
+    .. attribute:: body
+
+        The markdown formatted original text written by the author.
+
+    .. attribute:: body_html
+
+        The HTML formatted comment body.
+
+    .. attribute:: body_text
+
+        The plain-text formatted comment body.
+
+    .. attribute:: created_at
 
+        A :class:`~datetime.datetime` object representing the date and time
+        when this comment was created.
+
+    .. attribute:: id
+
+        The unique identifier for this comment.
+
+    .. attribute:: updated_at
+
+        A :class:`~datetime.datetime` object representing the date and time
+        when this comment was most recently updated.
+
+    .. attribute:: user
+
+        A :class:`~github3.users.ShortUser` representing the author of this
+        comment.
     """
 
     def _update_attributes(self, comment):
-        self._api = self._get_attribute(comment, 'url')
-        #: :class:`User <github3.users.User>` who made the comment
-        #: Unless it is not associated with an account
+        self._api = comment['url']
+        self.author_association = comment['author_association']
+        self.body = comment['body']
+        self.body_html = comment['body_html']
+        self.body_text = comment['body_text']
+        self.created_at = comment['created_at']
+        self.id = comment['id']
+        self.updated_at = comment['updated_at']
         self.user = self._class_attribute(
             comment, 'user', users.ShortUser, self,
         )
 
     def _repr(self):
         return '<Gist Comment [{0}]>'.format(self.user.login)
+
+    @decorators.requires_auth
+    def delete(self):
+        """Delete this comment from the gist.
+
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
+        """
+        return self._boolean(self._delete(self._api), 204, 404)
+
+    @decorators.requires_auth
+    def edit(self, body):
+        """Edit this comment.
+
+        :param str body:
+            (required), new body of the comment, Markdown-formatted
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
+        """
+        if body:
+            json = self._json(self._patch(self._api,
+                                          json={'body': body}), 200)
+            if json:
+                self._update_attributes(json)
+                return True
+        return False
diff --git a/tests/unit/json/gist_comment_example b/tests/unit/json/gist_comment_example
@@ -1,5 +1,8 @@
 {
+    "author_association": "OWNER",
     "body": "I was using curl, but this is awesome, too :)\r\n\r\n`curl -u <username> -XDELETE https://api.github.com/gists/<gist_id>/comments/<comment_id>`",
+    "body_html": "I was using curl, but this is awesome, too",
+    "body_text": "I was using curl, but this is awesome, too",
     "created_at": "2012-12-17T19:56:05Z",
     "id": 655725,
     "updated_at": "2012-12-17T19:56:05Z",

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`{`
	`2`	`+ "author_association": "OWNER",`
`2`	`3`	"body": "I was using curl, but this is awesome, too :)\r\n\r\n`curl -u <username> -XDELETE https://api.github.com/gists/<gist_id>/comments/<comment_id>`",
	`4`	`+ "body_html": "I was using curl, but this is awesome, too",`
	`5`	`+ "body_text": "I was using curl, but this is awesome, too",`
`3`	`6`	`"created_at": "2012-12-17T19:56:05Z",`
`4`	`7`	`"id": 655725,`
`5`	`8`	`"updated_at": "2012-12-17T19:56:05Z",`