Merged pull request copitux#3 from natw/git_data

copitux · copitux · commit 8430f64e6f00 · 2012-04-17T18:45:46.000+02:00
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -11,8 +11,9 @@ Forked and redesign from Kenneth Reitz's repo
 
 Forked from https://github.com/kennethreitz/python-github3
 
-Kenneth Reitz is also the author of the awesome `requests <https://github.com/kennethreitz/requests>`_ library
-which `python-github3` needs it
+Kenneth Reitz is also the author of the awesome
+`requests <https://github.com/kennethreitz/requests>`_ library, which
+`python-github3` requires.
 
 Patches and Suggestions
 .........................
@@ -21,3 +22,4 @@ Patches and Suggestions
 - Rok Garbas
 - Antti Kaihola <akaihol+github@ambitone.com>
 - Francisco Marcos <fmarcos83@gmail.com>
+- Nathaniel Williams <nat.williams@gmail.com>
diff --git a/README.rst b/README.rst
@@ -41,11 +41,12 @@ Achievements
 - `Users service <http://developer.github.com/v3/users/>`_
 - `Repos service <http://developer.github.com/v3/repos/>`_
 - `Gists service <http://developer.github.com/v3/gists/>`_
+- `Git Data service <http://developer.github.com/v3/git/>`_
 
 TODO
 -----
 
-- Services: Git Data, Issues, Orgs, Pull Requests, Events
+- Services: Issues, Orgs, Pull Requests, Events
 - Oauth authorization API (service?)
 - Proxy methods into resources (e.g copitux.followers())
 
@@ -55,8 +56,12 @@ Contribute
 1. Fork the `repository <https://github.com/copitux/python-github3>`_
 2. Write a test to cover new feature or to reproduce bug
 3. Code with `pep8 <http://www.python.org/dev/peps/pep-0008/>`_ rules
-4. Add you to ``AUTHORS``
+4. Add yourself to ``AUTHORS``
 5. Pull request it
 
-**Note**: I use `nose <http://readthedocs.org/docs/nose/en/latest/>`_ test environment,
-with `mock <http://www.voidspace.org.uk/python/mock/>`_ ``pip install nose mock``
+Tests
+-----
+
+Test and docs requirements are listed in ``test_requirements.txt``.
+Run ``pip install -r test_requirements.txt`` to install them and ``nosetests``
+to run tests.
diff --git a/docs/git_data.rst b/docs/git_data.rst
@@ -0,0 +1,86 @@
+.. _Git Data service:
+
+Git Data services
+=================
+
+**Example**::
+
+  from pygithub3 import Github
+
+  gh = Github(user='someone', repo='some_repo')
+
+  a_blob = gh.git_data.blobs.get('a long sha')
+
+  dev_branch = gh.git_data.references.get('heads/add_a_thing')
+
+
+GitData
+-------
+
+.. autoclass:: pygithub3.services.git_data.GitData
+    :members:
+
+    .. attribute:: blobs
+
+        :ref:`Blobs service`
+
+    .. attribute:: commits
+
+        :ref:`Commits service`
+
+    .. attribute:: references
+
+        :ref:`References service`
+
+    .. attribute:: tags
+
+        :ref:`Tags service`
+
+    .. attribute:: trees
+
+        :ref:`Trees service`
+
+
+.. _Blobs service:
+
+Blobs
+-----
+
+.. autoclass:: pygithub3.services.git_data.Blobs
+    :members:
+
+
+.. _Commits service:
+
+Commits
+-------
+
+.. autoclass:: pygithub3.services.git_data.Commits
+    :members:
+
+
+.. _References service:
+
+References
+----------
+
+.. autoclass:: pygithub3.services.git_data.References
+    :members:
+
+
+.. _Tags service:
+
+Tags
+----
+
+.. autoclass:: pygithub3.services.git_data.Tags
+    :members:
+
+
+.. _Trees service:
+
+Trees
+-----
+
+.. autoclass:: pygithub3.services.git_data.Trees
+    :members:
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -15,15 +15,21 @@ Dependencies
 Required
 .........
 
-This library only depends on `request library`_ module.
+This library depends only on the `requests`_ module.
 
-If you install ``pygithub3`` with ``pip`` all is done. The best option
+If you install ``pygithub3`` with ``pip`` all is done. This is the best option.
 
 Optional
 .........
 
-If you want to run the test suite, you must install `nose`_ and `mock`_
+The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the
+documentation requires `sphinx`_.
 
-.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html
+Install all of these by running ``pip install -r test_requirements.txt``.  Then
+just run ``nosetests`` to run the tests.
+
+.. _requests: http://docs.python-requests.org/en/v0.10.6/index.html
 .. _nose: http://readthedocs.org/docs/nose/en/latest
 .. _mock: http://pypi.python.org/pypi/mock
+.. _unittest2: http://pypi.python.org/pypi/unittest2
+.. _sphinx: http://sphinx.pocoo.org/
diff --git a/docs/services.rst b/docs/services.rst
@@ -72,5 +72,6 @@ List of services
     users
     repos
     gists
+    git_data
 
 .. _mimetypes: http://developer.github.com/v3/mime
diff --git a/pygithub3/github.py b/pygithub3/github.py
@@ -17,9 +17,11 @@ def __init__(self, **config):
         from pygithub3.services.users import User
         from pygithub3.services.repos import Repo
         from pygithub3.services.gists import Gist
+        from pygithub3.services.git_data import GitData
         self._users = User(**config)
         self._repos = Repo(**config)
         self._gists = Gist(**config)
+        self._git_data = GitData(**config)
 
     @property
     def remaining_requests(self):
@@ -47,3 +49,10 @@ def gists(self):
         :ref:`Gists service <Gists service>`
         """
         return self._gists
+
+    @property
+    def git_data(self):
+        """
+        :ref:`Git Data service <Git Data service>`
+        """
+        return self._git_data
diff --git a/pygithub3/requests/git_data/__init__.py b/pygithub3/requests/git_data/__init__.py
diff --git a/pygithub3/requests/git_data/blobs.py b/pygithub3/requests/git_data/blobs.py
@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request
+from pygithub3.resources.git_data import Blob
+
+
+class Get(Request):
+    uri = 'repos/{user}/{repo}/git/blobs/{sha}'
+    resource = Blob
+
+
+class Create(Request):
+    uri = 'repos/{user}/{repo}/git/blobs'
+    resource = Blob
+    body_schema = {
+        'schema': ('content', 'encoding'),
+        'required': ('content', 'encoding'),  # TODO: is enc really required?
+    }
diff --git a/pygithub3/requests/git_data/commits.py b/pygithub3/requests/git_data/commits.py
@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request
+from pygithub3.resources.git_data import Commit
+
+
+class Get(Request):
+    uri = 'repos/{user}/{repo}/git/commits/{sha}'
+    resource = Commit
+
+
+class Create(Request):
+    uri = 'repos/{user}/{repo}/git/commits'
+    resource = Commit
+    body_schema = {
+        'schema': ('message', 'tree', 'parents', 'author', 'committer'),
+        'required': ('message', 'tree', 'parents'),
+    }
diff --git a/pygithub3/requests/git_data/references.py b/pygithub3/requests/git_data/references.py
@@ -0,0 +1,33 @@
+from pygithub3.requests.base import Request
+from pygithub3.resources.git_data import Reference
+
+
+class Get(Request):
+    uri = 'repos/{user}/{repo}/git/refs/{ref}'
+    resource = Reference
+
+
+class List(Request):
+    uri = 'repos/{user}/{repo}/git/refs'
+    resource = Reference
+
+
+class Create(Request):
+    uri = 'repos/{user}/{repo}/git/refs'
+    resource = Reference
+    body_schema = {
+        'schema': ('ref', 'sha'),
+        'required': ('ref', 'sha'),
+    }
+
+class Update(Request):
+    uri = 'repos/{user}/{repo}/git/refs/{ref}'
+    resource = Reference
+    body_schema = {
+        'schema': ('sha', 'force'),
+        'required': ('sha',),
+    }
+
+
+class Delete(Request):
+    uri = 'repos/{user}/{repo}/git/refs/{ref}'
diff --git a/pygithub3/requests/git_data/tags.py b/pygithub3/requests/git_data/tags.py
@@ -0,0 +1,15 @@
+from pygithub3.requests.base import Request
+from pygithub3.resources.git_data import Tag
+
+
+class Get(Request):
+    uri = 'repos/{user}/{repo}/git/tags/{sha}'
+    resource = Tag
+
+class Create(Request):
+    uri = 'repos/{user}/{repo}/git/tags'
+    resource = Tag
+    body_schema = {
+        'schema': ('tag', 'message', 'object', 'type', 'tagger'),
+        'required': ('type',),
+    }
diff --git a/pygithub3/requests/git_data/trees.py b/pygithub3/requests/git_data/trees.py
@@ -0,0 +1,20 @@
+from pygithub3.requests.base import Request
+from pygithub3.resources.git_data import Tree
+
+
+class Get(Request):
+    uri = 'repos/{user}/{repo}/git/trees/{sha}'
+    resource = Tree
+
+    def clean_uri(self):
+        if self.recursive:
+            return self.uri + '?recursive=1'
+
+
+class Create(Request):
+    uri = 'repos/{user}/{repo}/git/trees'
+    resource = Tree
+    body_schema = {
+        'schema': ('tree',),
+        'required': ('tree',),
+    }
diff --git a/pygithub3/resources/gists.py b/pygithub3/resources/gists.py
@@ -15,6 +15,7 @@ class Fork(Resource):
 
     _dates = ('created_at', )
     _maps = {'user': User}
+
     def __str__(self):
         return '<GistFork>'
 
diff --git a/pygithub3/resources/git_data.py b/pygithub3/resources/git_data.py
@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from .base import Resource
+from .repos import Author, Commit
+
+
+class Blob(Resource):
+    def __str__(self):
+        return "<Blob (%s)>" % getattr(self, 'content', '')
+
+
+class Reference(Resource):
+    def __str__(self):
+        return '<Reference (%s)>' % getattr(self, 'ref', '')
+
+
+class Tag(Resource):
+    _maps = {'object': Commit,
+             'tagger': Author}  # committer? tagger?
+
+    def __str__(self):
+        return '<Tag (%s)>' % getattr(self, 'tag', '')
+
+
+class Tree(Resource):
+    def __str__(self):
+        return '<Tree (%s)>' % getattr(self, 'sha', '')
diff --git a/pygithub3/services/git_data/__init__.py b/pygithub3/services/git_data/__init__.py
@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+from .blobs import Blobs
+from .commits import Commits
+from .references import References
+from .tags import Tags
+from .trees import Trees
+
+class GitData(Service):
+    """Consume `Git Data API <http://developer.github.com/v3/git/>`_"""
+
+    def __init__(self, **config):
+        self.blobs = Blobs(**config)
+        self.commits = Commits(**config)
+        self.references = References(**config)
+        self.tags = Tags(**config)
+        self.trees = Trees(**config)
+        super(GitData, self).__init__(**config)
diff --git a/pygithub3/services/git_data/blobs.py b/pygithub3/services/git_data/blobs.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+
+
+class Blobs(Service):
+    """Consume `Blobs API <http://developer.github.com/v3/git/blobs/>`_"""
+
+    def get(self, sha, user=None, repo=None):
+        """Get a particular blob
+
+        :param str sha: The sha of the blob to get
+        :param str user: Username
+        :param str repo: Repository
+
+        """
+        request = self.make_request('git_data.blobs.get', sha=sha,
+                                       user=user, repo=repo)
+        return self._get(request)
+
+    def create(self, data, user=None, repo=None):
+        """Create a blob
+
+        :param dict data: Data describing the blob to create
+        :param str user: Username
+        :param str repo: Repository
+
+        """
+        request = self.make_request('git_data.blobs.create', body=data,
+                                    user=user, repo=repo)
+        return self._post(request)
diff --git a/pygithub3/services/git_data/commits.py b/pygithub3/services/git_data/commits.py
diff --git a/pygithub3/services/git_data/references.py b/pygithub3/services/git_data/references.py
diff --git a/pygithub3/services/git_data/tags.py b/pygithub3/services/git_data/tags.py
diff --git a/pygithub3/services/git_data/trees.py b/pygithub3/services/git_data/trees.py
diff --git a/pygithub3/tests/services/test_git_data.py b/pygithub3/tests/services/test_git_data.py
diff --git a/test_requirements.txt b/test_requirements.txt
