Remove GitHubStatus (#982)

* Update GitHubStatus for new GitHub status api

On 2018-12-11, GitHub updated its public-facing statuspage: https://github.blog/2018-12-11-introducing-the-new-github-status-site/

The new statuspage has a different API, backed by Statuspage.io: https://www.githubstatus.com/api/

This PR updates the GitHubStatus class to use the new API, and wraps all
functions appropriately. It is technically a breaking change, because
the new API is significantly different than the old.

I've updated tests where appropriate; and introduced a few new
line-length errors from the linter. However, when fixing those, the
linter began complaining about different docstring errors and so I
decided that lengthy docstrings might be acceptable in this case. 😄

* Add myself to AUTHORS.rst

* Actually, remove GitHubStatus

After conversation on the PR to fix this object ... it does seem that no
one really uses it. After all, it's been utterly non-functional for at
least a year, and no one has opened an issue.

This commit rips it out.

Co-authored-by: Ian Stapleton Cordasco <graffatcolmingov@gmail.com>

Author: 2 people

AUTHORS.rst

@@ -195,4 +195,6 @@ Contributors
 
 - Bharat Raghunathan (@Bharat123rox)
 
-- Kevin P. Fleming (@kpfleming)
+- Kevin P. Fleming (@kpfleming)
+
+- Andrew Hayworth (@ahayworth)

docs/source/api-reference/github.rst

@@ -29,13 +29,6 @@ object so for brevity's sake, I'm not listing all of it's inherited members.
     :members:
 
 
-GitHubStatus Object
-===================
-
-.. autoclass:: github3.github.GitHubStatus
-    :members:
-
-
 GitHubSession Object
 ====================
 

src/github3/__init__.py

@@ -56,14 +56,13 @@
     user,
     zen,
 )
-from .github import GitHub, GitHubEnterprise, GitHubStatus
+from .github import GitHub, GitHubEnterprise
 from .exceptions import GitHubError
 
 __all__ = (
     "GitHub",
     "GitHubEnterprise",
     "GitHubError",
-    "GitHubStatus",
     "authorize",
     "login",
     "enterprise_login",

src/github3/github.py

@@ -2919,39 +2919,3 @@ def admin_stats(self, option):
             url = self._build_url("enterprise", "stats", option.lower())
             stats = self._json(self._get(url), 200)
         return stats
-
-
-class GitHubStatus(models.GitHubCore):
-    """A sleek interface to the GitHub System Status API.
-
-    This will only ever return the JSON objects returned by the API.
-    """
-
-    def __init__(self, session=None):
-        """Create a status API client."""
-        super(GitHubStatus, self).__init__({}, session or self.new_session())
-        self.session.base_url = "https://status.github.com"
-
-    def _repr(self):
-        return "<GitHub Status>"
-
-    def _recipe(self, *args):
-        url = self._build_url(*args)
-        resp = self._get(url)
-        return resp.json() if self._boolean(resp, 200, 404) else {}
-
-    def api(self):
-        """Retrieve API status."""
-        return self._recipe("api.json")
-
-    def status(self):
-        """Retrieve overall status."""
-        return self._recipe("api", "status.json")
-
-    def last_message(self):
-        """Retrieve the last message."""
-        return self._recipe("api", "last-message.json")
-
-    def messages(self):
-        """Retrieve all messages."""
-        return self._recipe("api", "messages.json")

tests/cassettes/GitHubStatus_api.json

@@ -123,8 +123,3 @@ def match(self, request, recorded_request):
 class GitHubEnterpriseHelper(IntegrationHelper):
     def get_client(self):
         return github3.GitHubEnterprise(self.enterprise_url)
-
-
-class GitHubStatusHelper(IntegrationHelper):
-    def get_client(self):
-        return github3.GitHubStatus()

tests/cassettes/GitHubStatus_last_message.json

@@ -9,7 +9,6 @@
 from .helper import (
     GitHubEnterpriseHelper,
     IntegrationHelper,
-    GitHubStatusHelper,
 )
 
 GPG_KEY = (
@@ -773,40 +772,3 @@ def test_admin_stats(self):
             stats = self.gh.admin_stats("all")
 
         assert isinstance(stats, dict)
-
-
-class TestGitHubStatus(GitHubStatusHelper):
-    def setUp(self):
-        super(TestGitHubStatus, self).setUp()
-
-    def test_api(self):
-        """Test the ability to check the status of /api."""
-        cassette_name = self.cassette_name("api")
-        with self.recorder.use_cassette(cassette_name):
-            api = self.gh.api()
-
-        assert isinstance(api, dict)
-
-    def test_last_message(self):
-        """Test the ability to check the status of /api/last-message."""
-        cassette_name = self.cassette_name("last_message")
-        with self.recorder.use_cassette(cassette_name):
-            last_message = self.gh.last_message()
-
-        assert isinstance(last_message, dict)
-
-    def test_messages(self):
-        """Test the ability to check the status of /api/messages."""
-        cassette_name = self.cassette_name("messages")
-        with self.recorder.use_cassette(cassette_name):
-            messages = self.gh.messages()
-
-        assert isinstance(messages, list)
-
-    def test_status(self):
-        """Test the ability to check the status of /api/status."""
-        cassette_name = self.cassette_name("status")
-        with self.recorder.use_cassette(cassette_name):
-            status = self.gh.status()
-
-        assert isinstance(status, dict)

tests/cassettes/GitHubStatus_messages.json

@@ -1,7 +1,7 @@
 import pytest
 
 from github3 import GitHubEnterprise, GitHubError
-from github3.github import GitHub, GitHubStatus
+from github3.github import GitHub
 from github3.projects import Project
 
 from . import helper
@@ -1542,34 +1542,3 @@ def test_str(self):
         assert str(self.instance) == "<GitHub Enterprise [{0}]>".format(
             enterprise_url_for()
         )
-
-
-class TestGitHubStatus(helper.UnitHelper):
-
-    """Test methods on GitHubStatus."""
-
-    described_class = GitHubStatus
-
-    def test_api(self):
-        """Verify the request for /api."""
-        with helper.mock.patch.object(GitHubStatus, "_recipe") as _recipe:
-            self.instance.api()
-            _recipe.assert_called_once_with("api.json")
-
-    def test_last_message(self):
-        """Verify the request for /api/last-message."""
-        with helper.mock.patch.object(GitHubStatus, "_recipe") as _recipe:
-            self.instance.last_message()
-            _recipe.assert_called_once_with("api", "last-message.json")
-
-    def test_messages(self):
-        """Verify the request for /api/messages."""
-        with helper.mock.patch.object(GitHubStatus, "_recipe") as _recipe:
-            self.instance.messages()
-            _recipe.assert_called_once_with("api", "messages.json")
-
-    def test_status(self):
-        """Verify the request for /api/status."""
-        with helper.mock.patch.object(GitHubStatus, "_recipe") as _recipe:
-            self.instance.status()
-            _recipe.assert_called_once_with("api", "status.json")