feat: 978 - new prices features (thumbnails, stats)

New file: * `price_total_stats.dart`: Total stats for Prices. Impacted files: * `api_get_product_test.dart`: unrelated minor fix * `api_prices_test.dart`: added test for the new `getStats` method; added test for thumbnails * `location.dart`: added new count fields * `location.g.dart`: generated * `open_prices_api_client.dart`: new method `getStats` * `openfoodfacts.dart`: exported new file `price_total_stats.dart` * `price_product.dart`: added new count fields * `price_product.g.dart`: generated * `price_user.dart`: added new count fields * `price_user.g.dart`: generated * `proof.dart`: added thumbnail field and getter * `proof.g.dart`: generated * `proof_type.dart`: added new "SHOP_IMPORT" value
openfoodfacts · Oct 4, 2024 · 6ed58f8 · 6ed58f8
1 parent 0d3f6fc
commit 6ed58f8
Show file tree

Hide file tree

Showing 14 changed files with 244 additions and 23 deletions.
diff --git a/lib/openfoodfacts.dart b/lib/openfoodfacts.dart
@@ -114,6 +114,7 @@ export 'src/prices/order_by.dart';
 export 'src/prices/price.dart';
 export 'src/prices/price_per.dart';
 export 'src/prices/price_product.dart';
+export 'src/prices/price_total_stats.dart';
 export 'src/prices/price_user.dart';
 export 'src/prices/proof.dart';
 export 'src/prices/proof_type.dart';

diff --git a/lib/src/open_prices_api_client.dart b/lib/src/open_prices_api_client.dart
@@ -21,6 +21,7 @@ import 'prices/get_users_result.dart';
 import 'prices/location.dart';
 import 'prices/location_osm_type.dart';
 import 'prices/price_product.dart';
+import 'prices/price_total_stats.dart';
 import 'prices/proof_type.dart';
 import 'prices/session.dart';
 import 'prices/update_price_parameters.dart';
@@ -612,4 +613,29 @@ class OpenPricesAPIClient {
     }
     return MaybeError<GetUsersResult>.responseError(response);
   }
+
+  /// Returns the total stats.
+  static Future<MaybeError<PriceTotalStats>> getStats({
+    final UriProductHelper uriHelper = uriHelperFoodProd,
+  }) async {
+    final Uri uri = getUri(
+      path: '/api/v1/stats',
+      uriHelper: uriHelper,
+    );
+    final Response response = await HttpHelper().doGetRequest(
+      uri,
+      uriHelper: uriHelper,
+    );
+    if (response.statusCode == 200) {
+      try {
+        final dynamic decodedResponse = HttpHelper().jsonDecodeUtf8(response);
+        return MaybeError<PriceTotalStats>.value(
+          PriceTotalStats.fromJson(decodedResponse),
+        );
+      } catch (e) {
+        //
+      }
+    }
+    return MaybeError<PriceTotalStats>.responseError(response);
+  }
 }
diff --git a/lib/src/prices/location.dart b/lib/src/prices/location.dart
@@ -8,7 +8,7 @@ part 'location.g.dart';
 
 /// Location object in the Prices API.
 ///
-/// cf. `LocationBase` in https://prices.openfoodfacts.net/docs
+/// cf. `Location` in https://prices.openfoodfacts.org/api/docs
 @JsonSerializable()
 class Location extends JsonObject {
   /// ID of the location in OpenStreetMap: the store where the product was bought.
@@ -25,7 +25,19 @@ class Location extends JsonObject {
 
   /// Number of prices for this location.
   @JsonKey(name: 'price_count')
-  late int priceCount;
+  int? priceCount;
+
+  /// Number of users for this location.
+  @JsonKey(name: 'user_count')
+  int? userCount;
+
+  /// Number of products for this location.
+  @JsonKey(name: 'product_count')
+  int? productCount;
+
+  /// Number of proofs for this location.
+  @JsonKey(name: 'proof_count')
+  int? proofCount;
 
   /// ID in the Prices API.
   @JsonKey(name: 'id')
@@ -65,7 +77,7 @@ class Location extends JsonObject {
   @JsonKey(fromJson: JsonHelper.stringTimestampToDate)
   late DateTime created;
 
-  /// Date when the product was bought.
+  /// Latest update timestamp.
   @JsonKey(fromJson: JsonHelper.nullableStringTimestampToDate)
   DateTime? updated;
 

diff --git a/lib/src/prices/location.g.dart b/lib/src/prices/location.g.dart
diff --git a/lib/src/prices/price_product.dart b/lib/src/prices/price_product.dart
@@ -8,7 +8,7 @@ part 'price_product.g.dart';
 
 /// Product object in the Prices API.
 ///
-/// cf. `ProductFull` in https://prices.openfoodfacts.net/docs
+/// cf. `ProductFull` in https://prices.openfoodfacts.org/api/docs
 @JsonSerializable()
 class PriceProduct extends JsonObject {
   /// Barcode (EAN) of the product, as a string.
@@ -17,7 +17,19 @@ class PriceProduct extends JsonObject {
 
   /// Number of prices for this product.
   @JsonKey(name: 'price_count')
-  late int priceCount;
+  int? priceCount;
+
+  /// Number of locations for this product.
+  @JsonKey(name: 'location_count')
+  int? locationCount;
+
+  /// Number of users for this product.
+  @JsonKey(name: 'user_count')
+  int? userCount;
+
+  /// Number of proofs for this product.
+  @JsonKey(name: 'proof_count')
+  int? proofCount;
 
   @JsonKey(name: 'id')
   late int productId;

diff --git a/lib/src/prices/price_product.g.dart b/lib/src/prices/price_product.g.dart
diff --git a/lib/src/prices/price_total_stats.dart b/lib/src/prices/price_total_stats.dart
@@ -0,0 +1,62 @@
+import 'package:json_annotation/json_annotation.dart';
+
+import '../interface/json_object.dart';
+import '../utils/json_helper.dart';
+
+part 'price_total_stats.g.dart';
+
+/// Total stats for Prices.
+///
+/// cf. `TotalStats` in https://prices.openfoodfacts.org/api/docs
+@JsonSerializable()
+class PriceTotalStats extends JsonObject {
+  @JsonKey(name: 'price_count')
+  int? priceCount;
+
+  @JsonKey(name: 'price_type_product_code_count')
+  int? priceTypeProductCodeCount;
+
+  @JsonKey(name: 'price_type_category_tag_count')
+  int? priceTypeCategoryTagCount;
+
+  @JsonKey(name: 'product_count')
+  int? productCount;
+
+  @JsonKey(name: 'product_with_price_count')
+  int? productWithPriceCount;
+
+  @JsonKey(name: 'location_count')
+  int? locationCount;
+
+  @JsonKey(name: 'location_with_price_count')
+  int? locationWithPriceCount;
+
+  @JsonKey(name: 'proof_count')
+  int? proofCount;
+
+  @JsonKey(name: 'proof_with_price_count')
+  int? proofWithPriceCount;
+
+  @JsonKey(name: 'proof_type_price_tag_count')
+  int? proofTypePriceTagCount;
+
+  @JsonKey(name: 'proof_type_receipt_count')
+  int? proofTypeReceiptCount;
+
+  @JsonKey(name: 'user_count')
+  int? userCount;
+
+  @JsonKey(name: 'user_with_price_count')
+  int? userWithPriceCount;
+
+  @JsonKey(fromJson: JsonHelper.nullableStringTimestampToDate)
+  DateTime? updated;
+
+  PriceTotalStats();
+
+  factory PriceTotalStats.fromJson(Map<String, dynamic> json) =>
+      _$PriceTotalStatsFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$PriceTotalStatsToJson(this);
+}
diff --git a/lib/src/prices/price_user.dart b/lib/src/prices/price_user.dart
@@ -6,19 +6,27 @@ part 'price_user.g.dart';
 
 /// Price user object.
 ///
-/// cf. `UserBase`  in https://prices.openfoodfacts.org/api/docs
+/// cf. `User`  in https://prices.openfoodfacts.org/api/docs
 @JsonSerializable()
 class PriceUser extends JsonObject {
   @JsonKey(name: 'user_id')
   late String userId;
 
   /// Number of prices for this user.
   @JsonKey(name: 'price_count')
-  late int priceCount;
+  int? priceCount;
 
-  /// Number of prices for this user.
-  @JsonKey(name: 'is_moderator')
-  bool? isModerator;
+  /// Number of locations for this user.
+  @JsonKey(name: 'location_count')
+  int? locationCount;
+
+  /// Number of products for this user.
+  @JsonKey(name: 'product_count')
+  int? productCount;
+
+  /// Number of proofs for this user.
+  @JsonKey(name: 'proof_count')
+  int? proofCount;
 
   PriceUser();
 

diff --git a/lib/src/prices/price_user.g.dart b/lib/src/prices/price_user.g.dart
diff --git a/lib/src/prices/proof.dart b/lib/src/prices/proof.dart
@@ -24,6 +24,10 @@ class Proof extends JsonObject {
   @JsonKey(name: 'file_path')
   String? filePath;
 
+  /// Image thumb file path. Read-only.
+  @JsonKey(name: 'image_thumb_path')
+  String? imageThumbPath;
+
   /// Mime type. Read-only.
   @JsonKey()
   late String mimetype;
@@ -89,12 +93,25 @@ class Proof extends JsonObject {
   @override
   Map<String, dynamic> toJson() => _$ProofToJson(this);
 
-  /// Returns the URL of the proof image.
-  Uri? getFileUrl({required final UriProductHelper uriProductHelper}) =>
-      filePath == null
+  /// Returns the URL of the proof image, thumbnail or full.
+  Uri? getFileUrl({
+    required final UriProductHelper uriProductHelper,
+    final bool isThumbnail = true,
+  }) =>
+      _getFileUrl(
+        uriProductHelper: uriProductHelper,
+        path: isThumbnail ? imageThumbPath : filePath,
+      );
+
+  /// Returns the URL of a proof image.
+  static Uri? _getFileUrl({
+    required final UriProductHelper uriProductHelper,
+    required String? path,
+  }) =>
+      path == null
           ? null
           : OpenPricesAPIClient.getUri(
-              path: 'img/$filePath',
+              path: 'img/$path',
               uriHelper: uriProductHelper,
               addUserAgentParameters: false,
             );

diff --git a/lib/src/prices/proof.g.dart b/lib/src/prices/proof.g.dart
diff --git a/lib/src/prices/proof_type.dart b/lib/src/prices/proof_type.dart
@@ -12,7 +12,10 @@ enum ProofType implements OffTagged {
   receipt(offTag: 'RECEIPT'),
 
   @JsonValue('GDPR_REQUEST')
-  gdprRequest(offTag: 'GDPR_REQUEST');
+  gdprRequest(offTag: 'GDPR_REQUEST'),
+
+  @JsonValue('SHOP_IMPORT')
+  shopImport(offTag: 'SHOP_IMPORT');
 
   const ProofType({
     required this.offTag,

diff --git a/test/api_get_product_test.dart b/test/api_get_product_test.dart
@@ -78,8 +78,6 @@ void main() {
       expect(nutriments.getValue(Nutrient.proteins, perSize), isNotNull);
       expect(nutriments.getValue(Nutrient.salt, perSize), isNotNull);
       expect(nutriments.getValue(Nutrient.fat, perSize), isNotNull);
-
-      expect(result.product!.countries, 'United States');
     });
 
     test('check alcohol data', () async {