support custom filename in raw file upload

Author: maxtepkeev

CHANGELOG.rst

@@ -6,6 +6,7 @@ Changelog
 
 **Improvements**:
 
+- Support custom filename in ``redmine.upload()``
 - 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)

docs/advanced/working_with_files.rst

@@ -20,11 +20,12 @@ Upload
 
    :param f: (required). File path / stream that will be uploaded.
    :type f: string or file-like object
+   :param filename: (optional). Filename for the file that will be uploaded.
    :return: dict with id and token string (Redmine >= 3.4.0) or dict with token string only (Redmine < 3.4.0)
 
 .. code-block:: python
 
-   >>> data = redmine.upload('/usr/local/image.jpg')
+   >>> data = redmine.upload('/usr/local/image.jpg', filename='beauty.jpg')
    >>> data
    {'id': 7167, 'token': '7167.ed1ccdb093229ca1bd0b043618d88743'}
 

redminelib/__init__.py

@@ -86,18 +86,20 @@ def session(self, **options):
         finally:
             self.engine = engine
 
-    def upload(self, f):
+    def upload(self, f, filename=None):
         """
         Uploads file from file path / file stream to Redmine and returns an assigned token.
 
         :param f: (required). File path / stream that will be uploaded.
         :type f: string or file-like object
+        :param filename: (optional). Filename for the file that will be uploaded.
         """
         if self.ver is not None and LooseVersion(str(self.ver)) < LooseVersion('1.4.0'):
             raise exceptions.VersionMismatchError('File uploading')
 
         url = '{0}/uploads.json'.format(self.url)
         headers = {'Content-Type': 'application/octet-stream'}
+        params = {'filename': filename or ''}
 
         # There're myriads of file-like object implementations here and there and some of them don't have
         # a "read" method, which is wrong, but that's what we have, on the other hand it looks like all of
@@ -127,7 +129,7 @@ def upload(self, f):
             stream = open(f, 'rb')
             close = True
 
-        response = self.engine.request('post', url, data=stream, headers=headers)
+        response = self.engine.request('post', url, params=params, data=stream, headers=headers)
 
         if close:
             stream.close()

redminelib/resources/base.py

@@ -257,7 +257,8 @@ def decode(cls, attr, value, manager):
         if attr == 'uploads':
             for index, attachment in enumerate(value):
                 if 'token' not in attachment:
-                    value[index]['token'] = manager.redmine.upload(attachment.pop('path', ''))['token']
+                    value[index]['token'] = manager.redmine.upload(
+                        attachment.pop('path', ''), filename=attachment.get('filename'))['token']
 
             return attr, value
         elif attr == 'include' and isinstance(value, (list, tuple)):

tests/test_redmine.py

@@ -62,7 +62,7 @@ def test_session_requests(self):
     def test_successful_file_upload(self):
         self.response.status_code = 201
         self.response.json.return_value = {'upload': {'id': 1, 'token': '123456'}}
-        self.assertEqual(self.redmine.upload('foo')['token'], '123456')
+        self.assertEqual(self.redmine.upload('foo', filename='foo.jpg')['token'], '123456')
 
     def test_successful_filestream_upload(self):
         from io import StringIO