Repository navigation
Expand file tree
/
Copy pathorgs.py
More file actions
621 lines (504 loc) · 22.8 KB
/
Copy pathorgs.py
File metadata and controls
621 lines (504 loc) · 22.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
# -*- coding: utf-8 -*-
"""
github3.orgs
============
This module contains all of the classes related to organizations.
"""
from __future__ import unicode_literals
import warnings
from json import dumps
from .events import Event
from .models import BaseAccount, GitHubCore
from .repos import Repository
from .users import User
from .decorators import requires_auth
from uritemplate import URITemplate
class Team(GitHubCore):
"""The :class:`Team <Team>` object.
Two team instances can be checked like so::
t1 == t2
t1 != t2
And is equivalent to::
t1.id == t2.id
t1.id != t2.id
See also: http://developer.github.com/v3/orgs/teams/
"""
# Roles available to members on a team.
members_roles = frozenset(['member', 'maintainer', 'all'])
def _update_attributes(self, team):
self._api = team.get('url', '')
#: This team's name.
self.name = team.get('name')
#: This team's slug.
self.slug = team.get('slug')
#: Unique ID of the team.
self.id = team.get('id')
#: Permission level of the group.
self.permission = team.get('permission')
#: Number of members in this team.
self.members_count = team.get('members_count')
members = team.get('members_url')
#: Members URL Template. Expands with ``member``.
self.members_urlt = URITemplate(members) if members else None
#: Number of repos owned by this team.
self.repos_count = team.get('repos_count')
#: Repositories url (not a template).
self.repositories_url = team.get('repositories_url')
def _repr(self):
return '<Team [{0}]>'.format(self.name)
@requires_auth
def add_member(self, username):
"""Add ``username`` to this team.
:param str username: the username of the user you would like to add to
the team.
: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', username, base_url=self._api)
return self._boolean(self._put(url), 204, 404)
@requires_auth
def add_repository(self, repository, permission=''):
"""Add ``repository`` to this team.
:param str repository: (required), form: 'user/repo'
:param str permission: (optional), ('pull', 'push', 'admin')
:returns: bool
"""
data = {'permission': permission}
url = self._build_url('repos', repository, base_url=self._api)
return self._boolean(self._put(url, data=dumps(data)), 204, 404)
@requires_auth
def delete(self):
"""Delete this team.
:returns: bool
"""
return self._boolean(self._delete(self._api), 204, 404)
@requires_auth
def edit(self, name, permission=''):
"""Edit this team.
:param str name: (required)
:param str permission: (optional), ('pull', 'push', 'admin')
:returns: bool
"""
if name:
data = {'name': name, 'permission': permission}
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_attributes(json)
return True
return False
@requires_auth
def has_repository(self, repository):
"""Check if this team has access to ``repository``.
:param str repository: (required), form: 'user/repo'
:returns: bool
"""
url = self._build_url('repos', repository, 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)
@requires_auth
def is_member(self, username):
"""Check if ``login`` is a member of this team.
:param str username: (required), username name of the user
:returns: bool
"""
url = self._build_url('members', username, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
@requires_auth
def members(self, role=None, number=-1, etag=None):
r"""Iterate over the members of this team.
:param str role: (optional), filter members returned by their role
in the team. Can be one of: ``"member"``, ``"maintainer"``,
``"all"``. Default: ``"all"``.
:param int number: (optional), number of users to iterate over.
Default: -1 iterates over all values
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
"""
headers = {}
params = {}
if role in self.members_roles:
params['role'] = role
headers['Accept'] = 'application/vnd.github.ironman-preview+json'
url = self._build_url('members', base_url=self._api)
return self._iter(int(number), url, User, params=params, etag=etag,
headers=headers)
@requires_auth
def repositories(self, number=-1, etag=None):
"""Iterate over the repositories this team has access to.
:param int number: (optional), number of repos to iterate over.
Default: -1 iterates over all values
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
objects
"""
headers = {'Accept': 'application/vnd.github.ironman-preview+json'}
url = self._build_url('repos', base_url=self._api)
return self._iter(int(number), url, Repository, etag=etag,
headers=headers)
@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, username):
"""Remove ``username`` from this team.
:param str username: (required), username 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', username, 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_repository(self, repository):
"""Remove ``repository`` from this team.
:param str repository: (required), form: 'user/repo'
:returns: bool
"""
url = self._build_url('repos', repository, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
class Organization(BaseAccount):
"""The :class:`Organization <Organization>` object.
Two organization instances can be checked like so::
o1 == o2
o1 != o2
And is equivalent to::
o1.id == o2.id
o1.id != o2.id
See also: http://developer.github.com/v3/orgs/
"""
# Filters available when listing members. Note: ``"2fa_disabled"``
# is only available for organization owners.
members_filters = frozenset(['2fa_disabled', 'all'])
# Roles available to members in an organization.
members_roles = frozenset(['all', 'admin', 'member'])
def _update_attributes(self, org):
super(Organization, self)._update_attributes(org)
self.type = self.type or 'Organization'
#: Events url (not a template)
self.events_url = org.get('events_url')
#: Number of private repositories.
self.private_repos = org.get('private_repos', 0)
members = org.get('members_url')
#: Members URL Template. Expands with ``member``
self.members_urlt = URITemplate(members) if members else None
members = org.get('public_members_url')
#: Public Members URL Template. Expands with ``member``
self.public_members_urlt = URITemplate(members) if members else None
#: Repositories url (not a template)
self.repos_url = org.get('repos_url')
@requires_auth
def add_member(self, username, team_id):
"""Add ``username`` 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.
.. 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.
.. versionchanged:: 1.0
The second parameter used to be ``team`` but has been changed to
``team_id``. This parameter is now required to be an integer to
improve performance of this method.
:param str username: (required), login name of the user to be added
:param int team_id: (required), team id
: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)
if int(team_id) < 0:
return False
url = self._build_url('teams', str(team_id), 'members', str(username))
return self._boolean(self._put(url), 204, 404)
@requires_auth
def add_repository(self, repository, team_id):
"""Add ``repository`` to ``team``.
.. versionchanged:: 1.0
The second parameter used to be ``team`` but has been changed to
``team_id``. This parameter is now required to be an integer to
improve performance of this method.
:param str repository: (required), form: 'user/repo'
:param int team_id: (required), team id
:returns: bool
"""
if int(team_id) < 0:
return False
url = self._build_url('teams', str(team_id), 'repos', str(repository))
return self._boolean(self._put(url), 204, 404)
@requires_auth
def create_repository(self, name, description='', homepage='',
private=False, has_issues=True, has_wiki=True,
team_id=0, auto_init=False, gitignore_template='',
license_template=''):
"""Create a repository for this organization.
If the client is authenticated and a member of the organization, this
will create a new repository in the organization.
:param str name: (required), name of the repository
:param str description: (optional)
:param str homepage: (optional)
:param bool private: (optional), If ``True``, create a private
repository. API default: ``False``
:param bool has_issues: (optional), If ``True``, enable issues for
this repository. API default: ``True``
:param bool has_wiki: (optional), If ``True``, enable the wiki for
this repository. API default: ``True``
:param int team_id: (optional), id of the team that will be granted
access to this repository
:param bool auto_init: (optional), auto initialize the repository.
:param str gitignore_template: (optional), name of the template; this
is ignored if auto_int = False.
:param str license_template: (optional), name of the license; this
is ignored if auto_int = False.
:returns: :class:`Repository <github3.repos.Repository>`
.. warning: ``name`` should be no longer than 100 characters
"""
url = self._build_url('repos', base_url=self._api)
data = {'name': name, 'description': description,
'homepage': homepage, 'private': private,
'has_issues': has_issues, 'has_wiki': has_wiki,
'license_template': license_template, 'auto_init': auto_init,
'gitignore_template': gitignore_template}
if int(team_id) > 0:
data.update({'team_id': team_id})
json = self._json(self._post(url, data), 201)
return self._instance_or_null(Repository, json)
@requires_auth
def conceal_member(self, username):
"""Conceal ``username``'s membership in this organization.
:param str username: username of the organization member to conceal
:returns: bool
"""
url = self._build_url('public_members', username, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def create_team(self, name, repo_names=[], permission=''):
"""Create a new team and return it.
This only works if the authenticated user owns this organization.
:param str name: (required), name to be given to the team
:param list repo_names: (optional) repositories, e.g.
['github/dotfiles']
:param str permission: (optional), options:
- ``pull`` -- (default) members can not push or administer
repositories accessible by this team
- ``push`` -- members can push and pull but not administer
repositories accessible by this team
- ``admin`` -- members can push, pull and administer
repositories accessible by this team
:returns: :class:`Team <Team>`
"""
data = {'name': name, 'repo_names': repo_names,
'permission': permission}
url = self._build_url('teams', base_url=self._api)
json = self._json(self._post(url, data), 201)
return self._instance_or_null(Team, json)
@requires_auth
def edit(self, billing_email=None, company=None, email=None, location=None,
name=None):
"""Edit this organization.
:param str billing_email: (optional) Billing email address (private)
:param str company: (optional)
:param str email: (optional) Public email address
:param str location: (optional)
:param str name: (optional)
:returns: bool
"""
json = None
data = {'billing_email': billing_email, 'company': company,
'email': email, 'location': location, 'name': name}
self._remove_none(data)
if data:
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_attributes(json)
return True
return False
def is_member(self, username):
"""Check if the user named ``username`` is a member.
:param str username: name of the user you'd like to check
:returns: bool
"""
url = self._build_url('members', username, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
def is_public_member(self, username):
"""Check if the user named ``username`` is a public member.
:param str username: name of the user you'd like to check
:returns: bool
"""
url = self._build_url('public_members', username, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
def events(self, number=-1, etag=None):
r"""Iterate over events for this org.
:param int number: (optional), number of events to return. Default: -1
iterates over all events available.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Event <github3.events.Event>`\ s
"""
url = self._build_url('events', base_url=self._api)
return self._iter(int(number), url, Event, etag=etag)
def members(self, filter=None, role=None, number=-1, etag=None):
r"""Iterate over members of this organization.
:param str filter: (optional), filter members returned by this method.
Can be one of: ``"2fa_disabled"``, ``"all",``. Default: ``"all"``.
Filtering by ``"2fa_disabled"`` is only available for organization
owners with private repositories.
:param str role: (optional), filter members returned by their role.
Can be one of: ``"all"``, ``"admin"``, ``"member"``. Default:
``"all"``.
:param int number: (optional), number of members to return. Default:
-1 will return all available.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
"""
headers = {}
params = {}
if filter in self.members_filters:
params['filter'] = filter
if role in self.members_roles:
params['role'] = role
headers['Accept'] = 'application/vnd.github.ironman-preview+json'
url = self._build_url('members', base_url=self._api)
return self._iter(int(number), url, User, params=params, etag=etag,
headers=headers)
def public_members(self, number=-1, etag=None):
r"""Iterate over public members of this organization.
:param int number: (optional), number of members to return. Default:
-1 will return all available.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`User <github3.users.User>`\ s
"""
url = self._build_url('public_members', base_url=self._api)
return self._iter(int(number), url, User, etag=etag)
def repositories(self, type='', number=-1, etag=None):
r"""Iterate over repos for this organization.
:param str type: (optional), accepted values:
('all', 'public', 'member', 'private', 'forks', 'sources'), API
default: 'all'
:param int number: (optional), number of members to return. Default:
-1 will return all available.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Repository <github3.repos.Repository>`
"""
url = self._build_url('repos', base_url=self._api)
params = {}
if type in ('all', 'public', 'member', 'private', 'forks', 'sources'):
params['type'] = type
return self._iter(int(number), url, Repository, params, etag)
@requires_auth
def teams(self, number=-1, etag=None):
r"""Iterate over teams that are part of this organization.
:param int number: (optional), number of teams to return. Default: -1
returns all available teams.
:param str etag: (optional), ETag from a previous request to the same
endpoint
:returns: generator of :class:`Team <Team>`\ s
"""
url = self._build_url('teams', base_url=self._api)
return self._iter(int(number), url, Team, etag=etag)
@requires_auth
def publicize_member(self, username):
"""Make ``username``'s membership in this organization public.
:param str username: the name of the user whose membership you wish to
publicize
:returns: bool
"""
url = self._build_url('public_members', username, base_url=self._api)
return self._boolean(self._put(url), 204, 404)
@requires_auth
def remove_member(self, username):
"""Remove the user named ``username`` from this organization.
:param str username: name of the user to remove from the org
:returns: bool
"""
url = self._build_url('members', username, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def remove_repository(self, repository, team_id):
"""Remove ``repository`` from the team with ``team_id``.
:param str repository: (required), form: 'user/repo'
:param int team_id: (required)
:returns: bool
"""
if int(team_id) > 0:
url = self._build_url('teams', str(team_id), 'repos',
str(repository))
return self._boolean(self._delete(url), 204, 404)
return False
@requires_auth
def team(self, team_id):
"""Return the team specified by ``team_id``.
:param int team_id: (required), unique id for the team
:returns: :class:`Team <Team>`
"""
json = None
if int(team_id) > 0:
url = self._build_url('teams', str(team_id))
json = self._json(self._get(url), 200)
return self._instance_or_null(Team, json)
class Membership(GitHubCore):
"""The wrapper for information about Team and Organization memberships."""
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: whether the edit was successful or not
:rtype: bool
"""
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 True
return False