zulip/zerver/webhooks/basecamp/view.py

132 lines
4.9 KiB
Python

import logging
import re
from typing import Any, Dict, Text
from django.http import HttpRequest, HttpResponse
from zerver.decorator import api_key_only_webhook_view
from zerver.lib.actions import check_send_stream_message
from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_error, json_success
from zerver.models import UserProfile
from .support_event import SUPPORT_EVENTS
DOCUMENT_TEMPLATE = "{user_name} {verb} the document [{title}]({url})"
QUESTION_TEMPLATE = "{user_name} {verb} the question [{title}]({url})"
QUESTIONS_ANSWER_TEMPLATE = ("{user_name} {verb} the [answer]({answer_url}) " +
"of the question [{question_title}]({question_url})")
COMMENT_TEMPLATE = ("{user_name} {verb} the [comment]({answer_url}) "
"of the task [{task_title}]({task_url})")
MESSAGE_TEMPLATE = "{user_name} {verb} the message [{title}]({url})"
TODO_LIST_TEMPLATE = "{user_name} {verb} the todo list [{title}]({url})"
TODO_TEMPLATE = "{user_name} {verb} the todo task [{title}]({url})"
@api_key_only_webhook_view('Basecamp')
@has_request_variables
def api_basecamp_webhook(request, user_profile, payload=REQ(argument_type='body'),
stream=REQ(default='basecamp')):
# type: (HttpRequest, UserProfile, Dict[str, Any], Text) -> HttpResponse
event = get_event_type(payload)
if event not in SUPPORT_EVENTS:
logging.warning("Basecamp {} event is not supported".format(event))
return json_success()
subject = get_project_name(payload)
if event.startswith('document_'):
body = get_document_body(event, payload)
elif event.startswith('question_answer_'):
body = get_questions_answer_body(event, payload)
elif event.startswith('question_'):
body = get_questions_body(event, payload)
elif event.startswith('message_'):
body = get_message_body(event, payload)
elif event.startswith('todolist_'):
body = get_todo_list_body(event, payload)
elif event.startswith('todo_'):
body = get_todo_body(event, payload)
elif event.startswith('comment_'):
body = get_comment_body(event, payload)
else:
logging.warning("Basecamp handling of {} event is not implemented".format(event))
return json_success()
check_send_stream_message(user_profile, request.client,
stream, subject, body)
return json_success()
def get_project_name(payload: Dict[str, Any]) -> Text:
return payload['recording']['bucket']['name']
def get_event_type(payload: Dict[str, Any]) -> Text:
return payload['kind']
def get_event_creator(payload: Dict[str, Any]) -> Text:
return payload['creator']['name']
def get_subject_url(payload: Dict[str, Any]) -> Text:
return payload['recording']['app_url']
def get_subject_title(payload: Dict[str, Any]) -> Text:
return payload['recording']['title']
def get_verb(event: Text, prefix: Text) -> Text:
verb = event.replace(prefix, '')
if verb == 'active':
return 'activated'
matched = re.match(r"(?P<subject>[A-z]*)_changed", verb)
if matched:
return "changed {} of".format(matched.group('subject'))
return verb
def get_document_body(event: Text, payload: Dict[str, Any]) -> Text:
return get_generic_body(event, payload, 'document_', DOCUMENT_TEMPLATE)
def get_questions_answer_body(event: Text, payload: Dict[str, Any]) -> Text:
verb = get_verb(event, 'question_answer_')
question = payload['recording']['parent']
return QUESTIONS_ANSWER_TEMPLATE.format(
user_name=get_event_creator(payload),
verb=verb,
answer_url=get_subject_url(payload),
question_title=question['title'],
question_url=question['app_url']
)
def get_comment_body(event: Text, payload: Dict[str, Any]) -> Text:
verb = get_verb(event, 'comment_')
task = payload['recording']['parent']
return COMMENT_TEMPLATE.format(
user_name=get_event_creator(payload),
verb=verb,
answer_url=get_subject_url(payload),
task_title=task['title'],
task_url=task['app_url']
)
def get_questions_body(event: Text, payload: Dict[str, Any]) -> Text:
return get_generic_body(event, payload, 'question_', QUESTION_TEMPLATE)
def get_message_body(event: Text, payload: Dict[str, Any]) -> Text:
return get_generic_body(event, payload, 'message_', MESSAGE_TEMPLATE)
def get_todo_list_body(event: Text, payload: Dict[str, Any]) -> Text:
return get_generic_body(event, payload, 'todolist_', TODO_LIST_TEMPLATE)
def get_todo_body(event: Text, payload: Dict[str, Any]) -> Text:
return get_generic_body(event, payload, 'todo_', TODO_TEMPLATE)
def get_generic_body(event: Text, payload: Dict[str, Any], prefix: Text, template: Text) -> Text:
verb = get_verb(event, prefix)
return template.format(
user_name=get_event_creator(payload),
verb=verb,
title=get_subject_title(payload),
url=get_subject_url(payload),
)