Merge pull request #8 from woosignal/master

v3.1.0 updates

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.1.0] - 2022-05-19
+
+* New API for product tags
+* Flutter format
+* Dependency updates
+* Dart version 2.17
+
 ## [3.0.5] - 2022-01-29
 
 * Version added to woosignal.dart

README.md

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

lib/models/response/product_tag.dart

@@ -0,0 +1,55 @@
+// Copyright (c) 2022, WooSignal Ltd.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms are permitted
+// provided that the above copyright notice and this paragraph are
+// duplicated in all such forms and that any documentation,
+// advertising materials, and other materials related to such
+// distribution and use acknowledge that the software was developed
+// by the WooSignal. The name of the
+// WooSignal may not be used to endorse or promote products derived
+// from this software without specific prior written permission.
+// THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+import 'package:woosignal/models/links.dart';
+
+class ProductTag {
+  int? id;
+  String? name;
+  String? slug;
+  String? description;
+  int? count;
+  Links? links;
+
+  ProductTag(
+      {this.id,
+      this.name,
+      this.slug,
+      this.description,
+      this.count,
+      this.links});
+
+  ProductTag.fromJson(Map<String, dynamic> json) {
+    id = json['id'];
+    name = json['name'];
+    slug = json['slug'];
+    description = json['description'];
+    count = json['count'];
+    links = json['_links'] != null ? new Links.fromJson(json['_links']) : null;
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    data['id'] = this.id;
+    data['name'] = this.name;
+    data['slug'] = this.slug;
+    data['description'] = this.description;
+    data['count'] = this.count;
+    if (this.links != null) {
+      data['_links'] = this.links!.toJson();
+    }
+    return data;
+  }
+}

lib/networking/api_provider.dart

@@ -14,9 +14,9 @@
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
 import 'dart:convert';
+import 'package:device_info_plus/device_info_plus.dart';
 import 'package:dio/dio.dart';
 import 'package:woosignal/helpers/shared_pref.dart';
-import 'package:device_info/device_info.dart';
 import 'dart:io' show Platform;
 
 class ApiProvider {
@@ -36,8 +36,8 @@ class ApiProvider {
       AndroidDeviceInfo androidDeviceInfo = await deviceInfo.androidInfo;
       _deviceMeta = {
         "model": androidDeviceInfo.device,
-        "brand":
-            androidDeviceInfo.brand.replaceAll(RegExp('[^\u0001-\u007F]'), '_'),
+        "brand": androidDeviceInfo.brand
+            ?.replaceAll(RegExp('[^\u0001-\u007F]'), '_'),
         "manufacturer": androidDeviceInfo.manufacturer,
         "version": androidDeviceInfo.version.sdkInt.toString(),
         "uuid": uuid,
@@ -48,7 +48,8 @@ class ApiProvider {
       IosDeviceInfo iosDeviceInfo = await deviceInfo.iosInfo;
       _deviceMeta = {
         "model": iosDeviceInfo.model,
-        "brand": iosDeviceInfo.name.replaceAll(RegExp('[^\u0001-\u007F]'), '_'),
+        "brand":
+            iosDeviceInfo.name?.replaceAll(RegExp('[^\u0001-\u007F]'), '_'),
         "manufacturer": "Apple",
         "version": iosDeviceInfo.systemVersion,
         "uuid": uuid,
@@ -82,7 +83,7 @@ class ApiProvider {
   /// Set the http headers for Dio
   _setDioHeaders() {
     _dio.options.headers = {
-      "Authorization": "Bearer " + _apiKey,
+      "Authorization": "Bearer $_apiKey",
       "Content-Type": "application/json",
       "X-DMETA": json.encode(_deviceMeta).toString()
     };

lib/woosignal.dart

@@ -20,6 +20,7 @@ import 'package:woosignal/models/response/continent.dart';
 import 'package:woosignal/models/response/currencies.dart';
 import 'package:woosignal/models/response/customer_download.dart';
 import 'package:woosignal/models/response/order_batch.dart' as ob;
+import 'package:woosignal/models/response/product_tag.dart';
 import 'package:woosignal/models/response/refund.dart';
 import 'package:woosignal/models/response/order_notes.dart';
 import 'package:woosignal/models/response/coupon.dart';
@@ -52,7 +53,7 @@ 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";
+const String wooSignalVersion = "3.1.0";
 
 class WooSignal {
   WooSignal._privateConstructor();
@@ -85,7 +86,7 @@ class WooSignal {
   /// Print to the console a [message]
   void _printLog(String message) {
     if (_debugMode == true) {
-      print("WOOSIGNAL LOG: " + message);
+      print("WooSignal LOG: $message");
     }
   }
 
@@ -99,7 +100,7 @@ class WooSignal {
       required String path,
       required T Function(dynamic json) jsonResponse,
       String postUrl = "/request"}) async {
-    _printLog("Parameters: " + payload.toString());
+    _printLog("Parameters: $payload");
     payload = _standardPayload(method, payload, path);
 
     dynamic json = await _apiProvider.post(postUrl, payload);
@@ -1380,4 +1381,89 @@ class WooSignal {
       jsonResponse: (json) => ProductBatch.fromJson(json),
     );
   }
+
+  /// https://woosignal.com/docs/api/1.0/products#create-product-tags
+  Future<ProductTag?> createProductTag(
+      {required String name, String? slug, String? description}) async {
+    Map<String, dynamic> payload = {'name': name};
+    if (slug != null) payload['slug'] = slug;
+    if (description != null) payload['description'] = description;
+
+    return await _wooSignalRequest<ProductTag?>(
+      method: "post",
+      path: "products/tags",
+      payload: payload,
+      jsonResponse: (json) => ProductTag.fromJson(json),
+    );
+  }
+
+  /// https://woosignal.com/docs/api/1.0/products#create-product-tag
+  Future<ProductTag?> retrieveProductTag(int id) async {
+    return await _wooSignalRequest<ProductTag?>(
+      method: "get",
+      path: "products/tags/" + id.toString(),
+      jsonResponse: (json) => ProductTag.fromJson(json),
+    );
+  }
+
+  /// https://woosignal.com/docs/api/1.0/products#create-product-tags
+  Future<List<ProductTag>?> getProductTags(
+      {String? context,
+      int? page,
+      int? perPage,
+      String? search,
+      List<int>? exclude,
+      List<int>? include,
+      int? offset,
+      String? order,
+      String? orderBy,
+      bool? hideEmpty,
+      int? product,
+      String? slug}) async {
+    Map<String, dynamic> payload = {};
+
+    if (context != null) payload["context"] = context;
+    if (page != null) payload["page"] = page;
+    if (perPage != null) payload["per_page"] = perPage;
+    if (search != null) payload["search"] = search;
+    if (exclude != null) payload["exclude"] = exclude;
+    if (include != null) payload["include"] = include;
+    if (offset != null) payload["offset"] = offset;
+    if (order != null) payload["order"] = order;
+    if (orderBy != null) payload["orderby"] = orderBy;
+    if (hideEmpty != null) payload["hide_empty"] = hideEmpty;
+    if (product != null) payload["product"] = product;
+    if (slug != null) payload["slug"] = slug;
+
+    return await _wooSignalRequest<List<ProductTag>?>(
+      method: "get",
+      path: "products/tags",
+      payload: payload,
+      jsonResponse: (json) =>
+          (json as List).map((i) => ProductTag.fromJson(i)).toList(),
+    );
+  }
+
+  /// https://woosignal.com/docs/api/1.0/products#create-product-tags
+  Future<ProductTag?> updateProductTag(int productTagId,
+      {Map<String, dynamic>? data}) async {
+    return await _wooSignalRequest<ProductTag?>(
+      method: "put",
+      path: "products/tags/" + productTagId.toString(),
+      payload: data ?? {},
+      jsonResponse: (json) => ProductTag.fromJson(json),
+    );
+  }
+
+  /// https://woosignal.com/docs/api/1.0/products#delete-product-tags
+  Future<ProductTag?> deleteProductTag(int productTagId,
+      {bool force = false}) async {
+    Map<String, dynamic> payload = {"force": force};
+    return await _wooSignalRequest<ProductTag?>(
+      method: "delete",
+      path: "products/tags/" + productTagId.toString(),
+      payload: payload,
+      jsonResponse: (json) => ProductTag.fromJson(json),
+    );
+  }
 }

pubspec.yaml

@@ -1,23 +1,23 @@
 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.5
+version: 3.1.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.15.0 <3.0.0'
+  sdk: '>=2.17.0 <3.0.0'
 
 dependencies:
-  dio: ^4.0.4
-  device_info: ^2.0.3
-  shared_preferences: ^2.0.12
-  uuid: ^3.0.5
+  dio: ^4.0.6
+  device_info_plus: ^3.2.3
+  shared_preferences: ^2.0.15
+  uuid: ^3.0.6
 
   flutter:
     sdk: flutter
 
 dev_dependencies:
-  lints: ^1.0.0
+  lints: ^2.0.0
   test: ^1.16.0