Ability to add and remove roles from a user

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.1.0] - 2021-09-02
+
+* Ability to add and remove roles from a user
+* Dependency updates
+
 ## [3.0.0] - 2021-04-10
 
 * Added null safety support

README.md

@@ -11,6 +11,8 @@
 * Get Users Info
 * Update Users Info
 * Update Users Password
+* Add role to a user
+* Remove role from a user
 
 **WooCommerce**
 
@@ -25,7 +27,7 @@ In your flutter project add the dependency:
 ``` dart 
 dependencies:
   ...
-  wp_json_api: ^3.0.0
+  wp_json_api: ^3.1.0
 ```
 
 ### Usage example #
@@ -153,6 +155,30 @@ WPUserResetPasswordResponse wpUserResetPasswordResponse = await WPJsonAPI.instan
         ));
 ```
 
+#### WordPress - Add a role to a user
+- Used to add a role to a user in WordPress
+- The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
+
+``` dart
+WPUserAddRoleResponse wpUserAddRoleResponse = await WPJsonAPI.instance
+        .api((request) => request.wpUserAddRole(
+            userToken,
+            role: "customer" // e.g. customer, subscriber
+        ));
+```
+
+#### WordPress - Remove a role from a user
+- Used to remove a role from a user in WordPress
+- The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
+
+``` dart
+WPUserRemoveRoleResponse wpUserAddRemoveResponse = await WPJsonAPI.instance
+        .api((request) => request.wpUserRemoveRole(
+            userToken,
+            role: "customer" // e.g. customer, subscriber
+        ));
+```
+
 #### WooCommerce - Get users info in WooCommerce
 - Used to get WooCommerce info for a given user
 - The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
@@ -208,6 +234,6 @@ For help getting started with WooSignal, view our
 To use this plugin, add `wp_json_api` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
 
 ## Note
-Install WordPress plugin "WP JSON API" 3.0.x or later for version 2.0.0+
+Install WordPress plugin "WP JSON API" 3.1.x from [woosignal](https://woosignal.com/plugins/wordpress/wp-json-api) to use this flutter plugin `wp_json_api` (3.1.0).
 
 Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.

lib/enums/wp_route_type.dart

@@ -14,23 +14,31 @@
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
 enum WPRouteType {
-  /// Route type [WPRouteType.UserUpdatePassword] is used to update a WordPress users password.
+  /// Route type [WPRouteType.UserUpdatePassword] is used to update a WordPress user's password.
   /// For WordPress
   UserUpdatePassword,
 
-  /// Route type [WPRouteType.UserUpdateInfo] is used to update a WordPress users account info.
+  /// Route type [WPRouteType.UserUpdateInfo] is used to update a WordPress user's account info.
   /// For WordPress
   UserUpdateInfo,
 
-  /// Route type [WPRouteType.UserInfo] is used to return a WordPress users info.
+  /// Route type [WPRouteType.UserAddRole] is used to add a role to a WordPress user's account.
+  /// For WordPress
+  UserAddRole,
+
+  /// Route type [WPRouteType.UserRemoveRole] is used to remove a role to a WordPress user's account.
+  /// For WordPress
+  UserRemoveRole,
+
+  /// Route type [WPRouteType.UserInfo] is used to return a WordPress user's info.
   /// For WordPress
   UserInfo,
 
-  /// Route type [WPRouteType.UserRegister] is used to Register a user on WordPress.
+  /// Route type [WPRouteType.UserRegister] is used to Register a user's on WordPress.
   /// For WordPress
   UserRegister,
 
-  /// Route type [WPRouteType.UserLogin] is used to Login a user on WordPress.
+  /// Route type [WPRouteType.UserLogin] is used to Login a user's on WordPress.
   /// For WordPress
   UserLogin,
 
@@ -42,7 +50,7 @@ enum WPRouteType {
   /// For WordPress
   AuthVerify,
 
-  /// Route type [WPRouteType.WCCustomerInfo] is used to get a Customers info.
+  /// Route type [WPRouteType.WCCustomerInfo] is used to get a Customer's info.
   /// For WooCommerce
   WCCustomerInfo,
 

lib/models/responses/wp_user_add_role_response.dart

@@ -0,0 +1,40 @@
+// Copyright (c) 2021, 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.
+
+class WPUserAddRoleResponse {
+  List<dynamic>? data;
+  String? message;
+  int? status;
+
+  WPUserAddRoleResponse({this.data, this.message, this.status});
+
+  WPUserAddRoleResponse.fromJson(Map<String, dynamic> json) {
+    if (json['data'] != null) {
+      data = json['data'];
+    }
+    message = json['message'];
+    status = json['status'];
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    if (this.data != null) {
+      data['data'] = this.data!.map((v) => v.toJson()).toList();
+    }
+    data['message'] = this.message;
+    data['status'] = this.status;
+    return data;
+  }
+}

lib/models/responses/wp_user_remove_role_response.dart

@@ -0,0 +1,40 @@
+// Copyright (c) 2021, 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.
+
+class WPUserRemoveRoleResponse {
+  List<dynamic>? data;
+  String? message;
+  int? status;
+
+  WPUserRemoveRoleResponse({this.data, this.message, this.status});
+
+  WPUserRemoveRoleResponse.fromJson(Map<String, dynamic> json) {
+    if (json['data'] != null) {
+      data = json['data'];
+    }
+    message = json['message'];
+    status = json['status'];
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    if (this.data != null) {
+      data['data'] = this.data!.map((v) => v.toJson()).toList();
+    }
+    data['message'] = this.message;
+    data['status'] = this.status;
+    return data;
+  }
+}

lib/networking/network_manager.dart

@@ -34,9 +34,11 @@ import 'package:wp_json_api/models/responses/wc_customer_info_response.dart';
 import 'package:wp_json_api/models/responses/wc_customer_updated_response.dart';
 import 'package:wp_json_api/models/responses/wp_nonce_response.dart';
 import 'package:wp_json_api/models/responses/wp_nonce_verified_response.dart';
+import 'package:wp_json_api/models/responses/wp_user_add_role_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_info_updated_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_login_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_register_response.dart';
+import 'package:wp_json_api/models/responses/wp_user_remove_role_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_reset_password_response.dart';
 import 'package:wp_json_api/models/wp_meta_meta.dart';
 import 'package:wp_json_api/wp_json_api.dart';
@@ -235,6 +237,52 @@ class WPAppNetworkManager {
         : WPUserInfoUpdatedResponse.fromJson(json);
   }
 
+  /// Sends a request to add a role to a WordPress user. Include a valid
+  /// [userToken] and [role] to send a successful request.
+  ///
+  /// Returns a [WPUserInfoUpdatedResponse] future.
+  /// Throws an [Exception] if fails.
+  Future<WPUserAddRoleResponse> wpUserAddRole(userToken, {required String role}) async {
+    Map<String, dynamic> payload = {};
+    payload["role"] = role;
+
+    // send http request
+    final json = await _http(
+      method: "POST",
+      url: _urlForRouteType(WPRouteType.UserAddRole),
+      userToken: userToken,
+      body: payload,
+    );
+
+    // return response
+    return _jsonHasBadStatus(json)
+        ? this._throwExceptionForStatusCode(json)
+        : WPUserAddRoleResponse.fromJson(json);
+  }
+
+  /// Sends a request to remove a role from a WordPress user. Include a valid
+  /// [userToken] and [role] to send a successful request.
+  ///
+  /// Returns a [WPUserInfoUpdatedResponse] future.
+  /// Throws an [Exception] if fails.
+  Future<WPUserRemoveRoleResponse> wpUserRemoveRole(userToken, {required String role}) async {
+    Map<String, dynamic> payload = {};
+    payload["role"] = role;
+
+    // send http request
+    final json = await _http(
+      method: "POST",
+      url: _urlForRouteType(WPRouteType.UserRemoveRole),
+      userToken: userToken,
+      body: payload,
+    );
+
+    // return response
+    return _jsonHasBadStatus(json)
+        ? this._throwExceptionForStatusCode(json)
+        : WPUserRemoveRoleResponse.fromJson(json);
+  }
+
   /// Reset a user password using the [userToken] and new [password] created.
   ///
   /// Returns a [WCCustomerInfoResponse] future.
@@ -464,7 +512,7 @@ class WPAppNetworkManager {
   /// Returns [String] url path for request.
   String _getRouteUrlForType(
     WPRouteType wpRouteType, {
-    String apiVersion = 'v2',
+    String apiVersion = 'v3',
   }) {
     switch (wpRouteType) {
       // AUTH API
@@ -493,6 +541,14 @@ class WPAppNetworkManager {
         {
           return "/wpapp/api/$apiVersion/update/user/info";
         }
+        case WPRouteType.UserAddRole:
+        {
+          return "/wpapp/api/$apiVersion/update/user/role/add";
+        }
+        case WPRouteType.UserRemoveRole:
+        {
+          return "/wpapp/api/$apiVersion/update/user/role/remove";
+        }
       case WPRouteType.UserUpdatePassword:
         {
           return "/wpapp/api/$apiVersion/update/user/password";

pubspec.lock

@@ -7,7 +7,7 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.5.0"
+    version: "2.6.1"
   boolean_selector:
     dependency: transitive
     description:
@@ -66,7 +66,7 @@ packages:
       name: http
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.13.1"
+    version: "0.13.3"
   http_parser:
     dependency: transitive
     description:
@@ -113,7 +113,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   stack_trace:
     dependency: transitive
     description:
@@ -148,7 +148,7 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.2.19"
+    version: "0.3.0"
   typed_data:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: wp_json_api
 description: WordPress and WooCommerce JSON API for Flutter Mobile. API allows you to login, register new users, get users info and more.
-version: 3.0.0
+version: 3.1.0
 homepage: https://woosignal.com
 repository: https://github.com/woosignal/wp-json-api-flutter
 issue_tracker: https://github.com/woosignal/wp-json-api-flutter/issues
@@ -10,7 +10,7 @@ environment:
   sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
-  http: ^0.13.1
+  http: ^0.13.3
   flutter:
     sdk: flutter
   collection: ^1.15.0