Changes for breaking GitHub API changes

sigmavirus24 · sigmavirus24 · commit f44694acb9dc · 2014-10-05T20:43:34.000-05:00
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,6 +1,22 @@
 History/Changelog
 -----------------
 
+0.9.2: 2014-10-05
+~~~~~~~~~~~~~~~~~
+
+- Updates for `new team management`_ API changes
+
+  - Add ``Team#invite``, ``Team#membership_for``, and
+    ``Team#revoke_membership``
+
+  - Deprecate ``Team#add_member``, ``Team#remove_member``, and
+    ``Organization#add_member``.
+
+  - Update payload handler for ``TeamAddEvent``.
+
+.. _new team management:
+    https://developer.github.com/changes/2014-09-23-one-more-week-before-the-add-team-member-api-breaking-change/
+
 0.9.1: 2014-08-10
 ~~~~~~~~~~~~~~~~~
 
diff --git a/github3/events.py b/github3/events.py
@@ -156,8 +156,8 @@ def _team(payload):
         payload['team'] = Team(payload['team'], None)
     if payload.get('repo'):
         payload['repo'] = Repository(payload['repo'], None)
-    if payload.get('user'):
-        payload['user'] = User(payload['user'], None)
+    if payload.get('sender'):
+        payload['sender'] = User(payload['sender'], None)
     return payload
 
 
diff --git a/github3/github.py b/github3/github.py
@@ -10,15 +10,15 @@
 
 from .auths import Authorization
 from .decorators import (requires_auth, requires_basic_auth,
-                                requires_app_credentials)
+                         requires_app_credentials)
 from .events import Event
 from .gists import Gist
 from .issues import Issue, issue_params
 from .models import GitHubCore
-from .orgs import Organization, Team
+from .orgs import Membership, Organization, Team
 from .repos import Repository
 from .search import (CodeSearchResult, IssueSearchResult,
-                            RepositorySearchResult, UserSearchResult)
+                     RepositorySearchResult, UserSearchResult)
 from .structs import SearchIterator
 from .users import User, Key
 from .notifications import Thread
@@ -931,6 +931,14 @@ def markdown(self, text, mode='', context='', raw=False):
                 return req.content
         return ''  # (No coverage)
 
+    @requires_auth
+    def membership_in(self, organization):
+        """Retrieve the user's membership in the specified organization."""
+        url = self._build_url('user', 'memberships', 'orgs',
+                              str(organization))
+        json = self._json(self._get(url), 200)
+        return Membership(json, self)
+
     def meta(self):
         """Returns a dictionary with arrays of addresses in CIDR format
         specifying theaddresses that the incoming service hooks will originate
@@ -962,6 +970,22 @@ def organization(self, login):
         json = self._json(self._get(url), 200)
         return Organization(json, self) if json else None
 
+    @requires_auth
+    def organization_memberships(self, state=None, number=-1, etag=None):
+        """List organizations of which the user is a current or pending member.
+
+        :param str state: (option), state of the membership, i.e., active,
+            pending
+        :returns: iterator of :class:`Membership <github3.orgs.Membership>`
+        """
+        params = None
+        url = self._build_url('user', 'memberships', 'orgs')
+        if state is not None and state.lower() in ('active', 'pending'):
+            params = {'state': state.lower()}
+        return self._iter(int(number), url, Membership,
+                          params=params,
+                          etag=etag)
+
     @requires_auth
     def pubsubhubbub(self, mode, topic, callback, secret=''):
         """Create/update a pubsubhubbub hook.
diff --git a/github3/orgs.py b/github3/orgs.py
@@ -8,6 +8,8 @@
 """
 from __future__ import unicode_literals
 
+import warnings
+
 from json import dumps
 from .events import Event
 from .models import BaseAccount, GitHubCore
@@ -66,6 +68,11 @@ def add_member(self, login):
 
         :returns: bool
         """
+        warnings.warn(
+            'This is no longer supported by the GitHub API, see '
+            'https://developer.github.com/changes/2014-09-23-one-more-week'
+            '-before-the-add-team-member-api-breaking-change/',
+            DeprecationWarning)
         url = self._build_url('members', login, base_url=self._api)
         return self._boolean(self._put(url), 204, 404)
 
@@ -112,6 +119,20 @@ def has_repo(self, repo):
         url = self._build_url('repos', repo, base_url=self._api)
         return self._boolean(self._get(url), 204, 404)
 
+    @requires_auth
+    def invite(self, username):
+        """Invite the user to join this team.
+
+        This returns a dictionary like so::
+
+            {'state': 'pending', 'url': 'https://api.github.com/teams/...'}
+
+        :param str username: (required), user to invite to join this team.
+        :returns: dictionary
+        """
+        url = self._build_url('memberships', username, base_url=self._api)
+        return self._json(self._put(url), 200)
+
     def is_member(self, login):
         """Check if ``login`` is a member of this team.
 
@@ -146,16 +167,42 @@ def iter_repos(self, number=-1, etag=None):
         url = self._build_url('repos', base_url=self._api)
         return self._iter(int(number), url, Repository, etag=etag)
 
+    @requires_auth
+    def membership_for(self, username):
+        """Retrieve the membership information for the user.
+
+        :param str username: (required), name of the user
+        :returns: dictionary
+        """
+        url = self._build_url('memberships', username, base_url=self._api)
+        json = self._json(self._get(url), 200)
+        return json or {}
+
     @requires_auth
     def remove_member(self, login):
         """Remove ``login`` from this team.
 
         :param str login: (required), login of the member to remove
         :returns: bool
         """
+        warnings.warn(
+            'This is no longer supported by the GitHub API, see '
+            'https://developer.github.com/changes/2014-09-23-one-more-week'
+            '-before-the-add-team-member-api-breaking-change/',
+            DeprecationWarning)
         url = self._build_url('members', login, base_url=self._api)
         return self._boolean(self._delete(url), 204, 404)
 
+    @requires_auth
+    def revoke_membership(self, username):
+        """Revoke this user's team membership.
+
+        :param str username: (required), name of the team member
+        :returns: bool
+        """
+        url = self._build_url('memberships', username, base_url=self._api)
+        return self._boolean(self._delete(url), 204, 404)
+
     @requires_auth
     def remove_repo(self, repo):
         """Remove ``repo`` from this team.
@@ -209,6 +256,11 @@ def __init__(self, org, session=None):
     def add_member(self, login, team):
         """Add ``login`` to ``team`` and thereby to this organization.
 
+        .. warning::
+            This method is no longer valid. To add a member to a team, you
+            must now retrieve the team directly, and use the ``invite``
+            method.
+
         Any user that is to be added to an organization, must be added
         to a team as per the GitHub api.
 
@@ -223,6 +275,11 @@ def add_member(self, login, team):
         :param str team: (required), team name
         :returns: bool
         """
+        warnings.warn(
+            'This is no longer supported by the GitHub API, see '
+            'https://developer.github.com/changes/2014-09-23-one-more-week'
+            '-before-the-add-team-member-api-breaking-change/',
+            DeprecationWarning)
         for t in self.iter_teams():
             if team == t.name:
                 return t.add_member(login)
@@ -484,3 +541,38 @@ def team(self, team_id):
             url = self._build_url('teams', str(team_id))
             json = self._json(self._get(url), 200)
         return Team(json, self._session) if json else None
+
+
+class Membership(GitHubCore):
+
+    """The wrapper for information about Team and Organization memberships."""
+
+    def __init__(self, membership, session=None):
+        super(Membership, self).__init__(membership, session)
+        self._update_attributes(membership)
+
+    def _repr(self):
+        return '<Membership [{0}]>'.format(self.organization)
+
+    def _update_attributes(self, membership):
+        self._api = membership.get('url')
+        self.organization = Organization(membership.get('organization', {}),
+                                         self)
+        self.state = membership.get('state', '')
+        self.organization_url = membership.get('organization_url')
+        self.active = self.state.lower() == 'active'
+        self.pending = self.state.lower() == 'pending'
+
+    @requires_auth
+    def edit(self, state):
+        """Edit the user's membership.
+
+        :param str state: (required), the state the membership should be in.
+            Only accepts ``"active"``.
+        :returns: itself
+        """
+        if state and state.lower() == 'active':
+            data = dumps({'state': state.lower()})
+            json = self._json(self._patch(self._api, data=data))
+            self._update_attributes(json)
+        return self
