Merge pull request #4 from VhiktorBrown/cancel-payment-feat

implemented payment cancellation. Clicking on the 'Cancel Payment' on the Paystack payment page now closes the Payment webview.

Author: VhiktorBrown

.flutter-plugins-dependencies

@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"webview_flutter_wkwebview","path":"/Users/user/.pub-cache/hosted/pub.dev/webview_flutter_wkwebview-3.14.0/","native_build":true,"dependencies":[]}],"android":[{"name":"webview_flutter_android","path":"/Users/user/.pub-cache/hosted/pub.dev/webview_flutter_android-3.16.3/","native_build":true,"dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[]},"dependencyGraph":[{"name":"webview_flutter","dependencies":["webview_flutter_android","webview_flutter_wkwebview"]},{"name":"webview_flutter_android","dependencies":[]},{"name":"webview_flutter_wkwebview","dependencies":[]}],"date_created":"2024-09-22 06:48:17.163407","version":"3.21.0-1.0.pre.6"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"webview_flutter_wkwebview","path":"/Users/user/.pub-cache/hosted/pub.dev/webview_flutter_wkwebview-3.14.0/","native_build":true,"dependencies":[]}],"android":[{"name":"webview_flutter_android","path":"/Users/user/.pub-cache/hosted/pub.dev/webview_flutter_android-3.16.3/","native_build":true,"dependencies":[]}],"macos":[],"linux":[],"windows":[],"web":[]},"dependencyGraph":[{"name":"webview_flutter","dependencies":["webview_flutter_android","webview_flutter_wkwebview"]},{"name":"webview_flutter_android","dependencies":[]},{"name":"webview_flutter_wkwebview","dependencies":[]}],"date_created":"2024-09-23 01:23:01.343186","version":"3.21.0-1.0.pre.6"}

CHANGELOG.md

@@ -5,4 +5,9 @@
 
 ## 1.0.1
 
-* Fixed GIF and screenshots not showing in README.md
+* Fixed GIF and screenshots not showing in README.md
+
+## 1.0.2
+
+* Fixed `showProgressBar` argument not being used in implementation. Now, whatever value you set is used.
+* Clicking on `Cancel Payment` on Paystack payment page now cancels the payment and closes the page, calling the onCancelled callback.

README.md

@@ -17,6 +17,11 @@ The Flutter package that makes it super easy to integrate Paystack's payment gat
 |:------------------------------------------------------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------:|
 | <img src="https://raw.githubusercontent.com/VhiktorBrown/paystack_flutter/master/screenshots/pay_with_bank.png" height="400" width="200"/> | <img src="https://raw.githubusercontent.com/VhiktorBrown/paystack_flutter/master/screenshots/payment_success.png" height="400" width="200"/> |
 
+## Significant Changes:
+* Fixed `showProgressBar` argument not being used in implementation. Now, whatever value you set is used.
+* Clicking on `Cancel Payment` on Paystack payment page now cancels the payment and closes the page, calling the onCancelled callback.
+
+
 ## :dart: Add dependency to pubspec.yaml:
 ``` dart
 dependencies:

example/lib/main.dart

@@ -42,7 +42,7 @@ class _MyHomePageState extends State<MyHomePage> {
                 PaystackFlutter().pay(
                   context: context,
                   secretKey:
-                      'YOUR PAYSTACK_SECRET_KEY', // Your Paystack secret key.
+                      'YOUR_PAYSTACK_SECRET_KEY', // Your Paystack secret key.
                   amount:
                       60000, // The amount to be charged in the smallest currency unit. If amount is 600, multiply by 100(600*100)
                   email:

lib/src/models/paystack_request.dart

@@ -59,7 +59,7 @@ class PaystackRequest {
 
   /// Any additional metadata you want to associate with the transaction.
   /// This can be a map of key-value pairs (optional).
-  final dynamic metaData;
+  dynamic metaData;
 
   /// Creates a new PaystackRequest object.
   ///
@@ -87,8 +87,22 @@ class PaystackRequest {
     this.currency,
   });
 
+  /// Updates or adds the provided key-value pair to the `metadata`.
+  /// Ensures `metaData` is a Map before adding the data.
+  void updateMetadata(String key, String value) {
+    if (metaData == null) {
+      metaData = {}; // Initialize as an empty Map if not already set
+    } else if (metaData is! Map) {
+      throw ArgumentError('metaData must be a Map');
+    }
+    metaData[key] = value;
+  }
+
   /// Converts the PaystackRequest object to a JSON map suitable for sending to the Paystack API.
   Map<String, dynamic> toJson() {
+    // Call updateMetadata to ensure the "cancel_action" key-value pair is added
+    updateMetadata("cancel_action", "https://github.com/VhiktorBrown/paystack_flutter");
+
     final Map<String, dynamic> baseJson = {
       "amount": amount,
       "email": email,

lib/src/paystack_flutter.dart

@@ -97,7 +97,7 @@ class PaystackFlutter {
           email: email,
           amount: amount,
           reference: reference,
-          showProgressBar: false,
+          showProgressBar: showProgressBar,
           confirmTransaction: confirmTransaction,
           paymentOptions: paymentOptions,
           currency: currency,

lib/src/paystack_webview.dart

@@ -191,6 +191,13 @@ class _PaystackWebviewState extends State<PaystackWebview> {
                       return NavigationDecision.navigate;
                     }
 
+                    //check if Paystack redirects to cancel_url
+                    if(uri.toString() == "https://github.com/VhiktorBrown/paystack_flutter"){
+                      Navigator.pop(context);
+                      //this means the user cancelled payment.
+                      widget.onCancelled(callback);
+                    }
+
                     //check if user is redirected to https://standard.paystack.co/close
                     if (uri
                         .toString()

pubspec.yaml

@@ -1,5 +1,5 @@
 name: paystack_for_flutter
-description: The paystack_flutter package helps you collect payment in your app with just few lines of code. Offers many payment options.
+description: The Flutter package that makes it super easy to integrate Paystack's payment gateway into your app with just few lines of code.
 version: 1.0.1
 homepage: https://github.com/VhiktorBrown/paystack_flutter
 documentation: https://github.com/VhiktorBrown/paystack_flutter/blob/master/README.md