Add GitHubSession#retrieve_client_credentials

sigmavirus24 · sigmavirus24 · commit 81b903f5b13e · 2014-02-22T14:46:57.000-06:00
- Convenience method for revoking authorizations
diff --git a/github3/session.py b/github3/session.py
@@ -87,6 +87,15 @@ def request(self, *args, **kwargs):
             response = new_response
         return response
 
+    def retrieve_client_credentials(self):
+        """Return the client credentials.
+
+        :returns: tuple(client_id, client_secret)
+        """
+        client_id = self.params.get('client_id')
+        client_secret = self.params.get('client_secret')
+        return (client_id, client_secret)
+
     def two_factor_auth_callback(self, callback):
         if not callback:
             return
diff --git a/tests/unit/test_github_session.py b/tests/unit/test_github_session.py
@@ -200,3 +200,21 @@ def test_temporary_basic_auth_replaces_auth(self):
         s.basic_auth('foo', 'bar')
         with s.temporary_basic_auth('temp', 'pass'):
             assert s.auth == ('temp', 'pass')
+
+    def test_retrieve_client_credentials_when_set(self):
+        """Test that retrieve_client_credentials will return the credentials.
+
+        We must assert that when set, this function will return them.
+        """
+        s = self.build_session()
+        s.params = {'client_id': 'id', 'client_secret': 'secret'}
+        assert s.retrieve_client_credentials() == ('id', 'secret')
+
+    def test_retrieve_client_credentials_returns_none(self):
+        """Test that retrieve_client_credentials will return (None, None).
+
+        Namely, then the necessary parameters are set, it will not raise an
+        error.
+        """
+        s = self.build_session()
+        assert s.retrieve_client_credentials() == (None, None)
