zulip/zerver/views/webhooks/trello/board_actions.py

109 lines
4.0 KiB
Python

from six import text_type
from typing import Mapping, Any, Tuple, Optional, MutableMapping
from .exceptions import UnknownUpdateBoardAction
from .templates import TRELLO_SUBJECT_TEMPLATE, TRELLO_MESSAGE_TEMPLATE
SUPPORTED_BOARD_ACTIONS = [
u'removeMemberFromBoard',
u'addMemberToBoard',
u'createList',
u'updateBoard',
]
REMOVE_MEMBER = u'removeMemberFromBoard'
ADD_MEMBER = u'addMemberToBoard'
CREATE_LIST = u'createList'
CHANGE_NAME = u'changeName'
TRELLO_BOARD_URL_TEMPLATE = u'[{board_name}]({board_url})'
ACTIONS_TO_MESSAGE_MAPPER = {
REMOVE_MEMBER: u'removed {member_name} from {board_url_template}',
ADD_MEMBER: u'added {member_name} to {board_url_template}',
CREATE_LIST: u'added {list_name} list to {board_url_template}',
CHANGE_NAME: u'renamed the board from {old_name} to {board_url_template}'
}
def process_board_action(payload, action_type):
# type: (Mapping[str, Any], text_type) -> Tuple[text_type, text_type]
action_type = get_proper_action(payload, action_type)
return get_subject(payload), get_body(payload, action_type)
def get_proper_action(payload, action_type):
# type: (Mapping[str, Any], text_type) -> text_type
if action_type == 'updateBoard':
data = get_action_data(payload)
if data.get('old').get('name'):
return CHANGE_NAME
raise UnknownUpdateBoardAction()
return action_type
def get_subject(payload):
# # type: (Mapping[str, Any]) -> text_type
data = {
'board_name': get_action_data(payload).get('board').get('name')
}
return TRELLO_SUBJECT_TEMPLATE.format(**data)
def get_body(payload, action_type):
# type: (Mapping[str, Any], text_type) -> text_type
message_body = ACTIONS_TO_FILL_BODY_MAPPER[action_type](payload, action_type)
creator = payload.get('action').get('memberCreator').get('fullName')
return TRELLO_MESSAGE_TEMPLATE.format(full_name=creator, rest=message_body)
def get_managed_member_body(payload, action_type):
# type: (Mapping[str, Any], text_type) -> text_type
data = {
'member_name': payload.get('action').get('member').get('fullName'),
}
return fill_appropriate_message_content(payload, action_type, data)
def get_create_list_body(payload, action_type):
# type: (Mapping[str, Any], text_type) -> text_type
data = {
'list_name': get_action_data(payload).get('list').get('name'),
}
return fill_appropriate_message_content(payload, action_type, data)
def get_change_name_body(payload, action_type):
# type: (Mapping[str, Any], text_type) -> text_type
data = {
'old_name': get_action_data(payload).get('old').get('name'),
}
return fill_appropriate_message_content(payload, action_type, data)
def fill_appropriate_message_content(payload, action_type, data=None):
# type: (Mapping[str, Any], text_type, Optional[Dict[str, Any]]) -> text_type
data = {} if data is None else data
data['board_url_template'] = data.get('board_url_template', get_filled_board_url_template(payload))
message_body = get_message_body(action_type)
return message_body.format(**data)
def get_filled_board_url_template(payload):
# type: (Mapping[str, Any]) -> text_type
return TRELLO_BOARD_URL_TEMPLATE.format(board_name=get_board_name(payload), board_url=get_board_url(payload))
def get_board_name(payload):
# type: (Mapping[str, Any]) -> text_type
return get_action_data(payload).get('board').get('name')
def get_board_url(payload):
# type: (Mapping[str, Any]) -> text_type
return u'https://trello.com/b/{}'.format(get_action_data(payload).get('board').get('shortLink'))
def get_message_body(action_type):
# type: (text_type) -> text_type
return ACTIONS_TO_MESSAGE_MAPPER[action_type]
def get_action_data(payload):
# type: (Mapping[str, Any]) -> Mapping[str, Any]
return payload.get('action').get('data')
ACTIONS_TO_FILL_BODY_MAPPER = {
REMOVE_MEMBER: get_managed_member_body,
ADD_MEMBER: get_managed_member_body,
CREATE_LIST: get_create_list_body,
CHANGE_NAME: get_change_name_body
}