Merge pull request sigmavirus24#620 from sigmavirus24/bug/619

itsmemattchung · web-flow · commit e8ff4f4d32df · 2016-06-18T14:25:53.000-07:00
Create the StarredRepository object
diff --git a/docs/repos.rst b/docs/repos.rst
@@ -6,6 +6,7 @@ Repository
 This part of the documentation covers:
 
 - :class:`Repository <github3.repos.repo.Repository>`
+- :class:`StarredRepository <github3.repos.repo.StarredRepository>`
 - :class:`Asset <github3.repos.release.Asset>`
 - :class:`Branch <github3.repos.branch.Branch>`
 - :class:`Contents <github3.repos.contents.Contents>`
@@ -45,6 +46,11 @@ Repository Objects
 
 ---------
 
+.. autoclass:: github3.repos.repo.StarredRepository
+    :inherited-members:
+
+---------
+
 .. module:: github3.repos.branch
 
 .. autoclass:: github3.repos.branch.Branch
diff --git a/github3/repos/__init__.py b/github3/repos/__init__.py
@@ -8,5 +8,6 @@
 """
 
 from .repo import Repository
+from .repo import StarredRepository
 
-__all__ = [Repository]
+__all__ = ('Repository', 'StarredRepository')
diff --git a/github3/repos/repo.py b/github3/repos/repo.py
@@ -1984,6 +1984,27 @@ def weekly_commit_count(self):
         return json
 
 
+class StarredRepository(GitHubCore):
+
+    """The :class:`~github3.repos.repo.StarredRepository` object.
+
+    It represents how GitHub sends back a repository a user has starred, e.g.,
+    from :meth:`~github3.users.User.starred_repositories`.
+
+    See also:
+    https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
+
+    """
+
+    def _update_attributes(self, starred_repository):
+        self.starred_at = self._strptime(starred_repository.get('starred_at'))
+        self.repository = Repository(starred_repository.get('repo'), self)
+        self.repo = self.repository
+
+    def _repr(self):
+        return '<StarredRepository [{0!r}]>'.format(self.repository)
+
+
 def repo_issue_params(milestone=None,
                       state=None,
                       assignee=None,
diff --git a/github3/users.py b/github3/users.py
@@ -360,14 +360,14 @@ def starred_repositories(self, sort=None, direction=None, number=-1,
             'desc'
         :param str etag: (optional), ETag from a previous request to the same
             endpoint
-        :returns: generator of :class:`Repository <github3.repos.Repository>`
+        :returns: generator of :class:`~github3.repos.repo.StarredRepository`
         """
-        from .repos import Repository
+        from .repos import Repository, StarredRepository
 
         params = {'sort': sort, 'direction': direction}
         self._remove_none(params)
         url = self.starred_urlt.expand(owner=None, repo=None)
-        return self._iter(int(number), url, Repository, params, etag,
+        return self._iter(int(number), url, StarredRepository, params, etag,
                           headers=Repository.STAR_HEADERS)
 
     def subscriptions(self, number=-1, etag=None):
diff --git a/tests/integration/test_users.py b/tests/integration/test_users.py
@@ -140,7 +140,7 @@ def test_starred_repositories(self):
 
         assert len(repos) > 0
         for starred in repos:
-            assert isinstance(starred, github3.repos.Repository)
+            assert isinstance(starred, github3.repos.StarredRepository)
             assert isinstance(starred.starred_at, datetime.datetime)
 
     def test_subscriptions(self):
