api: Add add-reaction and remove-reaction routes

Author: chrisbobbe

lib/api/route/messages.dart

@@ -263,3 +263,60 @@ class UploadFileResult {
 
   Map<String, dynamic> toJson() => _$UploadFileResultToJson(this);
 }
+
+/// https://zulip.com/api/add-reaction
+Future<AddReactionResult> addReaction(ApiConnection connection, {
+  required int messageId,
+  required ReactionType reactionType,
+  required String emojiCode,
+  required String emojiName,
+}) {
+  return connection.post('addReaction', AddReactionResult.fromJson, 'messages/$messageId/reactions', {
+    'emoji_name': RawParameter(emojiName),
+    'emoji_code': RawParameter(emojiCode),
+    'reaction_type': RawParameter(switch (reactionType) {
+      ReactionType.unicodeEmoji => 'unicode_emoji',
+      ReactionType.realmEmoji => 'realm_emoji',
+      ReactionType.zulipExtraEmoji => 'zulip_extra_emoji',
+    }),
+  });
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class AddReactionResult {
+  AddReactionResult();
+
+  factory AddReactionResult.fromJson(Map<String, dynamic> json) =>
+    _$AddReactionResultFromJson(json);
+
+  Map<String, dynamic> toJson() => _$AddReactionResultToJson(this);
+}
+
+
+/// https://zulip.com/api/remove-reaction
+Future<RemoveReactionResult> removeReaction(ApiConnection connection, {
+  required int messageId,
+  required ReactionType reactionType,
+  required String emojiCode,
+  required String emojiName,
+}) {
+  return connection.delete('removeReaction', RemoveReactionResult.fromJson, 'messages/$messageId/reactions', {
+    'emoji_name': RawParameter(emojiName),
+    'emoji_code': RawParameter(emojiCode),
+    'reaction_type': RawParameter(switch (reactionType) {
+      ReactionType.unicodeEmoji => 'unicode_emoji',
+      ReactionType.realmEmoji => 'realm_emoji',
+      ReactionType.zulipExtraEmoji => 'zulip_extra_emoji',
+    }),
+  });
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class RemoveReactionResult {
+  RemoveReactionResult();
+
+  factory RemoveReactionResult.fromJson(Map<String, dynamic> json) =>
+    _$RemoveReactionResultFromJson(json);
+
+  Map<String, dynamic> toJson() => _$RemoveReactionResultToJson(this);
+}

lib/api/route/messages.g.dart

@@ -334,4 +334,110 @@ void main() {
       });
     });
   });
+
+  group('addReaction', () {
+    Future<void> checkAddReaction(FakeApiConnection connection, {
+      required int messageId,
+      required Reaction reaction,
+      required String expectedReactionType,
+    }) async {
+      connection.prepare(json: AddReactionResult().toJson());
+      final result = await addReaction(connection,
+        messageId: messageId,
+        reactionType: reaction.reactionType,
+        emojiCode: reaction.emojiCode,
+        emojiName: reaction.emojiName,
+      );
+      // (If AddReactionResult grows any fields, check them here.)
+      check(result).isA<AddReactionResult>();
+      check(connection.lastRequest).isNotNull().isA<http.Request>()
+        ..method.equals('POST')
+        ..url.path.equals('/api/v1/messages/$messageId/reactions')
+        ..bodyFields.deepEquals({
+            'reaction_type': expectedReactionType,
+            'emoji_code': reaction.emojiCode,
+            'emoji_name': reaction.emojiName,
+          });
+    }
+
+    test('unicode emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkAddReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.unicodeEmojiReaction,
+          expectedReactionType: 'unicode_emoji');
+      });
+    });
+
+    test('realm emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkAddReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.realmEmoji,
+          expectedReactionType: 'realm_emoji');
+      });
+    });
+
+    test('Zulip extra emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkAddReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.zulipExtraEmoji,
+          expectedReactionType: 'zulip_extra_emoji');
+      });
+    });
+  });
+
+  group('removeReaction', () {
+    Future<void> checkRemoveReaction(FakeApiConnection connection, {
+      required int messageId,
+      required Reaction reaction,
+      required String expectedReactionType,
+    }) async {
+      connection.prepare(json: RemoveReactionResult().toJson());
+      final result = await removeReaction(connection,
+        messageId: messageId,
+        reactionType: reaction.reactionType,
+        emojiCode: reaction.emojiCode,
+        emojiName: reaction.emojiName,
+      );
+      // (If RemoveReactionResult grows any fields, check them here.)
+      check(result).isA<RemoveReactionResult>();
+      check(connection.lastRequest).isNotNull().isA<http.Request>()
+        ..method.equals('DELETE')
+        ..url.path.equals('/api/v1/messages/$messageId/reactions')
+        ..bodyFields.deepEquals({
+            'reaction_type': expectedReactionType,
+            'emoji_code': reaction.emojiCode,
+            'emoji_name': reaction.emojiName,
+          });
+    }
+
+    test('unicode emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkRemoveReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.unicodeEmojiReaction,
+          expectedReactionType: 'unicode_emoji');
+      });
+    });
+
+    test('realm emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkRemoveReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.realmEmoji,
+          expectedReactionType: 'realm_emoji');
+      });
+    });
+
+    test('Zulip extra emoji', () {
+      return FakeApiConnection.with_((connection) async {
+        await checkRemoveReaction(connection,
+          messageId: eg.streamMessage().id,
+          reaction: eg.zulipExtraEmoji,
+          expectedReactionType: 'zulip_extra_emoji');
+      });
+    });
+  });
 }

test/api/route/messages_test.dart

@@ -195,6 +195,20 @@ Reaction unicodeEmojiReaction = Reaction(
   userId: selfUser.userId,
 );
 
+Reaction realmEmoji = Reaction(
+  emojiName: 'twocents',
+  emojiCode: '181',
+  reactionType: ReactionType.realmEmoji,
+  userId: selfUser.userId,
+);
+
+Reaction zulipExtraEmoji = Reaction(
+  emojiName: 'zulip',
+  emojiCode: 'zulip',
+  reactionType: ReactionType.zulipExtraEmoji,
+  userId: selfUser.userId,
+);
+
 // TODO example data for many more types
 
 InitialSnapshot initialSnapshot({