Merge pull request #1 from rainxh11/main

rainxh11 · web-flow · commit b76a669a6ea2 · 2022-07-13T15:44:50.000+01:00
+Moved to main repo
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,29 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, CHAKHOUM AHMED
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,16 +1,47 @@
+<img src="https://raw.githubusercontent.com/rainxh11/chargily-epay-flutter/master/assets/chargily_flutter.svg" heigh="300">
+
 # chargily-epay-flutter
 Flutter Package for Chargily ePay Gateway
 
-
 ![Chargily ePay Gateway](https://raw.githubusercontent.com/Chargily/epay-gateway-php/main/assets/banner-1544x500.png "Chargily ePay Gateway")
 
 This Plugin is to integrate ePayment gateway with Chargily easily.
 - Currently support payment by **CIB / EDAHABIA** cards and soon by **Visa / Mastercard** 
 - This repo is recently created for **Flutter Package**, If you are a developer and want to collaborate to the development of this package, you are welcomed!
 
-# Contribution tips
-1. Make a fork of this repo.
-2. Take a tour to our [API documentation here](https://dev.chargily.com/docs/#/epay_integration_via_api)
-3. Get your API Key/Secret from [ePay by Chargily](https://epay.chargily.com.dz) dashboard for free.
-4. Start developing.
-5. Finished? Push and merge.
+# Installation:
+Edit `pubspec.yaml` file to include [`chargily_flutter`](https://pub.dev/packages/chargily_flutter) package:
+```yaml
+dependencies:
+  flutter:
+    sdk: flutter
+  chargily_flutter: any # <-- Add this
+```
+then run the command:
+```powershell
+flutter pub get
+# or
+dart pub get
+```
+
+# Usage:
+```dart
+import 'package:chargily_flutter/chargily.dart'
+
+void main(List<String> args) async {
+    final chargilyClient = Chargily('[API_KEY]');
+
+    final invoice = Invoice(
+        client: 'ahmed',
+        clientEmail: 'rainxh11@gmail.com',
+        amount: 1500,
+        discount: 20.0,
+        webhookUrl: 'http://webhookurl.com/',
+        backUrl: 'http://backurl.com/',
+        comment: 'Purchace',
+        mode: PaymentMethod.CIB,
+        invoiceNumber: '12345');
+
+    final response = await chargilyClient.createPayment(invoice);
+}
+```
diff --git a/assets/chargily_flutter.svg b/assets/chargily_flutter.svg
diff --git a/chargily_flutter/.gitignore b/chargily_flutter/.gitignore
@@ -0,0 +1,29 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+# Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/
diff --git a/chargily_flutter/.metadata b/chargily_flutter/.metadata
@@ -0,0 +1,10 @@
+# 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.
+
+version:
+  revision: 5464c5bac742001448fe4fc0597be939379f88ea
+  channel: stable
+
+project_type: package
diff --git a/chargily_flutter/CHANGELOG.md b/chargily_flutter/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.
diff --git a/chargily_flutter/LICENSE b/chargily_flutter/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present, CHAKHOUM AHMED
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/chargily_flutter/README.md b/chargily_flutter/README.md
@@ -0,0 +1,45 @@
+# chargily-epay-flutter
+Flutter Package for Chargily ePay Gateway
+
+![Chargily ePay Gateway](https://raw.githubusercontent.com/Chargily/epay-gateway-php/main/assets/banner-1544x500.png "Chargily ePay Gateway")
+
+This Plugin is to integrate ePayment gateway with Chargily easily.
+- Currently support payment by **CIB / EDAHABIA** cards and soon by **Visa / Mastercard** 
+- This repo is recently created for **Flutter Package**, If you are a developer and want to collaborate to the development of this package, you are welcomed!
+
+# Installation:
+Edit `pubspec.yaml` file to include [`chargily_flutter`](https://pub.dev/packages/chargily_flutter) package:
+```yaml
+dependencies:
+  flutter:
+    sdk: flutter
+  chargily_flutter: any # <-- Add this
+```
+then run the command:
+```powershell
+flutter pub get
+# or
+dart pub get
+```
+
+# Usage:
+```dart
+import 'package:chargily_flutter/chargily.dart'
+
+void main(List<String> args) async {
+    final chargilyClient = Chargily('[API_KEY]');
+
+    final invoice = Invoice(
+        client: 'ahmed',
+        clientEmail: 'rainxh11@gmail.com',
+        amount: 1500,
+        discount: 20.0,
+        webhookUrl: 'http://webhookurl.com/',
+        backUrl: 'http://backurl.com/',
+        comment: 'Purchace',
+        mode: PaymentMethod.CIB,
+        invoiceNumber: '12345');
+
+    final response = await chargilyClient.createPayment(invoice);
+}
+```
diff --git a/chargily_flutter/analysis_options.yaml b/chargily_flutter/analysis_options.yaml
@@ -0,0 +1,4 @@
+include: package:flutter_lints/flutter.yaml
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/chargily_flutter/lib/chargily.dart b/chargily_flutter/lib/chargily.dart
@@ -0,0 +1,31 @@
+library chargily_flutter;
+
+import 'package:chargily_flutter/validations.dart';
+import 'package:dio/dio.dart';
+import 'package:logger/logger.dart';
+
+import 'chargily_api.dart';
+
+class Chargily {
+  final String apiKey;
+  ChargilyApiClient? apiClient = ChargilyApiClient(Dio());
+  final Logger? logger;
+
+  /// Chargily Payment Gateway Client
+  ///
+  /// Get `apiKey` from https://epay.chargily.com.dz/secure/admin/epay-api
+  Chargily(this.apiKey, {this.logger, this.apiClient});
+
+  /// Create Payment from `invoice`
+  Future<PaymentResponse> createPayment(Invoice invoice) async {
+    final validator = InvoiceValidator();
+
+    final validations = validator.validate(invoice);
+    if (validations.hasError) {
+      logger?.e(validations.errors);
+      return PaymentResponse(false, validations.errors);
+    }
+    final response = await apiClient?.createInvoice(apiKey, invoice);
+    return PaymentResponse(true, response);
+  }
+}
diff --git a/chargily_flutter/lib/chargily_api.dart b/chargily_flutter/lib/chargily_api.dart
@@ -0,0 +1,68 @@
+import 'package:retrofit/retrofit.dart';
+import 'package:json_annotation/json_annotation.dart';
+import 'package:dio/dio.dart' hide Headers;
+
+part 'chargily_api.g.dart';
+
+@RestApi(baseUrl: "https://epay.chargily.com.dz")
+abstract class ChargilyApiClient {
+  factory ChargilyApiClient(Dio dio, {String baseUrl}) = _ChargilyApiClient;
+
+  @Headers(<String, dynamic>{"Accept": "application/json"})
+  @POST("/api/invoice")
+  Future<ChargilyResponse> createInvoice(
+      @Header("X-Authorization") apiKey, Invoice invoice);
+}
+
+@JsonSerializable()
+class Invoice {
+  String? client;
+  @JsonKey(name: "client_email")
+  String? clientEmail;
+  @JsonKey(name: "invoice_number")
+  String? invoiceNumber;
+  double? discount;
+  double? amount;
+  @JsonKey(name: "back_url")
+  String? backUrl;
+  @JsonKey(name: "webhook_url")
+  String? webhookUrl;
+  PaymentMethod? mode;
+  String? comment;
+
+  Invoice(
+      {this.client,
+      this.clientEmail,
+      this.amount,
+      this.discount,
+      this.backUrl,
+      this.webhookUrl,
+      this.mode,
+      this.invoiceNumber,
+      this.comment});
+
+  factory Invoice.fromJson(Map<String, dynamic> json) =>
+      _$InvoiceFromJson(json);
+  Map<String, dynamic> toJson() => _$InvoiceToJson(this);
+}
+
+@JsonSerializable()
+class ChargilyResponse {
+  @JsonKey(name: "checkout_url")
+  String? checkoutUrl;
+}
+
+@JsonSerializable()
+class PaymentResponse {
+  bool isSuccessful = false;
+  dynamic body;
+
+  PaymentResponse(this.isSuccessful, this.body);
+}
+
+enum PaymentMethod {
+  @JsonValue('EDAHABIA')
+  EDAHABIA,
+  @JsonValue('CIB')
+  CIB
+}
diff --git a/chargily_flutter/lib/chargily_api.g.dart b/chargily_flutter/lib/chargily_api.g.dart
diff --git a/chargily_flutter/lib/validations.dart b/chargily_flutter/lib/validations.dart
diff --git a/chargily_flutter/pubspec.yaml b/chargily_flutter/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## 0.0.1`
	`2`	`+`
	`3`	`+* TODO: Describe initial release.`