#!/usr/bin/python # -*- coding: utf-8 -*- # # Copyright (C) 2013 Gauvain Pocentek # # 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 . import requests __title__ = 'python-gitlab' __version__ = '0.1' __author__ = 'Gauvain Pocentek' __email__ = 'gauvain@pocentek.net' __license__ = 'LGPL3' __copyright__ = 'Copyright 2013 Gauvain Pocentek' class GitlabConnectionError(Exception): pass class GitlabGetError(Exception): pass class GitlabCreateError(Exception): pass class GitlabUpdateError(Exception): pass class GitlabDeleteError(Exception): pass class GitlabAuthenticationError(Exception): pass class Gitlab(object): def __init__(self, url, private_token=None, email=None, password=None): self.url = '%s/api/v3' % url self.private_token = private_token self.email = email self.password = password def auth(self): 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 = self.get(CurrentUser) return True except: return False def setUrl(self, url): self.url = '%s/api/v3' % url def setToken(self, token): self.private_token = token def setCredentials(self, email, password): 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 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(): 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: url = '%s%s/%d?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): 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 Project(self, id=None): return self.getListOrObject(Project, id) def Group(self, id=None): return self.getListOrObject(Group, id) def Issue(self, id=None): return self.getListOrObject(Issue, id) def User(self, id=None): return self.getListOrObject(User, id) class GitlabObject(object): url = None returnClass = None constructorTypes = None canGet = True canGetList = True canCreate = True canUpdate = True canDelete = True @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): 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__)) class User(GitlabObject): url = '/users' 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): if id is None: return CurrentUserKey.list(self.gitlab) else: return CurrentUserKey(self.gitlab, id) class Group(GitlabObject): url = '/groups' constructorTypes = {'projects': 'Project'} 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 class ProjectCommit(GitlabObject): url = '/projects/%(project_id)d/repository/commits' canGet = False canDelete = False canUpdate = False canCreate = False class ProjectHook(GitlabObject): url = '/projects/%(project_id)d/hooks' class ProjectIssueNote(GitlabObject): url = '/projects/%(project_id)d/issues/%(issue_id)d/notes' constructorTypes = {'author': 'User'} canUpdate = False canDelete = False class ProjectIssue(GitlabObject): url = '/projects/%(project_id)s/issues/' constructorTypes = {'author': 'User', 'assignee': 'User', 'milestone': 'ProjectMilestone'} canDelete = False def Note(self, id=None): return self.getListOrObject(ProjectIssueNote, id, project_id=self.project_id, issue_id=self.id) class ProjectMember(GitlabObject): url = '/projects/%(project_id)d/members' returnClass = User class ProjectNote(GitlabObject): url = '/projects/%(project_id)d/notes' constructorTypes = {'author': 'User'} canUpdate = False canDelete = False 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 def Note(self, id=None): return self.getListOrObject(ProjectMergeRequestNote, id, project_id=self.id, merge_request_id=self.id) class ProjectMilestone(GitlabObject): url = '/projects/%(project_id)s/milestones' canDelete = False class ProjectSnippetNote(GitlabObject): url = '/projects/%(project_id)d/snippets/%(snippet_id)d/notes' constructorTypes = {'author': 'User'} canUpdate = False canDelete = False class ProjectSnippet(GitlabObject): url = '/projects/%(project_id)d/snippets' constructorTypes = {'author': 'User'} def Note(self, id=None): return self.getListOrObject(ProjectSnippetNote, id, project_id=self.project_id, snippet_id=self.id) class Project(GitlabObject): url = '/projects' constructorTypes = {'owner': 'User', 'namespace': 'Group'} canUpdate = False canDelete = False def Branch(self, id=None): return self.getListOrObject(ProjectBranch, id, project_id=self.id) def Commit(self, id=None): return self.getListOrObject(ProjectCommit, id, project_id=self.id) def Hook(self, id=None): return self.getListOrObject(ProjectHook, id, project_id=self.id) def Issue(self, id=None): return self.getListOrObject(ProjectIssue, id, project_id=self.id) def Member(self, id=None): return self.getListOrObject(ProjectMember, id, project_id=self.id) def MergeRequest(self, id=None): return self.getListOrObject(ProjectMergeRequest, id, project_id=self.id) def Milestone(self, id=None): return self.getListOrObject(ProjectMilestone, id, project_id=self.id) def Note(self, id=None): return self.getListOrObject(ProjectNote, id, project_id=self.id) def Snippet(self, id=None): return self.getListOrObject(ProjectSnippet, id, project_id=self.id) def Tag(self, id=None): return self.getListOrObject(ProjectTag, id, project_id=self.id) if __name__ == '__main__': # Quick "doc" # # See https://github.com/gitlabhq/gitlabhq/tree/master/doc/api for the # source # Register a connection to a gitlab instance, using its URL and a user # private token gl = Gitlab('http://192.168.123.107:8080', 'JVNSESs8EwWRx5yDxM5q') # Connect to get the current user (as gl.user) gl.auth() # get a list of projects for p in gl.Project(): print p.name # get associated issues issues = p.Issue() for issue in issues: closed = 0 if not issue.closed else 1 print " %d => %s (closed: %d)" % (issue.id, issue.title, closed) # and close them all issue.closed = 1 issue.save()