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
1208 lines (965 loc) · 38.9 KB
/
gitlab.py
File metadata and controls
1208 lines (965 loc) · 38.9 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
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
#
# Copyright (C) 2013-2014 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/>.
from __future__ import print_function, division, absolute_import
import six
import json
import requests
import sys
from itertools import chain
__title__ = 'python-gitlab'
__version__ = '0.8'
__author__ = 'Gauvain Pocentek'
__email__ = 'gauvain@pocentek.net'
__license__ = 'LGPL3'
__copyright__ = 'Copyright 2013-2014 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 GitlabListError(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, ssl_verify=True, timeout=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)
ssl_verify: (Passed to requests-library)
timeout: (Passed to requests-library). Timeout to use for requests to
gitlab server. Float or tuple(Float,Float).
"""
self._url = '%s/api/v3' % url
self.timeout = timeout
self.setToken(private_token)
self.email = email
self.password = password
self.ssl_verify = ssl_verify
# Gitlab should handle UTF-8
self.gitlab_encoding = 'UTF-8'
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.
"""
if self.private_token:
self.token_auth()
else:
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.setToken(self.user.private_token)
def token_auth(self):
self.user = CurrentUser(self)
def setUrl(self, url):
"""Updates the gitlab URL"""
self._url = '%s/api/v3' % url
def constructUrl(self, id_, obj, parameters):
args = _sanitize_dict(parameters)
url = obj._url % args
if id_ is not None:
url = '%s%s/%s' % (self._url, url, str(id_))
else:
url = '%s%s' % (self._url, url)
return url
def setToken(self, token):
"""Sets the private token for authentication"""
self.private_token = token if token else None
self.headers = {"PRIVATE-TOKEN": token} if token else None
def setCredentials(self, email, password):
"""Sets the email/login and password for authentication"""
self.email = email
self.password = password
def rawGet(self, path, **kwargs):
url = '%s%s' % (self._url, path)
if kwargs:
url += "?%s" % ("&".join(
["%s=%s" % (k, v) for k, v in kwargs.items()]))
try:
return requests.get(url,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def rawPost(self, path, data=None):
url = '%s%s' % (self._url, path)
try:
return requests.post(url, data,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def rawPut(self, path):
url = '%s%s' % (self._url, path)
try:
return requests.put(url,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def rawDelete(self, path):
url = '%s%s' % (self._url, path)
try:
return requests.delete(url,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
except:
raise GitlabConnectionError(
"Can't connect to GitLab server (%s)" % self._url)
def list(self, obj_class, **kwargs):
missing = []
for k in chain(obj_class.requiredUrlAttrs,
obj_class.requiredListAttrs):
if k not in kwargs:
missing.append(k)
if missing:
raise GitlabListError('Missing attribute(s): %s' %
", ".join(missing))
url = self.constructUrl(id_=None, obj=obj_class, parameters=kwargs)
# Remove attributes that are used in url so that there is only
# url-parameters left
params = kwargs.copy()
for attribute in obj_class.requiredUrlAttrs:
del params[attribute]
try:
r = requests.get(url, params=kwargs, headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
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
cls_kwargs = kwargs.copy()
# Add _created manually, because we are not creating objects
# through normal path
cls_kwargs['_created'] = True
# Remove parameters from kwargs before passing it to constructor
for key in ['page', 'per_page']:
if key in cls_kwargs:
del cls_kwargs[key]
return [cls(self, item, **cls_kwargs) for item in r.json() if item is not None]
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):
missing = []
for k in chain(obj_class.requiredUrlAttrs,
obj_class.requiredGetAttrs):
if k not in kwargs:
missing.append(k)
if missing:
raise GitlabGetError('Missing attribute(s): %s' %
", ".join(missing))
url = self.constructUrl(id_=id, obj=obj_class, parameters=kwargs)
# Remove attributes that are used in url so that there is only
# url-parameters left
params = kwargs.copy()
for attribute in obj_class.requiredUrlAttrs:
del params[attribute]
try:
r = requests.get(url, params=params, headers=self.headers,
verify=self.ssl_verify, timeout=self.timeout)
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'])
elif r.status_code == 404:
raise GitlabGetError("Object doesn't exist")
else:
raise GitlabGetError('%d: %s' % (r.status_code, r.text))
def delete(self, obj):
params = obj.__dict__.copy()
missing = []
for k in chain(obj.requiredUrlAttrs, obj.requiredDeleteAttrs):
if k not in params:
missing.append(k)
if missing:
raise GitlabDeleteError('Missing attribute(s): %s' %
", ".join(missing))
url = self.constructUrl(id_=obj.id, obj=obj, parameters=params)
# Remove attributes that are used in url so that there is only
# url-parameters left
for attribute in obj.requiredUrlAttrs:
del params[attribute]
try:
r = requests.delete(url,
params=params,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
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'])
else:
raise GitlabDeleteError(r.json()['message'])
return False
def create(self, obj):
missing = []
for k in chain(obj.requiredUrlAttrs, obj.requiredCreateAttrs):
if k not in obj.__dict__:
missing.append(k)
if missing:
raise GitlabCreateError('Missing attribute(s): %s' %
", ".join(missing))
url = self.constructUrl(id_=None, obj=obj, parameters=obj.__dict__)
for k, v in list(obj.__dict__.items()):
if type(v) == bool:
obj.__dict__[k] = 1 if v else 0
try:
r = requests.post(url, obj.__dict__,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
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):
missing = []
for k in chain(obj.requiredUrlAttrs, obj.requiredCreateAttrs):
if k not in obj.__dict__:
missing.append(k)
if missing:
raise GitlabUpdateError('Missing attribute(s): %s' %
", ".join(missing))
url = self.constructUrl(id_=obj.id, obj=obj, parameters=obj.__dict__)
# build a dict of data that can really be sent to server
d = {}
for k, v in list(obj.__dict__.items()):
if type(v) in (int, str):
d[k] = str(v)
elif type(v) == bool:
d[k] = 1 if v else 0
elif six.PY2 and type(v) == six.text_type:
d[k] = str(v.encode(self.gitlab_encoding, "replace"))
try:
r = requests.put(url, d,
headers=self.headers,
verify=self.ssl_verify,
timeout=self.timeout)
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, tests the matching hook.
If id is a dict, creates 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 raises a
GitlabGetError if not found)
If id is a dict, creates 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 UserProject(self, id=None, **kwargs):
"""Creates a project for a user.
id must be a dict.
"""
return self._getListOrObject(UserProject, id, **kwargs)
def _list_projects(self, url, **kwargs):
r = self.rawGet(url, **kwargs)
if r.status_code != 200:
raise GitlabListError
l = []
for o in r.json():
l.append(Project(self, o))
return l
def search_projects(self, query):
"""Searches projects by name.
Returns a list of matching projects.
"""
return self._list_projects("/projects/search/" + query)
def all_projects(self, page=None, per_page=None):
"""Lists all the projects (need admin rights)."""
d = {}
if page is not None:
d['page'] = page
if per_page is not None:
d['per_page'] = per_page
return self._list_projects("/projects/all", **d)
def owned_projects(self, page=None, per_page=None):
"""Lists owned projects."""
d = {}
if page is not None:
d['page'] = page
if per_page is not None:
d['per_page'] = per_page
return self._list_projects("/projects/owned", **d)
def Group(self, id=None, **kwargs):
"""Creates/gets/lists group(s) known by the GitLab server.
If id is None, returns a list of groups.
If id is an integer, returns the matching group (or raises a
GitlabGetError if not found)
If id is a dict, creates 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.
Does not support creation or getting a single issue unlike other
methods in this class yet.
"""
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 users.
If id is an integer, returns the matching user (or raises a
GitlabGetError if not found)
If id is a dict, creates 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)
def Team(self, id=None, **kwargs):
"""Creates/gets/lists team(s) known by the GitLab server.
If id is None, returns a list of teams.
If id is an integer, returns the matching team (or raises 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(Team, id, **kwargs)
def _get_display_encoding():
return sys.stdout.encoding or sys.getdefaultencoding()
def _sanitize(value):
if isinstance(value, six.string_types):
return value.replace('/', '%2F')
return value
def _sanitize_dict(src):
return dict((k, _sanitize(v)) for k, v in src.items())
class GitlabObject(object):
_url = None
_returnClass = None
_constructorTypes = None
# Tells if _getListOrObject should return list or object when id is None
getListWhenNoId = True
canGet = True
canList = True
canCreate = True
canUpdate = True
canDelete = True
requiredUrlAttrs = []
requiredListAttrs = []
requiredGetAttrs = []
requiredDeleteAttrs = []
requiredCreateAttrs = []
optionalCreateAttrs = []
idAttr = 'id'
shortPrintAttr = None
@classmethod
def list(cls, gl, **kwargs):
if not cls.canList:
raise NotImplementedError
if not cls._url:
raise NotImplementedError
return gl.list(cls, **kwargs)
def _getListOrObject(self, cls, id, **kwargs):
if id is None and cls.getListWhenNoId:
if not cls.canList:
raise GitlabListError
return cls.list(self.gitlab, **kwargs)
elif id is None and not cls.getListWhenNoId:
if not cls.canGet:
raise GitlabGetError
return cls(self.gitlab, id, **kwargs)
elif isinstance(id, dict):
if not cls.canCreate:
raise GitlabCreateError
return cls(self.gitlab, id, **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 is None:
self.__dict__[k] = None
else:
self.__dict__[k] = self._getObject(k, v)
def _create(self):
if not self.canCreate:
raise NotImplementedError
json = self.gitlab.create(self)
self._setFromDict(json)
self._created = True
def _update(self):
if not self.canUpdate:
raise NotImplementedError
json = self.gitlab.update(self)
self._setFromDict(json)
def save(self):
if self._created:
self._update()
else:
self._create()
def delete(self):
if not self.canDelete:
raise NotImplementedError
if not self._created:
raise GitlabDeleteError
return self.gitlab.delete(self)
def __init__(self, gl, data=None, **kwargs):
self._created = False
self.gitlab = gl
if data is None or isinstance(data, six.integer_types) or\
isinstance(data, six.string_types):
data = self.gitlab.get(self.__class__, data, **kwargs)
# Object is created because we got it from api
self._created = True
self._setFromDict(data)
if kwargs:
for k, v in kwargs.items():
self.__dict__[k] = v
# Special handling for api-objects that don't have id-number in api
# responses. Currently only Labels and Files
if not hasattr(self, "id"):
self.id = None
def __str__(self):
return '%s => %s' % (type(self), str(self.__dict__))
def display(self, pretty):
if pretty:
self.pretty_print()
else:
self.short_print()
def short_print(self, depth=0):
id = self.__dict__[self.idAttr]
print("%s%s: %s" % (" " * depth * 2, self.idAttr, id))
if self.shortPrintAttr:
print("%s%s: %s" % (" " * depth * 2,
self.shortPrintAttr.replace('_', '-'),
self.__dict__[self.shortPrintAttr]))
@staticmethod
def _obj_to_str(obj):
if isinstance(obj, dict):
s = ", ".join(["%s: %s" %
(x, GitlabObject._obj_to_str(y))
for (x, y) in obj.items()])
return "{ %s }" % s
elif isinstance(obj, list):
s = ", ".join([GitlabObject._obj_to_str(x) for x in obj])
return "[ %s ]" % s
elif six.PY2 and isinstance(obj, six.text_type):
return obj.encode(_get_display_encoding(), "replace")
else:
return str(obj)
def pretty_print(self, depth=0):
id = self.__dict__[self.idAttr]
print("%s%s: %s" % (" " * depth * 2, self.idAttr, id))
for k in sorted(self.__dict__.keys()):
if k == self.idAttr or k == 'id':
continue
if k[0] == '_':
continue
v = self.__dict__[k]
pretty_k = k.replace('_', '-')
if six.PY2:
pretty_k = pretty_k.encode(_get_display_encoding(), "replace")
if isinstance(v, GitlabObject):
if depth == 0:
print("%s:" % pretty_k)
v.pretty_print(1)
else:
print("%s: %s" % (pretty_k, v.id))
else:
if isinstance(v, Gitlab):
continue
v = GitlabObject._obj_to_str(v)
print("%s%s: %s" % (" " * depth * 2, pretty_k, v))
def json(self):
return json.dumps(self.__dict__, cls=jsonEncoder)
class UserKey(GitlabObject):
_url = '/users/%(user_id)s/keys'
canGet = False
canUpdate = False
requiredUrlAttrs = ['user_id']
requiredCreateAttrs = ['title', 'key']
class User(GitlabObject):
_url = '/users'
shortPrintAttr = 'username'
# FIXME: password is required for create but not for update
requiredCreateAttrs = ['email', 'username', 'name']
optionalCreateAttrs = ['password', 'skype', 'linkedin', 'twitter',
'projects_limit', 'extern_uid', 'provider',
'bio', 'admin', 'can_create_group', 'website_url']
def Key(self, id=None, **kwargs):
return self._getListOrObject(UserKey, id,
user_id=self.id,
**kwargs)
class CurrentUserKey(GitlabObject):
_url = '/user/keys'
canUpdate = False
shortPrintAttr = 'title'
requiredCreateAttrs = ['title', 'key']
class CurrentUser(GitlabObject):
_url = '/user'
canList = False
canCreate = False
canUpdate = False
canDelete = False
shortPrintAttr = 'username'
def Key(self, id=None, **kwargs):
return self._getListOrObject(CurrentUserKey, id, **kwargs)
class GroupMember(GitlabObject):
_url = '/groups/%(group_id)s/members'
canGet = False
canUpdate = False
requiredUrlAttrs = ['group_id']
requiredCreateAttrs = ['access_level', 'user_id']
shortPrintAttr = 'username'
class Group(GitlabObject):
_url = '/groups'
canUpdate = False
_constructorTypes = {'projects': 'Project'}
requiredCreateAttrs = ['name', 'path']
shortPrintAttr = 'name'
GUEST_ACCESS = 10
REPORTER_ACCESS = 20
DEVELOPER_ACCESS = 30
MASTER_ACCESS = 40
OWNER_ACCESS = 50
def Member(self, id=None, **kwargs):
return self._getListOrObject(GroupMember, id,
group_id=self.id,
**kwargs)
def transfer_project(self, id):
url = '/groups/%d/projects/%d' % (self.id, id)
r = self.gitlab.rawPost(url, None)
if r.status_code != 201:
raise GitlabTransferProjectError()
class Hook(GitlabObject):
_url = '/hooks'
canUpdate = False
requiredCreateAttrs = ['url']
shortPrintAttr = 'url'
class Issue(GitlabObject):
_url = '/issues'
_constructorTypes = {'author': 'User', 'assignee': 'User',
'milestone': 'ProjectMilestone'}
canGet = False
canDelete = False
canUpdate = False
canCreate = False
shortPrintAttr = 'title'
class ProjectBranch(GitlabObject):
_url = '/projects/%(project_id)s/repository/branches'
_constructorTypes = {'author': 'User', "committer": "User"}
idAttr = 'name'
canUpdate = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['branch_name', 'ref']
_constructorTypes = {'commit': 'ProjectCommit'}
def protect(self, protect=True):
url = self._url % {'project_id': self.project_id}
action = 'protect' if protect else 'unprotect'
url = "%s/%s/%s" % (url, self.name, action)
r = self.gitlab.rawPut(url)
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)s/repository/commits'
canDelete = False
canUpdate = False
canCreate = False
requiredUrlAttrs = ['project_id']
shortPrintAttr = 'title'
def diff(self):
url = ('/projects/%(project_id)s/repository/commits/%(commit_id)s/diff'
% {'project_id': self.project_id, 'commit_id': self.id})
r = self.gitlab.rawGet(url)
if r.status_code == 200:
return r.json()
raise GitlabGetError
def blob(self, filepath):
url = '/projects/%(project_id)s/repository/blobs/%(commit_id)s' % \
{'project_id': self.project_id, 'commit_id': self.id}
url += '?filepath=%s' % filepath
r = self.gitlab.rawGet(url)
if r.status_code == 200:
return r.content
raise GitlabGetError
class ProjectKey(GitlabObject):
_url = '/projects/%(project_id)s/keys'
canUpdate = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['title', 'key']
class ProjectEvent(GitlabObject):
_url = '/projects/%(project_id)s/events'
canGet = False
canDelete = False
canUpdate = False
canCreate = False
requiredUrlAttrs = ['project_id']
shortPrintAttr = 'target_title'
class ProjectHook(GitlabObject):
_url = '/projects/%(project_id)s/hooks'
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['url']
optionalCreateAttrs = ['push_events', 'issues_events',
'merge_requests_events', 'tag_push_events']
shortPrintAttr = 'url'
class ProjectIssueNote(GitlabObject):
_url = '/projects/%(project_id)s/issues/%(issue_id)s/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredUrlAttrs = ['project_id', 'issue_id']
requiredCreateAttrs = ['body']
class ProjectIssue(GitlabObject):
_url = '/projects/%(project_id)s/issues/'
_constructorTypes = {'author': 'User', 'assignee': 'User',
'milestone': 'ProjectMilestone'}
canDelete = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['title']
optionalCreateAttrs = ['description', 'assignee_id', 'milestone_id',
'labels']
shortPrintAttr = 'title'
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)s/members'
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['access_level', 'user_id']
shortPrintAttr = 'username'
class ProjectNote(GitlabObject):
_url = '/projects/%(project_id)s/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['body']
class ProjectTag(GitlabObject):
_url = '/projects/%(project_id)s/repository/tags'
idAttr = 'name'
canGet = False
canDelete = False
canUpdate = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['tag_name', 'ref']
optionalCreateattrs = ['message']
shortPrintAttr = 'name'
class ProjectMergeRequestNote(GitlabObject):
_url = '/projects/%(project_id)s/merge_requests/%(merge_request_id)s/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredUrlAttrs = ['project_id', 'merge_request_id']
requiredCreateAttrs = ['body']
class ProjectMergeRequest(GitlabObject):
_url = '/projects/%(project_id)s/merge_requests'
_constructorTypes = {'author': 'User', 'assignee': 'User'}
canDelete = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['source_branch', 'target_branch', 'title']
optionalCreateAttrs = ['assignee_id']
def Note(self, id=None, **kwargs):
return self._getListOrObject(ProjectMergeRequestNote, id,
project_id=self.project_id,
merge_request_id=self.id,
**kwargs)
class ProjectMilestone(GitlabObject):
_url = '/projects/%(project_id)s/milestones'
canDelete = False
requiredUrlAttrs = ['project_id']
requiredCreateAttrs = ['title']
optionalCreateAttrs = ['description', 'due_date', 'state_event']
shortPrintAttr = 'title'
class ProjectLabel(GitlabObject):
_url = '/projects/%(project_id)s/labels'
requiredUrlAttrs = ['project_id']
idAttr = 'name'
requiredDeleteAttrs = ['name']
requiredCreateAttrs = ['name', 'color']
# FIXME: new_name is only valid with update
optionalCreateAttrs = ['new_name']
class ProjectFile(GitlabObject):
_url = '/projects/%(project_id)s/repository/files'
canList = False
requiredUrlAttrs = ['project_id']
requiredGetAttrs = ['file_path', 'ref']
requiredCreateAttrs = ['file_path', 'branch_name', 'content',
'commit_message']
optionalCreateAttrs = ['encoding']
requiredDeleteAttrs = ['branch_name', 'commit_message']
getListWhenNoId = False
shortPrintAttr = 'name'
class ProjectSnippetNote(GitlabObject):
_url = '/projects/%(project_id)s/snippets/%(snippet_id)s/notes'
_constructorTypes = {'author': 'User'}
canUpdate = False
canDelete = False
requiredUrlAttrs = ['project_id', 'snippet_id']
requiredCreateAttrs = ['body']