Support setting commit status

Colin D Bennett · Colin D Bennett · commit 7b96b0c757a3 · 2016-01-07T12:40:05.000-08:00
Support commit status updates.  Commit status can be set by a POST to
the appropriate commit URL.  The status can be updated by a subsequent
POST to the same URL with the same `name` and `ref`, but different
values for `state`, `description`, etc.

Add project-commit-status example to README.md file.

Note: Listing the commit statuses is not yet supported.  This is done
through a different path on the server, under the `repository` path.
diff --git a/README.md b/README.md
@@ -166,4 +166,9 @@ Impossible to create object (Missing attribute(s): title, file-name, code)
 
 # oops, let's add the attributes:
 gitlab project-snippet create --project-id 2 --title "the title" --file-name "the name" --code "the code"
+
+# add a build status to a commit
+gitlab project-commit-status create --project-id 2 --commit-id a43290c \
+    --state success --name ci/jenkins --target-url http://server/build/123 \
+    --description "Jenkins build succeeded"
 `````
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -521,3 +521,21 @@ def Team(self, id=None, **kwargs):
         to write it on the server.
         """
         return Team._get_list_or_object(self, id, **kwargs)
+
+    def Status(self, id=None, **kwargs):
+        """Create status for a Git commit.
+
+        This is often used for automated software build or test status.
+
+        Args:
+            id: Commit reference.
+            kwargs: Arbitrary keyword arguments for the status:
+                Required:
+                - state: pending, running, success, failed, canceled
+                Optional:
+                - description: short description of this status
+                - name:        label for this status e.g., name=ci/jenkins
+                - ref:         branch reference e.g., ref=master
+                - target_url:  hyperlink target for this status
+        """
+        return ProjectCommitStatus._get_list_or_object(self, id, **kwargs)
diff --git a/gitlab/objects.py b/gitlab/objects.py
@@ -520,6 +520,21 @@ class ProjectCommitManager(BaseManager):
     obj_cls = ProjectCommit
 
 
+class ProjectCommitStatus(GitlabObject):
+    _url = '/projects/%(project_id)s/statuses/%(commit_id)s'
+    canUpdate = False
+    canDelete = False
+    requiredUrlAttrs = ['project_id', 'commit_id']
+    requiredCreateAttrs = ['state']
+    optionalCreateAttrs = ['description', 'name', 'ref', 'target_url']
+    requiredGetAttrs = []
+    requiredUpdateAttrs = []
+    requiredDeleteAttrs = []
+
+class ProjectCommitStatusManager(BaseManager):
+    obj_cls = ProjectCommitStatus
+
+
 class ProjectKey(GitlabObject):
     _url = '/projects/%(project_id)s/keys'
     canUpdate = False
@@ -787,6 +802,7 @@ class Project(GitlabObject):
     managers = [
         ('branches', ProjectBranchManager, [('project_id', 'id')]),
         ('commits', ProjectCommitManager, [('project_id', 'id')]),
+        ('statuses', ProjectCommitStatusManager, [('project_id', 'id')]),
         ('events', ProjectEventManager, [('project_id', 'id')]),
         ('files', ProjectFileManager, [('project_id', 'id')]),
         ('hooks', ProjectHookManager, [('project_id', 'id')]),
