diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..cd8eb86 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..bb6265e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.gitattributes export-ignore +/.gitignore export-ignore +/.travis.yml export-ignore +/phpunit.xml.dist export-ignore +/.scrutinizer.yml export-ignore +/tests export-ignore +/.editorconfig export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..808f8c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +build +composer.lock +docs +vendor +coverage \ No newline at end of file diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 0000000..df16b68 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,19 @@ +filter: + excluded_paths: [tests/*] + +checks: + php: + remove_extra_empty_lines: true + remove_php_closing_tag: true + remove_trailing_whitespace: true + fix_use_statements: + remove_unused: true + preserve_multiple: false + preserve_blanklines: true + order_alphabetically: true + fix_php_opening_tag: true + fix_linefeed: true + fix_line_ending: true + fix_identation_4spaces: true + fix_doc_comments: true + diff --git a/.styleci.yml b/.styleci.yml new file mode 100644 index 0000000..f4d3cbc --- /dev/null +++ b/.styleci.yml @@ -0,0 +1,4 @@ +preset: laravel + +disabled: + - single_class_element_per_statement diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..24c2d6c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +language: php + +php: + - 7.1 + - 7.2 + - 7.3 + +env: + matrix: + - COMPOSER_FLAGS="--prefer-lowest" + - COMPOSER_FLAGS="" + +before_script: + - travis_retry composer self-update + - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source + +script: + - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover + +after_script: + - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0dcef9a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `laravel-hyperpay` will be documented in this file + +## 1.0.0 - 201X-XX-XX + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..14f95b9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) darbaoui imad + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8637388 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Very short description of the package + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/devinweb/laravel-hyperpay.svg?style=flat-square)](https://packagist.org/packages/devinweb/laravel-hyperpay) +[![Build Status](https://img.shields.io/travis/devinweb/laravel-hyperpay/master.svg?style=flat-square)](https://travis-ci.org/devinweb/laravel-hyperpay) +[![Quality Score](https://img.shields.io/scrutinizer/g/devinweb/laravel-hyperpay.svg?style=flat-square)](https://scrutinizer-ci.com/g/devinweb/laravel-hyperpay) +[![Total Downloads](https://img.shields.io/packagist/dt/devinweb/laravel-hyperpay.svg?style=flat-square)](https://packagist.org/packages/devinweb/laravel-hyperpay) + +This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors. + +## Installation + +You can install the package via composer: + +```bash +composer require devinweb/laravel-hyperpay +``` + +## Usage + +``` php +// Usage description here +``` + +### Testing + +``` bash +composer test +``` + +### Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +### Security + +If you discover any security related issues, please email imad@devinweb.com instead of using the issue tracker. + +## Credits + +- [darbaoui imad](https://github.com/devinweb) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. + +## Laravel Package Boilerplate + +This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..87c4650 --- /dev/null +++ b/composer.json @@ -0,0 +1,54 @@ +{ + "name": "devinweb/laravel-hyperpay", + "description": "Laravel package for Hyperpay payment gateway in MENA.", + "keywords": [ + "devinweb", + "laravel-hyperpay" + ], + "homepage": "https://github.com/devinweb/laravel-hyperpay", + "license": "MIT", + "type": "library", + "authors": [ + { + "name": "darbaoui imad", + "email": "imad@devinweb.com", + "role": "Developer" + } + ], + "require": { + "php": "^7.3", + "guzzlehttp/guzzle": "^6.3" + }, + "require-dev": { + "orchestra/testbench": "^4.0", + "phpunit/phpunit": "^8.0" + }, + "autoload": { + "psr-4": { + "Devinweb\\LaravelHyperpay\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Devinweb\\LaravelHyperpay\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage" + + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "Devinweb\\LaravelHyperpay\\LaravelHyperpayServiceProvider" + ], + "aliases": { + "LaravelHyperpay": "Devinweb\\LaravelHyperpay\\Facades\\LaravelHyperpay" + } + } + } +} diff --git a/config/hyperpay.php b/config/hyperpay.php new file mode 100644 index 0000000..53bf158 --- /dev/null +++ b/config/hyperpay.php @@ -0,0 +1,12 @@ + env('PAYMENT_MODE', 'staging'), + "entityIdMada" => env('ENTITY_ID_MADA'), + "entityId" => env('ENTITY_ID'), + "access_token" => env('ACCESS_TOKEN'), + "currency" => 'SAR' +]; diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..22fe879 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,29 @@ + + + + + tests + + + + + src/ + + + + + + + + + + diff --git a/src/Console/BillingCommand.php b/src/Console/BillingCommand.php new file mode 100644 index 0000000..2676d23 --- /dev/null +++ b/src/Console/BillingCommand.php @@ -0,0 +1,85 @@ +composer = $composer; + } + + /** + * Execute the console command. + * + * @return void + */ + public function handle() + { + parent::handle(); + + $this->composer->dumpAutoloads(); + } + + /** + * Get the stub file for the generator. + * + * @return string + */ + protected function getStub() + { + return __DIR__.'/stubs/billing.stub'; + } + + /** + * Get the default namespace for the class. + * + * @param string $rootNamespace + * @return string + */ + protected function getDefaultNamespace($rootNamespace) + { + return $rootNamespace.'\Billing'; + } +} diff --git a/src/Console/stubs/billing.stub b/src/Console/stubs/billing.stub new file mode 100644 index 0000000..63ca2d9 --- /dev/null +++ b/src/Console/stubs/billing.stub @@ -0,0 +1,20 @@ +client = $client; + $this->config = config('hyperpay'); + if ($this->config['payment_mode'] == 'staging') { + $this->config['testMode'] = 'EXTERNAL'; + } + } + + /** + * + * + */ + public function mada() + { + $this->config['entityId'] = config('hyperpay.entityIdMada'); + + return $this; + } + + /** + * Add billing data to the payment body + * @param BillingInterface $billing; + * + * return $this + */ + public function addBilling(BillingInterface $billing) + { + $this->billing = $billing; + return $this; + } + + public function prepareCheckout(Model $user, $amount) + { + return $this->getCheckoutId($user, $amount); + } + + /** + * + * + */ + public function getCheckoutId(Model $user, $amount) + { + $this->token = $this->generateToken(); + $this->config['merchantTransactionId'] = $this->token; + return (new HttpPayload())->paramaters($amount, $user, $this->config, $this->billing); + } + + /** + * + * + */ + public function getPaymentStatus(string $resourcePath, string $brand) + { + } + + /** + * + * + */ + public function isSuccessfulResponse(array $response): bool + { + return false; + } + + /** + * + * + * + */ + public function getMessageFromError(array $response): ?string + { + return ''; + } + + public function pending() + { + } + + public function merchantTransactionId() + { + return $this->token; + } + + private function generateToken() + { + return Str::random('64'); + } +} diff --git a/src/LaravelHyperpayServiceProvider.php b/src/LaravelHyperpayServiceProvider.php new file mode 100644 index 0000000..6cbbd88 --- /dev/null +++ b/src/LaravelHyperpayServiceProvider.php @@ -0,0 +1,67 @@ +loadTranslationsFrom(__DIR__.'/../resources/lang', 'laravel-hyperpay'); + // $this->loadViewsFrom(__DIR__.'/../resources/views', 'laravel-hyperpay'); + // $this->loadMigrationsFrom(__DIR__.'/../database/migrations'); + // $this->loadRoutesFrom(__DIR__.'/routes.php'); + + if ($this->app->runningInConsole()) { + $this->publishes([ + __DIR__.'/../config/config.php' => config_path('hyperpay.php'), + ], 'config'); + + // Publishing the views. + /*$this->publishes([ + __DIR__.'/../resources/views' => resource_path('views/vendor/laravel-hyperpay'), + ], 'views');*/ + + // Publishing assets. + /*$this->publishes([ + __DIR__.'/../resources/assets' => public_path('vendor/laravel-hyperpay'), + ], 'assets');*/ + + // Publishing the translation files. + /*$this->publishes([ + __DIR__.'/../resources/lang' => resource_path('lang/vendor/laravel-hyperpay'), + ], 'lang');*/ + + // Registering package commands. + // $this->commands([]); + + $this->commands([ + BillingCommand::class, + ]); + } + } + + /** + * Register the application services. + */ + public function register() + { + // Automatically apply the package configuration + $this->mergeConfigFrom(__DIR__.'/../config/hyperpay.php', 'hyperpay'); + + // Register the main class to use with the facade + $this->app->singleton('laravelHyperpay', function () { + return new LaravelHyperpay(new GuzzleClient()); + }); + } +} diff --git a/src/Model/User.php b/src/Model/User.php new file mode 100644 index 0000000..50af0b3 --- /dev/null +++ b/src/Model/User.php @@ -0,0 +1,8 @@ +getBodyParameters($amount, $user, $heyperpayConfig); + + $billing_parameters = $this->getBillingParameters($billing); + + $parameters = array_merge($body, $billing_parameters); + + return $parameters; + } + + /** + * + * + */ + protected function getBillingParameters($billing): array + { + if ($billing instanceof BillingInterface) { + return $billing->getBillingData(); + } + return []; + } + + /** + * + * + */ + protected function getBodyParameters($amount, Model $user, $heyperpayConfig): array + { + return [ + 'entityId' => $heyperpayConfig['entityId'], + 'amount' => $amount, + 'currency' => $heyperpayConfig['currency'], + 'paymentType' => 'DB', + 'merchantTransactionId' => $heyperpayConfig['merchantTransactionId'], + 'customer.email' => $user->email + ]; + } +} diff --git a/src/Support/Mada.php b/src/Support/Mada.php new file mode 100644 index 0000000..8a3ce05 --- /dev/null +++ b/src/Support/Mada.php @@ -0,0 +1,12 @@ +assertTrue(true); + } +}