Added warning for listing commits in repos containing '.'.

JNRowe · JNRowe · commit bf97f4da9f03 · 2011-05-22T22:15:05.000+01:00
diff --git a/github2/commits.py b/github2/commits.py
@@ -29,6 +29,11 @@ class Commits(GithubCommand):
     def list(self, project, branch="master", file=None):
         """List commits on a project
 
+        .. warning::
+           Unfortunately, listing the commits from repositories containing
+           certain characters such as '.' will fail.  This is an issue with the
+           GitHub API, and can't currently be worked around in this library.
+
         :param str project: project name
         :param str branch: branch name
         :param str file: optional file filter
diff --git a/tests/data/github.com,api,v2,json,commits,list,kennethreitz,osxpython.org,master,f245f9d2f5db473934bef7aed73bbdac b/tests/data/github.com,api,v2,json,commits,list,kennethreitz,osxpython.org,master,f245f9d2f5db473934bef7aed73bbdac
@@ -0,0 +1,12 @@
+status: 404
+content-location: https://github.com/api/v2/json/commits/list/kennethreitz/osxpython.org/master
+x-runtime: 24ms
+content-length: 21
+server: nginx/0.7.67
+connection: keep-alive
+x-ratelimit-limit: 60
+cache-control: no-cache
+date: Sun, 22 May 2011 20:40:50 GMT
+content-type: application/json; charset=utf-8
+
+{"error":"Not Found"}
diff --git a/tests/test_commits.py b/tests/test_commits.py
@@ -2,7 +2,7 @@
 
 import sys
 
-from nose.tools import assert_equals
+from nose.tools import (assert_equals, assert_false)
 
 import utils
 
@@ -34,3 +34,21 @@ def test_list_with_branch_and_file(self):
         assert_equals(len(commits), 35)
         assert_equals(commits[0].id,
                 '482f657443df4b701137a3025ae08476cddd2b7d')
+
+    def test_list_repo_with_dot(self):
+        """GitHub returns error listing commits in repos containing '.'
+
+        The purpose of this test is to tell us when this issue is fixed
+        upstream.
+        """
+        try:
+            commits = self.client.commits.list('kennethreitz/osxpython.org')
+        except RuntimeError:
+            # The hoop jumping here is for Python 2 & 3 compatibility, it is
+            # also good a sign it may be time to use 2to3 on the tests.
+            e = sys.exc_info()[1]
+            if """'{"error":"Not Found"}'""" not in e.args[0]:
+                raise
+            commits = None
+        assert_false(commits,
+                     "Listing commits with '.' in name is fixed upstream!")
