Fix: Added missing product fields to ProductField enum (#331)

* fix: Added missing arguments to ProductField * Update Product.dart * Added tests * fix: #328 type product_quantity
openfoodfacts · Dec 19, 2021 · 4bbd66c · 4bbd66c
1 parent 8910b5a
commit 4bbd66c
Show file tree

Hide file tree

Showing 5 changed files with 94 additions and 9 deletions.
diff --git a/lib/model/Product.dart b/lib/model/Product.dart
@@ -1,10 +1,13 @@
+import 'dart:convert';
+
 import 'package:json_annotation/json_annotation.dart';
-import 'package:openfoodfacts/model/AttributeGroup.dart';
 import 'package:openfoodfacts/model/Attribute.dart';
+import 'package:openfoodfacts/model/AttributeGroup.dart';
 import 'package:openfoodfacts/model/ProductImage.dart';
 import 'package:openfoodfacts/utils/JsonHelper.dart';
 import 'package:openfoodfacts/utils/LanguageHelper.dart';
 import 'package:openfoodfacts/utils/ProductFields.dart';
+
 import '../interface/JsonObject.dart';
 import 'Additives.dart';
 import 'Allergens.dart';
@@ -102,6 +105,11 @@ class Product extends JsonObject {
       includeIfNull: false)
   Map<OpenFoodFactsLanguage, String>? productNameInLanguages;
 
+  ///Common name
+  ///Example: Chocolate bar with milk and hazelnuts
+  @JsonKey(name: 'generic_name', includeIfNull: false)
+  String? genericName;
+
   @JsonKey(name: 'brands', includeIfNull: false)
   String? brands;
   @JsonKey(name: 'brands_tags', includeIfNull: false)
@@ -156,13 +164,20 @@ class Product extends JsonObject {
 
   @JsonKey(name: 'serving_size', includeIfNull: false)
   String? servingSize;
+
   @JsonKey(
-      name: 'serving_quantity',
-      fromJson: JsonHelper.servingQuantityFromJson,
-      includeIfNull: false)
+    name: 'serving_quantity',
+    fromJson: JsonHelper.quantityFromJson,
+    includeIfNull: false,
+  )
   double? servingQuantity;
-  @JsonKey(name: 'product_quantity', includeIfNull: false)
-  dynamic packagingQuantity;
+
+  @JsonKey(
+    name: 'product_quantity',
+    fromJson: JsonHelper.quantityFromJson,
+    includeIfNull: false,
+  )
+  double? packagingQuantity;
 
   /// cause nesting is sooo cool ;)
   @JsonKey(
@@ -292,6 +307,9 @@ class Product extends JsonObject {
   @JsonKey(name: 'stores_tags', includeIfNull: false)
   List<String>? storesTags;
 
+  @JsonKey(name: 'stores', includeIfNull: false)
+  String? stores;
+
   @JsonKey(
       name: 'attribute_groups',
       includeIfNull: false,
@@ -322,6 +340,7 @@ class Product extends JsonObject {
       {this.barcode,
       this.productName,
       this.productNameInLanguages,
+      this.genericName,
       this.brands,
       this.brandsTags,
       this.countries,
@@ -369,6 +388,7 @@ class Product extends JsonObject {
       this.statesTags,
       this.tracesTags,
       this.storesTags,
+      this.stores,
       this.attributeGroups,
       this.lastModified,
       this.ecoscoreGrade,

diff --git a/lib/model/Product.g.dart b/lib/model/Product.g.dart
diff --git a/lib/utils/JsonHelper.dart b/lib/utils/JsonHelper.dart
@@ -1,8 +1,8 @@
 import 'package:openfoodfacts/interface/JsonObject.dart';
 import 'package:openfoodfacts/model/AttributeGroup.dart';
-import 'package:openfoodfacts/utils/LanguageHelper.dart';
 import 'package:openfoodfacts/model/Ingredient.dart';
 import 'package:openfoodfacts/model/ProductImage.dart';
+import 'package:openfoodfacts/utils/LanguageHelper.dart';
 
 /// Helper class around product field conversion to/from JSON
 class JsonHelper {
@@ -127,7 +127,7 @@ class JsonHelper {
   }
 
   /// Returns a double from a JSON-encoded int or double
-  static double? servingQuantityFromJson(dynamic data) {
+  static double? quantityFromJson(dynamic data) {
     if (data == null || data is double) {
       return data;
     }

diff --git a/lib/utils/ProductFields.dart b/lib/utils/ProductFields.dart
@@ -15,6 +15,7 @@ enum ProductField {
   LANGUAGE,
   QUANTITY,
   SERVING_SIZE,
+  SERVING_QUANTITY,
   PACKAGING_QUANTITY,
   FRONT_IMAGE,
   SELECTED_IMAGE,
@@ -43,15 +44,21 @@ enum ProductField {
   CATEGORIES,
   CATEGORIES_TAGS,
   CATEGORIES_TAGS_IN_LANGUAGES,
+  LABELS,
   LABELS_TAGS,
   LABELS_TAGS_IN_LANGUAGES,
+  PACKAGING,
+  PACKAGING_TAGS,
   MISC_TAGS,
   STATES_TAGS,
   TRACES_TAGS,
+  STORES_TAGS,
+  STORES,
   INGREDIENTS_ANALYSIS_TAGS,
   ALLERGENS,
   ENVIRONMENT_IMPACT_LEVELS,
   ATTRIBUTE_GROUPS,
+  LAST_MODIFIED,
   ECOSCORE_GRADE,
   ECOSCORE_SCORE,
   ECOSCORE_DATA,
@@ -73,6 +80,7 @@ extension ProductFieldExtension on ProductField {
     ProductField.LANGUAGE: 'lang',
     ProductField.QUANTITY: 'quantity',
     ProductField.SERVING_SIZE: 'serving_size',
+    ProductField.SERVING_QUANTITY: 'serving_quantity',
     ProductField.PACKAGING_QUANTITY: 'product_quantity',
     ProductField.FRONT_IMAGE: 'image_small_url',
     ProductField.IMAGE_FRONT_URL: 'image_front_url',
@@ -101,15 +109,21 @@ extension ProductFieldExtension on ProductField {
     ProductField.CATEGORIES: 'categories',
     ProductField.CATEGORIES_TAGS: 'categories_tags',
     ProductField.CATEGORIES_TAGS_IN_LANGUAGES: 'categories_tags_',
+    ProductField.LABELS: 'labels',
     ProductField.LABELS_TAGS: 'labels_tags',
     ProductField.LABELS_TAGS_IN_LANGUAGES: 'labels_tags_',
+    ProductField.PACKAGING: 'packaging',
+    ProductField.PACKAGING_TAGS: 'packaging_tags',
     ProductField.MISC_TAGS: 'misc',
     ProductField.STATES_TAGS: 'states_tags',
     ProductField.TRACES_TAGS: 'traces_tags',
+    ProductField.STORES_TAGS: 'stores_tags',
+    ProductField.STORES: 'stores',
     ProductField.INGREDIENTS_ANALYSIS_TAGS: 'ingredients_analysis_tags',
     ProductField.ALLERGENS: 'allergens_tags',
     ProductField.ENVIRONMENT_IMPACT_LEVELS: 'environment_impact_level_tags',
     ProductField.ATTRIBUTE_GROUPS: 'attribute_groups',
+    ProductField.LAST_MODIFIED: 'last_modified_t',
     ProductField.ECOSCORE_GRADE: 'ecoscore_grade',
     ProductField.ECOSCORE_SCORE: 'ecoscore_score',
     ProductField.ECOSCORE_DATA: 'ecoscore_data',

diff --git a/test/api_getProduct_test.dart b/test/api_getProduct_test.dart
@@ -35,6 +35,7 @@ void main() {
       Product product = Product(
         barcode: barcode,
         productName: 'Coca Cola Light',
+        genericName: 'Softdrink',
         lang: OpenFoodFactsLanguage.GERMAN,
         countries: 'Frankreich,Deutschland',
         brands: 'Coca Cola',
@@ -77,6 +78,8 @@ void main() {
       expect(result.product!.barcode, barcode);
       expect(result.product!.lastModified != null, true);
 
+      expect(result.product!.genericName, 'Softdrink');
+
       // only german ingredients
       expect(result.product!.ingredientsText != null, true);
 
@@ -1647,4 +1650,48 @@ void main() {
       'de-es.openfoodfacts.net',
     );
   });
+
+  test('get minified product', () async {
+    String barcode = '111111555555';
+
+    //First add the product to the Test DB
+    Product product = Product(
+      barcode: barcode,
+      lang: OpenFoodFactsLanguage.GERMAN,
+      genericName: 'Softdrink',
+      labels: 'MyTestLabel',
+      packaging: 'de:In einer Plastikflasche',
+      quantity: '5.5 Liter',
+    );
+
+    await OpenFoodAPIClient.saveProduct(
+      TestConstants.TEST_USER,
+      product,
+    );
+
+    ProductQueryConfiguration configurations = ProductQueryConfiguration(
+      barcode,
+      language: OpenFoodFactsLanguage.GERMAN,
+      fields: [
+        ProductField.GENERIC_NAME,
+        ProductField.LABELS,
+        ProductField.PACKAGING,
+        ProductField.PACKAGING_TAGS,
+        ProductField.QUANTITY,
+      ],
+    );
+
+    ProductResult result = await OpenFoodAPIClient.getProduct(
+      configurations,
+      user: TestConstants.TEST_USER,
+    );
+
+    expect(result.status, 1);
+    expect(result.product?.barcode, null);
+    expect(result.product?.genericName, 'Softdrink');
+    expect(result.product?.labels, 'MyTestLabel');
+    expect(result.product?.packaging, 'de:In einer Plastikflasche');
+    expect(result.product?.packagingTags, ['de-in-einer-plastikflasche']);
+    expect(result.product?.quantity, '5.5 Liter');
+  });
 }