fix(projects): support approval_rules endpoint for projects

srikanthchelluri · srikanthchelluri · commit 87b25522e758 · 2019-10-23T17:00:25.000-04:00
The `approvers` API endpoint is deprecated [1]. GitLab instead uses the `approval_rules` API endpoint to modify approval settings for merge requests. This adds the functionality for project-level merge request approval settings. Note that there does not exist an endpoint to 'get' a single approval rule at this moment - only 'list'. [1] https://docs.gitlab.com/ee/api/merge_request_approvals.html
diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst
@@ -12,6 +12,8 @@ References
 
   + :class:`gitlab.v4.objects.ProjectApproval`
   + :class:`gitlab.v4.objects.ProjectApprovalManager`
+  + :class:`gitlab.v4.objects.ProjectApprovalRule`
+  + :class:`gitlab.v4.objects.ProjectApprovalRuleManager`
   + :attr:`gitlab.v4.objects.Project.approvals`
   + :class:`gitlab.v4.objects.ProjectMergeRequestApproval`
   + :class:`gitlab.v4.objects.ProjectMergeRequestApprovalManager`
@@ -22,6 +24,19 @@ References
 Examples
 --------
 
+List project-level MR approval rules::
+
+    p_mras = project.approvalrules.list()
+
+Change project-level MR approval rule::
+
+    p_approvalrule.user_ids = [234]
+    p_approvalrule.save()
+
+Delete project-level MR approval rule::
+
+    p_approvalrule.delete()
+
 Get project-level or MR-level MR approvals settings::
 
     p_mras = project.approvals.get()
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -3735,6 +3735,26 @@ def set_approvers(self, approver_ids=None, approver_group_ids=None, **kwargs):
         self.gitlab.http_put(path, post_data=data, **kwargs)
 
 
+class ProjectApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject):
+    _id_attr = "id"
+
+
+class ProjectApprovalRuleManager(ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager):
+    _path = "/projects/%(project_id)s/approval_rules"
+    _obj_cls = ProjectApprovalRule
+    _from_parent_attrs = {"project_id": "id"}
+    _create_attrs = (
+        (
+            "name",
+            "approvals_required",
+        ),
+        (
+            "user_ids",
+            "group_ids",
+        )
+    )
+
+
 class ProjectDeployment(RESTObject):
     pass
 
@@ -3845,6 +3865,7 @@ class Project(SaveMixin, ObjectDeleteMixin, RESTObject):
     _managers = (
         ("accessrequests", "ProjectAccessRequestManager"),
         ("approvals", "ProjectApprovalManager"),
+        ("approvalrules", "ProjectApprovalRuleManager"),
         ("badges", "ProjectBadgeManager"),
         ("boards", "ProjectBoardManager"),
         ("branches", "ProjectBranchManager"),
