zulip/zerver/webhooks/wordpress/view.py
PIG208 dcbb2a78ca python: Migrate most json_error => JsonableError.
JsonableError has two major benefits over json_error:
* It can be raised from anywhere in the codebase, rather than
  being a return value, which is much more convenient for refactoring,
  as one doesn't potentially need to change error handling style when
  extracting a bit of view code to a function.
* It is guaranteed to contain the `code` property, which is helpful
  for API consistency.

Various stragglers are not updated because JsonableError requires
subclassing in order to specify custom data or HTTP status codes.
2021-06-30 16:22:38 -07:00

56 lines
1.9 KiB
Python

# Webhooks for external integrations.
from django.http import HttpRequest, HttpResponse
from django.utils.translation import gettext as _
from zerver.decorator import webhook_view
from zerver.lib.exceptions import JsonableError
from zerver.lib.request import REQ, has_request_variables
from zerver.lib.response import json_success
from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile
PUBLISH_POST_OR_PAGE_TEMPLATE = """
New {type} published:
* [{title}]({url})
""".strip()
USER_REGISTER_TEMPLATE = """
New blog user registered:
* **Name**: {name}
* **Email**: {email}
""".strip()
WP_LOGIN_TEMPLATE = "User {name} logged in."
@webhook_view("WordPress", notify_bot_owner_on_invalid_json=False)
@has_request_variables
def api_wordpress_webhook(
request: HttpRequest,
user_profile: UserProfile,
hook: str = REQ(default="WordPress action"),
post_title: str = REQ(default="New WordPress post"),
post_type: str = REQ(default="post"),
post_url: str = REQ(default="WordPress post URL"),
display_name: str = REQ(default="New user name"),
user_email: str = REQ(default="New user email"),
user_login: str = REQ(default="Logged in user"),
) -> HttpResponse:
# remove trailing whitespace (issue for some test fixtures)
hook = hook.rstrip()
if hook == "publish_post" or hook == "publish_page":
data = PUBLISH_POST_OR_PAGE_TEMPLATE.format(type=post_type, title=post_title, url=post_url)
elif hook == "user_register":
data = USER_REGISTER_TEMPLATE.format(name=display_name, email=user_email)
elif hook == "wp_login":
data = WP_LOGIN_TEMPLATE.format(name=user_login)
else:
raise JsonableError(_("Unknown WordPress webhook action: {}").format(hook))
topic = "WordPress notification"
check_send_webhook_message(request, user_profile, topic, data)
return json_success()