support for /my/account endpoint

Author: maxtepkeev

CHANGELOG.rst

@@ -6,6 +6,9 @@ Changelog
 
 **Improvements**:
 
+- Support for ``get()`` and ``update()`` operations for ``/my/account`` endpoint which doesn't require admin
+  privileges by using ``me`` as an id, i.e. ``redmine.user.get('me')`` or ``redmine.user.update('me',firstname='John')``
+  (requires Redmine >= 4.1.0)
 - News ``create()``, ``update()``, ``delete()`` operations support (requires Redmine >= 4.1.0)
 - ResourceSet's ``export()`` method now supports ``columns`` keyword argument which can be either an iterable
   of column names, an "all" string which tells Python-Redmine to export all available columns, "all_gui" string

docs/resources/user.rst

@@ -293,6 +293,16 @@ update
    ... )
    True
 
+.. hint::
+
+   By default Python-Redmine uses ``/users/ID`` API endpoint which requires admin privileges, it is also
+   possible to use ``/my/account`` endpoint which doesn't by using ``me`` as an ID (requires Redmine >= 4.1.0):
+
+   .. code-block:: python
+
+      >>> redmine.user.update('me', firstname='John')
+      True
+
 save
 ++++
 

redminelib/managers/standard.py

@@ -23,11 +23,24 @@ def _process_create_response(self, request, response):
 
 
 class UserManager(ResourceManager):
+    @staticmethod
+    def _check_custom_url(path):
+        if path.endswith('/me.json'):
+            path = '/my/account.json'
+
+        return path
+
+    def _construct_get_url(self, path):
+        return super(UserManager, self)._construct_get_url(self._check_custom_url(path))
+
     def _prepare_create_request(self, request):
         request = super(UserManager, self)._prepare_create_request(request)
         request['send_information'] = request[self.container].pop('send_information', False)
         return request
 
+    def _construct_update_url(self, path):
+        return super(UserManager, self)._construct_update_url(self._check_custom_url(path))
+
     def _prepare_update_request(self, request):
         request = super(UserManager, self)._prepare_update_request(request)
         request['send_information'] = request[self.resource_class.container_update].pop('send_information', False)

tests/test_resources_standard.py

@@ -1018,6 +1018,12 @@ def test_user_get(self):
         self.assertEqual(user.id, 1)
         self.assertEqual(user.firstname, 'John')
 
+    def test_user_get_account(self):
+        self.response.json.return_value = responses['user']['get']
+        user = self.redmine.user.get('me')
+        self.assertEqual(user.firstname, 'John')
+        self.assertTrue(self.patch_requests.call_args[0][1].endswith('/my/account.json'))
+
     def test_user_all(self):
         self.response.json.return_value = responses['user']['all']
         users = self.redmine.user.all()
@@ -1062,6 +1068,10 @@ def test_user_update(self):
         user.firstname = 'Bar'
         self.assertIsInstance(user.save(), resources.User)
 
+    def test_user_update_account(self):
+        self.redmine.user.update('me', lastname='Foo', firstname='Bar')
+        self.assertTrue(self.patch_requests.call_args[0][1].endswith('/my/account.json'))
+
     def test_user_update_with_send_information(self):
         import json
         self.response.json.return_value = responses['user']['get']