Add support for features flags

Gauvain Pocentek · Gauvain Pocentek · commit f5850d950a77 · 2018-01-01T15:30:24.000+01:00
Fixes python-gitlab#360
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -15,6 +15,7 @@ API examples
    gl_objects/deploy_keys
    gl_objects/deployments
    gl_objects/environments
+   gl_objects/features
    gl_objects/groups
    gl_objects/issues
    gl_objects/labels
diff --git a/docs/gl_objects/features.rst b/docs/gl_objects/features.rst
@@ -0,0 +1,26 @@
+##############
+Features flags
+##############
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.Feature`
+  + :class:`gitlab.v4.objects.FeatureManager`
+  + :attr:`gitlab.Gitlab.features`
+
+* GitLab API: https://docs.gitlab.com/ce/api/features.html
+
+Examples
+--------
+
+List features::
+
+    features = gl.features.list()
+
+Create or set a feature::
+
+    feature = gl.features.set(feature_name, True)
+    feature = gl.features.set(feature_name, 30)
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -125,6 +125,7 @@ def __init__(self, url, private_token=None, oauth_token=None, email=None,
             self.teams = objects.TeamManager(self)
         else:
             self.dockerfiles = objects.DockerfileManager(self)
+            self.features = objects.FeatureManager(self)
             self.pagesdomains = objects.PagesDomainManager(self)
             self.user_activities = objects.UserActivitiesManager(self)
 
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -242,7 +242,7 @@ def set(self, key, value, **kwargs):
             GitlabSetError: If an error occured
 
         Returns:
-            UserCustomAttribute: The created/updated user attribute
+            obj: The created/updated attribute
         """
         path = '%s/%s' % (self.path, key.replace('/', '%2F'))
         data = {'value': value}
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -400,6 +400,38 @@ class DockerfileManager(RetrieveMixin, RESTManager):
     _obj_cls = Dockerfile
 
 
+class Feature(RESTObject):
+    _id_attr = 'name'
+
+
+class FeatureManager(ListMixin, RESTManager):
+    _path = '/features/'
+    _obj_cls = Feature
+
+    @exc.on_http_error(exc.GitlabSetError)
+    def set(self, name, value, feature_group=None, user=None, **kwargs):
+        """Create or update the object.
+
+        Args:
+            name (str): The value to set for the object
+            value (bool/int): The value to set for the object
+            feature_group (str): A feature group name
+            user (str): A GitLab username
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabSetError: If an error occured
+
+        Returns:
+            obj: The created/updated attribute
+        """
+        path = '%s/%s' % (self.path, name.replace('/', '%2F'))
+        data = {'value': value, 'feature_group': feature_group, 'user': user}
+        server_data = self.gitlab.http_post(path, post_data=data, **kwargs)
+        return self._obj_cls(self, server_data)
+
+
 class Gitignore(RESTObject):
     _id_attr = 'name'
 
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -551,6 +551,11 @@
 ns = gl.namespaces.list(search='root', all=True)[0]
 assert(ns.kind == 'user')
 
+# features
+feat = gl.features.set('foo', 30)
+assert(feat.name == 'foo')
+assert(len(gl.features.list()) == 1)
+
 # broadcast messages
 msg = gl.broadcastmessages.create({'message': 'this is the message'})
 msg.color = '#444444'
