Add support for project deployments

Gauvain Pocentek · Gauvain Pocentek · commit 8d7faf42b3e9 · 2016-08-27T23:10:19.000+02:00
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -10,6 +10,7 @@ API objects manipulation
    gl_objects/builds
    gl_objects/commits
    gl_objects/deploy_keys
+   gl_objects/deployments
    gl_objects/environments
    gl_objects/groups
    gl_objects/issues
diff --git a/docs/gl_objects/deployments.py b/docs/gl_objects/deployments.py
@@ -0,0 +1,11 @@
+# list
+deployments = gl.project_deployments.list(project_id=1)
+# or
+deployments = project.deployments.list()
+# end list
+
+# get
+deployment = gl.project_deployments.get(deployment_id, project_id=1)
+# or
+deployment = project.deployments.get(deployment_id)
+# end get
diff --git a/docs/gl_objects/deployments.rst b/docs/gl_objects/deployments.rst
@@ -0,0 +1,23 @@
+###########
+Deployments
+###########
+
+Use :class:`~gitlab.objects.ProjectDeployment` objects to manipulate project
+deployments. The :attr:`gitlab.Gitlab.project_deployments`, and
+:attr:`Project.deployments <gitlab.objects.Project.deployments>` manager
+objects provide helper functions.
+
+Examples
+--------
+
+List deployments for a project:
+
+.. literalinclude:: deployments.py
+   :start-after: # list
+   :end-before: # end list
+
+Get a single deployment:
+
+.. literalinclude:: deployments.py
+   :start-after: # get
+   :end-before: # end get
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -92,6 +92,8 @@ class Gitlab(object):
             GitLab projects commits comments
         project_commit_statuses (ProjectCommitStatusManager): Manager for
             GitLab projects commits statuses
+        project_deployments (ProjectDeploymentManager): Manager for GitLab
+            projects deployments
         project_keys (ProjectKeyManager): Manager for GitLab projects keys
         project_environments (ProjectEnvironmentManager): Manager for GitLab
             projects environments
@@ -178,6 +180,7 @@ def __init__(self, url, private_token=None, email=None, password=None,
         self.project_commits = ProjectCommitManager(self)
         self.project_commit_comments = ProjectCommitCommentManager(self)
         self.project_commit_statuses = ProjectCommitStatusManager(self)
+        self.project_deployments = ProjectDeploymentManager(self)
         self.project_keys = ProjectKeyManager(self)
         self.project_environments = ProjectEnvironmentManager(self)
         self.project_events = ProjectEventManager(self)
diff --git a/gitlab/objects.py b/gitlab/objects.py
@@ -1862,6 +1862,17 @@ class ProjectAccessRequestManager(BaseManager):
     obj_cls = ProjectAccessRequest
 
 
+class ProjectDeployment(GitlabObject):
+    _url = '/projects/%(project_id)s/deployments'
+    canCreate = False
+    canUpdate = False
+    canDelete = False
+
+
+class ProjectDeploymentManager(BaseManager):
+    obj_cls = ProjectDeployment
+
+
 class Project(GitlabObject):
     _url = '/projects'
     _constructorTypes = {'owner': 'User', 'namespace': 'Group'}
@@ -1890,6 +1901,7 @@ class Project(GitlabObject):
          [('project_id', 'id')]),
         ('commit_statuses', ProjectCommitStatusManager,
          [('project_id', 'id')]),
+        ('deployments', ProjectDeploymentManager, [('project_id', 'id')]),
         ('environments', ProjectEnvironmentManager, [('project_id', 'id')]),
         ('events', ProjectEventManager, [('project_id', 'id')]),
         ('files', ProjectFileManager, [('project_id', 'id')]),
