refactor mentee claim/unclaim to class based message

Author: AllenAnthes

pybot/endpoints/slack/actions/mentor_request.py

@@ -1,12 +1,14 @@
 import json
+import logging
 
 from sirbot import SirBot
 from slack import methods
 from slack.actions import Action
 
-from pybot.endpoints.slack.message_templates.mentor_request import MentorRequest
-from pybot.endpoints.slack.utils.action_messages import base_response, mentor_details_dialog, \
-    mentee_unclaimed_attachment, mentee_claimed_attachment
+from pybot.endpoints.slack.message_templates.mentor_request import MentorRequest, MentorRequestClaim
+from pybot.endpoints.slack.utils.action_messages import mentor_details_dialog
+
+logger = logging.getLogger(__name__)
 
 
 async def mentor_request_submit(action: Action, app: SirBot):
@@ -123,34 +125,19 @@ async def claim_mentee(action: Action, app: SirBot):
         slack = app.plugins['slack'].api
         airtable = app.plugins['airtable'].api
 
-        update_airtable = True
-        clicker_id = action['user']['id']
-        request_record = action['actions'][0]['name']
-        click_type = action['actions'][0]['value']
-
-        response = base_response(action)
-
-        user_info = await slack.query(methods.USERS_INFO, dict(user=clicker_id))
-        clicker_email = user_info['user']['profile']['email']
+        event = MentorRequestClaim(action, slack, airtable)
+        if event.is_claim():
+            user_info = await slack.query(methods.USERS_INFO, {'user': event.clicker})
+            clicker_email = user_info['user']['profile']['email']
 
-        if click_type == 'mentee_claimed':
-            records = await airtable.find_records(table_name='Mentors', field='Email', value=clicker_email)
-            mentor_id = records[0]['id'] if records else ''
+            mentor_records = await airtable.find_records(table_name='Mentors', field='Email', value=clicker_email)
+            mentor_id = mentor_records[0]['id'] if mentor_records else False
 
-            if mentor_id:
-                attachment = mentee_claimed_attachment(clicker_id, request_record)
-            else:
-                update_airtable = False
-                attachment = action['original_message']['attachments']
-                attachment[0]['text'] = f":warning: <@{clicker_id}>'s slack Email not found in Mentor table. :warning:"
+            await event.claim_request(mentor_id)
         else:
-            mentor_id = ''
-            attachment = mentee_unclaimed_attachment(clicker_id, request_record)
+            await event.unclaim_request()
 
-        response['attachments'] = attachment
+        await event.update_message()
 
-        await slack.query(methods.CHAT_UPDATE, response)
-        if update_airtable:
-            await airtable.update_request(request_record, mentor_id)
-    except Exception as ex:
-        print(ex)
+    except Exception:
+        logger.exception('Exception while updating claim')

pybot/endpoints/slack/message_templates/mentor_request.py

@@ -1,7 +1,10 @@
+from typing import MutableMapping, Optional
+
 from slack import methods
 from slack.actions import Action
 from slack.io.abc import SlackAPI
 
+from pybot.endpoints.slack.utils.action_messages import now
 from pybot.plugins.airtable.api import AirtableAPI
 
 SERVICE_INDEX = 0
@@ -18,6 +21,12 @@ def __init__(self, action: Action, channel=None):
         self.action = action
         self.channel = channel
 
+    def __getitem__(self, item):
+        return self.action[item]
+
+    def __setitem__(self, key, value):
+        self.action[key] = value
+
     @classmethod
     def selected_option(cls, attachment):
         action = attachment['actions'][0]
@@ -27,7 +36,7 @@ def selected_option(cls, attachment):
 
     @property
     def attachments(self):
-        return self.action['attachments']
+        return self['attachments']
 
     @property
     def service(self):
@@ -91,7 +100,7 @@ def details(self, new_details):
     def update_params(self):
         return {
             'channel': self.channel,
-            'ts': self.action['ts'],
+            'ts': self['ts'],
             'attachments': self.attachments
         }
 
@@ -139,11 +148,108 @@ def submission_complete(self, slack: SlackAPI):
         done_attachment['text'] = 'Request submitted successfully!'
         done_attachment['actions'] = [{'type': 'button', 'text': 'Dismiss', 'name': 'cancel', 'value': 'cancel'}]
 
-        self.action['attachments'] = [done_attachment]
+        self['attachments'] = [done_attachment]
         return self.update(slack)
 
     def clear_skillsets(self):
         self.attachments[SKILLSET_INDEX]['text'] = ''
 
     def update(self, slack: SlackAPI):
         return slack.query(methods.CHAT_UPDATE, self.update_params)
+
+
+class MentorRequestClaim(Action):
+
+    def __init__(self, raw_action: MutableMapping, slack: SlackAPI, airtable: AirtableAPI):
+        super().__init__(raw_action)
+        self.slack = slack
+        self.airtable = airtable
+        self.attachment = raw_action['original_message']['attachments'][0]
+        self.should_update = True
+
+    @property
+    def trigger(self) -> dict:
+        return self['actions'][0]
+
+    @property
+    def click_type(self) -> str:
+        return self.trigger['value']
+
+    def is_claim(self):
+        return self.click_type == 'mentee_claimed'
+
+    @property
+    def record(self) -> str:
+        """ Airtable record ID for the mentor request """
+        return self.trigger['name']
+
+    @property
+    def clicker(self):
+        return self['user']['id']
+
+    @property
+    def attachment(self):
+        return self['original_message']['attachments'][0]
+
+    @attachment.setter
+    def attachment(self, value):
+        self['original_message']['attachments'][0] = value
+
+    def claim_request(self, mentor_record):
+        if mentor_record:
+            self.attachment = self.mentee_claimed_attachment()
+        else:
+            self.attachment['text'] = f":warning: <@{self.clicker}>'s slack Email not found in Mentor table. :warning:"
+            self.should_update = False
+
+        return self.update_airtable(mentor_record)
+
+    def unclaim_request(self):
+        self.attachment = self.mentee_unclaimed_attachment()
+        return self.update_airtable('')
+
+    async def update_airtable(self, mentor_id: Optional[str]):
+        if mentor_id:
+            return self.airtable.update_request(self.record, mentor_id)
+
+    async def update_message(self):
+        response = {
+            'channel': self['channel']['id'],
+            'ts': self['message_ts'],
+            'attachments': self['original_message']['attachments']
+        }
+        await self.slack.query(methods.CHAT_UPDATE, response)
+
+    def mentee_claimed_attachment(self) -> dict:
+        return {
+            "text": f":100: Request claimed by <@{self.clicker}>:100:\n"
+                    f"<!date^{now()}^Claimed at {{date_num}} {{time_secs}}|Failed to parse time>",
+            "fallback": "",
+            "color": "#3AA3E3",
+            "callback_id": "claim_mentee",
+            "attachment_type": "default",
+            "actions": [{
+                'name': f'{self.record}',
+                "text": f"Reset claim",
+                "type": "button",
+                "style": "danger",
+                "value": "reset_claim_mentee",
+            }]
+        }
+
+    def mentee_unclaimed_attachment(self) -> dict:
+        return {
+            'text': f"Reset by <@{self.clicker}> at"
+                    f" <!date^{now()}^ {{date_num}} {{time_secs}}|Failed to parse time>",
+            'fallback': '',
+            'color': '#3AA3E3',
+            'callback_id': 'claim_mentee',
+            'attachment_type': 'default',
+            'actions': [{
+                'name': f'{self.record}',
+                'text': 'Claim Mentee',
+                'type': 'button',
+                'style': 'primary',
+                'value': 'mentee_claimed'
+            }]
+        }

pybot/endpoints/slack/utils/action_messages.py

@@ -250,42 +250,6 @@ def mentor_details_dialog(action):
     }
 
 
-def mentee_claimed_attachment(user_id: str, record: str) -> List[dict]:
-    return [{
-        "text": f":100: Request claimed by <@{user_id}>:100:\n"
-                f"<!date^{now()}^Claimed at {{date_num}} {{time_secs}}|Failed to parse time>",
-        "fallback": "",
-        "color": "#3AA3E3",
-        "callback_id": "claim_mentee",
-        "attachment_type": "default",
-        "actions": [{
-            'name': f'{record}',
-            "text": f"Reset claim",
-            "type": "button",
-            "style": "danger",
-            "value": "reset_claim_mentee",
-        }]
-    }]
-
-
-def mentee_unclaimed_attachment(user_id: str, record: str) -> List[dict]:
-    return [{
-        'text': f"Reset by <@{user_id}> at"
-                f" <!date^{now()}^ {{date_num}} {{time_secs}}|Failed to parse time>",
-        'fallback': '',
-        'color': '#3AA3E3',
-        'callback_id': 'claim_mentee',
-        'attachment_type': 'default',
-        'actions': [{
-            'name': f'{record}',
-            'text': 'Claim Mentee',
-            'type': 'button',
-            'style': 'primary',
-            'value': 'mentee_claimed'
-        }]
-    }]
-
-
 def new_suggestion_text(user_id: str, suggestion: str) -> str:
     return f":exclamation:<@{user_id}> just submitted a suggestion for a help topic:exclamation:\n-- {suggestion}"