Merge pull request #235 from chynh/add-greetings

add "I will DM" button

Author: Aaron Suarez

README.md

@@ -212,6 +212,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

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)
 

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)

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}")

pybot/endpoints/slack/utils/action_messages.py

@@ -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": "",

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(