v3.8.0

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.8.0] - 2023-07-12
+
+* Encrypted for app info response.
+* New Firebase config fields added to `WooSignalApp` class.
+* Pubspec.yaml dependency updates.
+
 ## [3.7.1] - 2023-07-03
 
 * Update parameters for creating orders.

README.md

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

lib/models/response/woosignal_app.dart

@@ -50,6 +50,9 @@ class WooSignalApp {
   Map<String, dynamic>? socialLinks;
   List<MenuLink> menuLinks = [];
   Map<String, dynamic>? themeColors;
+  Map<String, dynamic>? firebaseOptionsIos = {};
+  Map<String, dynamic>? firebaseOptionsAndroid = {};
+  bool? firebaseFcmIsEnabled;
 
   WooSignalApp(
       {this.appName,
@@ -82,7 +85,9 @@ class WooSignalApp {
       this.themeFont,
       this.socialLinks,
       this.menuLinks = const [],
-      this.themeColors});
+      this.themeColors,
+      this.firebaseOptionsIos = const {},
+      this.firebaseOptionsAndroid = const {}});
 
   WooSignalApp.fromJson(Map<String, dynamic> json) {
     appName = json['app_name'];
@@ -151,6 +156,26 @@ class WooSignalApp {
         json['theme_colors'] is Map<String, dynamic>?) {
       themeColors = json['theme_colors'];
     }
+
+    if (json.containsKey('firebase_config') &&
+        json['firebase_config'] is Map<String, dynamic>?) {
+      Map<String, dynamic> firebaseConfig = json['firebase_config'];
+      if (firebaseConfig.containsKey('firebase_options_ios') &&
+          firebaseConfig['firebase_options_ios'] != null) {
+        firebaseOptionsIos = firebaseConfig['firebase_options_ios'];
+      }
+
+      if (firebaseConfig.containsKey('firebase_options_android') &&
+          firebaseConfig['firebase_options_android'] != null) {
+        firebaseOptionsAndroid = firebaseConfig['firebase_options_android'];
+      }
+    }
+
+    if (json['firebase_fcm_enabled'] != null) {
+      firebaseFcmIsEnabled =
+          json['firebase_fcm_enabled'].toString() == "1" ? true : false;
+    }
+
     if (json.containsKey('menu_links')) {
       menuLinks = List.from(json['menu_links'])
           .map((bet) => MenuLink.fromJson(bet))
@@ -191,6 +216,14 @@ class WooSignalApp {
     data['theme_font'] = themeFont;
     data['social_links'] = socialLinks;
     data['theme_colors'] = themeColors;
+    if (firebaseOptionsIos != null) {
+      data['firebase_config']['firebase_options_ios'] = firebaseOptionsIos;
+    }
+    if (firebaseOptionsAndroid != null) {
+      data['firebase_config']['firebase_options_android'] =
+          firebaseOptionsAndroid;
+    }
+    data['fcm_enabled'] = firebaseFcmIsEnabled;
     return data;
   }
 }

lib/networking/api_provider.dart

@@ -122,9 +122,9 @@ class ApiProvider {
   }
 
   /// HTTP GET request using a [url]
-  Future<dynamic> get(url) async {
+  Future<dynamic> get(url, {dynamic data}) async {
     try {
-      Response response = await _dio.get(url);
+      Response response = await _dio.get(url, data: data);
       return response.data;
     } catch (error, stacktrace) {
       _printLog("$error stackTrace: $stacktrace");

lib/woosignal.dart

@@ -15,6 +15,8 @@ library woosignal;
 // IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
+import 'dart:convert';
+
 import 'package:woosignal/models/response/api_data.dart';
 import 'package:woosignal/models/response/continent.dart';
 import 'package:woosignal/models/response/currencies.dart';
@@ -51,24 +53,37 @@ import 'package:woosignal/models/response/system_status.dart';
 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';
+import 'package:encrypt/encrypt.dart' as enc;
+import 'package:encrypt/encrypt.dart';
 
 /// WooSignal Package version
-const String wooSignalVersion = "3.7.1";
+const String wooSignalVersion = "3.8.0";
 
 class WooSignal {
   WooSignal._privateConstructor();
   static final WooSignal instance = WooSignal._privateConstructor();
 
   late ApiProvider _apiProvider;
   bool? _debugMode;
+  String? _encryptKey, _encryptSecret;
 
   /// Initialize the class
-  Future<void> init({required String? appKey, bool debugMode = false}) async {
+  Future<void> init(
+      {required String? appKey,
+      bool debugMode = false,
+      String? encryptKey,
+      String? encryptSecret}) async {
     assert(appKey != null && appKey != "",
         "Provide a valid app key. Visit https://woosignal.com");
     _apiProvider = ApiProvider(
         appKey: appKey!, debugMode: debugMode, version: wooSignalVersion);
     setDebugMode(debugMode);
+    if (encryptKey != null) {
+      _encryptKey = encryptKey;
+    }
+    if (encryptSecret != null) {
+      _encryptSecret = encryptSecret;
+    }
     await _apiProvider.init();
   }
 
@@ -121,14 +136,45 @@ class WooSignal {
     return model;
   }
 
+  String encrypt(String text) {
+    if (_encryptKey == null) {
+      return "";
+    }
+    if (_encryptSecret == null) {
+      return "";
+    }
+    final key = enc.Key.fromUtf8(_encryptKey!);
+    final iv = IV.fromUtf8(_encryptSecret!);
+    final encrypter = Encrypter(AES(key, mode: AESMode.cbc));
+    final encrypted = encrypter.encrypt(text, iv: iv);
+    return encrypted.base64;
+  }
+
+  String decrypt(String text) {
+    if (_encryptKey == null) {
+      return "";
+    }
+    if (_encryptSecret == null) {
+      return "";
+    }
+    final key = enc.Key.fromUtf8(_encryptKey!);
+    final iv = IV.fromUtf8(_encryptSecret!);
+    final encrypter = Encrypter(AES(key, mode: AESMode.cbc));
+    final decrypted = encrypter.decrypt(Encrypted.fromBase64(text), iv: iv);
+    return decrypted;
+  }
+
   /// Get app information from WooSignal
-  Future<WooSignalApp?> getApp() async {
-    dynamic response = await _apiProvider.get("/app");
+  Future<WooSignalApp?> getApp({bool encrypted = false}) async {
+    dynamic response =
+        await _apiProvider.get("/app", data: {"encrypted": encrypted});
     if (response == null) {
       return null;
     }
+    if (encrypted == true) {
+      response = jsonDecode(decrypt(response));
+    }
     WooSignalApp wooSignalApp = WooSignalApp.fromJson(response);
-
     _printLog(wooSignalApp.toString());
     return wooSignalApp;
   }

pubspec.yaml

@@ -1,18 +1,19 @@
 name: woosignal
 description: WooCommerce REST API for dart, connect a WooCommerce store and start developing with our interface for their API endpoints.
-version: 3.7.1
+version: 3.8.0
 homepage: https://woosignal.com
 repository: https://github.com/woosignal/flutter-woocommerce-api
 issue_tracker: https://github.com/woosignal/flutter-woocommerce-api/issues
 documentation: https://woosignal.com/docs/api/1.0/overview
 
 environment:
-  sdk: '>=2.19.0 <4.0.0'
+  sdk: '>=3.0.0 <4.0.0'
 
 dependencies:
   dio: ^5.2.1+1
   device_info_plus: ^9.0.2
   shared_preferences: ^2.2.0
+  encrypt: ^5.0.1
   uuid: ^3.0.6
 
   flutter: