Merge branch 'pr/459' into develop

Author: sigmavirus24

AUTHORS.rst

@@ -106,3 +106,5 @@ Contributors
 - Sourav Singh(@souravsingh)
 
 - Matt Chung (@itsmemattchung)
+
+- Martin Ek (@ekmartin)

docs/testing.rst

@@ -257,7 +257,7 @@ environment variables when running `py.test`, e.g.,
 .. code::
 
     GH_AUTH="abc123" py.test
-    GH_USER="sigmavirus24" GH_PASS="super-secure-password-plz-kthxbai" py.test
+    GH_USER="sigmavirus24" GH_PASSWORD="super-secure-password-plz-kthxbai" py.test
 
 If you are concerned that your credentials will be saved, you need not worry.
 Betamax sanitizes information like that before saving the cassette. It never

github3/github.py

@@ -363,25 +363,53 @@ def feeds(self):
 
         :returns: dictionary parsed to include URITemplates
         """
-        url = self._build_url('feeds')
-        json = self._json(self._get(url), 200)
-        del json['ETag']
-        del json['Last-Modified']
-
-        urls = [
-            'timeline_url', 'user_url', 'current_user_public_url',
-            'current_user_url', 'current_user_actor_url',
-            'current_user_organization_url',
-            ]
-
-        for url in urls:
-            json[url] = URITemplate(json[url])
+        def replace_href(feed_dict):
+            if not feed_dict:
+                return feed_dict
+            ret_dict = {}
+            # Let's pluck out what we're most interested in, the href value
+            href = feed_dict.pop('href', None)
+            # Then we update the return dictionary with the rest of the values
+            ret_dict.update(feed_dict)
+            if href is not None:
+                # So long as there is something to template, let's template it
+                ret_dict['href'] = URITemplate(href)
+            return ret_dict
 
-        links = json.get('_links', {})
-        for d in links.values():
-            d['href'] = URITemplate(d['href'])
-
-        return json
+        url = self._build_url('feeds')
+        json = self._json(self._get(url), 200, include_cache_info=False)
+        if json is None:  # If something went wrong, get out early
+            return None
+
+        # We have a response body to parse
+        feeds = {}
+
+        # Let's pop out the old links so we don't have to skip them below
+        old_links = json.pop('_links', {})
+        _links = {}
+        # If _links is in the response JSON, iterate over that and recreate it
+        # so that any templates contained inside can be turned into
+        # URITemplates
+        for key, value in old_links.items():
+            if isinstance(value, list):
+                # If it's an array/list of links, let's replace that with a
+                # new list of links
+                _links[key] = [replace_href(d) for d in value]
+            else:
+                # Otherwise, just use the new value
+                _links[key] = replace_href(value)
+
+        # Start building up our return dictionary
+        feeds['_links'] = _links
+
+        for key, value in json.items():
+            # This should roughly be the same logic as above.
+            if isinstance(value, list):
+                feeds[key] = [URITemplate(v) for v in value]
+            else:
+                feeds[key] = URITemplate(value)
+
+        return feeds
 
     @requires_auth
     def follow(self, username):

github3/models.py

@@ -152,15 +152,16 @@ def _instance_or_null(self, instance_class, json):
         except TypeError:  # instance_class is not a subclass of GitHubCore
             return instance_class(json)
 
-    def _json(self, response, status_code):
+    def _json(self, response, status_code, include_cache_info=True):
         ret = None
         if self._boolean(response, status_code, 404) and response.content:
             __logs__.info('Attempting to get JSON information from a Response '
                           'with status code %d expecting %d',
                           response.status_code, status_code)
             ret = response.json()
             headers = response.headers
-            if ((headers.get('Last-Modified') or headers.get('ETag')) and
+            if (include_cache_info and
+                    (headers.get('Last-Modified') or headers.get('ETag')) and
                     isinstance(ret, dict)):
                 ret['Last-Modified'] = response.headers.get(
                     'Last-Modified', ''

tests/cassettes/GitHub_feeds.json

@@ -1 +1 @@
-{"http_interactions": [{"request": {"body": "", "headers": {"Accept-Encoding": "gzip, deflate, compress", "Accept": "application/vnd.github.v3.full+json", "User-Agent": "github3.py/0.8.0", "Accept-Charset": "utf-8", "Content-Type": "application/json", "Authorization": "Basic <BASIC_AUTH>"}, "method": "GET", "uri": "https://api.github.com/feeds"}, "response": {"body": {"base64_string": "H4sIAAAAAAAAA7WS3W6EIBCF34XbNmJ/zFqTTR/FIDsoWRUCw6at4d2rNt0Yo2zZpHcQzpw5zHwDQdlBK3sonWlJQRpEbQtKa4mNqxKuOvqrII/EWTD7wmF69qOMO2Ogx3KWa1e1ku9XWVl37CKNs8+v69rdTMuiRBt5YQjvqM7QH08VHPI8fTrkbxlLU8iAifQlEyeRVYJzse7BOKrAp7Y6JXNNwlB1dzZVpma9/GIoVb8/mqXK0mG8erqdJypJOe77bEkxXJc/nRsD4iYA+KlhFDGtx53O6ek0hYePriX+h4+w15WRG04bCIWNVxhF2P/dN560iBjlDFV8mLtgjMm1pDAc7594DYb1/hvCfOv/xAQAAA==", "encoding": "utf-8"}, "headers": {"status": "200 OK", "x-ratelimit-remaining": "4995", "x-github-media-type": "github.v3; param=full; format=json", "x-content-type-options": "nosniff", "access-control-expose-headers": "ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes", "transfer-encoding": "chunked", "x-github-request-id": "451DE2C3:1D7B:505B77D:52883781", "content-encoding": "gzip", "vary": "Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding", "server": "GitHub.com", "cache-control": "private, max-age=60, s-maxage=60", "x-ratelimit-limit": "5000", "etag": "\"3bbafa6adae7e4ed162e5a704331adc8\"", "access-control-allow-credentials": "true", "date": "Sun, 17 Nov 2013 03:26:57 GMT", "access-control-allow-origin": "*", "content-type": "application/json; charset=utf-8", "x-ratelimit-reset": "1384660420"}, "url": "https://api.github.com/feeds", "status_code": 200}, "recorded_at": "2013-11-17T03:26:48"}], "recorded_with": "betamax"}
+{"recorded_with": "betamax/0.5.1", "http_interactions": [{"recorded_at": "2015-11-03T23:30:23", "response": {"url": "https://api.github.com/feeds", "headers": {"X-XSS-Protection": "1; mode=block", "X-RateLimit-Remaining": "4981", "X-GitHub-Request-Id": "54CA42F2:1AD5:EED2670:5639438F", "X-Frame-Options": "deny", "Strict-Transport-Security": "max-age=31536000; includeSubdomains; preload", "Access-Control-Expose-Headers": "ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval", "Status": "200 OK", "Content-Security-Policy": "default-src 'none'", "Transfer-Encoding": "chunked", "X-RateLimit-Limit": "5000", "X-Served-By": "d594a23ec74671eba905bf91ef329026", "X-RateLimit-Reset": "1446595535", "X-GitHub-Media-Type": "github.v3; param=full; format=json", "X-Content-Type-Options": "nosniff", "Cache-Control": "private, max-age=60, s-maxage=60", "ETag": "W/\"9052b85649ffe4245d566403987a31e5\"", "Access-Control-Allow-Origin": "*", "Content-Type": "application/json; charset=utf-8", "Vary": "Accept, Authorization, Cookie, X-GitHub-OTP", "Server": "GitHub.com", "Date": "Tue, 03 Nov 2015 23:30:23 GMT", "Access-Control-Allow-Credentials": "true", "Content-Encoding": "gzip"}, "status": {"code": 200, "message": "OK"}, "body": {"string": "", "encoding": "utf-8", "base64_string": "H4sIAAAAAAAAA72TYU/CMBCG/0u/yphCREJCDEJEBHEifEBDljIKa7Zuo+1gQPbfbQEXGGw4Tfy2dO/dvXf33AZwTJCNHaT71AYVYHLusYqqzjA3/XHecIn6rQA54DNEk4Ub+TsUMsOnFDlc38o9f2xjIzlqV6nIEeNSHw9PtBWLy3sULyBHechdcs9dCznV2muJkoZhl5dttuorbmfSXQ8HA2IFil9CXcVipeueM9SWtWo1Xhca3E3pNbG6DDvxUFtoynzZanYezVnw9tz7eLrtBi+QFNt+mgeXzqCD15Bj19kPMG4zLmGg8nluiYc6psphi5ebQnHKJvtdRxtInGTroV7o3ZUn3AyaWBs0+q/1eb3f0t4b1lEXoxzQBVKW8LKJ+JLfJkXTi4zxlYeECHqewGbbuipXehUQG4Q7BNNzRRheyHSG0vTEp6RmqJApdeIKfg5zBmv6lvVfGvwj71lsHjJ84FacxD6L5ONoq0fUi8tIQ/A/LyRyfJ7yURh+AZ4k23SZBQAA"}}, "request": {"headers": {"Authorization": "Basic <BASIC_AUTH>", "Accept": "application/vnd.github.v3.full+json", "Connection": "keep-alive", "Accept-Charset": "utf-8", "Accept-Encoding": "gzip, deflate", "User-Agent": "github3.py/1.0.0a2", "Content-Type": "application/json"}, "uri": "https://api.github.com/feeds", "body": {"string": "", "encoding": "utf-8"}, "method": "GET"}}]}

tests/integration/test_github.py

@@ -102,15 +102,21 @@ def test_feeds(self):
         with self.recorder.use_cassette(cassette_name):
             feeds = self.gh.feeds()
 
-        for v in feeds['_links'].values():
-            assert isinstance(v['href'], uritemplate.URITemplate)
-
-        # The processing on _links has been tested. Get rid of it.
-        del feeds['_links']
-
-        # Test the rest of the response
-        for v in feeds.values():
-            assert isinstance(v, uritemplate.URITemplate)
+        _links = feeds.pop('_links')
+
+        for urls in feeds.values():
+            if not isinstance(urls, list):
+                urls = [urls]
+            for url in urls:
+                assert isinstance(url, uritemplate.URITemplate)
+
+        for links in _links.values():
+            if not isinstance(links, list):
+                links = [links]
+            for link in links:
+                href = link.get('href')
+                assert (href is None or
+                        isinstance(href, uritemplate.URITemplate))
 
     def test_gist(self):
         """Test the ability to retrieve a single gist."""

tests/unit/test_github.py

@@ -114,6 +114,11 @@ def test_emojis(self):
 
         self.session.get.assert_called_once_with(url_for('emojis'))
 
+    def test_feeds(self):
+        self.instance.feeds()
+
+        self.session.get.assert_called_once_with(url_for('feeds'))
+
     def test_follow(self):
         """Test the request to follow a user."""
         self.instance.follow('username')
@@ -867,6 +872,11 @@ def test_emails(self):
         with pytest.raises(AuthenticationFailed):
             self.instance.emails()
 
+    def test_feeds(self):
+        """Show that one needs to authenticate to use #feeds."""
+        with pytest.raises(AuthenticationFailed):
+            self.instance.feeds()
+
     def test_follow(self):
         """Show that one needs to authenticate to use #follow."""
         with pytest.raises(AuthenticationFailed):