diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..a7c44dd --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +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 + +[*.{yml,yaml}] +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..886475c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,14 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.github export-ignore +/.gitattributes export-ignore +/.gitignore export-ignore +/phpunit.xml.dist export-ignore +/tests export-ignore +/.editorconfig export-ignore +/.php_cs.dist export-ignore +/psalm.xml export-ignore +/psalm.xml.dist export-ignore +/testbench.yaml export-ignore diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/.github/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/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..689fd8c --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: h-farm diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..92fa71b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/h-farm/laravel-email-domain-rule/discussions/new?category=q-a + about: Ask the community for help + - name: Request a feature + url: https://github.com/h-farm/laravel-email-domain-rule/discussions/new?category=ideas + about: Share ideas for new features + - name: Report a bug + url: https://github.com/h-farm/laravel-email-domain-rule/issues/new + about: Report a reproducable bug diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..3e7f122 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +If you discover any security related issues, please email riccardo.dallavia@h-farm.com instead of using the issue tracker. diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml new file mode 100644 index 0000000..a83d708 --- /dev/null +++ b/.github/workflows/php-cs-fixer.yml @@ -0,0 +1,23 @@ +name: Check & fix styling + +on: [push] + +jobs: + php-cs-fixer: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + ref: ${{ github.head_ref }} + + - name: Run PHP CS Fixer + uses: docker://oskarstark/php-cs-fixer-ga + with: + args: --config=.php-cs-fixer.dist.php --allow-risky=yes + + - name: Commit changes + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: Fix styling diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml new file mode 100644 index 0000000..99cf0d9 --- /dev/null +++ b/.github/workflows/psalm.yml @@ -0,0 +1,33 @@ +name: Psalm + +on: + push: + paths: + - '**.php' + - 'psalm.xml.dist' + +jobs: + psalm: + name: psalm + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: '7.4' + extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick + coverage: none + + - name: Cache composer dependencies + uses: actions/cache@v2 + with: + path: vendor + key: composer-${{ hashFiles('composer.lock') }} + + - name: Run composer install + run: composer install -n --prefer-dist + + - name: Run psalm + run: ./vendor/bin/psalm --output-format=github diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml new file mode 100644 index 0000000..799d0ca --- /dev/null +++ b/.github/workflows/run-tests.yml @@ -0,0 +1,43 @@ +name: run-tests + +on: [push, pull_request] + +jobs: + test: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: true + matrix: + os: [ubuntu-latest, windows-latest] + php: [8.0, 7.4] + laravel: [8.*] + stability: [prefer-lowest, prefer-stable] + include: + - laravel: 8.* + testbench: 6.* + + name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }} + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo + coverage: none + + - name: Setup problem matchers + run: | + echo "::add-matcher::${{ runner.tool_cache }}/php.json" + echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" + + - name: Install dependencies + run: | + composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update + composer update --${{ matrix.stability }} --prefer-dist --no-interaction + + - name: Execute tests + run: vendor/bin/phpunit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0a63bc1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +.idea +.php_cs +.php_cs.cache +.phpunit.result.cache +build +composer.lock +coverage +docs +phpunit.xml +psalm.xml +testbench.yaml +vendor +node_modules +.php-cs-fixer.cache diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..d612a54 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,35 @@ +in([ + __DIR__ . '/src', + __DIR__ . '/tests', + ]) + ->name('*.php') + ->notName('*.blade.php') + ->ignoreDotFiles(true) + ->ignoreVCS(true); + +return (new PhpCsFixer\Config()) + ->setRules([ + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'ordered_imports' => ['sort_algorithm' => 'alpha'], + 'no_unused_imports' => true, + 'not_operator_with_successor_space' => true, + 'trailing_comma_in_multiline' => true, + 'phpdoc_scalar' => true, + 'unary_operator_spaces' => true, + 'binary_operator_spaces' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_var_without_name' => true, + 'method_argument_space' => [ + 'on_multiline' => 'ensure_fully_multiline', + 'keep_multiple_spaces_after_comma' => true, + ], + 'single_trait_insert_per_statement' => true, + ]) + ->setFinder($finder); diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d4c9d39 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `laravel-email-domain-rule` will be documented in this file. + +## 1.0.0 - 2021-06-16 + +- first release 🚀 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..7ef178d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2021 H-FARM SPA + +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 new file mode 100644 index 0000000..dda9193 --- /dev/null +++ b/README.md @@ -0,0 +1,177 @@ +

Social Card of Laravel Email Domain Rule

+ +# Laravel Email Domain Rule + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/h-farm/laravel-email-domain-rule.svg?style=flat-square)](https://packagist.org/packages/h-farm/laravel-email-domain-rule) +[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/h-farm/laravel-email-domain-rule/run-tests?label=tests)](https://github.com/h-farm/laravel-email-domain-rule/actions?query=workflow%3Arun-tests+branch%3Amain) +[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/h-farm/laravel-email-domain-rule/Check%20&%20fix%20styling?label=code%20style)](https://github.com/h-farm/laravel-email-domain-rule/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/h-farm/laravel-email-domain-rule.svg?style=flat-square)](https://packagist.org/packages/h-farm/laravel-email-domain-rule) + +This package allows to define a subset of allowed email domains and validate any user registration form with a custom rule. + +## Installation + +You can install the package via composer: + +```bash +composer require h-farm/laravel-email-domain-rule +``` + +You can publish and run the migrations with: + +```bash +php artisan vendor:publish --provider="HFarm\EmailDomainRule\EmailDomainRuleServiceProvider" --tag="email-domain-rule-migrations" +php artisan migrate +``` + +You can publish the config file with: +```bash +php artisan vendor:publish --provider="HFarm\EmailDomainRule\EmailDomainRuleServiceProvider" --tag="email-domain-rule-config" +``` + +This is the content of the published config file: + +```php +return [ + + /* + |-------------------------------------------------------------------------- + | Email Domain model + |-------------------------------------------------------------------------- + | + | Here you may specify the fully qualified class name of the email domain model. + | + */ + + 'email_domain_model' => HFarm\EmailDomainRule\Models\EmailDomain::class, + + /* + |-------------------------------------------------------------------------- + | Email Domain wildcard + |-------------------------------------------------------------------------- + | + | Here you may specify the character used as wildcard for all email domains. + | + */ + + 'email_domain_wildcard' => '*', + + /* + |-------------------------------------------------------------------------- + | Validation message + |-------------------------------------------------------------------------- + | + | Here you may specify the message thrown if the validation rule fails. + | + */ + + 'validation_message' => 'The selected :attribute does not have a valid domain.', +]; +``` + +## Usage + +### Basic + +To use the package, run the migration and fill in the table with a list of accepted email domains for your application. + +You can then just add the custom validation rule to validate, for example, a user registration form. + +```php +use HFarm\EmailDomainRule\EmailDomainRule; +use Illuminate\Support\Facades\Validator; + +$email = 'my-email@example.com'; + +Validator::make([ + 'email' => $email, +], [ + 'email' => [ + 'string', + 'email', + new EmailDomainRule, + ], +])->validated(); +``` + +That's all! +Laravel will handle the rest by validating the input and throwing an error message if validation fails. + +### Wildcard domains + +If needed, you can optionally add wildcard domains to the `email_domains` database table: the custom rule will handle the rest. + +The default wildcard character is an asterisk (`*`), but you can customize it within the `email_domain_wildcard` setting. + +```php +use HFarm\EmailDomainRule\EmailDomainRule; +use HFarm\EmailDomainRule\Models\EmailDomain; +use Illuminate\Support\Facades\Validator; + +EmailDomain::create(['domain' => '*.example.com']); + +Validator::make([ + 'email' => 'info@example.com', +], [ + 'email' => ['string', 'email', new EmailDomainRule], +])->fails(); // returns true as the given domain is not in the list + +Validator::make([ + 'email' => 'info@subdomain.example.com', +], [ + 'email' => ['string', 'email', new EmailDomainRule], +])->fails(); // returns false as the given domain matches the wildcard domain +``` + +### Model customization + +You can also override the default `EmailDomain` model to add any additional field by changing the `email_domain_model` setting. + +This can be useful when working with a multi-tenancy scenario in a single database system: in this case you can just add a `tenant_id` column to the migration and model classes, and apply a global scope to the custom model. + +```php +use HFarm\EmailDomainRule\EmailDomainRule as BaseEmailDomain; +use Illuminate\Database\Eloquent\Builder; + +class EmailDomain extends BaseEmailDomain +{ + protected $fillable = [ + 'domain', + 'tenant_id', + ]; + + protected static function booted() + { + static::addGlobalScope('tenantAware', function (Builder $builder) { + $builder->where('tenant_id', auth()->user()->tenant_id); + }); + } +} +``` + +## Testing + +```bash +composer test +``` + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. + +## Security Vulnerabilities + +Please review [our security policy](../../security/policy) on how to report security vulnerabilities. + +## Credits + +- [Riccardo Dalla Via](https://github.com/riccardodallavia) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/art/socialcard.png b/art/socialcard.png new file mode 100644 index 0000000..57dd20a Binary files /dev/null and b/art/socialcard.png differ diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..33d7d51 --- /dev/null +++ b/composer.json @@ -0,0 +1,61 @@ +{ + "name": "h-farm/laravel-email-domain-rule", + "description": "Laravel Email Domain Rule", + "keywords": [ + "h-farm", + "laravel-email-domain-rule" + ], + "homepage": "https://github.com/h-farm/laravel-email-domain-rule", + "license": "MIT", + "authors": [ + { + "name": "Riccardo Dalla Via", + "email": "riccardo.dallavia@h-farm.com", + "homepage": "https://h-farm.com", + "role": "Developer" + } + ], + "require": { + "php": "^7.4|^8.0", + "illuminate/contracts": "^8.0", + "illuminate/database": "^8.0", + "illuminate/support": "^8.0", + "spatie/laravel-package-tools": "^1.4.3" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.18", + "nunomaduro/collision": "^5.3", + "orchestra/testbench": "^6.0", + "phpunit/phpunit": "^9.3", + "spatie/laravel-ray": "^1.9", + "vimeo/psalm": "^4.4" + }, + "autoload": { + "psr-4": { + "HFarm\\EmailDomainRule\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "HFarm\\EmailDomainRule\\Tests\\": "tests" + } + }, + "scripts": { + "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes", + "psalm": "vendor/bin/psalm", + "test": "vendor/bin/phpunit --colors=always", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage" + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "HFarm\\EmailDomainRule\\EmailDomainRuleServiceProvider" + ] + } + }, + "minimum-stability": "dev", + "prefer-stable": true +} diff --git a/config/email-domain-rule.php b/config/email-domain-rule.php new file mode 100644 index 0000000..c75daa5 --- /dev/null +++ b/config/email-domain-rule.php @@ -0,0 +1,37 @@ + HFarm\EmailDomainRule\Models\EmailDomain::class, + + /* + |-------------------------------------------------------------------------- + | Email Domain wildcard + |-------------------------------------------------------------------------- + | + | Here you may specify the character used as wildcard for all email domains. + | + */ + + 'email_domain_wildcard' => '*', + + /* + |-------------------------------------------------------------------------- + | Validation message + |-------------------------------------------------------------------------- + | + | Here you may specify the message thrown if the validation rule fails. + | + */ + + 'validation_message' => 'The selected :attribute does not have a valid domain.', +]; diff --git a/database/migrations/create_email_domains_table.php.stub b/database/migrations/create_email_domains_table.php.stub new file mode 100644 index 0000000..e57cb43 --- /dev/null +++ b/database/migrations/create_email_domains_table.php.stub @@ -0,0 +1,32 @@ +id(); + $table->string('domain'); + $table->timestamps(); + }); + } + + /** + * Reverse the migrations. + * + * @return void + */ + public function down() + { + Schema::dropIfExists('email_domains'); + } +}; diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..ecb46b5 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,39 @@ + + + + + tests + + + + + ./src + + + + + + + + + + + diff --git a/psalm.xml.dist b/psalm.xml.dist new file mode 100644 index 0000000..c6df33e --- /dev/null +++ b/psalm.xml.dist @@ -0,0 +1,16 @@ + + + + + + + + + diff --git a/src/EmailDomainRule.php b/src/EmailDomainRule.php new file mode 100644 index 0000000..a624a24 --- /dev/null +++ b/src/EmailDomainRule.php @@ -0,0 +1,41 @@ +findEmailDomain($value); + + if (empty($emailDomain)) { + return false; + } + + /** @var EmailDomain $emailDomainModel */ + $emailDomainModel = app(config('email-domain-rule.email_domain_model')); + $emailDomainWildcard = config('email-domain-rule.email_domain_wildcard'); + + return $emailDomainModel::query() + ->where('domain', $emailDomain) + ->orWhereRaw("? LIKE LOWER(REPLACE(domain, '{$emailDomainWildcard}', '%'))", [ + $emailDomain, + ]) + ->exists(); + } + + protected function findEmailDomain(string $email): string + { + return Str::lower(Str::after($email, '@')); + } + + public function message() + { + /** @var string */ + return __(config('email-domain-rule.validation_message')); + } +} diff --git a/src/EmailDomainRuleServiceProvider.php b/src/EmailDomainRuleServiceProvider.php new file mode 100644 index 0000000..ac03ef0 --- /dev/null +++ b/src/EmailDomainRuleServiceProvider.php @@ -0,0 +1,17 @@ +name('laravel-email-domain-rule') + ->hasConfigFile() + ->hasMigration('create_email_domains_table'); + } +} diff --git a/src/Models/EmailDomain.php b/src/Models/EmailDomain.php new file mode 100644 index 0000000..85800b5 --- /dev/null +++ b/src/Models/EmailDomain.php @@ -0,0 +1,12 @@ + 'example.com']); + EmailDomain::create(['domain' => 'example.net']); + + $validation = Validator::make([ + 'email' => 'info@example.com', + ], [ + 'email' => [ + 'string', + 'email', + new EmailDomainRule, + ], + ]); + + $this->assertFalse($validation->fails()); + } + + /** @test */ + public function it_should_fail_with_an_unexisting_email_domain() + { + EmailDomain::create(['domain' => 'example.com']); + EmailDomain::create(['domain' => 'example.net']); + + $validation = Validator::make([ + 'email' => 'info@example.org', + ], [ + 'email' => [ + 'string', + 'email', + new EmailDomainRule, + ], + ]); + + $this->assertTrue($validation->fails()); + } + + /** @test */ + public function it_should_validate_an_existing_wildcard_email_domain() + { + EmailDomain::create(['domain' => '*.example.com']); + EmailDomain::create(['domain' => 'example.net']); + + $validation = Validator::make([ + 'email' => 'info@test.example.com', + ], [ + 'email' => [ + 'string', + 'email', + new EmailDomainRule, + ], + ]); + + $this->assertFalse($validation->fails()); + } + + /** @test */ + public function it_should_fail_with_an_unexisting_wildcard_email_domain() + { + EmailDomain::create(['domain' => '*.example.com']); + EmailDomain::create(['domain' => 'example.net']); + + $validation = Validator::make([ + 'email' => 'info@example.com', + ], [ + 'email' => [ + 'string', + 'email', + new EmailDomainRule, + ], + ]); + + $this->assertTrue($validation->fails()); + } +} diff --git a/tests/TestCase.php b/tests/TestCase.php new file mode 100644 index 0000000..3fe27e9 --- /dev/null +++ b/tests/TestCase.php @@ -0,0 +1,34 @@ +set('database.default', 'sqlite'); + $app['config']->set('database.connections.sqlite', [ + 'driver' => 'sqlite', + 'database' => ':memory:', + 'prefix' => '', + ]); + + include_once __DIR__.'/../database/migrations/create_email_domains_table.php.stub'; + (new \CreateEmailDomainsTable())->up(); + } +}