summaryrefslogtreecommitdiff
path: root/gitlab
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-05-27 19:28:31 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-05-27 19:28:31 +0200
commit70257438044b793a42adce791037b9b86ae35d9b (patch)
treee38f46effcfe54cb3346b985c1ca41c61b8da103 /gitlab
parent590ea0da7e5617c42e705c62370d6e94ff46ea74 (diff)
downloadgitlab-70257438044b793a42adce791037b9b86ae35d9b.tar.gz
Implement user_agent_detail for snippets
Add a new UserAgentDetail mixin to avoid code duplication.
Diffstat (limited to 'gitlab')
-rw-r--r--gitlab/mixins.py17
-rw-r--r--gitlab/tests/test_mixins.py7
-rw-r--r--gitlab/v4/objects.py25
3 files changed, 30 insertions, 19 deletions
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
index 013f7b7..988042b 100644
--- a/gitlab/mixins.py
+++ b/gitlab/mixins.py
@@ -371,6 +371,23 @@ class ObjectDeleteMixin(object):
self.manager.delete(self.get_id())
+class UserAgentDetailMixin(object):
+ @cli.register_custom_action(('Snippet', 'ProjectSnippet', 'ProjectIssue'))
+ @exc.on_http_error(exc.GitlabGetError)
+ def user_agent_detail(self, **kwargs):
+ """Get the user agent detail.
+
+ Args:
+ **kwargs: Extra options to send to the server (e.g. sudo)
+
+ Raises:
+ GitlabAuthenticationError: If authentication is not correct
+ GitlabGetError: If the server cannot perform the request
+ """
+ path = '%s/%s/user_agent_detail' % (self.manager.path, self.get_id())
+ return self.manager.gitlab.http_get(path, **kwargs)
+
+
class AccessRequestMixin(object):
@cli.register_custom_action(('ProjectAccessRequest', 'GroupAccessRequest'),
tuple(), ('access_level', ))
diff --git a/gitlab/tests/test_mixins.py b/gitlab/tests/test_mixins.py
index c737953..b3c2e81 100644
--- a/gitlab/tests/test_mixins.py
+++ b/gitlab/tests/test_mixins.py
@@ -73,6 +73,13 @@ class TestObjectMixinsAttributes(unittest.TestCase):
obj = O()
self.assertTrue(hasattr(obj, 'set'))
+ def test_user_agent_detail_mixin(self):
+ class O(UserAgentDetailMixin):
+ pass
+
+ obj = O()
+ self.assertTrue(hasattr(obj, 'user_agent_detail'))
+
class TestMetaMixins(unittest.TestCase):
def test_retrieve_mixin(self):
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
index 2c96e74..46a6fd7 100644
--- a/gitlab/v4/objects.py
+++ b/gitlab/v4/objects.py
@@ -786,7 +786,7 @@ class LicenseManager(RetrieveMixin, RESTManager):
_optional_get_attrs = ('project', 'fullname')
-class Snippet(SaveMixin, ObjectDeleteMixin, RESTObject):
+class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
_short_print_attr = 'title'
@cli.register_custom_action('Snippet')
@@ -1386,8 +1386,9 @@ class ProjectIssueDiscussionManager(RetrieveMixin, CreateMixin, RESTManager):
_create_attrs = (('body',), ('created_at',))
-class ProjectIssue(SubscribableMixin, TodoMixin, TimeTrackingMixin, SaveMixin,
- ObjectDeleteMixin, RESTObject):
+class ProjectIssue(UserAgentDetailMixin, SubscribableMixin, TodoMixin,
+ TimeTrackingMixin, SaveMixin, ObjectDeleteMixin,
+ RESTObject):
_short_print_attr = 'title'
_id_attr = 'iid'
_managers = (
@@ -1396,21 +1397,6 @@ class ProjectIssue(SubscribableMixin, TodoMixin, TimeTrackingMixin, SaveMixin,
('notes', 'ProjectIssueNoteManager'),
)
- @cli.register_custom_action('ProjectIssue')
- @exc.on_http_error(exc.GitlabUpdateError)
- def user_agent_detail(self, **kwargs):
- """Get user agent detail.
-
- Args:
- **kwargs: Extra options to send to the server (e.g. sudo)
-
- Raises:
- GitlabAuthenticationError: If authentication is not correct
- GitlabGetError: If the detail could not be retrieved
- """
- path = '%s/%s/user_agent_detail' % (self.manager.path, self.get_id())
- return self.manager.gitlab.http_get(path, **kwargs)
-
@cli.register_custom_action('ProjectIssue', ('to_project_id',))
@exc.on_http_error(exc.GitlabUpdateError)
def move(self, to_project_id, **kwargs):
@@ -2291,7 +2277,8 @@ class ProjectSnippetDiscussionManager(RetrieveMixin, CreateMixin, RESTManager):
_create_attrs = (('body',), ('created_at',))
-class ProjectSnippet(SaveMixin, ObjectDeleteMixin, RESTObject):
+class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin,
+ RESTObject):
_url = '/projects/%(project_id)s/snippets'
_short_print_attr = 'title'
_managers = (