sigmavirus24 · sigmavirus24 · Mar 12, 2018 · Dec 28, 2017 · Jan 11, 2018 · Jan 11, 2018
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,4 @@ build/
 .ipynb_checkpoints
 .cache/
 tests/id_rsa
+*.DS_Store
diff --git a/LATEST_VERSION_NOTES.rst b/LATEST_VERSION_NOTES.rst
@@ -3,11 +3,38 @@
 Unreleased
 ~~~~~~~~~~
 
+Breaking Changes (since 1.0.0a4)
+````````````````````````````````
+
+- Remove ``Thread.comment``, ``Thread.thread``, ``Thread.urls`` attributes.
+
+- Remove ``Thread#is_unread`` method. Use the ``Thread.unread`` attribute
+  instead.
+
+- ``Subscription`` has been split into two objects: ``ThreadSubscription`` and
+  ``RepositorySubscription`` with the same methods.
+
+- Remove ``is_ignored`` method from our Subscription objects. Use the
+  ``ignored`` attribute instead.
+
+- Remove ``is_subscribed`` method from our Subscription objects. Use the
+  ``subscribed`` attribute instead.
+
+Features Added (since 1.0.0a4)
+``````````````````````````````
+
 - Add ``Organization#all_events``.
-- Deprecate ``Organization#events`` in favor of ``Organization#public_events``.
-- Fix test failtures on windows caused by unclosed file handles.
+
 - Add ``Tag.tagger_as_User`` which attempts to return the tagger as as User.
+
 - Add ``Repo.statuses`` and a corresponding ``repo.status.CombinedStatus`` to
+
+Deprecations and Other Changes (since 1.0.0a4)
+``````````````````````````````````````````````
+
+- Deprecate ``Organization#events`` in favor of ``Organization#public_events``.
+
+- Fix test failtures on windows caused by unclosed file handles.
   get a combined view of commit statuses for a given ref.
 
 1.0.0a4: 2016-02-19

diff --git a/docs/git.rst b/docs/git.rst
@@ -9,7 +9,6 @@ section of the GitHub API.
 
 - :class:`Blob <Blob>`
 - :class:`Commit <Commit>`
-- :class:`GitData <GitData>`
 - :class:`GitObject <GitObject>`
 - :class:`Hash <Hash>`
 - :class:`Reference <Reference>`
@@ -27,12 +26,12 @@ Git Objects
 
 ------
 
-.. autoclass:: Commit
+.. autoclass:: ShortCommit
     :inherited-members:
 
 ------
 
-.. autoclass:: GitData
+.. autoclass:: Commit
     :inherited-members:
 
 ------
@@ -59,3 +58,8 @@ Git Objects
 
 .. autoclass:: Tree
     :inherited-members:
+
+------
+
+.. autoclass:: CommitTree
+    :inherited-members:
diff --git a/docs/models.rst b/docs/models.rst
@@ -13,18 +13,3 @@ Objects
 
 .. autoclass:: GitHubCore
     :inherited-members:
-
-------
-
-.. autoclass:: BaseAccount
-    :inherited-members:
-
-------
-
-.. autoclass:: BaseComment
-    :inherited-members:
-
-------
-
-.. autoclass:: BaseCommit
-    :inherited-members:
diff --git a/docs/notifications.rst b/docs/notifications.rst
@@ -4,8 +4,10 @@
 Notifications
 =============
 
-This part of the documentation covers the :class:`Thread <Thread>` and
-:class:`Subscription <Subscription>` objects.
+This part of the documentation covers the
+:class:`~github3.notifications.Thread`,
+:class:`~github3.notifications.RepositorySubscription`, and
+:class:`~github3.notifications.ThreadSubscription` objects.
 
 Notification Objects
 --------------------
@@ -15,5 +17,10 @@ Notification Objects
 
 ------
 
-.. autoclass:: Subscription
+.. autoclass:: RepositorySubscription
+    :inherited-members:
+
+------
+
+.. autoclass:: ThreadSubscription
     :inherited-members:
diff --git a/github3/auths.py b/github3/auths.py
@@ -1,64 +1,104 @@
 # -*- coding: utf-8 -*-
-"""
-github3.auths
-=============
-
-This module contains the Authorization object.
-
-"""
+"""This module contains the Authorization object."""
 from __future__ import unicode_literals
 
 from .decorators import requires_basic_auth
 from .models import GitHubCore
 
 
 class Authorization(GitHubCore):
+    """Representation of an OAuth Authorization.
 
-    """The :class:`Authorization <Authorization>` object.
+    See also: https://developer.github.com/v3/oauth_authorizations/
 
-    Two authorization instances can be checked like so::
+    This object has the following attributes:
 
-        a1 == a2
-        a1 != a2
+    .. attribute:: app
 
-    And is equivalent to::
+        Details about the application the authorization was created for.
 
-        a1.id == a2.id
-        a1.id != a2.id
+    .. attribute:: created_at
 
-    See also: http://developer.github.com/v3/oauth/#oauth-authorizations-api
+        A :class:`~datetime.datetime` representing when this authorization was
+        created.
 
-    """
+    .. attribute:: fingerprint
 
-    def _update_attributes(self, auth):
-        self._api = self._get_attribute(auth, 'url')
+        .. versionadded:: 1.0
+
+        The optional parameter that is used to allow an OAuth application to
+        create multiple authorizations for the same user. This will help
+        distinguish two authorizations for the same app.
+
+    .. attribute:: hashed_token
+
+        .. versionadded:: 1.0
+
+        This is the base64 of the SHA-256 digest of the token.
+
+        .. seealso::
+
+            `Removing Authorization Tokens`_
+                The blog post announcing the removal of :attr:`token`.
+
+    .. attribute:: id
+
+        The unique identifier for this authorization.
 
-        #: Details about the application (name, url)
-        self.app = self._get_attribute(auth, 'app', {})
+    .. attribute:: note_url
 
-        #: Returns the Authorization token
-        self.token = self._get_attribute(auth, 'token')
+        The URL that points to a longer description about the purpose of this
+        autohrization.
 
-        #: App name
-        self.name = self._get_attribute(self.app, 'name')
+    .. attribute:: note
 
-        #: URL about the note
-        self.note_url = self._get_attribute(auth, 'note_url')
+        The short note provided when this authorization was created.
 
-        #: Note about the authorization
-        self.note = self._get_attribute(auth, 'note')
+    .. attribute:: scopes
 
-        #: List of scopes this applies to
-        self.scopes = self._get_attribute(auth, 'scopes')
+        The list of scopes assigned to this token.
 
-        #: Unique id of the authorization
-        self.id = self._get_attribute(auth, 'id')
+        .. seealso::
 
-        #: datetime object representing when the authorization was created.
-        self.created_at = self._strptime_attribute(auth, 'created_at')
+            `Scopes for OAuth Applications`_
+                GitHub's documentation around available scopes and what they
+                mean
 
-        #: datetime object representing when the authorization was updated.
-        self.updated_at = self._strptime_attribute(auth, 'updated_at')
+    .. attribute:: token
+
+        If this authorization was created, this will contain the full token.
+        Otherwise, this attribute will be an empty string.
+
+    .. attribute:: token_last_eight
+
+        .. versionadded:: 1.0
+
+        The last eight characters of the token. This allows users to identify
+        a token after the initial retrieval.
+
+    .. attribute:: updated_at
+
+        A :class:`~datetime.datetime` representing when this authorization was
+        most recently updated.
+
+    .. _Scopes for OAuth Applications:
+        https://developer.github.com/apps/building-oauth-apps/scopes-for-oauth-apps/
+    .. _Removing Authorization Tokens:
+        https://developer.github.com/changes/2014-12-08-removing-authorizations-token/#what-should-you-do
+    """
+
+    def _update_attributes(self, auth):
+        self._api = auth['url']
+        self.app = auth['app']
+        self.created_at = self._strptime(auth['created_at'])
+        self.fingerprint = auth['fingerprint']
+        self.id = auth['id']
+        self.note_url = auth['note_url']
+        self.note = auth['note']
+        self.scopes = auth['scopes']
+        self.token = auth['token']
+        self.token_last_eight = auth['token_last_eight']
+        self.updated_at = self._strptime(auth['updated_at'])
 
     def _repr(self):
         return '<Authorization [{0}]>'.format(self.name)
@@ -79,23 +119,32 @@ def _update(self, scopes_data, note, note_url):
 
     @requires_basic_auth
     def add_scopes(self, scopes, note=None, note_url=None):
-        """Adds the scopes to this authorization.
+        """Add the scopes to this authorization.
 
         .. versionadded:: 1.0
 
-        :param list scopes: Adds these scopes to the ones present on this
-            authorization
-        :param str note: (optional), Note about the authorization
-        :param str note_url: (optional), URL to link to when the user views
-            the authorization
-        :returns: True if successful, False otherwise
-        :rtype: bool
+        :param list scopes:
+            Adds these scopes to the ones present on this authorization
+        :param str note:
+            (optional), Note about the authorization
+        :param str note_url:
+            (optional), URL to link to when the user views the authorization
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
         """
         return self._update({'add_scopes': scopes}, note, note_url)
 
     @requires_basic_auth
     def delete(self):
-        """Delete this authorization."""
+        """Delete this authorization.
+
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
+        """
         return self._boolean(self._delete(self._api), 204, 404)
 
     @requires_basic_auth
@@ -104,13 +153,16 @@ def remove_scopes(self, scopes, note=None, note_url=None):
 
         .. versionadded:: 1.0
 
-        :param list scopes: Remove these scopes from the ones present on this
-            authorization
-        :param str note: (optional), Note about the authorization
-        :param str note_url: (optional), URL to link to when the user views
-            the authorization
-        :returns: True if successful, False otherwise
-        :rtype: bool
+        :param list scopes:
+            Remove these scopes from the ones present on this authorization
+        :param str note:
+            (optional), Note about the authorization
+        :param str note_url:
+            (optional), URL to link to when the user views the authorization
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
         """
         return self._update({'rm_scopes': scopes}, note, note_url)
 
@@ -120,11 +172,15 @@ def replace_scopes(self, scopes, note=None, note_url=None):
 
         .. versionadded:: 1.0
 
-        :param list scopes: Use these scopes instead of the previous list
-        :param str note: (optional), Note about the authorization
-        :param str note_url: (optional), URL to link to when the user views
-            the authorization
-        :returns: True if successful, False otherwise
-        :rtype: bool
+        :param list scopes:
+            Use these scopes instead of the previous list
+        :param str note:
+            (optional), Note about the authorization
+        :param str note_url:
+            (optional), URL to link to when the user views the authorization
+        :returns:
+            True if successful, False otherwise
+        :rtype:
+            bool
         """
         return self._update({'scopes': scopes}, note, note_url)
diff --git a/github3/decorators.py b/github3/decorators.py
@@ -1,11 +1,5 @@
 # -*- coding: utf-8 -*-
-"""
-github3.decorators
-==================
-
-This module provides decorators to the rest of the library
-
-"""
+"""This module provides decorators to the rest of the library."""
 
 from functools import wraps
 from requests.models import Response
@@ -20,7 +14,10 @@
 
 
 class RequestsStringIO(StringIO):
+    """Shim compatibility for string IO."""
+
     def read(s
7495
elf, n=-1, *args, **kwargs):
+        """Ignore extra args and kwargs."""
         # StringIO is an old-style class, so can't use super
         return StringIO.read(self, n)
 
@@ -86,6 +83,7 @@ def auth_wrapper(self, *args, **kwargs):
 
 
 def generate_fake_error_response(msg, status_code=401, encoding='utf-8'):
+    """Generate a fake Response from requests."""
     r = Response()
     r.status_code = status_code
     r.encoding = encoding