feat(reddit): add flair proecessing

Author: ReenigneArcher

src/reddit_bot/bot.py

@@ -184,12 +184,15 @@ def process_submission(self, submission: models.Submission):
                     'created_utc': submission.created_utc,
                     'permalink': submission.permalink,
                     'url': submission.url,
+                    'link_flair_template_id': submission.link_flair_template_id if hasattr(
+                        submission, 'link_flair_template_id') else None,
                     'link_flair_text': submission.link_flair_text if hasattr(submission, 'link_flair_text') else None,
                     'link_flair_background_color': submission.link_flair_background_color if hasattr(
                         submission, 'link_flair_background_color') else None,
                     'bot_discord': existing_submission.get(
                         'bot_discord', {'sent': False, 'sent_utc': None}),
                 }
+                submission_data = self.flair(submission=submission, submission_data=submission_data)
                 submissions_table.update(submission_data, q.reddit_id == submission.id)
                 return
 
@@ -202,6 +205,8 @@ def process_submission(self, submission: models.Submission):
             'created_utc': submission.created_utc,
             'permalink': submission.permalink,
             'url': submission.url,
+            'link_flair_template_id': submission.link_flair_template_id if hasattr(
+                submission, 'link_flair_template_id') else None,
             'link_flair_text': submission.link_flair_text if hasattr(submission, 'link_flair_text') else None,
             'link_flair_background_color': submission.link_flair_background_color if hasattr(
                 submission, 'link_flair_background_color') else None,
@@ -220,9 +225,9 @@ def process_submission(self, submission: models.Submission):
         except Exception:
             logger.exception("Error awarding XP")
 
+        submission_data = self.flair(submission=submission, submission_data=submission_data)
         if os.getenv('DISCORD_REDDIT_CHANNEL_ID'):
             submission_data = self.discord(submission=submission, submission_data=submission_data)
-        submission_data = self.flair(submission=submission, submission_data=submission_data)
         submission_data = self.karma(submission=submission, submission_data=submission_data)
 
         with self.db as db:
@@ -305,11 +310,12 @@ def discord(self, submission: models.Submission, submission_data: dict) -> dict:
         submission_data : dict
             The submission data to process.
         """
-        # get the flair color
-        try:
-            color = int(submission.link_flair_background_color, 16)
-        except Exception:
-            color = common.colors['white']
+        flair_data = submission_data.get('flair', {})
+        color = flair_data.get('color') or self.parse_flair_color(submission_data.get('link_flair_background_color'))
+
+        footer_parts = [f'Posted on r/{self.subreddit_name}']
+        if flair_data.get('text'):
+            footer_parts.append(flair_data['text'])
 
         try:
             redditor = self.fetch_user(name=submission.author)
@@ -329,7 +335,7 @@ def discord(self, submission: models.Submission, submission_data: dict) -> dict:
             color=color,
             description=submission.selftext,
             footer=discord.EmbedFooter(
-                text=f'Posted on r/{self.subreddit_name}',
+                text=' - '.join(footer_parts),
                 icon_url='https://www.redditstatic.com/desktop2x/img/favicon/favicon-32x32.png'
             ),
             title=submission.title,
@@ -352,9 +358,31 @@ def discord(self, submission: models.Submission, submission_data: dict) -> dict:
 
         return submission_data
 
+    @staticmethod
+    def parse_flair_color(flair_color: Optional[str]) -> int:
+        if not flair_color:
+            return common.colors['white']
+
+        try:
+            return int(flair_color.removeprefix('#'), 16)
+        except ValueError:
+            return common.colors['white']
+
     def flair(self, submission: models.Submission, submission_data: dict) -> dict:
-        # TODO: implement automatic flair checks or updates from submission metadata.
-        logger.debug("Reddit flair handling is not implemented for submission=%r", submission)
+        flair_template_id = getattr(submission, 'link_flair_template_id', None)
+        flair_text = getattr(submission, 'link_flair_text', None)
+        flair_background_color = getattr(submission, 'link_flair_background_color', None)
+
+        submission_data['link_flair_template_id'] = flair_template_id
+        submission_data['link_flair_text'] = flair_text
+        submission_data['link_flair_background_color'] = flair_background_color
+        submission_data['flair'] = {
+            'template_id': flair_template_id,
+            'text': flair_text,
+            'background_color': flair_background_color,
+            'color': self.parse_flair_color(flair_background_color),
+        }
+
         return submission_data
 
     def karma(self, submission: models.Submission, submission_data: dict) -> dict:

tests/unit/reddit/test_reddit_bot.py

@@ -19,6 +19,7 @@
 import pytest
 
 # local imports
+from src.common import globals
 from src.reddit_bot.bot import Bot
 
 Betamax.register_serializer(PrettyJSONSerializer)
@@ -238,14 +239,75 @@ def test_stream_loop_stops_before_streaming():
     assert processed == []
 
 
-@pytest.mark.parametrize("method_name", ["flair", "karma"])
-def test_submission_placeholder_handlers_log_unimplemented(caplog, method_name):
+def test_flair_normalizes_submission_flair():
+    bot = bare_bot()
+    submission = SimpleNamespace(
+        id='abc123',
+        link_flair_template_id='be393440-ff87-11ec-9bbd-e2c872b60c34',
+        link_flair_text='Support',
+        link_flair_background_color='#ea0027',
+    )
+    submission_data = {}
+
+    result = bot.flair(submission=submission, submission_data=submission_data)
+
+    assert result is submission_data
+    assert result['link_flair_template_id'] == 'be393440-ff87-11ec-9bbd-e2c872b60c34'
+    assert result['link_flair_text'] == 'Support'
+    assert result['link_flair_background_color'] == '#ea0027'
+    assert result['flair'] == {
+        'template_id': 'be393440-ff87-11ec-9bbd-e2c872b60c34',
+        'text': 'Support',
+        'background_color': '#ea0027',
+        'color': 0xea0027,
+    }
+
+
+def test_discord_uses_normalized_flair(mocker):
+    bot = bare_bot()
+    bot.subreddit_name = 'LizardByte'
+    bot.fetch_user = mocker.Mock(return_value=SimpleNamespace(
+        name='test_user',
+        icon_img='https://example.com/avatar.png',
+    ))
+    send_message = mocker.Mock(return_value=object())
+    mocker.patch.object(globals, 'DISCORD_BOT', SimpleNamespace(send_message=send_message))
+    submission = SimpleNamespace(
+        author='test_user',
+        created_utc=1700000000,
+        permalink='/r/LizardByte/comments/abc123/test/',
+        selftext='Post body',
+        title='Post title',
+    )
+    submission_data = {
+        'flair': {
+            'template_id': 'be393440-ff87-11ec-9bbd-e2c872b60c34',
+            'text': 'Support',
+            'background_color': '#ea0027',
+            'color': 0xea0027,
+        },
+        'link_flair_background_color': '#ea0027',
+    }
+
+    with patch.dict(os.environ, {'DISCORD_REDDIT_CHANNEL_ID': '12345'}):
+        result = bot.discord(submission=submission, submission_data=submission_data)
+
+    send_message.assert_called_once()
+    embed = send_message.call_args.kwargs['embed']
+    assert send_message.call_args.kwargs['channel_id'] == '12345'
+    assert embed.color.value == 0xea0027
+    assert embed.footer.text == 'Posted on r/LizardByte - Support'
+    assert result['bot_discord']['sent'] is True
+    assert 'sent_utc' in result['bot_discord']
+
+
+def test_karma_placeholder_handler_logs_unimplemented(caplog):
     bot = bare_bot()
     submission = SimpleNamespace(id='abc123')
     submission_data = {}
 
     with caplog.at_level(logging.DEBUG, logger='src.reddit_bot.bot'):
-        result = getattr(bot, method_name)(submission=submission, submission_data=submission_data)
+        result = bot.karma(submission=submission, submission_data=submission_data)
 
     assert result is submission_data
     assert "not implemented" in caplog.text