Implement UserService.profileBanner request

Author: robertodoering

CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.5.8
+- Implemented `UserService.profileBanner` request
+
 # 0.5.7+1
 
 - Fixed `InitialInfo` and `EditedInfo` models were missing the `explicitToJson: true` flag (Thanks @ryzizub!)

lib/api/users/data/banner.dart

@@ -0,0 +1,63 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'banner.g.dart';
+
+@JsonSerializable(
+  explicitToJson: true,
+  fieldRename: FieldRename.snake,
+)
+class Banner {
+  Banner();
+
+  factory Banner.fromJson(Map<String, dynamic> json) => _$BannerFromJson(json);
+
+  BannerSizes? sizes;
+
+  Map<String, dynamic> toJson() => _$BannerToJson(this);
+}
+
+@JsonSerializable(
+  explicitToJson: true,
+  fieldRename: FieldRename.snake,
+)
+class BannerSizes {
+  BannerSizes();
+
+  factory BannerSizes.fromJson(Map<String, dynamic> json) =>
+      _$BannerSizesFromJson(json);
+
+  BannerSize? ipad;
+  BannerSize? ipadRetina;
+  BannerSize? web;
+  BannerSize? webRetina;
+  BannerSize? mobile;
+  BannerSize? mobileRetina;
+
+  @JsonKey(name: '300x100')
+  BannerSize? size300x100;
+
+  @JsonKey(name: '600x200')
+  BannerSize? size600x200;
+
+  @JsonKey(name: '1500x500')
+  BannerSize? size1500x500;
+
+  Map<String, dynamic> toJson() => _$BannerSizesToJson(this);
+}
+
+@JsonSerializable(
+  explicitToJson: true,
+  fieldRename: FieldRename.snake,
+)
+class BannerSize {
+  BannerSize();
+
+  factory BannerSize.fromJson(Map<String, dynamic> json) =>
+      _$BannerSizeFromJson(json);
+
+  int? h;
+  int? w;
+  String? url;
+
+  Map<String, dynamic> toJson() => _$BannerSizeToJson(this);
+}

lib/api/users/data/banner.g.dart

@@ -1,12 +1,5 @@
-import 'package:dart_twitter_api/api/abstract_twitter_client.dart';
-import 'package:dart_twitter_api/api/twitter_client.dart';
-import 'package:dart_twitter_api/api/users/data/friendship.dart';
-import 'package:dart_twitter_api/api/users/data/paginated_ids.dart';
-import 'package:dart_twitter_api/api/users/data/paginated_users.dart';
-import 'package:dart_twitter_api/api/users/data/relationship.dart';
-import 'package:dart_twitter_api/api/users/data/user.dart';
 import 'package:dart_twitter_api/src/utils/map_utils.dart';
-import 'package:dart_twitter_api/src/utils/transforms.dart';
+import 'package:dart_twitter_api/twitter_api.dart';
 
 class UserService {
   const UserService({
@@ -635,4 +628,29 @@ class UserService {
         )
         .then(transform);
   }
+
+  /// Returns available size variations of the specified user's profile banner.
+  ///
+  /// The profile banner data available at each size variant's URL is in PNG
+  /// format.
+  ///
+  /// If the user has not uploaded a profile banner, a `Future.error` is
+  /// returned instead with the 404 response.
+  ///
+  /// See https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner.
+  Future<Banner> profileBanner({
+    String? screenName,
+    String? userId,
+    TransformResponse<Banner> transform = defaultBannerTransform,
+  }) {
+    final params = <String, String>{}
+      ..addParameter('screen_name', screenName)
+      ..addParameter('user_id', userId);
+
+    return client
+        .get(
+          Uri.https('api.twitter.com', '1.1/users/profile_banner.json', params),
+        )
+        .then(transform);
+  }
 }

lib/api/users/user_service.dart

@@ -1,7 +1,5 @@
 import 'dart:convert';
 
-import 'package:dart_twitter_api/api/users/data/paginated_ids.dart';
-import 'package:dart_twitter_api/api/users/data/relationship.dart';
 import 'package:dart_twitter_api/twitter_api.dart';
 import 'package:http/http.dart';
 
@@ -249,3 +247,11 @@ Future<List<int>> defaultIntListTransform(Response response) async {
 List<int> _isolateIntListTransform(String body) {
   return (json.decode(body) as List<dynamic>).map((e) => e as int).toList();
 }
+
+Future<Banner> defaultBannerTransform(Response response) async {
+  return await compute<String, Banner>(_isolateBannerTransform, response.body);
+}
+
+Banner _isolateBannerTransform(String body) {
+  return Banner.fromJson(json.decode(body));
+}

lib/src/utils/transforms.dart

@@ -37,10 +37,13 @@ export 'api/tweets/timeline_service.dart';
 export 'api/tweets/tweet_search_service.dart';
 export 'api/tweets/tweet_service.dart';
 export 'api/twitter_client.dart';
+export 'api/users/data/banner.dart';
 export 'api/users/data/derived.dart';
 export 'api/users/data/friendship.dart';
 export 'api/users/data/location.dart';
+export 'api/users/data/paginated_ids.dart';
 export 'api/users/data/paginated_users.dart';
+export 'api/users/data/relationship.dart';
 export 'api/users/data/user.dart';
 export 'api/users/data/user_entities.dart';
 export 'api/users/user_service.dart';