mirror of
https://github.com/zulip/zulip.git
synced 2025-11-21 23:19:10 +00:00
a041a23199
I feel like getting notifications about a board's background being changed isn't very useful information and could interrupt the flow of other important information such as Card changes or movement, so I think we should not support this event and should simply ignore such payloads in the future.
114 lines
4.1 KiB
Python
114 lines
4.1 KiB
Python
from typing import Any, Dict, Optional, Mapping, MutableMapping, Text, Tuple
|
|
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) -> Optional[Tuple[Text, Text]]
|
|
action_type = get_proper_action(payload, action_type)
|
|
if action_type is not None:
|
|
return get_subject(payload), get_body(payload, action_type)
|
|
return None
|
|
|
|
def get_proper_action(payload, action_type):
|
|
# type: (Mapping[str, Any], Text) -> Optional[Text]
|
|
if action_type == 'updateBoard':
|
|
data = get_action_data(payload)
|
|
# we don't support events for when a board's background
|
|
# is changed
|
|
if data['old'].get('prefs', {}).get('background') is not None:
|
|
return None
|
|
elif data['old']['name']:
|
|
return CHANGE_NAME
|
|
raise UnknownUpdateBoardAction()
|
|
return action_type
|
|
|
|
def get_subject(payload):
|
|
# type: (Mapping[str, Any]) -> Text
|
|
data = {
|
|
'board_name': get_action_data(payload)['board']['name']
|
|
}
|
|
return TRELLO_SUBJECT_TEMPLATE.format(**data)
|
|
|
|
def get_body(payload, action_type):
|
|
# type: (Mapping[str, Any], Text) -> Text
|
|
message_body = ACTIONS_TO_FILL_BODY_MAPPER[action_type](payload, action_type)
|
|
creator = payload['action']['memberCreator']['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) -> Text
|
|
data = {
|
|
'member_name': payload['action']['member']['fullName'],
|
|
}
|
|
return fill_appropriate_message_content(payload, action_type, data)
|
|
|
|
def get_create_list_body(payload, action_type):
|
|
# type: (Mapping[str, Any], Text) -> Text
|
|
data = {
|
|
'list_name': get_action_data(payload)['list']['name'],
|
|
}
|
|
return fill_appropriate_message_content(payload, action_type, data)
|
|
|
|
def get_change_name_body(payload, action_type):
|
|
# type: (Mapping[str, Any], Text) -> Text
|
|
data = {
|
|
'old_name': get_action_data(payload)['old']['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, Optional[Dict[str, Any]]) -> Text
|
|
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
|
|
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
|
|
return get_action_data(payload)['board']['name']
|
|
|
|
def get_board_url(payload):
|
|
# type: (Mapping[str, Any]) -> Text
|
|
return u'https://trello.com/b/{}'.format(get_action_data(payload)['board']['shortLink'])
|
|
|
|
def get_message_body(action_type):
|
|
# type: (Text) -> Text
|
|
return ACTIONS_TO_MESSAGE_MAPPER[action_type]
|
|
|
|
def get_action_data(payload):
|
|
# type: (Mapping[str, Any]) -> Mapping[str, Any]
|
|
return payload['action']['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
|
|
}
|