v2

middlewares · Dec 3, 2019 · b8a4e68 · b8a4e68
1 parent 995ff48
commit b8a4e68
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 194 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,9 +1,10 @@
 * text=auto eol=lf
 
-/tests         export-ignore
-.editorconfig  export-ignore
-.gitattributes export-ignore
-.gitignore     export-ignore
-.travis.yml    export-ignore
-phpunit.xml    export-ignore
-phpcs.xml      export-ignore
+/tests            export-ignore
+.editorconfig     export-ignore
+.gitattributes    export-ignore
+.gitignore        export-ignore
+.php_cs           export-ignore
+.travis.yml       export-ignore
+phpcs.xml.dist    export-ignore
+phpunit.xml.dist  export-ignore
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 vendor
 composer.lock
-.php_cs.cache
 coverage
-.phpunit.result.cache
+*.cache
diff --git a/.php_cs b/.php_cs
@@ -1,129 +1,10 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
-    ->files()
-    ->name('*.php')
-    ->in(__DIR__ . '/src')
-    ->in(__DIR__ . '/tests')
-;
-
-return PhpCsFixer\Config::create()
-    ->setRules(array(
-        '@PSR2' => true,
-        'array_syntax' => ['syntax' => 'short'],
-        'binary_operator_spaces' => ['align_double_arrow' => false, 'align_equals' => false],
-        'blank_line_after_namespace' => true,
-        'blank_line_after_opening_tag' => false,
-        'blank_line_before_return' => false,
-        'braces' => ['allow_single_line_closure' => false],
-        'cast_spaces' => true,
-        'class_definition' => ['singleLine' => false, 'singleItemSingleLine' => true, 'multiLineExtendsEachSingleLine' => true],
-        'class_keyword_remove' => false,
-        'combine_consecutive_unsets' => true,
-        'concat_space' => false,
-        'declare_equal_normalize' => ['space' => 'single'],
-        'declare_strict_types' => false,
-        'elseif' => true,
-        'encoding' => true,
-        'full_opening_tag' => true,
-        'function_declaration' => true,
-        'function_typehint_space' => true,
-        'general_phpdoc_annotation_remove' => ['expectedExceptionMessageRegExp', 'expectedException', 'expectedExceptionMessage'],
-        'hash_to_slash_comment' => true,
-        'header_comment' => false,
-        'heredoc_to_nowdoc' => true,
-        'include' => true,
-        'indentation_type' => true,
-        'line_ending' => true,
-        'linebreak_after_opening_tag' => true,
-        'lowercase_cast' => true,
-        'lowercase_constants' => true,
-        'lowercase_keywords' => true,
-        'mb_str_functions' => false,
-        'method_argument_space' => true,
-        'method_separation' => true,
-        'native_function_casing' => true,
-        'native_function_invocation' => false,
-        'new_with_braces' => true,
-        'no_blank_lines_after_class_opening' => true,
-        'no_blank_lines_after_phpdoc' => false,
-        'no_blank_lines_before_namespace' => false,
-        'no_closing_tag' => true,
-        'no_empty_comment' => true,
-        'no_empty_phpdoc' => true,
-        'no_empty_statement' => true,
-        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
-        'no_leading_import_slash' => true,
-        'no_leading_namespace_whitespace' => true,
-        'no_mixed_echo_print' => ['use' => 'echo'],
-        'no_multiline_whitespace_around_double_arrow' => true,
-        'no_multiline_whitespace_before_semicolons' => true,
-        'no_short_bool_cast' => true,
-        'no_short_echo_tag' => true,
-        'no_singleline_whitespace_before_semicolons' => true,
-        'no_spaces_after_function_name' => true,
-        'no_spaces_around_offset' => true,
-        'no_spaces_inside_parenthesis' => true,
-        'no_trailing_comma_in_list_call' => true,
-        'no_trailing_comma_in_singleline_array' => true,
-        'no_trailing_whitespace' => true,
-        'no_trailing_whitespace_in_comment' => true,
-        'no_unneeded_control_parentheses' => true,
-        'no_unused_imports' => true,
-        'no_useless_else' => true,
-        'no_useless_return' => true,
-        'no_whitespace_before_comma_in_array' => true,
-        'no_whitespace_in_blank_line' => true,
-        'normalize_index_brace' => true,
-        'not_operator_with_space' => false,
-        'not_operator_with_successor_space' => false,
-        'object_operator_without_whitespace' => true,
-        'ordered_class_elements' => false,
-        'ordered_imports' => true,
-        'php_unit_fqcn_annotation' => true,
-        'php_unit_strict' => false,
-        'phpdoc_add_missing_param_annotation' => true,
-        'phpdoc_align' => true,
-        'phpdoc_inline_tag' => true,
-        'phpdoc_no_access' => true,
-        'phpdoc_no_alias_tag' => ['property-read' => 'property', 'property-write' => 'property', 'type' => 'var'],
-        'phpdoc_no_empty_return' => true,
-        'phpdoc_no_package' => true,
-        'phpdoc_no_useless_inheritdoc' => true,
-        'phpdoc_order' => true,
-        'phpdoc_return_self_reference' => true,
-        'phpdoc_scalar' => true,
-        'phpdoc_separation' => false,
-        'phpdoc_single_line_var_spacing' => true,
-        'phpdoc_summary' => false,
-        'phpdoc_to_comment' => true,
-        'phpdoc_trim' => true,
-        'phpdoc_types' => true,
-        'phpdoc_var_without_name' => true,
-        'pow_to_exponentiation' => false,
-        'pre_increment' => true,
-        'protected_to_private' => true,
-        'return_type_declaration' => true,
-        'semicolon_after_instruction' => true,
-        'short_scalar_cast' => true,
-        'single_blank_line_at_eof' => true,
-        'single_blank_line_before_namespace' => false,
-        'single_class_element_per_statement' => true,
-        'single_import_per_statement' => true,
-        'single_line_after_imports' => true,
-        'single_quote' => true,
-        'space_after_semicolon' => true,
-        'standardize_not_equals' => true,
-        'strict_param' => false,
-        'switch_case_semicolon_to_colon' => true,
-        'switch_case_space' => true,
-        'ternary_operator_spaces' => true,
-        'ternary_to_null_coalescing' => false,
-        'trailing_comma_in_multiline_array' => true,
-        'trim_array_spaces' => true,
-        'unary_operator_spaces' => true,
-        'visibility_required' => true,
-        'whitespace_after_comma_in_array' => true,
-    ))
-    ->setFinder($finder)
-;
+return My\PhpCsFixerConfig::create()
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->files()
+            ->name('*.php')
+            ->in(__DIR__.'/src')
+            ->in(__DIR__.'/tests')
+    );
diff --git a/.travis.yml b/.travis.yml
@@ -2,9 +2,8 @@ language: php
 sudo: false
 
 php:
-  - 7.0
-  - 7.1
   - 7.2
+  - 7.3
 
 before_script:
   - composer self-update

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,79 +2,61 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/) 
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
-
-### Fixed
-
-- Use `phpstan` as a dev dependency to detect bugs
-
+## [2.0.0] - 2019-12-04
 ### Added
+- New constructor argument to set a `ResponseFactoryInterface`
 
-- Added `responseFactory` option to `__construct`
+### Removed
+- Support for PHP 7.0 and 7.1
+- The option `responseFactory`. Use the constructor argument.
 
 ## [1.1.0] - 2018-08-04
-
 ### Added
-
 - PSR-17 support
 - New option `responseFactory`
 
 ## [1.0.0] - 2018-01-27
-
 ### Added
-
 - Improved testing and added code coverage reporting
 - Added tests for PHP 7.2
 
 ### Changed
-
 - Upgraded to the final version of PSR-15 `psr/http-server-middleware`
 
 ### Fixed
-
 - Updated license year
 
 ## [0.5.0] - 2017-11-13
-
 ### Changed
-
 - Replaced `http-interop/http-middleware` with  `http-interop/http-server-middleware`.
 
 ### Removed
-
 - Removed support for PHP 5.x.
 
 ## [0.4.0] - 2017-09-21
-
 ### Changed
-
 - Append `.dist` suffix to phpcs.xml and phpunit.xml files
 - Changed the configuration of phpcs and php_cs
 - Upgraded phpunit to the latest version and improved its config file
 - Updated to `http-interop/http-middleware#0.5`
 
 ## [0.3.0] - 2016-12-26
-
 ### Changed
-
 - Updated tests
 - Updated to `http-interop/http-middleware#0.4`
 - Updated `friendsofphp/php-cs-fixer#2.0`
 
 ## [0.2.0] - 2016-11-27
-
 ### Changed
-
 - Updated to `http-interop/http-middleware#0.3`
 
 ## 0.1.0 - 2016-10-10
-
 First version
 
-[Unreleased]: https://github.com/middlewares/firewall/compare/v1.1.0...HEAD
+[2.0.0]: https://github.com/middlewares/firewall/compare/v1.1.0...v2.0.0
 [1.1.0]: https://github.com/middlewares/firewall/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/middlewares/firewall/compare/v0.5.0...v1.0.0
 [0.5.0]: https://github.com/middlewares/firewall/compare/v0.4.0...v0.5.0

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018
+Copyright (c) 2019
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -5,13 +5,12 @@
 [![Build Status][ico-travis]][link-travis]
 [![Quality Score][ico-scrutinizer]][link-scrutinizer]
 [![Total Downloads][ico-downloads]][link-downloads]
-[![SensioLabs Insight][ico-sensiolabs]][link-sensiolabs]
 
 Middleware to provide IP filtering using [M6Web/Firewall](https://github.com/M6Web/Firewall).
 
 ## Requirements
 
-* PHP >= 7.0
+* PHP >= 7.2
 * A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)
 * A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)
 
@@ -26,33 +25,56 @@ composer require middlewares/firewall
 ## Example
 
 ```php
-$dispatcher = new Dispatcher([
+Dispatcher::run([
     (new Middlewares\Firewall(['123.0.0.*']))
         ->blacklist([
             '123.0.0.1',
             '123.0.0.2',
         ])
 ]);
+```
+
+## Usage
+
+The constructor accepts an array with the whitelist ips. [See the ip formats allowed](https://github.com/M6Web/Firewall#entries-formats).
 
-$response = $dispatcher->dispatch(new ServerRequest());
+```php
+$firewall = new Middlewares\Firewall([
+    '127.0.0.1',
+    '198.168.0.*',
+]);
 ```
 
-## Options
+Optionally, you can provide a `Psr\Http\Message\ResponseFactoryInterface` as the second argument to create the error response (`403`). If it's not defined, [Middleware\Utils\Factory](https://github.com/middlewares/utils#factory) will be used to detect it automatically.
 
-#### `__construct(array $whitelist)`
+```php
+$responseFactory = new MyOwnResponseFactory();
 
-An array with the whitelist ips. [See the ip formats allowed](https://github.com/M6Web/Firewall#entries-formats).
+$firewall = new Middlewares\Firewall($whitelist, $responseFactory);
+```
 
-#### `blacklist(array $blacklist)`
+### blacklist
 
 The blacklist ips. The ip format is the same than whitelist.
 
-#### `ipAttribute(string $ipAttribute)`
+```php
+$whitelist = [
+    '127.0.0.1',
+    '198.168.0.*',
+];
+$blacklist = [
+    '192.168.0.50',
+];
+
+$firewall = (new Middlewares\Firewall($whitelist))->blacklist($blacklist);
+```
+
+### ipAttribute
 
-By default uses the `REMOTE_ADDR` server parameter to get the client ip. This option allows to use a request attribute. Useful to combine with any ip detection middleware, for example [client-ip](https://github.com/middlewares/client-ip):
+By default uses the `REMOTE_ADDR` server parameter to get the client ip. Use this option if you want to use a request attribute. Useful to combine with any ip detection middleware, for example [client-ip](https://github.com/middlewares/client-ip):
 
 ```php
-$dispatcher = new Dispatcher([
+Dispatcher::run([
     //detect the client ip and save it in client-ip attribute
     new Middlewares\ClientIP(),
 
@@ -62,10 +84,6 @@ $dispatcher = new Dispatcher([
 ]);
 ```
 
-#### `responseFactory(Psr\Http\Message\ResponseFactoryInterface $responseFactory)`
-
-A PSR-17 factory to create `403` responses.
-
 ---
 
 Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
@@ -77,10 +95,8 @@ The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
 [ico-travis]: https://img.shields.io/travis/middlewares/firewall/master.svg?style=flat-square
 [ico-scrutinizer]: https://img.shields.io/scrutinizer/g/middlewares/firewall.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/packagist/dt/middlewares/firewall.svg?style=flat-square
-[ico-sensiolabs]: https://img.shields.io/sensiolabs/i/0dec27d8-7743-416b-8959-62f9e07a3d6e.svg?style=flat-square
 
 [link-packagist]: https://packagist.org/packages/middlewares/firewall
 [link-travis]: https://travis-ci.org/middlewares/firewall
 [link-scrutinizer]: https://scrutinizer-ci.com/g/middlewares/firewall
 [link-downloads]: https://packagist.org/packages/middlewares/firewall
-[link-sensiolabs]: https://insight.sensiolabs.com/projects/0dec27d8-7743-416b-8959-62f9e07a3d6e