initial import

4 files changed, 476 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0d20b64
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..65c5ca8
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..534b959
--- /dev/null
+++ b/TODO
@@ -0,0 +1,4 @@
+- better error checking
+- documentation
+- implement some missing methods
+
diff --git a/gitlab.py b/gitlab.py
new file mode 100644
index 0000000..7d3100e
--- /dev/null
+++ b/gitlab.py
@@ -0,0 +1,306 @@
+#!/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 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import requests
+
+class GitlabConnectionError(Exception):
+    pass
+
+class GitlabGetError(Exception):
+    pass
+
+class GitlabCreateError(Exception):
+    pass
+
+class GitlabUpdateError(Exception):
+    pass
+
+class Gitlab(object):
+    def __init__(self, url, private_token):
+        self.url = '%s/api/v3'%url
+        self.private_token = private_token
+
+    def list(self, objClass, **kwargs):
+        url = objClass.url
+        if kwargs:
+            url = objClass.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 = objClass
+            if objClass.returnClass:
+                cls = objClass.returnClass
+            return [cls(item) for item in r.json]
+        else:
+            raise GitlabGetError('%d: %s'%(r.status_code, r.text))
+
+    def get(self, objClass, id, **kwargs):
+        url = objClass.url
+        if kwargs:
+            url = objClass.url % kwargs
+        url = '%s%s/%d?private_token=%s'%(self.url, url, id, 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:
+            cls = objClass
+            if objClass.returnClass:
+                cls = objClass.returnClass
+
+            return cls(r.json)
+        else:
+            raise GitlabGetError('%d: %s'%(r.status_code, r.text))
+
+    def delete(self, objClass, id, **kwargs):
+        # FIXME: not working for project members, gitlab bug or not?
+        url = objClass.url
+        if kwargs:
+            url = objClass.url % kwargs
+        url = '%s%s/%d?private_token=%s'%(self.url, url, 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
+        return False
+
+    def create(self, objClass, objData, **kwargs):
+        url = objClass.url
+        if kwargs:
+            url = objClass.url % kwargs
+        url = '%s%s?private_token=%s'%(self.url, url, self.private_token)
+
+        try:
+            r = requests.post(url, objData)
+        except:
+            raise GitlabConnectionError('Can\'t connect to GitLab server (%s)'%self.url)
+
+        if r.status_code == 201:
+            cls = objClass
+            if objClass.returnClass:
+                cls = objClass.returnClass
+
+            return cls(r.json)
+        else:
+            raise GitlabCreateError('%d: %s'%(r.status_code, r.text))
+
+    def update(self, objClass, id, objData, **kwargs):
+        url = objClass.url
+        if kwargs:
+            url = objClass.url % kwargs
+        url = '%s%s/%d?private_token=%s'%(self.url, url, id, self.private_token)
+
+        try:
+            r = requests.put(url, objData)
+        except:
+            raise GitlabConnectionError('Can\'t connect to GitLab server (%s)'%self.url)
+
+        if r.status_code == 200:
+            cls = objClass
+            if objClass.returnClass:
+                cls = objClass.returnClass
+
+            return cls(r.json)
+        else:
+            raise GitlabUpdateError('%d: %s'%(r.status_code, r.text))
+
+
+class GitlabObject(object):
+    url = None
+    returnClass = None
+    constructorTypes = None
+    canGet = True
+    canGetList = True
+    canCreate = True
+    canUpdate = True
+    canDelete = True
+
+    @classmethod
+    def update(cls, gl, id, data, **kwargs):
+        if not cls.canUpdate:
+            raise NotImplementedError
+
+        if not cls.url:
+            raise NotImplementedError
+
+        return gl.update(cls, id, data, **kwargs)
+
+    @classmethod
+    def create(cls, gl, data, **kwargs):
+        if not cls.canCreate:
+            raise NotImplementedError
+
+        if not cls.url:
+            raise NotImplementedError
+
+        return gl.create(cls, data, **kwargs)
+
+    @classmethod
+    def list(cls, gl, **kwargs):
+        if not cls.canGetList:
+            raise NotImplementedError
+
+        if not cls.url:
+            raise NotImplementedError
+
+        return gl.list(cls, **kwargs)
+
+    @classmethod
+    def get(cls, gl, id, **kwargs):
+        if not cls.canGet:
+            raise NotImplementedError
+
+        if not cls.url:
+            raise NotImplementedError
+
+        return gl.get(cls, id, **kwargs)
+
+    @classmethod
+    def delete(cls, gl, id, **kwargs):
+        if not cls.canDelete:
+            raise NotImplementedError
+
+        if not cls.url:
+            raise NotImplementedError
+
+        return gl.delete(cls, id, **kwargs)
+
+    def __init__(self, data):
+        for k, v in data.items():
+            if self.constructorTypes and k in self.constructorTypes:
+                self.__dict__[k] = self.constructorTypes[k](v)
+            else:
+                self.__dict__[k] = v
+
+    def __str__(self):
+        return '%s => %s'%(type(self), str(self.__dict__))
+
+
+class User(GitlabObject):
+    url = '/users'
+
+class Project(GitlabObject):
+    url = '/projects'
+    constructorTypes = {'owner': User}
+    canUpdate = False
+    canDelete = False
+
+class ProjectMember(GitlabObject):
+    url = '/projects/%(project_id)d/members'
+    returnClass = User
+
+class ProjectHook(GitlabObject):
+    url = '/projects/%(project_id)d/hooks'
+
+class ProjectBranch(GitlabObject):
+    url = '/projects/%(project_id)d/repository/branches'
+    canDelete = False
+    canUpdate = False
+    canCreate = False
+
+class ProjectTag(GitlabObject):
+    url = '/projects/%(project_id)d/repository/tags'
+    canGet = False
+    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 ProjectMilestone(GitlabObject):
+    url = '/projects/%(project_id)s/milestones'
+    canDelete = False
+
+class ProjectMergeRequest(GitlabObject):
+    url = '/projects/%(project_id)d/merge_request'
+    canDelete = False
+
+class Issue(GitlabObject):
+    url = '/issues'
+    canGet = False
+    canDelete = False
+    canUpdate = False
+    canCreate = False
+
+class ProjectIssue(GitlabObject):
+    url = '/projects/%(project_id)s/issues/'
+    returnClass = Issue
+    canDelete = False
+
+class Group(GitlabObject):
+    url = '/groups'
+
+class Session(object):
+    def __init__(self):
+        raise NotImplementedError
+
+class Snippet(GitlabObject):
+    url = '/projects/%(project_id)d/snippets'
+
+class User(GitlabObject):
+    url = '/users'
+
+class CurrentUser(GitlabObject):
+    url = '/user'
+    canGetList = False
+    canCreate = False
+    canUpdate = False
+    canDelete = False
+
+class CurrentUserKey(GitlabObject):
+    url = '/user/keys'
+    canUpdate = False
+
+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')
+
+    # get a list of projects
+    for p in Project.list(gl):
+        print p.name
+        # get associated issues
+        issues = ProjectIssue.list(gl, project_id=p.id)
+        for issue in issues:
+            print "  %d => %s (closed: %d)"%(issue.id, issue.title, issue.closed)
+            # and close them all
+            ProjectIssue.update(gl, issue.id, {'closed': 1}, project_id=p.id)
+