Add support Gitignore templates API and docs.

sigmavirus24 · sigmavirus24 · commit fe66189c79bb · 2012-12-03T11:32:07.000-05:00
diff --git a/docs/api.rst b/docs/api.rst
@@ -49,6 +49,14 @@ Or you can simply use the following functions
 
 ------
 
+.. autofunction:: github3.gitignore_template
+
+------
+
+.. autofunction:: github3.gitignore_templates
+
+------
+
 .. autofunction:: github3.issue
 
 ------
diff --git a/github3/api.py b/github3/api.py
@@ -57,6 +57,22 @@ def gist(id_num):
     return gh.gist(id_num)
 
 
+def gitignore_template(language):
+    """Returns the template for language.
+
+    :returns: str
+    """
+    return gh.gitignore_template(language)
+
+
+def gitignore_templates():
+    """Returns the list of available templates.
+
+    :returns: list of template names
+    """
+    return gh.gitignore_templates()
+
+
 def iter_events(number=-1):
     """Iterate over public events.
 
diff --git a/github3/github.py b/github3/github.py
@@ -257,6 +257,23 @@ def gist(self, id_num):
         json = self._json(self._get(url), 200)
         return Gist(json, self) if json else None
 
+    def gitignore_template(self, language):
+        """Returns the template for language.
+
+        :returns: str
+        """
+        url = self._build_url('gitignore', 'templates', language)
+        json = self._json(self._get(url), 200)
+        return json.get('source', '')
+
+    def gitignore_templates(self):
+        """Returns the list of available templates.
+
+        :returns: list of template names
+        """
+        url = self._build_url('gitignore', 'templates')
+        return self._json(self._get(url), 200) or []
+
     @requires_auth
     def is_following(self, login):
         """Check if the authenticated user is following login.
@@ -312,19 +329,6 @@ def issue(self, owner, repository, number):
             return repo.issue(number)
         return None
 
-    @requires_auth
-    def key(self, id_num):
-        """Gets the authenticated user's key specified by id_num.
-
-        :param int id_num: (required), unique id of the key
-        :returns: :class:`Key <github3.users.Key>`
-        """
-        json = None
-        if int(id_num) > 0:
-            url = self._build_url('user', 'keys', str(id_num))
-            json = self._json(self._get(url), 200)
-        return Key(json, self) if json else None
-
     @requires_basic_auth
     def iter_authorizations(self, number=-1):
         """Iterate over authorizations for the authenticated user. This will
@@ -631,6 +635,19 @@ def iter_subscriptions(self, login=None, number=-1):
         url = self._build_url('user', 'subscriptions')
         return self._iter(int(number), url, Repository)
 
+    @requires_auth
+    def key(self, id_num):
+        """Gets the authenticated user's key specified by id_num.
+
+        :param int id_num: (required), unique id of the key
+        :returns: :class:`Key <github3.users.Key>`
+        """
+        json = None
+        if int(id_num) > 0:
+            url = self._build_url('user', 'keys', str(id_num))
+            json = self._json(self._get(url), 200)
+        return Key(json, self) if json else None
+
     def login(self, username=None, password=None, token=None):
         """Logs the user into GitHub for protected API calls.
 
