Mastodon - add user home timeline

Author: SamR1

twootfeed/mastodon/generate_toots_feed.py

@@ -157,6 +157,12 @@ def generate_xml(
             feed_title = param['mastodon']['title'] + ' Bookmarks'
             feed_link = param['mastodon']['url'] + '/web/bookmarks'
             feed_desc = param['feed']['author_name'] + ' bookmarks toots.'
+        elif target == 'home_timeline':
+            result = api.timeline_home()
+            result = get_next_toots(api, result, max_items)
+            feed_title = param['mastodon']['title'] + ' Home Timeline'
+            feed_link = param['mastodon']['url']
+            feed_desc = param['feed']['author_name'] + ' home timeline.'
         else:
             raise Exception('Invalid target')
         xml = generate_mastodon_feed(

twootfeed/mastodon/routes.py

@@ -32,3 +32,9 @@ def toot_favorites_feed() -> Tuple[str, int]:
 def toot_bookmarks_feed() -> Tuple[str, int]:
     """generate a rss feed authenticated user's bookmarks"""
     return generate_xml(mastodon_api, mastodon_param, target='bookmarks')
+
+
+@mastodon_bp.route('/home_timeline', methods=['GET'])
+def home_timeline() -> Tuple[str, int]:
+    """generate a rss feed authenticated user's bookmarks"""
+    return generate_xml(mastodon_api, mastodon_param, target='home_timeline')

twootfeed/tests/data.py

@@ -846,3 +846,57 @@
     '<br>♻ : 0, ✰ : 0</div></blockquote>',
     'text': 'Boosted by User A: What\'s New in #python today?',
 }
+
+toot_1_home_timeline_feed = (
+    '<?xml version="1.0" encoding="UTF-8"?>\n'
+    '<rss version="2.0">'
+    '<channel>'
+    '<title>Recherche Mastodon :  Home Timeline</title>'
+    '<link>https://mastodon.social</link><'
+    'description> home timeline.</description>'
+    '<language>fr</language>'
+    '<lastBuildDate></lastBuildDate>'
+    '<item>'
+    '<title>User (UserD): What\'s New in #python today?</title>'
+    '<link>https://mastodon.social/@UserD/111111111111111111</link>'
+    '<description>&lt;blockquote&gt;&lt;div&gt;&lt;img src="https://files.'
+    'mastodon.social/accounts/avatars/000/000/000/original/DxDxDxDxDxDxDxDx'
+    '.jpg" alt="User" width= 100px"/&gt; &lt;strong&gt;User: &lt;/strong&gt'
+    ';&lt;p&gt;What\'s New in &lt;a href="https://linuxjobs.social/tags/'
+    'python" class="mention hashtag" rel="nofollow noopener" target="_blank'
+    '"&gt;#&lt;span&gt;python&lt;/span&gt;&lt;/a&gt; today?&lt;/p&gt;&lt;br'
+    '&gt;♻ : 0, ✰ : 0&lt;/div&gt;&lt;/blockquote&gt;</description>'
+    '<pubDate>Thu, 25 Oct 2018 16:16:42 +0200</pubDate>'
+    '</item>'
+    '</channel>'
+    '</rss>'
+)
+
+toot_100_home_timeline_feed = (
+    '<?xml version="1.0" encoding="UTF-8"?>\n'
+    '<rss version="2.0">'
+    '<channel>'
+    '<title>Recherche Mastodon :  Home Timeline</title>'
+    '<link>https://mastodon.social</link><'
+    'description> home timeline.</description>'
+    '<language>fr</language>'
+    '<lastBuildDate></lastBuildDate>'
+    + (
+        '<item>'
+        '<title>User (UserD): What\'s New in #python today?</title>'
+        '<link>https://mastodon.social/@UserD/111111111111111111</link>'
+        '<description>&lt;blockquote&gt;&lt;div&gt;&lt;img src="https://files.'
+        'mastodon.social/accounts/avatars/000/000/000/original/'
+        'DxDxDxDxDxDxDxDx.jpg" alt="User" width= 100px"/&gt; &lt;strong&gt;'
+        'User: &lt;/strong&gt;&lt;p&gt;What\'s New in &lt;a href="https://'
+        'linuxjobs.social/tags/python" class="mention hashtag" rel="nofollow '
+        'noopener" target="_blank"&gt;#&lt;span&gt;python&lt;/span&gt;&lt;/a&'
+        'gt; today?&lt;/p&gt;&lt;br&gt;♻ : 0, ✰ : 0&lt;/div&gt;&lt;/blockquote'
+        '&gt;</description>'
+        '<pubDate>Thu, 25 Oct 2018 16:16:42 +0200</pubDate>'
+        '</item>'
+    )
+    * 100
+    + '</channel>'
+    '</rss>'
+)

twootfeed/tests/test_mastodon_feed_generation.py

@@ -20,10 +20,12 @@
     toot_1_bookmarks_feed,
     toot_1_favorites_feed,
     toot_1_feed,
+    toot_1_home_timeline_feed,
     toot_1_search_feed,
     toot_100_bookmarks_feed,
     toot_100_favorites_feed,
     toot_100_feed,
+    toot_100_home_timeline_feed,
 )
 from .utils import MastodonApi
 
@@ -182,6 +184,30 @@ def test_generate_xml_bookmarks_limit_ok() -> None:
     assert code == 200
 
 
+def test_generate_xml_home_timeline_ok() -> None:
+    api = MastodonApi([toot1])
+    val, code = generate_xml(api, param, target='home_timeline')
+    val = re.sub(
+        r'(<lastBuildDate>)(.*)(</lastBuildDate>)',
+        '<lastBuildDate></lastBuildDate>',
+        val,
+    )
+    assert val == toot_1_home_timeline_feed
+    assert code == 200
+
+
+def test_generate_xml_home_timeline_limit_ok() -> None:
+    api = MastodonApi([toot1] * 150)
+    val, code = generate_xml(api, param, target='home_timeline')
+    val = re.sub(
+        r'(<lastBuildDate>)(.*)(</lastBuildDate>)',
+        '<lastBuildDate></lastBuildDate>',
+        val,
+    )
+    assert val == toot_100_home_timeline_feed
+    assert code == 200
+
+
 def test_it_raises_exception_when_target_is_invalid() -> None:
     api = MastodonApi([])
     with pytest.raises(Exception, match='Invalid target'):

twootfeed/tests/utils.py

@@ -92,6 +92,9 @@ def bookmarks(self) -> List[Dict]:
     def favourites(self) -> List[Dict]:
         return self.return_result()
 
+    def timeline_home(self) -> List[Dict]:
+        return self.return_result()
+
     def fetch_next(self, toots: List[Dict]) -> List[Dict]:
         return self.return_result()