forked from python-gitlab/python-gitlab
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgitlab.py
More file actions
707 lines (549 loc) · 21.4 KB
/
gitlab.py
File metadata and controls
707 lines (549 loc) · 21.4 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
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2013 Gauvain Pocentek <gauvain@pocentek.net>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import json
import requests
__title__ = 'python-gitlab'
__version__ = '0.1'
__author__ = 'Gauvain Pocentek'
__email__ = 'gauvain@pocentek.net'
__license__ = 'LGPL3'
__copyright__ = 'Copyright 2013 Gauvain Pocentek'
class jsonEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, GitlabObject):
return obj.__dict__
elif isinstance(obj, Gitlab):
return {'url': obj._url}
return json.JSONEncoder.default(self, obj)
class GitlabConnectionError(Exception):
pass
class GitlabGetError(Exception):
pass
class GitlabCreateError(Exception):
pass
class GitlabUpdateError(Exception):
pass
class GitlabDeleteError(Exception):
pass
class GitlabProtectError(Exception):
pass
class GitlabTransferProjectError(Exception):
pass
class GitlabAuthenticationError(Exception):
pass
class Gitlab(object):
"""Represents a GitLab server connection"""
def __init__(self, url, private_token=None, email=None, password=None):
"""Stores informations about the server
url: the URL of the Gitlab server
private_token: the user private token
email: the user email/login
password: the user password (associated with email)
"""
self._url = '%s/api/v3' % url
self.private_token = private_token
self.email = email
self.password = password
def auth(self):
"""Performs an authentication using either the private token, or the
email/password pair.
The user attribute will hold a CurrentUser object on success.
"""
r = False
if self.private_token:
r = self.token_auth()
if not r:
self.credentials_auth()
def credentials_auth(self):
if not self.email or not self.password:
raise GitlabAuthenticationError("Missing email/password")
r = self.rawPost('/session',
{'email': self.email, 'password': self.password})
if r.status_code == 201:
self.user = CurrentUser(self, r.json())
else:
raise GitlabAuthenticationError(r.json()['message'])
self.private_token = self.user.private_token
def token_auth(self):
try:
self.user = CurrentUser(self)
return True
except:
return False
def setUrl(self, url):
"""Updates the gitlab URL"""
self._url = '%s/api/v3' % url
def setToken(self, token):
"""Sets the private token for authentication"""
self.private_token = token
def setCredentials(self, email, password):
"""Sets the email/login and password for authentication"""
self.email = email
self.password = password
def rawPost(self, path, data):
url = '%s%s' % (self._url, path)
try:
r = requests.post(url, data)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
return r
def rawPut(self, path, with_token=False):
url = '%s%s' % (self._url, path)
if with_token:
url += "?private_token=%s" % self.private_token
try:
r = requests.put(url)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
return r
def list(self, obj_class, **kwargs):
url = obj_class._url
if kwargs:
url = obj_class._url % kwargs
url = '%s%s?private_token=%s' % (self._url, url, self.private_token)
if kwargs:
url += "&%s" % ("&".join(
["%s=%s" % (k, v) for k, v in kwargs.items()]))
try:
r = requests.get(url)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
if r.status_code == 200:
cls = obj_class
if obj_class._returnClass:
cls = obj_class._returnClass
l = [cls(self, item) for item in r.json()]
if kwargs:
for k, v in kwargs.items():
if k in ('page', 'per_page'):
continue
for obj in l:
obj.__dict__[k] = v
return l
elif r.status_code == 401:
raise GitlabAuthenticationError(r.json()['message'])
else:
raise GitlabGetError('%d: %s' % (r.status_code, r.text))
def get(self, obj_class, id=None, **kwargs):
url = obj_class._url
if kwargs:
url = obj_class._url % kwargs
if id is not None:
try:
url = '%s%s/%d?private_token=%s' % \
(self._url, url, id, self.private_token)
except TypeError: # id might be a str (ProjectBranch)
url = '%s%s/%s?private_token=%s' % \
(self._url, url, id, self.private_token)
else:
url = '%s%s?private_token=%s' % \
(self._url, url, self.private_token)
try:
r = requests.get(url)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
if r.status_code == 200:
return r.json()
elif r.status_code == 401:
raise GitlabAuthenticationError(r.json()['message'])
else:
raise GitlabGetError('%d: %s' % (r.status_code, r.text))
def delete(self, obj):
url = obj._url % obj.__dict__
url = '%s%s/%d?private_token=%s' % \
(self._url, url, obj.id, self.private_token)
try:
r = requests.delete(url)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
if r.status_code == 200:
return True
elif r.status_code == 401:
raise GitlabAuthenticationError(r.json()['message'])
return False
def create(self, obj):
missing = []
for k in obj.requiredCreateAttrs:
if k not in obj.__dict__:
missing.append (k)
if missing:
raise GitlabCreateError('Missing attribute(s): %s' % \
", ".join(missing))
url = obj._url % obj.__dict__
url = '%s%s?private_token=%s' % (self._url, url, self.private_token)
try:
# TODO: avoid too much work on the server side by filtering the
# __dict__ keys
r = requests.post(url, obj.__dict__)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
if r.status_code == 201:
return r.json()
elif r.status_code == 401:
raise GitlabAuthenticationError(r.json()['message'])
else:
raise GitlabCreateError('%d: %s' % (r.status_code, r.text))
def update(self, obj):
url = obj._url % obj.__dict__
url = '%s%s/%d?private_token=%s' % \
(self._url, url, obj.id, self.private_token)
# build a dict of data that can really be sent to server
d = {}
for k, v in obj.__dict__.items():
if type(v) in (int, str, unicode, bool):
d[k] = v
try:
r = requests.put(url, d)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
if r.status_code == 200:
return r.json()
elif r.status_code == 401:
raise GitlabAuthenticationError(r.json()['message'])
else:
raise GitlabUpdateError('%d: %s' % (r.status_code, r.text))
def _getListOrObject(self, cls, id, **kwargs):
if id is None:
return cls.list(self, **kwargs)
else:
return cls(self, id, **kwargs)
def Hook(self, id=None, **kwargs):
"""Creates/tests/lists system hook(s) known by the GitLab server.
If id is None, returns a list of hooks.
If id is an integer, test the matching hook.
If id is a dict, create a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return self._getListOrObject(Hook, id, **kwargs)
def Project(self, id=None, **kwargs):
"""Creates/gets/lists project(s) known by the GitLab server.
If id is None, returns a list of projects.
If id is an integer, returns the matching project (or raise a
GitlabGetError if not found)
If id is a dict, create a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return self._getListOrObject(Project, id, **kwargs)
def Group(self, id=None, **kwargs):
"""Creates/gets/lists groups(s) known by the GitLab server.
If id is None, returns a list of projects.
If id is an integer, returns the matching project (or raise a
GitlabGetError if not found)
If id is a dict, create a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return self._getListOrObject(Group, id, **kwargs)
def Issue(self, id=None, **kwargs):
"""Lists issues(s) known by the GitLab server."""
return self._getListOrObject(Issue, id, **kwargs)
def User(self, id=None, **kwargs):
"""Creates/gets/lists users(s) known by the GitLab server.
If id is None, returns a list of projects.
If id is an integer, returns the matching project (or raise a
GitlabGetError if not found)
If id is a dict, create a new object using attributes provided. The
object is NOT saved on the server. Use the save() method on the object
to write it on the server.
"""
return self._getListOrObject(User, id, **kwargs)
class GitlabObject(object):
_url = None
_returnClass = None
_constructorTypes = None
canGet = True
canGetList = True
canCreate = True
canUpdate = True
canDelete = True
requiredCreateAttrs = []
optionalCreateAttrs = []
@classmethod
def list(cls, gl, **kwargs):
if not cls.canGetList:
raise NotImplementedError
if not cls._url:
raise NotImplementedError
return gl.list(cls, **kwargs)
def _getListOrObject(self, cls, id, **kwargs):
if id is None:
if not cls.canGetList:
raise GitlabGetError
return cls.list(self.gitlab, **kwargs)
else:
if not cls.canGet:
raise GitlabGetError
return cls(self.gitlab, id, **kwargs)
def _getObject(self, k, v):
if self._constructorTypes and k in self._constructorTypes:
return globals()[self._constructorTypes[k]](self.gitlab, v)
else:
return v
def _setFromDict(self, data):
for k, v in data.items():
if isinstance(v, list):
self.__dict__[k] = []
for i in v:
self.__dict__[k].append(self._getObject(k, i))
elif v:
self.__dict__[k] = self._getObject(k, v)
else: # None object
self.__dict__[k] = None
def _create(self):
if not self.canCreate:
raise NotImplementedError
json = self.gitlab.create(self)
self._setFromDict(json)
def _update(self):
if not self.canUpdate:
raise NotImplementedError
json = self.gitlab.update(self)
self._setFromDict(json)
def save(self):
if hasattr(self, 'id'):
self._update()
else:
self._create()
def delete(self):
if not self.canDelete:
raise NotImplementedError
if not hasattr(self, 'id'):
raise GitlabDeleteError
return self.gitlab.delete(self)
def __init__(self, gl, data=None, **kwargs):
self.gitlab = gl
if data is None or isinstance(data, int) or isinstance(data, str):
data = self.gitlab.get(self.__class__, data, **kwargs)
self._setFromDict(data)
if kwargs:
for k, v in kwargs.items():
self.__dict__[k] = v
def __str__(self):
return '%s => %s' % (type(self), str(self.__dict__))
def json(self):
return json.dumps(self.__dict__, cls=jsonEncoder)
class User(GitlabObject):
_url = '/users'
requiredCreateAttrs = ['email', 'password', 'username', 'name']
optionalCreateAttrs = ['skype', 'linkedin', 'twitter', 'projects_limit',
'extern_uid', 'provider', 'bio']
class CurrentUserKey(GitlabObject):
_url = '/user/keys'
canUpdate = False
class CurrentUser(GitlabObject):
_url = '/user'
canGetList = False
canCreate = False
canUpdate = False
canDelete = False
def Key(self, id=None, **kwargs):
if id is None:
return CurrentUserKey.list(self.gitlab, **kwargs)
else:
return CurrentUserKey(self.gitlab, id)
class Group(GitlabObject):
_url = '/groups'
_constructorTypes = {'projects': 'Project'}
requiredCreateAttrs = ['name', 'path']
def transfer_project(self, id):
url = '/groups/%d/projects/%d?private_token=%s' % \
(self.id, id, self.gitlab.private_token)
r = self.gitlab.rawPost(url, None)
if r.status_code != 201:
raise GitlabTransferProjectError()
class Hook(GitlabObject):
_url = '/hooks'
requiredCreateAttrs = ['url']
class Issue(GitlabObject):
_url = '/issues'
_constructorTypes = {'author': 'User', 'assignee': 'User',
'milestone': 'ProjectMilestone'}
canGet = False
canDelete = False
canUpdate = False
canCreate = False
class ProjectBranch(GitlabObject):
_url = '/projects/%(project_id)d/repository/branches'
canDelete = False
canUpdate = False
canCreate = False
def protect(self, protect=True):
url = self._url % {'project_id': self.project_id}
if protect:
url = "%s/%s/protect" % (url, self.name)
else:
url = "%s/%s/unprotect" % (url, self.name)
r = self.gitlab.rawPut(url, True)
if r.status_code == 200:
if protect:
self.protected = protect
else:
del self.protected
else:
raise GitlabProtectError
def unprotect(self):
self.protect(False)
class ProjectCommit(GitlabObject):
_url = '/projects/%(project_id)d/repository/commits'
canGet = False
canDelete = False
canUpdate = False
canCreate = False
class ProjectKey(GitlabObject):
_url = '/projects/%(project_id)d/keys'
canUpdate = False
requiredCreateAttrs = ['title', 'key']
class ProjectHook(GitlabObject):
_url = '/projects/%(project_id)d/hooks'
requiredCreateAttrs = ['url']
class ProjectIssueNote(GitlabObject):
_url = '/projects/%(project_id)d/issues/%(issue_id)d/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredCreateAttrs = ['body']
class ProjectIssue(GitlabObject):
_url = '/projects/%(project_id)s/issues/'
_constructorTypes = {'author': 'User', 'assignee': 'User',
'milestone': 'ProjectMilestone'}
canDelete = False
requiredCreateAttrs = ['title']
optionalCreateAttrs = ['description', 'assignee_id', 'milestone_id',
'labels']
def Note(self, id=None, **kwargs):
return self._getListOrObject(ProjectIssueNote, id,
project_id=self.project_id,
issue_id=self.id,
**kwargs)
class ProjectMember(GitlabObject):
_url = '/projects/%(project_id)d/members'
_returnClass = User
requiredCreateAttrs = ['user_id', 'access_level']
class ProjectNote(GitlabObject):
_url = '/projects/%(project_id)d/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredCreateAttrs = ['body']
class ProjectTag(GitlabObject):
_url = '/projects/%(project_id)d/repository/tags'
canGet = False
canDelete = False
canUpdate = False
canCreate = False
class ProjectMergeRequestNote(GitlabObject):
_url = '/projects/%(project_id)d/merge_requests/%(merge_request_id)d/notes'
_constructorTypes = {'author': 'User'}
canGet = False
canCreate = False
canUpdate = False
canDelete = False
class ProjectMergeRequest(GitlabObject):
_url = '/projects/%(project_id)d/merge_request'
_constructorTypes = {'author': 'User', 'assignee': 'User'}
canDelete = False
requiredCreateAttrs = ['source_branch', 'target_branch', 'title']
optionalCreateAttrs = ['assignee_id']
def Note(self, id=None, **kwargs):
return self._getListOrObject(ProjectMergeRequestNote, id,
project_id=self.id,
merge_request_id=self.id,
**kwargs)
class ProjectMilestone(GitlabObject):
_url = '/projects/%(project_id)s/milestones'
canDelete = False
requiredCreateAttrs = ['title']
optionalCreateAttrs = ['description', 'due_date']
class ProjectSnippetNote(GitlabObject):
_url = '/projects/%(project_id)d/snippets/%(snippet_id)d/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredCreateAttrs = ['body']
class ProjectSnippet(GitlabObject):
_url = '/projects/%(project_id)d/snippets'
_constructorTypes = {'author': 'User'}
requiredCreateAttrs = ['title', 'file_name', 'code']
optionalCreateAttrs = ['lifetime']
def Note(self, id=None, **kwargs):
return self._getListOrObject(ProjectSnippetNote, id,
project_id=self.project_id,
snippet_id=self.id,
**kwargs)
class Project(GitlabObject):
_url = '/projects'
_constructorTypes = {'owner': 'User', 'namespace': 'Group'}
canUpdate = False
canDelete = False
requiredCreateAttrs = ['name']
optionalCreateAttrs = ['default_branch', 'issues_enabled', 'wall_enabled',
'merge_requests_enabled', 'wiki_enabled',
'namespace_id']
def Branch(self, id=None, **kwargs):
return self._getListOrObject(ProjectBranch, id,
project_id=self.id,
**kwargs)
def Commit(self, id=None, **kwargs):
return self._getListOrObject(ProjectCommit, id,
project_id=self.id,
**kwargs)
def Hook(self, id=None, **kwargs):
return self._getListOrObject(ProjectHook, id,
project_id=self.id,
**kwargs)
def Key(self, id=None, **kwargs):
return self._getListOrObject(ProjectKey, id,
project_id=self.id,
**kwargs)
def Issue(self, id=None, **kwargs):
return self._getListOrObject(ProjectIssue, id,
project_id=self.id,
**kwargs)
def Member(self, id=None, **kwargs):
return self._getListOrObject(ProjectMember, id,
project_id=self.id,
**kwargs)
def MergeRequest(self, id=None, **kwargs):
return self._getListOrObject(ProjectMergeRequest, id,
project_id=self.id,
**kwargs)
def Milestone(self, id=None, **kwargs):
return self._getListOrObject(ProjectMilestone, id,
project_id=self.id,
**kwargs)
def Note(self, id=None, **kwargs):
return self._getListOrObject(ProjectNote, id,
project_id=self.id,
**kwargs)
def Snippet(self, id=None, **kwargs):
return self._getListOrObject(ProjectSnippet, id,
project_id=self.id,
**kwargs)
def Tag(self, id=None, **kwargs):
return self._getListOrObject(ProjectTag, id,
project_id=self.id,
**kwargs)