Merge pull request #245 from OperationCode/staging

AllenAnthes · web-flow · commit 75ee8b9598a8 · 2020-10-28T16:13:18.000-05:00
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ extending [Pyslacker's](https://pyslackers.com/)
 framework.
 
 ## Resources
-* [Slack Bot Tutorial](https://www.fullstackpython.com/blog/build-first-slack-bot-python.html)
+* [Slack Bot Tutorial](https://www.digitalocean.com/community/tutorials/how-to-build-a-slackbot-in-python-on-ubuntu-20-04)
 * [Slack Events API Framework](https://github.com/slackapi/python-slack-events-api)
 * [sir-bot-a-lot](https://github.com/pyslackers/sir-bot-a-lot-2)
 
@@ -213,6 +213,13 @@ example:
 
     https://123_random_code_321.ngrok.io/slack/events
 
+Additional setup may needed depending on the type of events pybot is subscribing to. 
+For example, in order to work on the app's functionality on a `team_join` event, you need to:  
+
+* Add `team_join` to workspace event
+* Make sure `greetings` channel exists and ensure the app is invited to the channel
+* Add necessary OAuth scopes to the app e.g. `users:read`, `chat:write`, etc.
+
 #### Slash Commands
 
 You can follow the instructions (and read helpful relation information) on the
diff --git a/pybot/endpoints/airtable/message_templates/messages.py b/pybot/endpoints/airtable/message_templates/messages.py
@@ -1,12 +1,15 @@
 from typing import List
 
 
-def mentor_request_text(user_id, service, skillsets, requested_mentor_message=None):
+def mentor_request_text(
+    user_id, service, skillsets, affiliation, requested_mentor_message=None
+):
     if not skillsets:
         skillsets = "None provided"
     text = (
         f"User <@{user_id}> has requested a mentor for {service}\n\n"
-        f"Requested Skillset(s): {skillsets.replace(',', ', ')}"
+        f"Requested Skillset(s): {skillsets.replace(',', ', ')}\n\n"
+        f"Requestor Affiliation: {affiliation}"
     )
 
     if requested_mentor_message:
@@ -29,7 +32,7 @@ def claim_mentee_attachment(record: str) -> List[dict]:
                     "text": "Claim Mentee",
                     "type": "button",
                     "style": "primary",
-                    "value": f"mentee_claimed",
+                    "value": "mentee_claimed",
                 }
             ],
         }
diff --git a/pybot/endpoints/airtable/utils.py b/pybot/endpoints/airtable/utils.py
@@ -65,6 +65,7 @@ def _create_messages(
             slack_id,
             service_translation,
             request.get("skillsets", None),
+            request.get("affiliation", "None Provided"),
             requested_mentor_message,
         ),
         "attachments": claim_mentee_attachment(request["record"]),
diff --git a/pybot/endpoints/api/utils.py b/pybot/endpoints/api/utils.py
@@ -6,7 +6,7 @@
 from slack.io.abc import SlackAPI
 from slack.methods import Methods
 
-from pybot.endpoints.slack.utils import PYBOT_ENV, OPS_CHANNEL
+from pybot.endpoints.slack.utils import OPS_CHANNEL, PYBOT_ENV
 from pybot.endpoints.slack.utils.action_messages import (
     TICKET_OPTIONS,
     not_claimed_attachment,
diff --git a/pybot/endpoints/slack/actions/__init__.py b/pybot/endpoints/slack/actions/__init__.py
@@ -20,9 +20,11 @@
 )
 from .new_member import (
     member_greeted,
+    member_messaged,
     open_suggestion,
     post_suggestion,
     reset_greet,
+    reset_message,
     resource_buttons,
 )
 from .report_message import open_report_dialog, send_report
@@ -38,6 +40,8 @@ def create_endpoints(plugin: SlackPlugin):
     plugin.on_action("resource_buttons", resource_buttons, wait=False)
     plugin.on_action("greeted", member_greeted, name="greeted", wait=False)
     plugin.on_action("greeted", reset_greet, name="reset_greet", wait=False)
+    plugin.on_action("messaged", member_messaged, name="messaged", wait=False)
+    plugin.on_action("messaged", reset_message, name="reset_message", wait=False)
     plugin.on_action("suggestion", open_suggestion, wait=False)
     plugin.on_action("suggestion_modal", post_suggestion, wait=False)
 
diff --git a/pybot/endpoints/slack/actions/new_member.py b/pybot/endpoints/slack/actions/new_member.py
@@ -6,8 +6,10 @@
 from pybot.endpoints.slack.utils.action_messages import (
     HELP_MENU_RESPONSES,
     base_response,
+    direct_messaged_attachment,
     greeted_attachment,
     new_suggestion_text,
+    not_direct_messaged_attachment,
     not_greeted_attachment,
     reset_greet_message,
     suggestion_dialog,
@@ -71,3 +73,25 @@ async def reset_greet(action: Action, app: SirBot):
     response["attachments"][0]["text"] = reset_greet_message(action["user"]["id"])
 
     await app.plugins["slack"].api.query(methods.CHAT_UPDATE, response)
+
+
+async def member_messaged(action: Action, app: SirBot):
+    """
+    Called when a outreach team member clicks the button saying they messaged the new member
+    """
+    response = base_response(action)
+    user_id = action["user"]["id"]
+    response["attachments"] = direct_messaged_attachment(user_id)
+
+    await app.plugins["slack"].api.query(methods.CHAT_UPDATE, response)
+
+
+async def reset_message(action: Action, app: SirBot):
+    """
+    Resets the claim messaged button back to its initial state and appends the user that hit reset and the time
+    """
+    response = base_response(action)
+    response["attachments"] = not_direct_messaged_attachment()
+    response["attachments"][0]["text"] = reset_greet_message(action["user"]["id"])
+
+    await app.plugins["slack"].api.query(methods.CHAT_UPDATE, response)
diff --git a/pybot/endpoints/slack/commands.py b/pybot/endpoints/slack/commands.py
@@ -48,19 +48,16 @@ async def slash_mentor(command: Command, app: SirBot):
 
 @catch_command_slack_error
 async def slash_mentor_volunteer(command: Command, app: SirBot) -> None:
-    airtable = app.plugins["airtable"].api
-    skillsets = await airtable.get_all_records("Skillsets", "Name")
 
-    blocks = mentor_volunteer_blocks(skillsets)
     response = {
-        "text": "Mentor Sign up Form",
-        "blocks": blocks,
+        "text": "Please fill up the Mentor Sign up Form here: https://op.co.de/volunteer-signup",
         "channel": command["user_id"],
         "as_user": True,
     }
 
     await app.plugins["slack"].api.query(methods.CHAT_POST_MESSAGE, response)
 
+
 @catch_command_slack_error
 async def slash_report(command: Command, app: SirBot):
     """
diff --git a/pybot/endpoints/slack/events.py b/pybot/endpoints/slack/events.py
@@ -29,10 +29,11 @@ async def team_join(event: Event, app: SirBot) -> None:
     slack_api = app.plugins["slack"].api
     user_id = event["user"]["id"]
 
-    *user_messages, community_message = build_messages(user_id)
+    *user_messages, community_message, outreach_team_message = build_messages(user_id)
     futures = [
         send_user_greetings(user_messages, slack_api),
         send_community_notification(community_message, slack_api),
+        send_community_notification(outreach_team_message, slack_api),
     ]
 
     logger.info(f"New team join event: {event}")
diff --git a/pybot/endpoints/slack/message_templates/commands.py b/pybot/endpoints/slack/message_templates/commands.py
@@ -78,7 +78,7 @@ def mentor_request_blocks(services, skillsets):
         {
             "type": "section",
             "block_id": "comments",
-            "text": {"type": "mrkdwn", "text": "*Add additional comments* (optional)"},
+            "text": {"type": "mrkdwn", "text": "*Add comments* (required)"},
             "accessory": {
                 "type": "button",
                 "action_id": "comments_btn",
@@ -111,6 +111,10 @@ def mentor_request_blocks(services, skillsets):
                         "text": {"type": "plain_text", "text": "Military Spouse"},
                         "value": "Military Spouse",
                     },
+                    {
+                        "text": {"type": "plain_text", "text": "Non Veteran"},
+                        "value": "Non Veteran",
+                    },
                 ],
             },
         },
diff --git a/pybot/endpoints/slack/message_templates/mentor_request.py b/pybot/endpoints/slack/message_templates/mentor_request.py
@@ -81,14 +81,14 @@ def affiliation(self, new_affiliation: str) -> None:
             self.clear_errors()
 
     def validate_self(self) -> bool:
-        if not self.service or not self.affiliation:
+        if not self.service or not self.affiliation or not self.details:
             return False
         self.clear_errors()
         return True
 
     def add_errors(self) -> None:
         submit_attachment = {
-            "text": ":warning: Service and group certification are required. :warning:",
+            "text": ":warning: Service, group certification and comments are required. :warning:",
             "color": "danger",
         }
         self.attachments = [submit_attachment]
@@ -245,7 +245,7 @@ def mentee_claimed_attachment(self) -> dict:
             "actions": [
                 {
                     "name": f"{self.record}",
-                    "text": f"Reset claim",
+                    "text": "Reset claim",
                     "type": "button",
                     "style": "danger",
                     "value": "reset_claim_mentee",
diff --git a/pybot/endpoints/slack/utils/action_messages.py b/pybot/endpoints/slack/utils/action_messages.py
@@ -103,7 +103,7 @@ def greeted_attachment(user_id: str) -> List[dict]:
             "actions": [
                 {
                     "name": "reset_greet",
-                    "text": f"Reset claim",
+                    "text": "Reset claim",
                     "type": "button",
                     "style": "danger",
                     "value": "reset_greet",
@@ -134,6 +134,49 @@ def not_greeted_attachment():
     ]
 
 
+def direct_messaged_attachment(user_id: str) -> List[dict]:
+    return [
+        {
+            "text": f":100:<@{user_id}> has DMed the new user!:100:\n"
+            f"<!date^{now()}^DMed at {{date_num}} {{time_secs}}|Failed to parse time>",
+            "fallback": "",
+            "color": "#3AA3E3",
+            "callback_id": "messaged",
+            "attachment_type": "default",
+            "actions": [
+                {
+                    "name": "reset_message",
+                    "text": f"Reset DM",
+                    "type": "button",
+                    "style": "danger",
+                    "value": "reset_message",
+                }
+            ],
+        }
+    ]
+
+
+def not_direct_messaged_attachment():
+    return [
+        {
+            "text": "",
+            "fallback": "Someone should DM them!",
+            "color": "#3AA3E3",
+            "callback_id": "messaged",
+            "attachment_type": "default",
+            "actions": [
+                {
+                    "name": "messaged",
+                    "text": "I will DM them!",
+                    "type": "button",
+                    "style": "primary",
+                    "value": "messaged",
+                }
+            ],
+        }
+    ]
+
+
 def not_claimed_attachment():
     return {
         "text": "",
@@ -165,7 +208,7 @@ def claimed_attachment(user_id):
         "actions": [
             {
                 "name": "reset_claim",
-                "text": f"Reset claim",
+                "text": "Reset claim",
                 "type": "button",
                 "style": "danger",
                 "value": "reset_claim",
diff --git a/pybot/endpoints/slack/utils/event_utils.py b/pybot/endpoints/slack/utils/event_utils.py
@@ -12,7 +12,10 @@
     BACKEND_USERNAME,
     COMMUNITY_CHANNEL,
 )
-from pybot.endpoints.slack.utils.action_messages import not_greeted_attachment
+from pybot.endpoints.slack.utils.action_messages import (
+    not_direct_messaged_attachment,
+    not_greeted_attachment,
+)
 from pybot.endpoints.slack.utils.event_messages import (
     base_resources,
     external_button_attachments,
@@ -30,7 +33,7 @@ def base_user_message(user_id: str) -> Message:
     return message
 
 
-def build_messages(user_id) -> Tuple[Message, Message, Message, Message]:
+def build_messages(user_id) -> Tuple[Message, Message, Message, Message, Message]:
     initial_message = base_user_message(user_id)
     initial_message["text"] = team_join_initial_message(user_id)
 
@@ -47,7 +50,21 @@ def build_messages(user_id) -> Tuple[Message, Message, Message, Message]:
     community_message["attachments"] = not_greeted_attachment()
     community_message["channel"] = COMMUNITY_CHANNEL
 
-    return initial_message, second_message, action_menu, community_message
+    outreach_team_message = Message()
+    outreach_team_message["text"] = (
+        f":spiral_note_pad: Outreach Team: Please reach out to <@{user_id}> via DM"
+        f":spiral_note_pad: "
+    )
+    outreach_team_message["attachments"] = not_direct_messaged_attachment()
+    outreach_team_message["channel"] = COMMUNITY_CHANNEL
+
+    return (
+        initial_message,
+        second_message,
+        action_menu,
+        community_message,
+        outreach_team_message,
+    )
 
 
 async def send_user_greetings(
diff --git a/pybot/endpoints/slack/utils/slash_lunch.py b/pybot/endpoints/slack/utils/slash_lunch.py
@@ -12,7 +12,7 @@
 class LunchCommand:
     DEFAULT_LUNCH_DISTANCE = 20
     MIN_LUNCH_RANGE = 1
-    AUTH_HEADER = {f"Authorization": f"Bearer {YELP_TOKEN}"}
+    AUTH_HEADER = {"Authorization": f"Bearer {YELP_TOKEN}"}
 
     def __init__(self, channel: str, user: str, input_text: str, user_name: str):
 
diff --git a/pybot/plugins/airtable/api.py b/pybot/plugins/airtable/api.py
@@ -16,19 +16,19 @@ def __init__(self, session, api_key, base_key):
         self.base_key = base_key
 
     async def get(self, url, **kwargs):
-        auth_header = {f"Authorization": f"Bearer {self.api_key}"}
+        auth_header = {"Authorization": f"Bearer {self.api_key}"}
 
         async with self.session.get(url, headers=auth_header, **kwargs) as r:
             return await r.json()
 
     async def patch(self, url, **kwargs):
-        auth_header = {f"authorization": f"Bearer {self.api_key}"}
+        auth_header = {"authorization": f"Bearer {self.api_key}"}
         async with self.session.patch(url, headers=auth_header, **kwargs) as r:
             r.raise_for_status()
             return await r.json()
 
     async def post(self, url, **kwargs):
-        auth_header = {f"authorization": f"Bearer {self.api_key}"}
+        auth_header = {"authorization": f"Bearer {self.api_key}"}
         async with self.session.post(url, headers=auth_header, **kwargs) as r:
             return await r.json()
 
