added topic suggestion option and notification

Author: AllenAnthes

src/app.py

@@ -4,9 +4,11 @@
 from utils.log_manager import setup_logging
 from decouple import config
 import traceback
+from pprint import pprint
+
 
 from src.help_menu import HELP_MENU_RESPONSES
-from src.messages import HELP_MENU, MESSAGE, needs_greet_button, greeted_response_attachments
+from src.messages import HELP_MENU, MESSAGE, needs_greet_button, greeted_response_attachments, SUGGESTION_MODAL
 
 logger = logging.getLogger(__name__)
 new_event_logger = logging.getLogger(f'{__name__}.new_member')
@@ -19,9 +21,10 @@
 # COMMUNITY_CHANNEL = config('PERSONAL_PRIVATE_CHANNEL')
 
 TOKEN = config('OPCODE_APP_TOKEN')
-COMMUNITY_CHANNEL = config('OPCODE_REWRITE_CHANNEL')
-PROJECTS_CHANNEL = config('OPCODE_OC_PROJECTS_CHANNEL')
+# COMMUNITY_CHANNEL = config('OPCODE_REWRITE_CHANNEL')
+# PROJECTS_CHANNEL = config('OPCODE_OC_PROJECTS_CHANNEL')
 # COMMUNITY_CHANNEL = config('OPCODE_COMMUNITY_ID')
+COMMUNITY_CHANNEL = config('OPCODE_BOT_TESTING_CHANNEL')
 
 PROXY = PROXY if PROXY else None
 slack_client = SlackClient(TOKEN, proxies=PROXY)
@@ -39,9 +42,9 @@ def event_handler(event_dict: dict) -> None:
     :param event_dict:
     """
     # all_event_logger.info(event_dict)
-    if event_dict['type'] == 'team_join':
-        new_event_logger.info('New member event recieved')
-        new_member(event_dict)
+    # if event_dict['type'] == 'team_join':
+    #     new_event_logger.info('New member event recieved')
+    #     new_member(event_dict)
 
     """ Trigger for testing team_join event """
     if event_dict['type'] == 'message' and 'user' in event_dict.keys() and event_dict['text'] == 'testgreet':
@@ -55,12 +58,21 @@ def help_menu_interaction(data: dict) -> None:
     displayed message
     :param data:
     """
-    params = {'text': '  \n\n\n' + HELP_MENU_RESPONSES[data['actions'][0]['value']],
-              'channel': data['channel']['id'],
-              'ts': data['message_ts'],
-              'as_user': True
-              }
-    slack_client.api_call('chat.update', **params)
+
+    response = data['actions'][0]['value']
+
+    if response == 'suggestion':
+        trigger_id = data['trigger_id']
+        res = slack_client.api_call('dialog.open', trigger_id=trigger_id, dialog=SUGGESTION_MODAL)
+        pprint(res)
+
+    else:
+        params = {'text': '  \n\n\n' + HELP_MENU_RESPONSES[data['actions'][0]['value']],
+                  'channel': data['channel']['id'],
+                  'ts': data['message_ts'],
+                  'as_user': True
+                  }
+        slack_client.api_call('chat.update', **params)
 
 
 def greeted_interaction(data: dict) -> dict:
@@ -91,6 +103,13 @@ def greeted_interaction(data: dict) -> dict:
         res = slack_client.api_call("chat.update", **params)
 
 
+def suggestion_submission(data):
+    suggestion = data['submission']['suggestion']
+    user_id = data['user']['id']
+    message = f"<@{user_id}> just submitted a suggestion for a help topic:\n{suggestion}"
+    res = slack_client.api_call('chat.postMessage', channel=COMMUNITY_CHANNEL, text=message)
+
+
 def new_member(event_dict: dict) -> None:
     new_event_logger.info('Recieved json event: {}'.format(event_dict))
 
@@ -102,27 +121,27 @@ def new_member(event_dict: dict) -> None:
     custom_message = MESSAGE.format(real_name=real_name)
 
     new_event_logger.info('Built message: {}'.format(custom_message))
-    response = slack_client.api_call('chat.postMessage',
-                                     channel=user_id,
-                                     # channel=COMMUNITY_CHANNEL, #  testing option
-                                     # as_user=True,  # Currently not working.  DM comes from my account
-                                     text=custom_message)
+    # response = slack_client.api_call('chat.postMessage',
+    #                                  # channel=user_id,
+    #                                  channel=COMMUNITY_CHANNEL, #  testing option
+    #                                  # as_user=True,  # Currently not working.  DM comes from my account
+    #                                  text=custom_message)
 
     r2 = slack_client.api_call('chat.postMessage',
-                               channel=user_id,
-                               # channel=COMMUNITY_CHANNEL, #  testing option
+                               # channel=user_id,
+                               channel=COMMUNITY_CHANNEL, #  testing option
                                # as_user=True,
                                **HELP_MENU)
 
     # Notify #community
     text = f":tada: <@{user_id}> has joined the Slack team :tada:"
     slack_client.api_call('chat.postMessage', channel=COMMUNITY_CHANNEL,
                           text=text, attachments=needs_greet_button())
-
-    if response['ok']:
-        new_event_logger.info('New Member Slack response: Response 1: {} \nResponse2: {}'.format(response, r2))
-    else:
-        new_event_logger.error('FAILED -- Message to new member returned error: {}'.format(response))
+    #
+    # if response['ok']:
+    #     new_event_logger.info('New Member Slack response: Response 1: {} \nResponse2: {}'.format(response, r2))
+    # else:
+    #     new_event_logger.error('FAILED -- Message to new member returned error: {}'.format(response))
 
 
 def parse_slack_output(slack_rtm_output: list) -> None:
@@ -157,10 +176,10 @@ def join_channels():
     """
     response = slack_client.api_call('channels.join', name='general')
     print(response)
+# set the defalt to a 1 second delay
 
 
-# set the defalt to a 1 second delay
-def run_bot(delay: int=1) -> None:
+def run_bot(delay: int = 1) -> None:
     """
     Runs the bot using the Slack Real Time Messaging API.
     **Doesn't provide events or interactive functionality
@@ -183,4 +202,4 @@ def run_bot(delay: int=1) -> None:
 
 
 if __name__ == '__main__':
-    run_bot()
+    run_bot()

src/flask_endpoint.py

@@ -1,3 +1,5 @@
+from pprint import pprint
+
 from flask import Flask, request, make_response
 from decouple import config
 import json
@@ -8,8 +10,6 @@
 app = Flask(__name__)
 
 VERIFICATION_TOKEN = config('OPCODE_VERIFICATION_TOKEN')
-
-
 # VERIFICATION_TOKEN = config('APP_VERIFICATION_TOKEN')
 
 
@@ -25,11 +25,15 @@ def interaction():
         print("Bad request")
         return make_response("", 403)
     callback = data['callback_id']
+    pprint(data['user'])
 
     if callback == 'greeting_buttons':
         bot.help_menu_interaction(data)
     elif callback == 'greeted':
         bot.greeted_interaction(data)
+    elif callback == 'suggestion_modal':
+        pprint(data)
+        bot.suggestion_submission(data)
     return make_response('', 200)
 
 

src/messages.py

@@ -8,10 +8,12 @@
     "You can download it <https://slack.com/downloads|here.>\n\n"
     "Want to make your first change to a program right now? "
     "All active Operation Code Projects are located on our source control repository. "
-    "Our projects can be viewed on <https://github.com/OperationCode/START_HERE|Github.>")
+    "Our projects can be viewed on <https://github.com/OperationCode/START_HERE|Github.>\n\n"
+    "Click any of the buttons below to receive more information on the topic.\n\n"
+    "If you'd like to see something that isn't here let us know!")
 
 HELP_MENU = {
-    "text": "Click any of the buttons below to receive more information on the topic.",
+    "text": "",
     "attachments": [
         {
             "text": "",
@@ -53,11 +55,41 @@
                     "type": "button",
                     "value": "ruby_help",
                 },
+
+            ]
+        },
+        {
+            "text": "",
+            "fallback": "",
+            "color": "#3AA3E3",
+            "callback_id": "greeting_buttons",
+            "attachment_type": "default",
+            "actions": [
+                {
+                    "name": "suggestion",
+                    "text": "Are we missing something? Click!",
+                    "type": "button",
+                    "value": "suggestion",
+                },
             ]
         }
     ]
 }
 
+SUGGESTION_MODAL = {
+    "callback_id": "suggestion_modal",
+    "title": "Help topic suggestion",
+    "submit_label": "Suggestion",
+    "elements": [
+        {
+            "type": "text",
+            "label": "Suggestion",
+            "name": "suggestion",
+            "placeholder": "Underwater Basket Weaving"
+        },
+    ]
+}
+
 
 def greeted_response_attachments(clicker: str) -> list:
     return [