Merge pull request 'Add author and tags attributes to RSS feed entries' (#238) from 236-add-author-and-tags-columns-to-feeds into master

Reviewed-on: platypush/platypush#238

platypush/message/event/rss.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Optional
+from typing import Iterable, Optional
 
 from platypush.message.event import Event
 
@@ -10,11 +10,30 @@ class NewFeedEntryEvent(Event):
     """
 
     def __init__(
-            self, *, feed_url: str, url: str, title: Optional[str] = None, id: Optional[str] = None,
+        self,
-            feed_title: Optional[str] = None, published: Optional[datetime] = None, summary: Optional[str] = None,
+        *,
-            content: Optional[str] = None, **kwargs
+        feed_url: str,
+        url: str,
+        title: Optional[str] = None,
+        id: Optional[str] = None,
+        feed_title: Optional[str] = None,
+        published: Optional[datetime] = None,
+        summary: Optional[str] = None,
+        content: Optional[str] = None,
+        author: Optional[str] = None,
+        tags: Optional[Iterable[str]] = None,
+        **kwargs
     ):
         super().__init__(
-            feed_url=feed_url, url=url, title=title, id=id, feed_title=feed_title,
+            feed_url=feed_url,
-            published=published, summary=summary, content=content, **kwargs
+            url=url,
+            title=title,
+            id=id,
+            feed_title=feed_title,
+            published=published,
+            summary=summary,
+            content=content,
+            author=author,
+            tags=tags or [],
+            **kwargs
         )

platypush/plugins/rss/__init__.py

@@ -129,6 +129,12 @@ class RssPlugin(RunnablePlugin):
                         'title': entry.title,
                         'summary': getattr(entry, 'summary', None),
                         'content': self._parse_content(entry),
+                        'author': getattr(entry, 'author', None),
+                        'tags': [
+                            tag['term']
+                            for tag in getattr(entry, 'tags', [])
+                            if tag.get('term')
+                        ],
                     }
                     for entry in feed.entries
                     if getattr(entry, 'published_parsed', None)

platypush/schemas/rss.py

@@ -5,36 +5,40 @@ from platypush.schemas import DateTime
 
 
 class RssFeedEntrySchema(Schema):
-    feed_title = fields.String(metadata=dict(description='Feed title'))
+    feed_title = fields.String(metadata={'description': 'Feed title'})
     feed_url = fields.URL(
         required=True,
-        metadata=dict(
+        metadata={
-            description='URL of the feed',
+            'description': 'URL of the feed',
-            example='https://some-website/rss',
+            'example': 'https://some-website/rss',
-        )
+        },
     )
 
     id = fields.String(
         required=True,
-        metadata=dict(
+        metadata={
-            description='Feed entry ID',
+            'description': 'Feed entry ID',
-            example='1234',
+            'example': '1234',
-        )
+        },
     )
 
     url = fields.URL(
         required=True,
-        metadata=dict(
+        metadata={
-            description='URL of the feed entry',
+            'description': 'URL of the feed entry',
-            example='https://some-website/articles/1234',
+            'example': 'https://some-website/articles/1234',
-        )
+        },
     )
 
     published = DateTime(
-        required=True,
+        required=True, metadata={'description': 'Entry published time'}
-        metadata=dict(description='Entry published time')
     )
 
-    title = fields.String(metadata=dict(description='Feed entry title'))
+    title = fields.String(metadata={'description': 'Feed entry title'})
-    summary = fields.String(metadata=dict(description='Feed entry summary'))
+    summary = fields.String(metadata={'description': 'Feed entry summary'})
-    content = fields.String(metadata=dict(description='Feed entry content'))
+    content = fields.String(metadata={'description': 'Feed entry content'})
+    author = fields.String(metadata={'description': 'Feed entry author'})
+    tags = fields.List(
+        fields.String(),
+        metadata={'description': 'Feed entry tags'},
+    )

setup.cfg

@@ -4,7 +4,7 @@ commit = True
 tag = True
 
 [metadata]
-description-file = README.md
+description_file = README.md
 
 [flake8]
 max-line-length = 120