add /ticket functionality for requesting credentials, email accounts, etc

Author: AllenAnthes

pybot/endpoints/slack/__init__.py

@@ -1,5 +1,4 @@
-from pybot.endpoints.slack import messages
-from . import events, actions, commands
+from . import events, actions, commands, messages
 
 
 def create_endpoints(plugin):

pybot/endpoints/slack/actions.py

@@ -1,10 +1,15 @@
+import logging
+from pprint import pprint
+
 from sirbot import SirBot
 from slack import methods
 from slack.actions import Action
 
 from pybot.endpoints.slack.utils.action_messages import *
 from pybot.endpoints.slack.utils import COMMUNITY_CHANNEL
 
+logger = logging.getLogger(__name__)
+
 
 def create_endpoints(plugin):
     plugin.on_action("resource_buttons", resource_buttons, wait=False)
@@ -18,6 +23,33 @@ def create_endpoints(plugin):
     plugin.on_action("claimed", reset_claim, name='reset_claim', wait=False)
     plugin.on_action("report_message", open_report_dialog, wait=False)
     plugin.on_action("report_dialog", send_report, wait=False)
+    plugin.on_action("open_ticket", open_ticket, wait=False)
+    plugin.on_action("ticket_status", ticket_status, wait=False)
+
+
+async def ticket_status(action: Action, app: SirBot):
+    """
+    Updates the ticket status dropdown. (I don't know why we need to manually
+    update the message for this..)
+    """
+    logger.info(action)
+    response = updated_ticket_status(action)
+    await app.plugins["slack"].api.query(methods.CHAT_UPDATE, response)
+
+
+async def open_ticket(action: Action, app: SirBot):
+    """
+    Called when a user submits the ticket dialog.  Parses the submission and posts
+    the new ticket details to the required channel
+    """
+    attachments = ticket_attachments(action)
+    response = {
+        'channel': MODERATOR_CHANNEL,
+        'attachments': attachments,
+        'text': 'New Ticket Submission',
+    }
+
+    await app["plugins"]["slack"].api.query(methods.CHAT_POST_MESSAGE, response)
 
 
 async def send_report(action: Action, app: SirBot):
@@ -119,7 +151,13 @@ async def claimed(action: Action, app: SirBot):
     """
     response = base_response(action)
     user_id = action['user']['id']
-    response['attachments'] = claimed_attachment(user_id)
+
+    attachments = action['original_message']['attachments']
+
+    for index, attachment in enumerate(attachments):
+        if attachment['callback_id'] == 'claimed':
+            attachments[index] = claimed_attachment(user_id)
+    response['attachments'] = attachments
 
     await app.plugins['slack'].api.query(methods.CHAT_UPDATE, response)
 
@@ -131,7 +169,13 @@ async def reset_claim(action: Action, app: SirBot):
     Updates the button back to its initial state
     """
     response = base_response(action)
-    response['attachments'] = not_claimed_attachment()
+
+    attachments = action['original_message']['attachments']
+    for index, attachment in enumerate(attachments):
+        if attachment['callback_id'] == 'claimed':
+            attachments[index] = not_claimed_attachment()
+
+    response['attachments'] = attachments
     await app.plugins['slack'].api.query(methods.CHAT_UPDATE, response)
 
 

pybot/endpoints/slack/commands.py

@@ -5,7 +5,8 @@
 from slack import methods
 from slack.commands import Command
 
-from pybot.endpoints.slack.utils import PYBACK_HOST, PYBACK_PORT, PYBACK_TOKEN, REPORT_CHANNEL, YELP_TOKEN
+from pybot.endpoints.slack.message_templates.commands import ticket_dialog
+from pybot.endpoints.slack.utils import PYBACK_HOST, PYBACK_PORT, PYBACK_TOKEN, MODERATOR_CHANNEL, YELP_TOKEN
 from pybot.endpoints.slack.utils.action_messages import not_claimed_attachment
 from pybot.endpoints.slack.utils.command_utils import get_slash_here_messages, get_slash_repeat_messages, response_type
 from pybot.endpoints.slack.utils.slash_lunch import LunchCommand
@@ -24,6 +25,23 @@ def create_endpoints(plugin: SlackPlugin):
     plugin.on_command('/lunch', slash_lunch, wait=False)
     plugin.on_command('/repeat', slash_repeat, wait=False)
     plugin.on_command('/report', slash_report, wait=False)
+    plugin.on_command('/ticket', slash_ticket, wait=False)
+
+
+async def slash_ticket(command: Command, app: SirBot):
+    trigger_id = command['trigger_id']
+    user_id = command['user_id']
+    logger.warning(command['text'])
+
+    user_info = await app.plugins['slack'].api.query(methods.USERS_INFO, {'user': user_id})
+    clicker_email = user_info['user']['profile']['email']
+
+    response = {
+        "trigger_id": trigger_id,
+        "dialog": ticket_dialog(clicker_email, command['text'])
+    }
+
+    await app.plugins["slack"].api.query(methods.DIALOG_OPEN, response)
 
 
 async def slash_report(command: Command, app: SirBot):
@@ -40,8 +58,8 @@ async def slash_report(command: Command, app: SirBot):
 
     response = {
         'text': message,
-        'channel': REPORT_CHANNEL,
-        'attachments': not_claimed_attachment(),
+        'channel': MODERATOR_CHANNEL,
+        'attachments': [not_claimed_attachment()],
     }
 
     await slack.query(methods.CHAT_POST_MESSAGE, response)

…dpoints/slack/event_messages/__init__.py …ints/slack/message_templates/__init__.pypybot/endpoints/slack/event_messages/__init__.py renamed to pybot/endpoints/slack/message_templates/__init__.py pybot/endpoints/slack/event_messages/__init__.py renamed to pybot/endpoints/slack/message_templates/__init__.py

@@ -0,0 +1,27 @@
+def ticket_dialog(clicker_email, text):
+    return {
+        "callback_id": "open_ticket",
+        "title": "Open New Ticket",
+        "submit_label": "Submit",
+        "elements": [
+            {
+                "type": "text",
+                "label": "Email",
+                "name": "email",
+                "subtype": "email",
+                "value": clicker_email
+
+            },
+            {
+                "type": "text",
+                "label": "Request Type",
+                "name": "type",
+                "value": text
+            },
+            {
+                "type": "textarea",
+                "label": "Details",
+                "name": "details"
+            }
+        ]
+    }

pybot/endpoints/slack/message_templates/commands.py

@@ -4,7 +4,7 @@
 from slack.events import Message
 from slack import methods
 
-from pybot.endpoints.slack.event_messages.tech import TechTerms
+from .message_templates.tech import TechTerms
 
 logger = logging.getLogger(__name__)
 

…t/endpoints/slack/event_messages/tech.py …ndpoints/slack/message_templates/tech.pypybot/endpoints/slack/event_messages/tech.py renamed to pybot/endpoints/slack/message_templates/tech.py pybot/endpoints/slack/event_messages/tech.py renamed to pybot/endpoints/slack/message_templates/tech.py

@@ -5,7 +5,7 @@
 load_dotenv()
 
 COMMUNITY_CHANNEL = os.environ.get("COMMUNITY_CHANNEL") or "G12343"
-REPORT_CHANNEL = os.environ.get('REPORT_CHANNEL') or 'G8NDRJJF9'
+MODERATOR_CHANNEL = os.environ.get('REPORT_CHANNEL') or 'G8NDRJJF9'
 APP_TOKEN = os.environ.get('APP_TOKEN') or "123"
 YELP_TOKEN = os.environ.get('YELP_TOKEN') or 'token'
 PYBACK_HOST = os.environ.get('PYBACK_HOST') or 'pyback'

pybot/endpoints/slack/messages.py

@@ -2,9 +2,14 @@
 from time import time
 from typing import List
 
-from slack.events import Message
+from pybot.endpoints.slack.utils import MODERATOR_CHANNEL
 
-from pybot.endpoints.slack.utils import REPORT_CHANNEL
+TICKET_OPTIONS = {
+    'notStarted': 'Not Started',
+    'inProgress': 'In-progress',
+    'waitingOnUser': 'Waiting on User',
+    'complete': 'Complete'
+}
 
 
 def now():
@@ -16,14 +21,57 @@ def now():
 
 
 def base_response(action):
-    response = Message()
+    response = {
+        'text': action['original_message'].get('text', None),
+        'channel': action['channel']['id'],
+        'ts': action['message_ts'],
+    }
+    return response
+
+
+def updated_ticket_status(action):
+    selected_option = action['actions'][0]['selected_options'][0]
+    selected_option['text'] = TICKET_OPTIONS[selected_option['value']]
 
-    response['text'] = action['original_message']['text']
-    response['channel'] = action['channel']['id']
-    response['ts'] = action['message_ts']
+    updated_attachments = action['original_message']['attachments']
+    updated_attachments[0]['actions'][0]['selected_options'] = [selected_option]
+    response = {
+        **base_response(action),
+        'attachments': updated_attachments
+    }
     return response
 
 
+def ticket_attachments(action):
+    user_id = action['user']['id']
+    request_type = action['submission']['type']
+    email = action['submission']['email']
+    details = action['submission']['details']
+    attachments = [
+        {
+            'text': '',
+            'callback_id': 'ticket_status',
+            "response_type": "in_channel",
+            "fallback": "request details should have been here",
+            "fields": [
+                {"title": "User", "value": f"<@{user_id}>", "short": True},
+                {"title": "Email", "value": f"{email}", "short": True},
+                {"title": "Request Type", "value": f"{request_type}", "short": True},
+                {"title": "Details", "value": f"{details}", "short": True},
+            ],
+            'actions': [
+                {
+                    'name': 'status', 'text': 'Current Status', 'type': 'select',
+                    'selected_options': [{'text': 'Not Started', 'value': 'notStarted'}],
+                    'options': [{'text': text, 'value': value} for value, text in TICKET_OPTIONS.items()]
+                }
+            ]
+        },
+        not_claimed_attachment()
+    ]
+    return attachments
+
+
 def greeted_attachment(user_id: str) -> List[dict]:
     return [{
         "text": f":100:<@{user_id}> has greeted the new user!:100:\n"
@@ -60,24 +108,25 @@ def not_greeted_attachment():
 
 
 def not_claimed_attachment():
-    return [{
+    return {
         'text': "",
-        "fallback": "",
+        "fallback": "not claimed attachment",
         "color": "#3AA3E3",
         "callback_id": "claimed",
         "attachment_type": "default",
+        'short': True,
         "actions": [{
             "name": "claimed",
             "text": "Claim",
             "type": "button",
             "style": "primary",
             "value": "claimed"
         }]
-    }]
+    }
 
 
 def claimed_attachment(user_id):
-    return [{
+    return {
         "text": f"Claimed by <@{user_id}>\n"
                 f"<!date^{now()}^Claimed at {{date_num}} {{time_secs}}|Failed to parse time>",
         "fallback": "",
@@ -91,7 +140,7 @@ def claimed_attachment(user_id):
             "style": "danger",
             "value": "reset_claim",
         }]
-    }]
+    }
 
 
 def reset_greet_message(user_id):
@@ -165,7 +214,7 @@ def build_report_message(slack_id, details, message_details):
 
     return {
         "text": message,
-        "channel": REPORT_CHANNEL,
+        "channel": MODERATOR_CHANNEL,
         "attachments": attachment
     }