Merge pull request #16 from Flutterwave/release/1.0.4

Release/1.0.4

Author: FredDominant

CHANGELOG.md

@@ -1,9 +1,16 @@
-## [1.0.0] - September 9, 2021.
-* Initial release
+## [1.0.4] - July 4, 2022
+* Renamed property `isDebug` to `isTestMode`
+* Made property `redirectUrl` required
+* Updated README file
+
+## [1.0.3] - October 4, 2021.
+* Fixed issue with webview
 
+## [1.0.2] - September 23, 2021.
+* Fixed bug where cancel payment buttons are not clickable on iOS devices.
 
 ## [1.0.1] - September 14, 2021.
-* Fix bug where response is not returned to initiating screen when user cancels transaction.
+* Fixed bug where response is not returned to initiating screen when user cancels transaction.
 
-## [1.0.2] - September 23, 2021.
-* Fix bug where cancel payment buttons are not clickable on iOS devices.
+## [1.0.0] - September 9, 2021.
+* Initial release

README.md

@@ -1,132 +1,149 @@
-<p align="center">
-    <img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo/full.svg" width="50%"/>
-</p>
 
-# Flutterwave Flutter(Standard) SDK
+<p align="center">  
+   <img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo-colored.svg" width="50%"/>  
+</p>  
 
-The Flutter library helps you create seamless payment experiences in your dart mobile app. By connecting to our modal, you can start collecting payment in no time.
+# Flutterwave Flutter Standard SDK
 
-Available features include:
+## Table of Contents
 
-- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter.
-- Recurring payments: Tokenization and Subscriptions.
-- Split payments
+- [About](#about)
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+- [Deployment](#deployment)
+- [Built Using](#build-tools)
+- [References](#references)
+- [Support](#support)
 
-## Table of Contents
+<a id="about"></a>
+## About
+Flutterwave's Flutter SDK is Flutterwave's offical flutter sdk to integrate Flutterwave's [Standard](https://developer.flutterwave.com/docs/flutterwave-standard) payment into your flutter app. It comes with a ready made Drop In UI.
+
+
+
+<a id="getting-started"></a>
 
-1. [Requirements](#requirements)
-2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Support](#support)
-5. [Contribution guidelines](#contribution-guidelines)
-6. [License](#license)
+## Getting Started
 
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.  
+See [references](#references) for links to dashboard and API documentation.
 
 ## Requirements
+- Ensure you have your test (and live) [API keys](https://developer.flutterwave.com/docs/api-keys).   
+  ``` Flutter version >= 1.17.0 Flutterwave version 3 API keys ```
 
-1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
-2. Supported Flutter version >= 1.17.0
+## Installation Add the dependency
 
-## Installation
+In your `pubspec.yaml` file add:
 
-1. Add the dependency to your project. In your `pubspec.yaml` file add: `flutterwave_standard: 1.0.2`
-2. Run `flutter pub get`
+1. `flutterwave_standard: ^1.0.4`
+2. run `flutter pub get`  
+   <a id="usage"></a>
 
 ## Usage
 
-### Initializing a Flutterwave instance
-
-To create an instance, you should call the Flutterwave constructor. This constructor accepts a mandatory instance of the following:
-
-- The calling `Context`
--  `publicKey`
--  `Customer`
--  `amount`
--  `currency`
--  `email`
--  `fullName`
--  `txRef`
--  `isTestMode`
--  `paymentOptions`
--  `Customization` 
-
-It returns an instance of Flutterwave which we then call the async method `.charge()` on.
-
-```dart
-_handlePaymentInitialization() async {
-        final style = FlutterwaveStyle(
-            appBarText: "My Standard Blue",
-            buttonColor: Color(0xffd0ebff),
-            appBarIcon: Icon(Icons.message, color: Color(0xffd0ebff)),
-            buttonTextStyle: TextStyle(
-              color: Colors.black,
-              fontWeight: FontWeight.bold,
-              fontSize: 18,
-            ),
-          appBarColor: Color(0xffd0ebff),
-          dialogCancelTextStyle: TextStyle(
-            color: Colors.redAccent,
-            fontSize: 18,
-          ),
-          dialogContinueTextStyle: TextStyle(
-            color: Colors.blue,
-            fontSize: 18,
-          )
-        );
-        final Customer customer = Customer(
-                name: "FLW Developer",
-                phoneNumber: "1234566677777",
-                email: "[email protected]");
-
-        final Flutterwave flutterwave = Flutterwave(
-            context: context,
-            style: style,
-            publicKey: "Public Key,
-            currency: "RWF",
-            txRef: "unique_transaction_reference",
-            amount: "3000",
-            customer: customer,
-            paymentOptions: "ussd, card, barter, payattitude",
-            customization: Customization(title: "Test Payment"),
-            isTestMode: true);
-      }
-```
-
-
-### Handling the response
-
-Calling the `.charge()` method returns a Future of `ChargeResponse` which we await for the actual response as seen above.
- 
- ```dart
- final ChargeResponse response = await flutterwave.charge();
- if (response != null) {
-   print(response.toJson());
-   if(response.success) {
-     Call the verify transaction endpoint with the transactionID returned in `response.transactionId` to verify transaction before offering value to customer
-   } else {
-    // Transaction not successful
-   }
- } else {
-   // User cancelled
- }
-```
-
-#### Note:
- 1. `ChargeResponse` can be null if a user cancels the transaction by pressing back.
- 2. You need to confirm the transaction is succesful. Ensure that the txRef, amount, and status are correct and successful. Be sure to [verify the transaction details](https://developer.flutterwave.com/docs/verifications/transaction) before providing value.
-
-# Support
-
-For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg). 
-
-You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
-
-# Contribution guidelines
-
-Read more about our community contribution guidelines [here](/CONTRIBUTING.md).
-
-# License
-
-By contributing to the Flutter library, you agree that your contributions will be licensed under its [MIT license](/LICENSE).
-
-Copyright (c) Flutterwave Inc.
+Create a `Flutterwave` instance by calling the constructor `Flutterwave` The constructor accepts a mandatory instance of the following:  
+the calling `Context` , `publicKey`, `Customer`, `amount`, `currency`, `email`, `fullName`, `txRef`, `isDebug`, `paymentOptions`, and `Customization` . It returns an instance of `Flutterwave` which we then call the `async` method `.charge()` on.
+
+    _handlePaymentInitialization() async { 
+    final style = FlutterwaveStyle(
+     appBarText: "My Standard Blue", 
+     buttonColor: Color(0xffd0ebff), 
+     appBarIcon: Icon(Icons.message, color: Color(0xffd0ebff)),
+     buttonTextStyle: TextStyle( 
+	     color: Colors.black, 
+	     fontWeight: FontWeight.bold, 
+	     fontSize: 18), 
+    appBarColor: Color(0xffd0ebff), 
+    dialogCancelTextStyle: TextStyle(
+	    color: Colors.redAccent, 
+	    fontSize: 18
+	    ),
+    dialogContinueTextStyle: TextStyle(
+		    color: Colors.blue, 
+		    fontSize: 18
+		    ) 
+		  ); 
+
+    final Customer customer = Customer(
+		    name: "FLW Developer", 
+		    phoneNumber: "1234566677777", 
+		    email: "[email protected]"
+		    );  
+		    
+    final Flutterwave flutterwave = Flutterwave(
+		    context: context, 
+		    style: style, 
+		    publicKey: "Public Key, 
+		    currency: "RWF", 
+		    redirectUrl: "my_redirect_url" 
+		    txRef: "unique_transaction_reference", 
+		    amount: "3000", 
+		    customer: customer, 
+		    paymentOptions: "ussd, card, barter, payattitude", 
+		    customization: Customization(title: "Test Payment"),
+		    isDebug: true
+		    ); 
+		} 
+
+### 2. Handle the response
+
+Calling the `.charge()` method returns a `Future`  
+of `ChargeResponse` which we await for the actual response as seen above.
+
+
+
+     final ChargeResponse response = await flutterwave.charge(); 
+     if (response != null) { 
+	     print(response.toJson()); 
+		 if(response.success) { 
+		 Call the verify transaction endpoint with the transactionID returned in `response.transactionId` to verify transaction before offering value to customer 
+		 } else { 
+		  // Transaction not successful 
+		} 
+	 } else {
+	  // User cancelled 
+	 }
+
+#### Please note that:
+- `ChargeResponse` can be null, depending on if the user cancels  
+  the transaction by pressing back.
+- You need to check the status of the transaction from the instance of `ChargeResponse` returned from calling `.charge()`, the `status`, `success` and `txRef` are successful and correct before providing value to the customer
+
+>  **PLEASE NOTE**
+
+> We advise you to do a further verification of transaction's details on your server to be sure everything checks out before providing service.  
+<a id="deployment"></a>
+
+
+##Testing
+`pub run test`
+
+## Debugging Errors
+We understand that you may run into some errors while integrating our library. You can read more about our error messages [here](https://developer.flutterwave.com/docs/integration-guides/errors).
+
+For `authorization` and `validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support.
+
+<a id="support"></a>
+## Support For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
+
+You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊
+
+## Contribution guidelines
+Read more about our community contribution guidelines [here](https://www.notion.so/flutterwavego/Community-contribution-guide-ca1d8a876ba04d45ab4b663c758ae42a).
+
+## License
+By contributing to the Flutter library, you agree that your contributions will be licensed under its [MIT license](https://opensource.org/licenses/MIT).
+
+## Built Using
+- [flutter](https://flutter.dev/)
+- [http](https://pub.dev/packages/http)
+- [flutter_inappwebview](https://pub.dev/packages/flutter_inappwebview)
+- [fluttertoast](https://pub.dev/packages/fluttertoast)
+
+<a id="references"></a>
+## Flutterwave API  References
+
+- [Flutterwave API Doc](https://developer.flutterwave.com/docs)
+- [Flutterwave Inline Payment Doc](https://developer.flutterwave.com/docs/flutterwave-inline)
+- [Flutterwave Dashboard](https://dashboard.flutterwave.com/login)

example/.metadata

@@ -1,10 +1,30 @@
 # This file tracks properties of this Flutter project.
 # Used by Flutter tool to assess capabilities and perform upgrades etc.
 #
-# This file should be version controlled and should not be manually edited.
+# This file should be version controlled.
 
 version:
-  revision: fba99f6cf9a14512e461e3122c8ddfaa25394e89
+  revision: 85684f9300908116a78138ea4c6036c35c9a1236
   channel: stable
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+      base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+    - platform: android
+      create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+      base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'

example/analysis_options.yaml

@@ -0,0 +1,29 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at
+  # https://dart-lang.github.io/linter/lints/index.html.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options

example/android/.gitignore

@@ -9,3 +9,5 @@ GeneratedPluginRegistrant.java
 # Remember to never publicly share your keystore.
 # See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
 key.properties
+**/*.keystore
+**/*.jks

example/android/app/build.gradle

@@ -26,21 +26,29 @@ apply plugin: 'kotlin-android'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion flutter.compileSdkVersion
+    ndkVersion flutter.ndkVersion
 
-    sourceSets {
-        main.java.srcDirs += 'src/main/kotlin'
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
     }
 
-    lintOptions {
-        disable 'InvalidPackage'
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
     }
 
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
-        applicationId "com.example.flutterwave_beta"
-        minSdkVersion 19
-        targetSdkVersion 28
+        applicationId "com.example.example"
+        // You can update the following values to match your application needs.
+        // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration.
+        minSdkVersion 17
+        targetSdkVersion flutter.targetSdkVersion
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }