Skip to content
This repository was archived by the owner on Dec 17, 2019. It is now read-only.

Commit 4c63c55

Browse files
committed
Little fixs
1 parent 5178849 commit 4c63c55

File tree

8 files changed

+66
-24
lines changed

8 files changed

+66
-24
lines changed

docs/orgs.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _Orgs service:
2+
3+
Orgs services
4+
==============
5+
6+
**Fast sample**::
7+
8+
from pygithub3 import Github
9+
10+
gh = Github(token='abc123')
11+
12+
auth_orgs = gh.orgs.list().all()
13+
members = gh.orgs.members.list('github')
14+
15+
Org
16+
------
17+
18+
.. autoclass:: pygithub3.services.orgs.Org
19+
:members:
20+
21+
.. attribute:: members
22+
23+
:ref:`Members service`
24+
25+
.. attribute:: teams
26+
27+
:ref:`Teams service`
28+
29+
.. _Members service:
30+
31+
Members
32+
---------
33+
34+
.. autoclass:: pygithub3.services.orgs.members.Members
35+
:members:
36+
37+
.. _Teams service:
38+
39+
Teams
40+
-------
41+
42+
.. autoclass:: pygithub3.services.orgs.teams.Teams
43+
:members:
44+
45+
.. _github orgs doc: http://developer.github.com/v3/orgs
46+
.. _github orgs teams doc: http://developer.github.com/v3/orgs/teams

docs/services.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,6 @@ List of services
7272
users
7373
repos
7474
gists
75+
orgs
7576

7677
.. _mimetypes: http://developer.github.com/v3/mime

pygithub3/requests/orgs/members.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class List(Request):
99
resource = Member
1010

1111

12-
class Get(Request):
12+
class Is_member(Request):
1313
uri = 'orgs/{org}/members/{user}'
1414

1515

@@ -22,7 +22,7 @@ class Listpublic(Request):
2222
resource = Member
2323

2424

25-
class Getpublic(Request):
25+
class Is_public_member(Request):
2626
uri = 'orgs/{org}/public_members/{user}'
2727

2828

pygithub3/requests/orgs/teams.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ class Create(Request):
2323
'required': ('name',),
2424
}
2525

26+
# TODO: Check if this request fails with invalid permission
27+
#def clean_body(self):
28+
2629

2730
class Update(Request):
2831
uri = 'teams/{id}'

pygithub3/resources/orgs.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22
# -*- encoding: utf-8 -*-
33

44
from .base import Resource
5+
from .users import Plan
56

67
__all__ = ('Org', )
78

89

910
class Org(Resource):
1011

1112
_dates = ('created_at', )
13+
_maps = {'plan': Plan}
1214

1315
def __str__(self):
1416
return '<Org (%s)>' % getattr(self, 'login', '')

pygithub3/services/orgs/members.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ def is_member(self, org, user):
2727
:param str org: Organisation name
2828
:param str user: User name
2929
"""
30-
request = self.request_builder('orgs.members.get', org=org, user=user)
30+
request = self.request_builder('orgs.members.is_member', org=org,
31+
user=user)
3132
return self._bool(request)
3233

3334
def remove_member(self, org, user):
@@ -40,7 +41,7 @@ def remove_member(self, org, user):
4041
You must be authenticated and an owner of org
4142
4243
"""
43-
request = self.request_builder('orgs.members.get', org=org, user=user)
44+
request = self.request_builder('orgs.members.delete', org=org, user=user)
4445
return self._delete(request)
4546

4647
def list_public(self, org):
@@ -58,7 +59,7 @@ def is_public_member(self, org, user):
5859
:param str org: Organisation name
5960
:param str user: User name
6061
"""
61-
request = self.request_builder('orgs.members.getpublic',
62+
request = self.request_builder('orgs.members.is_public_member',
6263
org=org, user=user)
6364
return self._bool(request)
6465

pygithub3/services/orgs/teams.py

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,21 @@ def get(self, id):
2828
request = self.request_builder('orgs.teams.get', id=id)
2929
return self._get(request)
3030

31-
def create(self, org, name, repo_names=None, permission=None):
31+
def create(self, org, data):
3232
""" Create a new team
3333
3434
:param str org: Organisation name
35-
:param str name: Team name
36-
:param list repo_names: List of repo names to belong to the team
37-
:param str permission: Permissions to be granted to members
35+
:param dict data: Input. See `github orgs teams doc`_
3836
"""
39-
data = {'name': name}
40-
if repo_names:
41-
data['repo_names'] = repo_names
42-
if permission:
43-
data['permission'] = permission
4437
request = self.request_builder('orgs.teams.create', org=org, body=data)
4538
return self._post(request)
4639

47-
def update(self, id, name, permission=None):
40+
def update(self, id, data):
4841
""" Update a team
4942
5043
:param int id: The team id
51-
:param str name: Team name
52-
:param str permission: Permissions to be granted to members
44+
:param dict data: Input. See `github orgs teams doc`_
5345
"""
54-
data = {'name': name}
55-
if permission:
56-
data['permission'] = permission
5746
request = self.request_builder('orgs.teams.update', id=id, body=data)
5847
return self._patch(request)
5948

pygithub3/tests/services/test_orgs.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def test_UPDATE(self, request_method):
4444

4545

4646
@patch.object(requests.sessions.Session, 'request')
47-
class TestOrgMemberService(TestCase):
47+
class TestMemberService(TestCase):
4848
def setUp(self):
4949
self.ms = Members()
5050

@@ -92,7 +92,7 @@ def test_CONCEAL_MEMBERSHIP(self, request_method):
9292

9393

9494
@patch.object(requests.sessions.Session, 'request')
95-
class TestOrgMemberService(TestCase):
95+
class TestTeamsService(TestCase):
9696
def setUp(self):
9797
self.ts = Teams()
9898

@@ -109,13 +109,13 @@ def test_GET(self, request_method):
109109

110110
def test_CREATE(self, request_method):
111111
request_method.return_value = mock_response_result('post')
112-
self.ts.create('acme', 'committers')
112+
self.ts.create('acme', dict(name='new'))
113113
self.assertEqual(request_method.call_args[0],
114114
('post', _('orgs/acme/teams')))
115115

116116
def test_UPDATE(self, request_method):
117117
request_method.return_value = mock_response_result()
118-
self.ts.update(1, 'committers', 'push')
118+
self.ts.update(1, dict(name='edited'))
119119
self.assertEqual(request_method.call_args[0], ('patch', _('teams/1')))
120120

121121
def test_DELETE(self, request_method):

0 commit comments

Comments
 (0)