fix: Refactor Robotoff methods #723
Conversation
Deprecated and routed the robotoff apis to a new file for decluttering
Removed User parameter as mentioned in the requirements along with getIngredientSpellingCorrection method. Could be a breaking change
atharv028
changed the title
atharv028
changed the title
lib/openfoodfacts.dart
Outdated
| @@ -107,4 +107,5 @@ export 'src/utils/tag_type.dart'; | |||
| export 'src/utils/unit_helper.dart'; | |||
| export 'src/utils/uri_helper.dart'; | |||
| export 'src/utils/uri_reader.dart'; | |||
| export 'src/robotoff_api_client.dart'; | |||
There was a problem hiding this comment.
I would prefer robot_off_api_client.dart but that's not a big deal.
lib/src/open_food_api_client.dart
Outdated
| @@ -788,226 +789,66 @@ class OpenFoodAPIClient { | |||
| } | |||
| } | |||
|
|
|||
| //TODO(x): Add comments for robotoff | |||
| //TODO : Remove Robotoff APIs From here | |||
There was a problem hiding this comment.
That TODO is not very useful, please get rid of ot.
Instead, please add a specific TODO comment for each related method, something like that:
// TODO: deprecated from 2022-12-01; remove when old enough
There was a problem hiding this comment.
Added TODO on each method in open_food_api_client.dart which routes to RobotOffAPIClient
lib/src/open_food_api_client.dart
Outdated
| @@ -2,6 +2,7 @@ import 'dart:async'; | |||
| import 'dart:convert'; | |||
|
|
|||
| import 'package:http/http.dart'; | |||
| import 'package:openfoodfacts/openfoodfacts.dart'; | |||
There was a problem hiding this comment.
Please use src/ imports instead.
lib/src/robotoff_api_client.dart
Outdated
| import 'package:http/http.dart'; | ||
| import 'package:openfoodfacts/openfoodfacts.dart'; | ||
|
|
||
| class RobotoffApiClient { |
There was a problem hiding this comment.
For consistency with OpenFoodAPIClient, RobotOffAPIClient would make more sense.
There was a problem hiding this comment.
Changed the class name to RobotOffAPIClient
lib/src/robotoff_api_client.dart
Outdated
| import 'dart:convert'; | ||
|
|
||
| import 'package:http/http.dart'; | ||
| import 'package:openfoodfacts/openfoodfacts.dart'; |
There was a problem hiding this comment.
Please use src/ imports instead.
lib/src/robotoff_api_client.dart
Outdated
| class RobotoffApiClient { | ||
| RobotoffApiClient._(); | ||
|
|
||
| //TODO(x): Add comments for robotoff APIs |
There was a problem hiding this comment.
Please get rid of that comment.
There was a problem hiding this comment.
Deleted the comment
lib/src/robotoff_api_client.dart
Outdated
|
|
||
| static Future<RobotoffQuestionResult> getProductQuestions( | ||
| String barcode, | ||
| String lang, { |
There was a problem hiding this comment.
Should be OpenFoodFactsLanguage language instead.
There was a problem hiding this comment.
Changed the parameter type to OpenFoodFactsLanguage and name to language
lib/src/robotoff_api_client.dart
Outdated
| } | ||
|
|
||
| static Future<RobotoffQuestionResult> getRandomQuestions( | ||
| OpenFoodFactsLanguage? lang, |
Fixed import directives, also made the naming conventions for classes consistent. Added TODOs
What
Screenshot
Fixes bug(s)
Part of