Merge pull request #7 from woosignal/master

v3.0.4 - updates

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,15 @@
+## [3.0.5] - 2022-01-29
+
+* Version added to woosignal.dart
+* Flutter format
+* Improvements as per Dart analysis
+
+## [3.0.4] - 2022-01-28
+
+* Add new variables to woosignal_app
+* Update arguments for product review
+* Dependency updates
+
 ## [3.0.3] - 2022-01-03
 
 * Update coupon property types

README.md

@@ -15,7 +15,7 @@ In your flutter project add the dependency:
 ``` dart 
 dependencies:
   ...
-  woosignal: ^3.0.3
+  woosignal: ^3.0.5
 ```
 
 ### Usage example #

example/lib/main.dart

@@ -2,7 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:woosignal/woosignal.dart';
 import 'package:woosignal/models/response/products.dart';
 
-void woosignal_woocommerce_example() => runApp(MyApp());
+void woosignalWoocommerceExample() => runApp(MyApp());
 
 class MyApp extends StatelessWidget {
   @override

lib/models/response/continent.dart

@@ -113,23 +113,23 @@ class Country {
       };
 }
 
-enum CurrencyPos { LEFT, LEFT_SPACE, RIGHT, RIGHT_SPACE }
+enum CurrencyPos { left, leftSpace, right, rightSpace }
 
 final currencyPosValues = EnumValues({
-  "left": CurrencyPos.LEFT,
-  "left_space": CurrencyPos.LEFT_SPACE,
-  "right": CurrencyPos.RIGHT,
-  "right_space": CurrencyPos.RIGHT_SPACE
+  "left": CurrencyPos.left,
+  "left_space": CurrencyPos.leftSpace,
+  "right": CurrencyPos.right,
+  "right_space": CurrencyPos.rightSpace
 });
 
-enum Sep { EMPTY, SEP, PURPLE }
+enum Sep { empty, sep, purple }
 
-final sepValues = EnumValues({".": Sep.EMPTY, " ": Sep.PURPLE, ",": Sep.SEP});
+final sepValues = EnumValues({".": Sep.empty, " ": Sep.purple, ",": Sep.sep});
 
-enum DimensionUnit { CM, IN }
+enum DimensionUnit { cm, inch }
 
 final dimensionUnitValues =
-    EnumValues({"cm": DimensionUnit.CM, "in": DimensionUnit.IN});
+    EnumValues({"cm": DimensionUnit.cm, "in": DimensionUnit.inch});
 
 class State {
   State({
@@ -151,9 +151,9 @@ class State {
       };
 }
 
-enum WeightUnit { KG, OZ }
+enum WeightUnit { kg, oz }
 
-final weightUnitValues = EnumValues({"kg": WeightUnit.KG, "oz": WeightUnit.OZ});
+final weightUnitValues = EnumValues({"kg": WeightUnit.kg, "oz": WeightUnit.oz});
 
 class EnumValues<T> {
   Map<String, T> map;

lib/models/response/payment_gateway.dart

@@ -862,44 +862,44 @@ class TitleOptions {
 }
 
 enum Placeholder {
-  EMPTY,
-  OPTIONAL,
-  OPTIONAL_IF_YOU_PROVIDE_A_CERTIFICATE_BELOW,
-  YOU_YOUREMAIL_COM
+  empty,
+  optional,
+  optionalIfYouProvideACertificateBelow,
+  youYourEmailCom
 }
 
 final placeholderValues = EnumValues({
-  "": Placeholder.EMPTY,
-  "Optional": Placeholder.OPTIONAL,
+  "": Placeholder.empty,
+  "Optional": Placeholder.optional,
   "Optional if you provide a certificate below":
-      Placeholder.OPTIONAL_IF_YOU_PROVIDE_A_CERTIFICATE_BELOW,
-  "you@youremail.com": Placeholder.YOU_YOUREMAIL_COM
+      Placeholder.optionalIfYouProvideACertificateBelow,
+  "you@youremail.com": Placeholder.youYourEmailCom
 });
 
 enum Type {
-  TITLE,
-  CHECKBOX,
-  FILE,
-  PASSWORD,
-  TEXT,
-  SELECT,
-  EMAIL,
-  MULTISELECT,
-  IMAGE,
-  TEXTAREA
+  title,
+  checkbox,
+  file,
+  password,
+  text,
+  select,
+  email,
+  multiselect,
+  image,
+  textarea
 }
 
 final typeValues = EnumValues({
-  "checkbox": Type.CHECKBOX,
-  "email": Type.EMAIL,
-  "file": Type.FILE,
-  "image": Type.IMAGE,
-  "multiselect": Type.MULTISELECT,
-  "password": Type.PASSWORD,
-  "select": Type.SELECT,
-  "text": Type.TEXT,
-  "textarea": Type.TEXTAREA,
-  "title": Type.TITLE
+  "checkbox": Type.checkbox,
+  "email": Type.email,
+  "file": Type.file,
+  "image": Type.image,
+  "multiselect": Type.multiselect,
+  "password": Type.password,
+  "select": Type.select,
+  "text": Type.text,
+  "textarea": Type.textarea,
+  "title": Type.title
 });
 
 class HideFundingMethods {

lib/models/response/woosignal_app.dart

@@ -26,6 +26,9 @@ class WooSignalApp {
   String? stripeAccount;
   int? wpLoginEnabled;
   bool? couponEnabled;
+  bool? showProductReviews;
+  bool? showRelatedProducts;
+  bool? showUpsellProducts;
   String? wpLoginBaseUrl;
   String? wpLoginForgotPasswordUrl;
   String? wpLoginWpApiPath;
@@ -101,6 +104,24 @@ class WooSignalApp {
     } else {
       couponEnabled = false;
     }
+    if (json['show_product_reviews'] is int &&
+        json['show_product_reviews'] == 1) {
+      showProductReviews = true;
+    } else {
+      showProductReviews = false;
+    }
+    if (json['show_related_products'] is int &&
+        json['show_related_products'] == 1) {
+      showRelatedProducts = true;
+    } else {
+      showRelatedProducts = false;
+    }
+    if (json['show_upsell_products'] is int &&
+        json['show_upsell_products'] == 1) {
+      showUpsellProducts = true;
+    } else {
+      showUpsellProducts = false;
+    }
     wpLoginBaseUrl = json['wp_login_base_url'];
     wpLoginForgotPasswordUrl = json['wp_login_forgot_password_url'];
     wpLoginWpApiPath = json['wp_login_wp_api_path'];

lib/networking/api_provider.dart

@@ -23,6 +23,7 @@ class ApiProvider {
   late Dio _dio;
   bool _debugMode;
   late final String _apiKey;
+  late final String _version;
   Map<String, dynamic> _deviceMeta = {};
 
   /// Set the device meta
@@ -41,7 +42,7 @@ class ApiProvider {
         "version": androidDeviceInfo.version.sdkInt.toString(),
         "uuid": uuid,
         "platform_type": "android",
-        "api_version": "3.0.0/v3"
+        "api_version": "$_version/v3"
       };
     } else if (Platform.isIOS) {
       IosDeviceInfo iosDeviceInfo = await deviceInfo.iosInfo;
@@ -52,7 +53,7 @@ class ApiProvider {
         "version": iosDeviceInfo.systemVersion,
         "uuid": uuid,
         "platform_type": "ios",
-        "api_version": "3.0.0/v3"
+        "api_version": "$_version/v3"
       };
     }
   }
@@ -88,9 +89,11 @@ class ApiProvider {
   }
 
   /// Constructor requires a [appKey] from WooSignal
-  ApiProvider({required String appKey, bool debugMode = true})
+  ApiProvider(
+      {required String appKey, required String version, bool debugMode = true})
       : _apiKey = appKey,
-        _debugMode = debugMode;
+        _debugMode = debugMode,
+        _version = version;
 
   /// Initialize class
   Future init() async {

lib/woosignal.dart

@@ -51,6 +51,9 @@ import 'package:woosignal/models/response/setting_option.dart';
 import 'package:woosignal/models/response/setting_option_batch.dart';
 import 'package:woosignal/models/response/product_batch.dart';
 
+/// WooSignal Package version
+const String wooSignalVersion = "3.0.5";
+
 class WooSignal {
   WooSignal._privateConstructor();
   static final WooSignal instance = WooSignal._privateConstructor();
@@ -62,7 +65,8 @@ class WooSignal {
   Future<void> init({required String? appKey, bool debugMode = false}) async {
     assert(appKey != null && appKey != "",
         "Provide a valid app key. Visit https://woosignal.com");
-    _apiProvider = ApiProvider(appKey: appKey!, debugMode: debugMode);
+    _apiProvider = ApiProvider(
+        appKey: appKey!, debugMode: debugMode, version: wooSignalVersion);
     setDebugMode(debugMode);
     await _apiProvider.init();
   }
@@ -428,11 +432,11 @@ class WooSignal {
   /// https://woosignal.com/docs/api/1.0/product-reviews
   Future<ProductReview?> createProductReview(
       {int? productId,
-      int? status,
+      String? status,
       String? reviewer,
       String? reviewerEmail,
       String? review,
-      int? rating,
+      int? rating, // Review rating (0 to 5)
       bool? verified}) async {
     Map<String, dynamic> payload = {};
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: woosignal
 description: WooCommerce REST API for dart, connect a WooCommerce store and start developing with our interface for their API endpoints.
-version: 3.0.3
+version: 3.0.5
 homepage: https://woosignal.com
 repository: https://github.com/woosignal/flutter-woocommerce-api
 issue_tracker: https://github.com/woosignal/flutter-woocommerce-api/issues
@@ -12,7 +12,7 @@ environment:
 dependencies:
   dio: ^4.0.4
   device_info: ^2.0.3
-  shared_preferences: ^2.0.11
+  shared_preferences: ^2.0.12
   uuid: ^3.0.5
 
   flutter: