mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 21:43:21 +00:00
Reactions backend: make endpoints more REST-ful.
Adding a reaction is now a PUT request to /messages/<message_id>/emoji_reactions/<emoji_name> Similarly, removing a reaction is now a DELETE request to /messages/<message_id>/emoji_reactions/<emoji_name> This commit changes the url and updates the views and tests. This commit also adds a test for invalid emoji when removing reaction.
This commit is contained in:
Arpith Siromoney
committed by
Tim Abbott
Tim Abbott
parent
0bac986f26
commit
226e3cbf02
@@ -16,27 +16,27 @@ class ReactionEmojiTest(ZulipTestCase):
|
||||
Sending reaction without emoji fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': 1},
|
||||
result = self.client_put('/api/v1/messages/1/emoji_reactions',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Missing 'emoji' argument")
|
||||
self.assertEquals(result.status_code, 404)
|
||||
|
||||
def test_empty_emoji(self):
|
||||
# type: () -> None
|
||||
"""
|
||||
Sending empty emoji fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': 1, 'emoji': ''},
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Emoji '' does not exist")
|
||||
|
||||
def test_invalid_emoji(self):
|
||||
def test_add_invalid_emoji(self):
|
||||
# type: () -> None
|
||||
"""
|
||||
Sending invalid emoji fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': 1, 'emoji': 'foo'},
|
||||
result = self.client_put('/api/v1/messages/1/emoji_reactions/foo',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Emoji 'foo' does not exist")
|
||||
|
||||
def test_remove_invalid_emoji(self):
|
||||
# type: () -> None
|
||||
"""
|
||||
Removing invalid emoji fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_delete('/api/v1/messages/1/emoji_reactions/foo',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Emoji 'foo' does not exist")
|
||||
|
||||
@@ -46,7 +46,7 @@ class ReactionEmojiTest(ZulipTestCase):
|
||||
Reacting with valid emoji succeeds
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': 1, 'emoji': 'smile'},
|
||||
result = self.client_put('/api/v1/messages/1/emoji_reactions/smile',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_success(result)
|
||||
self.assertEqual(200, result.status_code)
|
||||
@@ -69,7 +69,7 @@ class ReactionEmojiTest(ZulipTestCase):
|
||||
self.assert_json_success(result)
|
||||
self.assertTrue(emoji_name in content["emoji"])
|
||||
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': 1, 'emoji': emoji_name},
|
||||
result = self.client_put('/api/v1/messages/1/emoji_reactions/%s' % (emoji_name,),
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_success(result)
|
||||
|
||||
@@ -80,9 +80,9 @@ class ReactionMessageIDTest(ZulipTestCase):
|
||||
Reacting without a message_id fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
result = self.client_post('/api/v1/reactions', {'emoji': 'smile'},
|
||||
result = self.client_put('/api/v1/messages//emoji_reactions/smile',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Missing 'message_id' argument")
|
||||
self.assertEquals(result.status_code, 404)
|
||||
|
||||
def test_invalid_message_id(self):
|
||||
# type: () -> None
|
||||
@@ -90,10 +90,9 @@ class ReactionMessageIDTest(ZulipTestCase):
|
||||
Reacting to an invalid message id fails
|
||||
"""
|
||||
sender = 'hamlet@zulip.com'
|
||||
message_id = -1
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': message_id, 'emoji': 'smile'},
|
||||
result = self.client_put('/api/v1/messages/-1/emoji_reactions/smile',
|
||||
**self.api_auth(sender))
|
||||
self.assert_json_error(result, "Bad value for 'message_id': " + str(message_id))
|
||||
self.assertEquals(result.status_code, 404)
|
||||
|
||||
def test_inaccessible_message_id(self):
|
||||
# type: () -> None
|
||||
@@ -111,7 +110,7 @@ class ReactionMessageIDTest(ZulipTestCase):
|
||||
self.assert_json_success(result)
|
||||
content = ujson.loads(result.content)
|
||||
pm_id = content['id']
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': pm_id, 'emoji': 'smile'},
|
||||
result = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_error(result, "Invalid message(s)")
|
||||
|
||||
@@ -131,13 +130,12 @@ class ReactionTest(ZulipTestCase):
|
||||
**self.api_auth(pm_sender))
|
||||
self.assert_json_success(pm)
|
||||
content = ujson.loads(pm.content)
|
||||
|
||||
pm_id = content['id']
|
||||
first = self.client_post('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
first = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(first)
|
||||
second = self.client_post('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
second = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_error(second, "Reaction already exists")
|
||||
|
||||
@@ -157,18 +155,15 @@ class ReactionTest(ZulipTestCase):
|
||||
self.assert_json_success(pm)
|
||||
content = ujson.loads(pm.content)
|
||||
pm_id = content['id']
|
||||
add = self.client_post('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
add = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(add)
|
||||
|
||||
first = self.client_delete('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
first = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(first)
|
||||
|
||||
second = self.client_delete('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
second = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_error(second, "Reaction does not exist")
|
||||
|
||||
@@ -197,8 +192,7 @@ class ReactionEventTest(ZulipTestCase):
|
||||
|
||||
events = [] # type: List[Dict[str, Any]]
|
||||
with tornado_redirected_to_list(events):
|
||||
result = self.client_post('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
result = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(result)
|
||||
self.assertEqual(len(events), 1)
|
||||
@@ -234,15 +228,13 @@ class ReactionEventTest(ZulipTestCase):
|
||||
expected_recipient_emails = set([pm_sender, pm_recipient])
|
||||
expected_recipient_ids = set([get_user_profile_by_email(email).id for email in expected_recipient_emails])
|
||||
|
||||
add = self.client_post('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
add = self.client_put('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(add)
|
||||
|
||||
events = [] # type: List[Dict[str, Any]]
|
||||
with tornado_redirected_to_list(events):
|
||||
result = self.client_delete('/api/v1/reactions', {'message_id': pm_id,
|
||||
'emoji': 'smile'},
|
||||
result = self.client_delete('/api/v1/messages/%s/emoji_reactions/smile' % (pm_id,),
|
||||
**self.api_auth(reaction_sender))
|
||||
self.assert_json_success(result)
|
||||
self.assertEqual(len(events), 1)
|
||||
|
||||
@@ -12,9 +12,8 @@ from zerver.lib.response import json_success
|
||||
from zerver.models import Reaction, UserProfile
|
||||
|
||||
@has_request_variables
|
||||
def add_reaction_backend(request, user_profile, emoji_name=REQ('emoji'),
|
||||
message_id = REQ('message_id', converter=to_non_negative_int)):
|
||||
# type: (HttpRequest, UserProfile, text_type, int) -> HttpResponse
|
||||
def add_reaction_backend(request, user_profile, message_id, emoji_name):
|
||||
# type: (HttpRequest, UserProfile, int, text_type) -> HttpResponse
|
||||
|
||||
# access_message will throw a JsonableError exception if the user
|
||||
# cannot see the message (e.g. for messages to private streams).
|
||||
@@ -36,9 +35,8 @@ def add_reaction_backend(request, user_profile, emoji_name=REQ('emoji'),
|
||||
return json_success()
|
||||
|
||||
@has_request_variables
|
||||
def remove_reaction_backend(request, user_profile, emoji_name=REQ('emoji'),
|
||||
message_id = REQ('message_id', converter=to_non_negative_int)):
|
||||
# type: (HttpRequest, UserProfile, text_type, int) -> HttpResponse
|
||||
def remove_reaction_backend(request, user_profile, message_id, emoji_name):
|
||||
# type: (HttpRequest, UserProfile, int, text_type) -> HttpResponse
|
||||
|
||||
# access_message will throw a JsonableError exception if the user
|
||||
# cannot see the message (e.g. for messages to private streams).
|
||||
|
||||
@@ -199,10 +199,11 @@ v1_api_and_json_patterns = [
|
||||
{'POST': 'zerver.views.messages.update_message_flags'}),
|
||||
|
||||
# reactions -> zerver.view.reactions
|
||||
# POST adds a reaction to a message
|
||||
# PUT adds a reaction to a message
|
||||
# DELETE removes a reaction from a message
|
||||
url(r'^reactions$', rest_dispatch,
|
||||
{'POST': 'zerver.views.reactions.add_reaction_backend',
|
||||
url(r'^messages/(?P<message_id>[0-9]+)/emoji_reactions/(?P<emoji_name>[0-9a-zA-Z.\-_]+(?<![.\-_]))$',
|
||||
rest_dispatch,
|
||||
{'PUT': 'zerver.views.reactions.add_reaction_backend',
|
||||
'DELETE': 'zerver.views.reactions.remove_reaction_backend'}),
|
||||
|
||||
# typing -> zerver.views.typing
|
||||
|
||||
Reference in New Issue
Block a user