news CUD operations support

Author: maxtepkeev

CHANGELOG.rst

@@ -1,11 +1,12 @@
 Changelog
 ---------
 
-2.2.2 (2019-08-XX)
+2.3.0 (2020-06-XX)
 ++++++++++++++++++
 
 **Improvements**:
 
+- 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
   for GUI like behaviour or iterable of elements with "all_gui" string and additional columns to export

docs/resources/news.rst

@@ -13,7 +13,60 @@ See the :doc:`../configuration` about how to configure redmine object.
 Create methods
 --------------
 
-Not supported by Redmine
+.. versionadded:: 2.3.0
+
+create
+++++++
+
+.. py:method:: create(**fields)
+   :module: redminelib.managers.ResourceManager
+   :noindex:
+
+   Creates new News resource with given fields and saves it to the Redmine.
+
+   :param project_id: (required). Id or identifier of News's project.
+   :type project_id: int or string
+   :param string title: (required). News title.
+   :param string description: (required). News description.
+   :param string summary: (optional). News summary.
+   :param list uploads:
+    .. raw:: html
+
+       (optional). Uploads as [{'': ''}, ...], accepted keys are:
+
+    - path (required). Absolute file path or file-like object that should be uploaded.
+    - filename (optional). Name of the file after upload.
+    - description (optional). Description of the file.
+    - content_type (optional). Content type of the file.
+
+   :return: :ref:`Resource` object
+
+.. code-block:: python
+
+   >>> news = redmine.news.create(title='Foo', description='foobar')
+   >>> news
+   <redminelib.resources.News #8 "Foo">
+
+new
++++
+
+.. py:method:: new()
+   :module: redminelib.managers.ResourceManager
+   :noindex:
+
+   Creates new empty News resource but saves it to the Redmine only when ``save()`` is called, also
+   calls ``pre_create()`` and ``post_create()`` methods of the :ref:`Resource` object. Valid attributes
+   are the same as for ``create()`` method above.
+
+   :return: :ref:`Resource` object
+
+.. code-block:: python
+
+   >>> news = redmine.news.new()
+   >>> news.title = 'Foo'
+   >>> news.description = 'foobar'
+   >>> news.save()
+   <redminelib.resources.News #8 "Foo">
 
 Read methods
 ------------
@@ -91,12 +144,96 @@ filter
 Update methods
 --------------
 
-Not supported by Redmine
+.. versionadded:: 2.3.0
+
+update
+++++++
+
+.. py:method:: update(resource_id, **fields)
+   :module: redminelib.managers.ResourceManager
+   :noindex:
+
+   Updates values of given fields of a News resource and saves them to the Redmine.
+
+   :param int resource_id: (required). News id.
+   :param string title: (optional). News title.
+   :param string description: (optional). News description.
+   :param string summary: (optional). News summary.
+   :return: True
+
+.. code-block:: python
+
+   >>> redmine.news.update(1, title='Bar', description='barfoo', summary='bar')
+   True
+
+save
+++++
+
+.. py:method:: save(**attrs)
+   :module: redminelib.resources.News
+   :noindex:
+
+   Saves current state of a News resource to the Redmine. Attrs that can be
+   changed are the same as for ``update()`` method above.
+
+   :return: :ref:`Resource` object
+
+.. code-block:: python
+
+   >>> news = redmine.news.get(1)
+   >>> news.title = 'Bar'
+   >>> news.description = 'barfoo'
+   >>> news.summary = 'bar'
+   >>> news.save()
+   <redminelib.resources.News #1 "Bar">
+
+.. versionadded:: 2.1.0 Alternative syntax was introduced.
+
+.. code-block:: python
+
+   >>> news = redmine.news.get(1).save(
+   ...     title='Bar',
+   ...     description='barfoo',
+   ...     summary='bar'
+   ... )
+   >>> news
+   <redminelib.resources.News #1 "Bar">
 
 Delete methods
 --------------
 
-Not supported by Redmine
+.. versionadded:: 2.3.0
+
+delete
+++++++
+
+.. py:method:: delete(resource_id)
+   :module: redminelib.managers.ResourceManager
+   :noindex:
+
+   Deletes single News resource from Redmine by it's id.
+
+   :param int resource_id: (required). News id.
+   :return: True
+
+.. code-block:: python
+
+   >>> redmine.news.delete(1)
+   True
+
+.. py:method:: delete()
+   :module: redminelib.resources.News
+   :noindex:
+
+   Deletes current News resource object from Redmine.
+
+   :return: True
+
+.. code-block:: python
+
+   >>> news = redmine.news.get(1)
+   >>> news.delete()
+   True
 
 Export
 ------

redminelib/managers/__init__.py

@@ -3,4 +3,4 @@
 """
 
 from .base import ResourceManager
-from .standard import WikiPageManager, FileManager
+from .standard import WikiPageManager, FileManager, NewsManager

redminelib/managers/standard.py

@@ -20,3 +20,11 @@ def _process_create_response(self, request, response):
             response = {self.container: {'id': int(request[self.container]['token'].split('.')[0])}}
 
         return super(FileManager, self)._process_create_response(request, response)
+
+
+class NewsManager(ResourceManager):
+    def _process_create_response(self, request, response):
+        if response is True:
+            response = {self.container: self.redmine.news.filter(**self.params)[0].raw()}
+
+        return super(NewsManager, self)._process_create_response(request, response)

redminelib/resources/standard.py

@@ -489,12 +489,20 @@ class Role(BaseResource):
 class News(BaseResource):
     redmine_version = '1.1'
     container_all = 'news'
+    container_one = 'news'
     container_filter = 'news'
+    container_create = 'news'
+    container_update = 'news'
     query_all_export = '/news.{format}'
     query_all = '/news.json'
+    query_one = '/news/{0}.json'
     query_filter = '/news.json'
+    query_create = '/projects/{project_id}/news.json'
+    query_update = '/news/{0}.json'
+    query_delete = '/news/{0}.json'
     query_url = '/news/{0}'
     search_hints = ['news']
+    manager_class = managers.NewsManager
 
     _repr = [['id', 'title']]
     _resource_map = {'project': 'Project', 'author': 'User'}

tests/responses/standard.py

@@ -57,8 +57,9 @@
         'all': {'roles': [{'name': 'Foo', 'id': 1}, {'name': 'Bar', 'id': 2}]},
     },
     'news': {
-        'all': {'news': [{'title': 'Foo', 'id': 1}, {'title': 'Bar', 'id': 2}]},
-        'filter': {'news': [{'title': 'Foo', 'id': 1}, {'title': 'Bar', 'id': 2}]},
+        'get': {'news': {'title': 'Foo', 'id': 1}},
+        'all': {'news': [{'title': 'Foo', 'id': 2}, {'title': 'Bar', 'id': 1}]},
+        'filter': {'news': [{'title': 'Foo', 'id': 2}, {'title': 'Bar', 'id': 1}]},
     },
     'issue_status': {
         'all': {'issue_statuses': [{'name': 'Foo', 'id': 1}, {'name': 'Bar', 'id': 2}]},

tests/test_resources_standard.py

@@ -1189,30 +1189,57 @@ def test_news_version(self):
         self.assertEqual(self.redmine.news.resource_class.redmine_version, '1.1')
 
     def test_news_get(self):
-        self.response.json.return_value = responses['news']['all']
+        self.response.json.return_value = responses['news']['get']
         news = self.redmine.news.get(1)
         self.assertEqual(news.id, 1)
         self.assertEqual(news.title, 'Foo')
 
     def test_news_all(self):
         self.response.json.return_value = responses['news']['all']
         news = self.redmine.news.all()
-        self.assertEqual(news[0].id, 1)
+        self.assertEqual(news[0].id, 2)
         self.assertEqual(news[0].title, 'Foo')
-        self.assertEqual(news[1].id, 2)
+        self.assertEqual(news[1].id, 1)
         self.assertEqual(news[1].title, 'Bar')
 
     def test_news_filter(self):
         self.response.json.return_value = responses['news']['filter']
         news = self.redmine.news.filter(project_id=1)
-        self.assertEqual(news[0].id, 1)
+        self.assertEqual(news[0].id, 2)
         self.assertEqual(news[0].title, 'Foo')
-        self.assertEqual(news[1].id, 2)
+        self.assertEqual(news[1].id, 1)
         self.assertEqual(news[1].title, 'Bar')
 
+    def test_news_create(self):
+        self.response.status_code = 201
+        self.response.json.return_value = responses['news']['get']
+        news = self.redmine.news.create(project_id=1, title='Foo')
+        self.assertEqual(news.title, 'Foo')
+
+    def test_news_create_empty_response(self):
+        self.set_patch_side_effect([
+            mock.Mock(status_code=204, history=[], content=''),
+            mock.Mock(status_code=201, history=[], **{'json.return_value': responses['news']['filter']})
+        ])
+        news = self.redmine.news.create(project_id=1, title='Foo')
+        self.assertEqual(news.title, 'Foo')
+
+    def test_news_delete(self):
+        self.response.json.return_value = responses['news']['get']
+        news = self.redmine.news.get(1)
+        self.response.content = ''
+        self.assertEqual(news.delete(), True)
+        self.assertEqual(self.redmine.news.delete(1), True)
+
+    def test_news_update(self):
+        self.response.json.return_value = responses['news']['get']
+        news = self.redmine.news.get(1)
+        news.title = 'Bar'
+        self.assertIsInstance(news.save(), resources.News)
+
     def test_news_url(self):
         self.response.json.return_value = responses['news']['filter']
-        self.assertEqual(self.redmine.news.filter(project_id=1)[0].url, '{0}/news/1'.format(self.url))
+        self.assertEqual(self.redmine.news.filter(project_id=1)[0].url, '{0}/news/2'.format(self.url))
 
     @mock.patch('redminelib.open', mock.mock_open(), create=True)
     def test_news_export(self):
@@ -1226,7 +1253,7 @@ def test_news_str(self):
 
     def test_news_repr(self):
         self.response.json.return_value = responses['news']['filter']
-        self.assertEqual(repr(self.redmine.news.filter(project_id=1)[0]), '<redminelib.resources.News #1 "Foo">')
+        self.assertEqual(repr(self.redmine.news.filter(project_id=1)[0]), '<redminelib.resources.News #2 "Foo">')
 
     def test_issue_status_version(self):
         self.assertEqual(self.redmine.issue_status.resource_class.redmine_version, '1.3')