Initial Commit

Author: bernard-ng

.github/ISSUE_TEMPLATES/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATES/custom.md

@@ -0,0 +1,8 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---

.github/ISSUE_TEMPLATES/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/lint.yaml

@@ -0,0 +1,21 @@
+name: Lint
+on: [push]
+jobs:
+  lint:
+    name: PHP Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: /tmp/composer-cache
+          key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
+
+      - uses: actions/checkout@master
+      - name: lint
+        run: make lint

.gitignore

@@ -0,0 +1 @@
+/vendor/

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Devscast]
+
+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.

Makefile

@@ -0,0 +1,16 @@
+.PHONY: help
+help: ## affiche cet aide
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: lint
+lint: vendor/autoload.php ## affiche les erreurs de formatage de code
+	php vendor/bin/ecs
+	php vendor/bin/phpstan
+
+.PHONY: lint-fix
+lint-fix: vendor/autoload.php ## corrige les erreurs de formatage de code
+	php vendor/bin/ecs --fix
+
+vendor/autoload.php: composer.lock # installe les dépendances PHP
+	composer update
+	composer dump-autoload

README.md

@@ -0,0 +1,71 @@
+# Maxicash PHP
+
+![Lint](https://github.com/devscast/maxicash/actions/workflows/lint.yaml/badge.svg)
+[![Latest Stable Version](https://poser.pugx.org/devscast/maxicash/version)](https://packagist.org/packages/devscast/maxicash)
+[![Total Downloads](https://poser.pugx.org/devscast/maxicash/downloads)](https://packagist.org/packages/devscast/maxicash)
+[![License](https://poser.pugx.org/devscast/maxicash/license)](https://packagist.org/packages/devscast/maxicash)
+
+
+The MaxiCash Integration Platform enables Merchants to integrate with the MaxiCash platform in order to receive payments through their mobile apps or their websites. The API uses JSON to interact with .Net client or open source platforms like PHP. see more at [Maxicash Documentation](https://developer.maxicashapp.com/Default)
+
+## Installation
+You can use the PHP client by installing the Composer package and adding it to your application’s dependencies:
+
+```bash
+composer require devscast/maxicash
+```
+## Usage 
+The MaxiCash Gateway enables the Merchant to Collect Payment into their MaxiCash account using multiple payment channels such as Credit Cards, MaxiCash, Paypal, Mobile Money and Mobile Banking.
+
+### Authentication
+* **Step 1**. Download the MaxiCash Mobile App and signup...
+* **Step 2**. Contact us to upgrade your account to a Merchant Account info@maxicashapp.com
+You will receive a Merchant Form to complete in order to provide your business details and preffered Cashout Wallet or Banking Details.
+* **Step 3**. Once the paperwork is completed, you will be issued with Live and Sandbox Accounts (MerchantID and MerchantPassword)
+
+
+```php
+use Devscast\Maxicash\Client as Maxicash;
+use Devscast\Maxicash\Credential;
+use Devscast\Maxicash\PaymentEntry;
+use Devscast\Maxicash\Environment;
+
+$maxicash = new Maxicash(
+    credential: new Credential('marchand_id', 'marchand_password'),
+    environment: Environment::SANDBOX // use `Environment::LIVE` for live
+);
+```
+
+### Create a Payment Entry
+```php
+$entry = new PaymentEntry(
+    credential: $maxicash->credential,
+    amount: intval(47.50 * 100), // amount in cents
+    reference: "this text will be shown on maxicash payment page",
+    acceptUrl: "your_website_accept_url",
+    declineUrl: "your_website_decline_url",
+);
+```
+> **Note**: we hightly recommand your `accept` and `decline` urls to be unique for each transaction, thus users will not be able to reuse them to validate other transactions, on your side save the transaction with a unique generated token (a.k.a transaction reference) and use it as parameter to your accept and decline urls, don't use it for the `PaymentEntry->reference`; once the user is redirected to your accept url, validate the token and grant access to the paid resource (with your own business logic). 
+
+
+### Redirect to Maxicash Gateway
+Redirect your user to the maxicash gateway to continue the payment process
+
+```php
+$url = $maxicash->queryStringURLPayment($entry);
+```
+> **Note** : we highly recommand to do a `server side` redirection, this url can be modified and leak your maxicash credentials when displayed to your user in any manner (eg: a link, button or form) ! you can use the `header("Location: $url")` fonction in vanilla PHP or return a `RedirectResponse($url)` in your controller when using Symfony or Laravel frameworks`
+
+### Donate Button for NGOs
+Once you signup as an NGO Merchant
+
+```php
+$donationUrl = $maxicash->donationUrl()
+```
+
+## Features supported
+- [x] QueryString URL Payment
+- [x] Donate Button for NGOs
+- [ ] Form Post Payment
+- [ ] Pay Entry Web

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "devscast/maxicash",
+    "description": "The MaxiCash integration platform enables merchants to integrate with the MaxiCash platform to receive payments via their mobile applications or websites. The API uses JSON to interact with .Net or open source platforms such as PHP.",
+    "keywords": [
+        "maxicash",
+        "mobile money",
+        "payment gateway",
+        "api"
+    ],
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Devscast\\Maxicash\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "bernard-ng",
+            "email": "ngandubernard@gmail.com"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require-dev": {
+        "phpstan/phpstan": "^1.10",
+        "symplify/easy-coding-standard": "^12.0"
+    },
+    "require": {
+        "php": ">=8.2",
+        "webmozart/assert": "^1.11"
+    },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/devscast/maxicash"
+        }
+    ]
+}