api: Add updatePresence

Author: chrisbobbe

lib/api/model/model.dart

@@ -350,7 +350,7 @@ class PerUserPresence {
   Map<String, dynamic> toJson() => _$PerUserPresenceToJson(this);
 }
 
-/// As in [PerClientPresence.status].
+/// As in [PerClientPresence.status] and [updatePresence].
 @JsonEnum(fieldRename: FieldRename.snake, alwaysCreate: true)
 enum PresenceStatus {
   active,

lib/api/route/users.dart

@@ -1,6 +1,7 @@
 import 'package:json_annotation/json_annotation.dart';
 
 import '../core.dart';
+import '../model/model.dart';
 
 part 'users.g.dart';
 
@@ -32,3 +33,49 @@ class GetOwnUserResult {
 
   Map<String, dynamic> toJson() => _$GetOwnUserResultToJson(this);
 }
+
+/// https://zulip.com/api/update-presence
+///
+/// Passes true for `slim_presence` to avoid getting an ancient data format
+/// in the response.
+// TODO(#1611) Passing `slim_presence` is the old, deprecated way to avoid
+//   getting an ancient data format. Pass `last_update_id` to new servers to get
+//   that effect (make lastUpdateId required?) and update the dartdoc.
+//   (Passing `slim_presence`, for now, shouldn't break things, but we'd like to
+//   stop; see discussion:
+//     https://chat.zulip.org/#narrow/channel/378-api-design/topic/presence.20rewrite/near/2201035 )
+Future<UpdatePresenceResult> updatePresence(ApiConnection connection, {
+  int? lastUpdateId,
+  int? historyLimitDays,
+  bool? newUserInput,
+  bool? pingOnly,
+  required PresenceStatus status,
+}) {
+  return connection.post('updatePresence', UpdatePresenceResult.fromJson, 'users/me/presence', {
+    if (lastUpdateId != null) 'last_update_id': lastUpdateId,
+    if (historyLimitDays != null) 'history_limit_days': historyLimitDays,
+    if (newUserInput != null) 'new_user_input': newUserInput,
+    if (pingOnly != null) 'ping_only': pingOnly,
+    'status': RawParameter(status.toJson()),
+    'slim_presence': true,
+  });
+}
+
+@JsonSerializable(fieldRename: FieldRename.snake)
+class UpdatePresenceResult {
+  final int? presenceLastUpdateId; // TODO(server-9.0) new in FL 263
+  final double? serverTimestamp; // 1656958539.6287155 in the example response
+  final Map<int, PerUserPresence>? presences;
+  // final bool zephyrMirrorActive; // deprecated, ignore
+
+  UpdatePresenceResult({
+    required this.presenceLastUpdateId,
+    required this.serverTimestamp,
+    required this.presences,
+  });
+
+  factory UpdatePresenceResult.fromJson(Map<String, dynamic> json) =>
+    _$UpdatePresenceResultFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UpdatePresenceResultToJson(this);
+}

lib/api/route/users.g.dart

@@ -0,0 +1,39 @@
+import 'package:checks/checks.dart';
+import 'package:http/http.dart' as http;
+import 'package:flutter_test/flutter_test.dart';
+import 'package:zulip/api/model/model.dart';
+import 'package:zulip/api/route/users.dart';
+
+import '../../stdlib_checks.dart';
+import '../fake_api.dart';
+
+void main() {
+  test('smoke updatePresence', () {
+    return FakeApiConnection.with_((connection) async {
+      final response = UpdatePresenceResult(
+        presenceLastUpdateId: -1,
+        serverTimestamp: 1656958539.6287155,
+        presences: {},
+      );
+      connection.prepare(json: response.toJson());
+      await updatePresence(connection,
+        lastUpdateId: -1,
+        historyLimitDays: 21,
+        newUserInput: false,
+        pingOnly: false,
+        status: PresenceStatus.active,
+      );
+      check(connection.takeRequests()).single.isA<http.Request>()
+        ..method.equals('POST')
+        ..url.path.equals('/api/v1/users/me/presence')
+        ..bodyFields.deepEquals({
+          'last_update_id': '-1',
+          'history_limit_days': '21',
+          'new_user_input': 'false',
+          'ping_only': 'false',
+          'status': 'active',
+          'slim_presence': 'true',
+        });
+    });
+  });
+}