-
Notifications
You must be signed in to change notification settings - Fork 131
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
intergrity violation fixes, and code cleanup
- Loading branch information
0 parents
commit 960d6dd
Showing
32 changed files
with
1,904 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[Makefile] | ||
indent_style = tab | ||
|
||
[*.php] | ||
indent_size = 4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
* text=auto | ||
/.github export-ignore | ||
/tests export-ignore | ||
/.editorconfig export-ignore | ||
/.gitattributes export-ignore | ||
/.gitignore export-ignore | ||
/.travis.yml export-ignore | ||
/.styleci.yml export-ignore | ||
/.sensiolabs.yml export-ignore | ||
/.coveralls.yml export-ignore | ||
/phpunit.xml export-ignore | ||
/CHANGELOG-* export-ignore | ||
/CONTRIBUTING.md export-ignore | ||
/CODE_OF_CONDUCT.md export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/vendor | ||
/.idea | ||
/node_modules | ||
/composer.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
preset: laravel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
language: php | ||
sudo: required | ||
|
||
php: | ||
- 7.1 | ||
- 7.2 | ||
|
||
before_script: | ||
- travis_retry composer self-update | ||
- travis_retry composer update --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 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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**! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2018 Zura Gabievi <[email protected]> | ||
|
||
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
# laravel-promocodes | ||
|
||
[![Packagist](https://img.shields.io/packagist/v/zgabievi/promocodes.svg)](https://packagist.org/packages/zgabievi/promocodes) | ||
[![Packagist](https://img.shields.io/packagist/dt/zgabievi/promocodes.svg)](https://packagist.org/packages/zgabievi/promocodes) | ||
[![license](https://img.shields.io/github/license/zgabievi/promocodes.svg)](https://packagist.org/packages/zgabievi/promocodes) | ||
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/zgabievi/laravel-promocodes/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/zgabievi/laravel-promocodes/?branch=master) | ||
[![Build Status](https://scrutinizer-ci.com/g/zgabievi/laravel-promocodes/badges/build.png?b=master)](https://scrutinizer-ci.com/g/zgabievi/laravel-promocodes/build-status/master) | ||
|
||
> Promocodes generator for [Laravel 5.*](http://laravel.com/). Trying to make the best package in this category. You are welcome to join the party, give me some advices :tada: and make pull requests. | ||
## Table of Contents | ||
- [Installation](#installation) | ||
- [Configuration](#configuration) | ||
- [Usage](#usage) | ||
- [Basic Methods](#usage) | ||
- [User Trait](#promocodes-can-be-related-to-users) | ||
- [Additional Data](#how-to-use-additional-data) | ||
- [Testing](#testing) | ||
- [License](#license) | ||
|
||
### What's new? | ||
- [Additional Data](#how-to-use-additional-data) | ||
|
||
## Installation | ||
|
||
Install this package via Composer: | ||
```bash | ||
$ composer require zgabievi/promocodes | ||
``` | ||
|
||
> If you are using Laravel 5.5, then installation is done. Otherwise follow the next steps. | ||
#### Open `config/app.php` and follow steps below: | ||
|
||
Find the `providers` array and add our service provider. | ||
|
||
```php | ||
'providers' => [ | ||
// ... | ||
Gabievi\Promocodes\PromocodesServiceProvider::class | ||
], | ||
``` | ||
|
||
Find the `aliases` array and add our facade. | ||
|
||
```php | ||
'aliases' => [ | ||
// ... | ||
'Promocodes' => Gabievi\Promocodes\Facades\Promocodes::class | ||
], | ||
``` | ||
|
||
## Configuration | ||
|
||
Publish config & migration file using Artisan command: | ||
```bash | ||
$ php artisan vendor:publish | ||
``` | ||
|
||
To create table for promocodes in database run: | ||
```bash | ||
$ php artisan migrate | ||
``` | ||
|
||
> Configuration parameters are well documented. There is no need to describe each parameter here. | ||
> Check `config/promocodes.php` and read comments there if you need. | ||
## Usage | ||
|
||
Generate as many codes as you wish and output them without saving to database. | ||
|
||
You will get array of codes in return: | ||
|
||
```php | ||
Promocodes::output($amount = 1); | ||
``` | ||
|
||
--- | ||
|
||
Create as many codes as you wish. Set reward (amount). | ||
|
||
Attach additional data as array. Specify for how many days should this codes stay alive. | ||
|
||
By default generated code will be multipass (several users will be able to use this code once). | ||
|
||
They will be saved in database and you will get collection of them in return: | ||
|
||
```php | ||
Promocodes::create($amount = 1, $reward = null, array $data = [], $expires_in = null); | ||
``` | ||
|
||
If you want to create code that will be used only once, here is method for you. | ||
|
||
```php | ||
Promocodes::createDisposable($amount = 1, $reward = null, array $data = [], $expires_in = null); | ||
``` | ||
|
||
--- | ||
|
||
Check if given code exists, is usable and not yet expired. | ||
|
||
This code may throw `\Gabievi\Promocodes\Exceptions\InvalidPromocodeException` if there is not such promocode in database, with give code. | ||
|
||
Returns `Promocode` object if valid, or `false` if not. | ||
|
||
```php | ||
Promocodes::check($code); | ||
``` | ||
|
||
--- | ||
|
||
Redeem or apply code. Redeem is alias for apply method. | ||
|
||
User should be authenticated to redeem code or this method will throw an exception (`\Gabievi\Promocodes\Exceptions\UnauthenticatedException`). | ||
|
||
Also if authenticated user will try to apply code twice, it will throw an exception (`\Gabievi\Promocodes\Exceptions\AlreadyUsedException`) | ||
|
||
Returns `Promocode` object if applied, or `false` if not. | ||
|
||
```php | ||
Promocodes::redeem($code); | ||
Promocodes::apply($code); | ||
``` | ||
|
||
--- | ||
|
||
You can immediately expire code by calling *disable* function. Returning boolean status of update. | ||
|
||
```php | ||
Promocodes::disable($code); | ||
``` | ||
|
||
--- | ||
|
||
And if you want to delete expired, or non-usable codes you can erase them. | ||
|
||
This method will remove redundant codes from database and their relations to users. | ||
|
||
```php | ||
Promocodes::clearRedundant(); | ||
``` | ||
|
||
--- | ||
|
||
### Promocodes can be related to users | ||
|
||
If you want to use user relation open `app/User.php` and make it `Rewardable` as in example: | ||
|
||
```php | ||
namespace App; | ||
|
||
use Illuminate\Notifications\Notifiable; | ||
use Gabievi\Promocodes\Traits\Rewardable; | ||
use Illuminate\Foundation\Auth\User as Authenticatable; | ||
|
||
class User extends Authenticatable | ||
{ | ||
use Notifiable, Rewardable; | ||
|
||
// ... | ||
} | ||
``` | ||
--- | ||
|
||
Redeem or apply code are same. *redeemCode* is alias of *applyCode* | ||
|
||
Pass promotion code you want to be applied by current user. | ||
|
||
```php | ||
User::redeemCode($code, $callback = null); | ||
User::applyCode($code, $callback = null); | ||
``` | ||
|
||
Example (usage of callback): | ||
|
||
```php | ||
$redeemMessage = $user->redeemCode('ABCD-DCBA', function ($promocode) use ($user) { | ||
return 'Congratulations, ' . $user->name . '! We have added ' . $promocode->reward . ' points on your account'; | ||
}); | ||
|
||
// Congratulations, Zura! We have added 10 points on your account | ||
``` | ||
|
||
### How to use additional data? | ||
|
||
1. Process of creation: | ||
|
||
```php | ||
Promocodes::create(1, 25, ['foo' => 'bar', 'baz' => 'qux']); | ||
``` | ||
|
||
2. Getting data back: | ||
|
||
```php | ||
Promocodes::redeem('ABC-DEF', function($promocode) { | ||
echo $promocode->data['foo']; | ||
}); | ||
|
||
// bar | ||
``` | ||
|
||
or | ||
|
||
```php | ||
User::redeemCode('ABC-DEF', function($promocode) { | ||
echo $promocode->data['foo']; | ||
}); | ||
|
||
// bar | ||
``` | ||
|
||
## Testing | ||
|
||
Finally it's here. I've written some test to keep this package healthy and stable | ||
|
||
![laravel-promocodes tests](https://user-images.githubusercontent.com/1515299/29971701-4971da9e-8f3a-11e7-9f68-f7677400ef16.png) | ||
|
||
## License | ||
|
||
laravel-promocodes is licensed under a [MIT License](https://github.com/zgabievi/laravel-promocodes/blob/master/LICENSE). |
Oops, something went wrong.