Merge copitux#5 'services/orgs'

copitux · copitux · commit 9dedea7efc93 · 2012-06-03T14:47:23.000+02:00
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -24,3 +24,4 @@ Patches and Suggestions
 - Francisco Marcos <fmarcos83@gmail.com>
 - Nathaniel Williams <nat.williams@gmail.com>
 - Alejandro Gómez <alejandroogomez@gmail.com>
+- Stefano Rivera <stefano@rivera.za.net>
diff --git a/README.rst b/README.rst
@@ -43,11 +43,12 @@ Achievements
 - `Gists service <http://developer.github.com/v3/gists/>`_
 - `Git Data service <http://developer.github.com/v3/git/>`_
 - `Pull requests service <http://developer.github.com/v3/pulls/>`_
+- `Orgs service <http://developer.github.com/v3/orgs/>`_
 
 TODO
 -----
 
-- Services: Issues, Orgs, Events
+- Services: Issues, Events
 - Oauth authorization API (service?)
 - Proxy methods into resources (e.g copitux.followers)
 
diff --git a/docs/orgs.rst b/docs/orgs.rst
@@ -0,0 +1,46 @@
+.. _Orgs service:
+
+Orgs services
+==============
+
+**Fast sample**::
+
+    from pygithub3 import Github
+
+    gh = Github(token='abc123')
+
+    auth_orgs = gh.orgs.list().all()
+    members = gh.orgs.members.list('github')
+
+Org
+------
+
+.. autoclass:: pygithub3.services.orgs.Org
+    :members:
+
+    .. attribute:: members
+
+        :ref:`Members service`
+
+    .. attribute:: teams
+
+        :ref:`Teams service`
+
+.. _Members service:
+
+Members
+---------
+
+.. autoclass:: pygithub3.services.orgs.members.Members
+    :members:
+
+.. _Teams service:
+
+Teams
+-------
+
+.. autoclass:: pygithub3.services.orgs.teams.Teams
+    :members:
+
+.. _github orgs doc: http://developer.github.com/v3/orgs
+.. _github orgs teams doc: http://developer.github.com/v3/orgs/teams
diff --git a/docs/services.rst b/docs/services.rst
@@ -74,5 +74,6 @@ List of services
     gists
     git_data
     pull_requests
+    orgs
 
 .. _mimetypes: http://developer.github.com/v3/mime
diff --git a/pygithub3/github.py b/pygithub3/github.py
@@ -19,11 +19,13 @@ def __init__(self, **config):
         from pygithub3.services.gists import Gist
         from pygithub3.services.git_data import GitData
         from pygithub3.services.pull_requests import PullRequests
+        from pygithub3.services.orgs import Org
         self._users = User(**config)
         self._repos = Repo(**config)
         self._gists = Gist(**config)
         self._git_data = GitData(**config)
         self._pull_requests = PullRequests(**config)
+        self._orgs = Org(**config)
 
     @property
     def remaining_requests(self):
@@ -65,3 +67,9 @@ def pull_requests(self):
         :ref:`Pull Requests service <Pull Requests service>`
         """
         return self._pull_requests
+
+    def orgs(self):
+        """
+        :ref:`Orgs service <Orgs service>`
+        """
+        return self._orgs
diff --git a/pygithub3/requests/orgs/__init__.py b/pygithub3/requests/orgs/__init__.py
@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.requests.base import Request
+from pygithub3.resources.orgs import Org
+
+
+class List(Request):
+    uri = 'users/{user}/orgs'
+    resource = Org
+
+    def clean_uri(self):
+        if not self.user:
+            return 'user/orgs'
+
+
+class Get(Request):
+    uri = 'orgs/{org}'
+    resource = Org
+
+
+class Update(Request):
+    uri = 'orgs/{org}'
+    resource = Org
+    body_schema = {
+        'schema': ('billing_email', 'company', 'email', 'location', 'name'),
+        'required': (),
+    }
diff --git a/pygithub3/requests/orgs/members.py b/pygithub3/requests/orgs/members.py
@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.resources.orgs import Member
+from . import Request
+
+
+class List(Request):
+    uri = 'orgs/{org}/members'
+    resource = Member
+
+
+class Is_member(Request):
+    uri = 'orgs/{org}/members/{user}'
+
+
+class Delete(Request):
+    uri = 'orgs/{org}/members/{user}'
+
+
+class Listpublic(Request):
+    uri = 'orgs/{org}/public_members'
+    resource = Member
+
+
+class Is_public_member(Request):
+    uri = 'orgs/{org}/public_members/{user}'
+
+
+class Publicize(Request):
+    uri = 'orgs/{org}/public_members/{user}'
+
+
+class Conceal(Request):
+    uri = 'orgs/{org}/public_members/{user}'
diff --git a/pygithub3/requests/orgs/teams.py b/pygithub3/requests/orgs/teams.py
@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.resources.orgs import Member, Team
+from pygithub3.resources.repos import Repo
+from . import Request
+
+
+class List(Request):
+    uri = 'orgs/{org}/teams'
+    resource = Team
+
+
+class Get(Request):
+    uri = 'teams/{id}'
+    resource = Team
+
+
+class Create(Request):
+    uri = 'orgs/{org}/teams'
+    resource = Team
+    body_schema = {
+        'schema': ('name', 'repo_names', 'permission',),
+        'required': ('name',),
+    }
+
+    # TODO: Check if this request fails with invalid permission
+    #def clean_body(self):
+
+
+class Update(Request):
+    uri = 'teams/{id}'
+    resource = Team
+    body_schema = {
+        'schema': ('name', 'permission',),
+        'required': ('name',),
+    }
+
+
+class Delete(Request):
+    uri = 'teams/{id}'
+
+
+class List_members(Request):
+    uri = 'teams/{id}/members'
+    resource = Member
+
+
+class Is_member(Request):
+    uri = 'teams/{id}/members/{user}'
+
+
+class Add_member(Request):
+    uri = 'teams/{id}/members/{user}'
+
+
+class Remove_member(Request):
+    uri = 'teams/{id}/members/{user}'
+
+
+class List_repos(Request):
+    uri = 'teams/{id}/repos'
+    resource = Repo
+
+
+class Contains_repo(Request):
+    uri = 'teams/{id}/repos/{user}/{repo}'
+
+
+class Add_repo(Request):
+    uri = 'teams/{id}/repos/{user}/{repo}'
+
+
+class Remove_repo(Request):
+    uri = 'teams/{id}/repos/{user}/{repo}'
diff --git a/pygithub3/requests/repos/__init__.py b/pygithub3/requests/repos/__init__.py
@@ -1,8 +1,9 @@
 # -*- encoding: utf-8 -*-
 
 from pygithub3.requests.base import Request, ValidationError
+from pygithub3.resources.orgs import Team
+from pygithub3.resources.repos import Repo, Tag, Branch
 from pygithub3.resources.users import User
-from pygithub3.resources.repos import Repo, Team, Tag, Branch
 
 class List(Request):
 
diff --git a/pygithub3/resources/orgs.py b/pygithub3/resources/orgs.py
@@ -2,13 +2,27 @@
 # -*- encoding: utf-8 -*-
 
 from .base import Resource
+from .users import Plan
 
 __all__ = ('Org', )
 
 
 class Org(Resource):
 
     _dates = ('created_at', )
+    _maps = {'plan': Plan}
 
     def __str__(self):
-        return '<Org (%s)>' % getattr(self, 'name', '')
+        return '<Org (%s)>' % getattr(self, 'login', '')
+
+
+class Team(Resource):
+
+    def __str__(self):
+        return '<Team (%s)>' % getattr(self, 'name', '')
+
+
+class Member(Resource):
+
+    def __str__(self):
+        return '<TeamMember (%s)>' % getattr(self, 'login', '')
diff --git a/pygithub3/resources/repos.py b/pygithub3/resources/repos.py
@@ -18,12 +18,6 @@ def __str__(self):
         return '<Repo (%s)>' % getattr(self, 'name', '')
 
 
-class Team(Resource):
-
-    def __str__(self):
-        return '<Team (%s)>' % getattr(self, 'name', '')
-
-
 class Author(Resource):
 
     _dates = ('date')
@@ -115,6 +109,7 @@ def ball_to_upload(self):
             'Policy': self.policy, 'Signature': self.signature,
             'Content-Type': self.mime_type})
 
+
 class Hook(Resource):
 
     _dates = ('created_at', 'pushed_at')
diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py
@@ -111,10 +111,10 @@ def _patch(self, request, **kwargs):
     def _put(self, request, **kwargs):
         """ Bug in Github API? requests library?
 
-        I must send data as empty string when the specifications' of some PUT
-        request are 'Not send input data'. If I don't do that and send data as
-        None, the requests library doesn't send 'Content-length' header and the
-        server returns 411 - Required Content length (at least 0)
+        I must send data when the specifications' of some PUT request are 'Not
+        send input data'. If I don't do that and send data as None, the
+        requests library doesn't send 'Content-length' header and the server
+        returns 411 - Required Content length (at least 0)
 
         For instance:
             - follow-user request doesn't send input data
@@ -125,7 +125,7 @@ def _put(self, request, **kwargs):
 
         Related: https://github.com/github/developer.github.com/pull/52
         """
-        input_data = request.get_body() or ''
+        input_data = request.get_body() or 'PLACEHOLDER'
         response = self._client.put(request, data=input_data, **kwargs)
         if response.status_code != 204:  # != NO_CONTENT
             return request.resource.loads(response.content)
diff --git a/pygithub3/services/orgs/__init__.py b/pygithub3/services/orgs/__init__.py
@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+
+from pygithub3.services.base import Service
+from .members import Members
+from .teams import Teams
+
+
+class Org(Service):
+    """ Consume `Orgs API <http://developer.github.com/v3/orgs>`_ """
+
+    def __init__(self, **config):
+        self.members = Members(**config)
+        self.teams = Teams(**config)
+        super(Org, self).__init__(**config)
+
+    def list(self, user=None):
+        """ Get user's orgs
+
+        :param str user: Username
+        :returns: A :doc:`result`
+
+        If you call it without user and you are authenticated, get the
+        authenticated user's orgs, public and private.
+
+        If you call it with a user, get the user's public orgs.
+
+        ::
+
+            org_service.list('copitux')
+            org_service.list()
+        """
+        request = self.request_builder('orgs.list', user=user)
+        return self._get_result(request)
+
+    def get(self, org):
+        """ Get a single org
+
+        :param str org: Org name
+        """
+        request = self.request_builder('orgs.get', org=org)
+        return self._get(request)
+
+    def update(self, org, data):
+        """ Update a single org
+
+        :param str org: Org name
+        :param dict data: Input. See `github orgs doc`_
+
+        .. warning ::
+            You must be authenticated
+
+        ::
+
+            org_service.update(dict(company='ACME Development',
+                                    location='Timbuctoo'))
+        """
+        request = self.request_builder('orgs.update', org=org, body=data)
+        return self._patch(request)
diff --git a/pygithub3/services/orgs/members.py b/pygithub3/services/orgs/members.py
diff --git a/pygithub3/services/orgs/teams.py b/pygithub3/services/orgs/teams.py
diff --git a/pygithub3/tests/services/test_core.py b/pygithub3/tests/services/test_core.py
diff --git a/pygithub3/tests/services/test_orgs.py b/pygithub3/tests/services/test_orgs.py
