From 50b7129cabdb1bd53e95904b7bf453187f45dffe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20Sessing=C3=B8?= <simon.sessingoe@gmail.com>
Date: Tue, 30 Mar 2021 20:44:40 +0200
Subject: [PATCH] Changed name of IpBlockAccess to IpRestrictAccess & updated
 documentation.

---
 README.md                                           | 13 +++++++++----
 .../{IpBlockAccess.php => IpRestrictAccess.php}     |  2 +-
 tests/Pecee/SimpleRouter/CustomMiddlewareTest.php   | 10 +++++-----
 ...BlockMiddleware.php => IpRestrictMiddleware.php} |  2 +-
 4 files changed, 16 insertions(+), 11 deletions(-)
 rename src/Pecee/Http/Middleware/{IpBlockAccess.php => IpRestrictAccess.php} (94%)
 rename tests/Pecee/SimpleRouter/Dummy/Middleware/{IpBlockMiddleware.php => IpRestrictMiddleware.php} (64%)

diff --git a/README.md b/README.md
index 6eda57a..df796aa 100644
--- a/README.md
+++ b/README.md
@@ -1373,16 +1373,19 @@ This behavior can be easily disabled by setting `SimpleRouter::enableMultiRouteR
 
 ## Restrict access to IP
 
-You can white- and blacklist access to IP's using the build in `IpBlockAccess` middleware.
+You can white- and blacklist access to IP's using the build in `IpRestrictAccess` middleware.
 
-Create your own Middleware and extend the `IpBlockAccess` class.
+Create your own custom Middleware and extend the `IpRestrictAccess` class.
+
+The `IpRestrictAccess` class contains two properties `ipBlacklist` and `ipWhitelist` that can be added 
+to your middleware to change which IP's has blocked or allowed access.
 
 You can use `*` to restrict access to a range of ips.
 
 ```php
-use \Pecee\Http\Middleware\IpBlockAccess;
+use \Pecee\Http\Middleware\IpRestrictAccess;
 
-class IpBlockMiddleware extends IpBlockAccess {
+class IpBlockerMiddleware extends IpRestrictAccess {
 
     protected $ipBlacklist = [
         '5.5.5.5',
@@ -1396,6 +1399,8 @@ class IpBlockMiddleware extends IpBlockAccess {
 }
 ```
 
+You can the middleware to multiple routes by adding your [middleware to a groups](#middleware).
+
 ## Url rewriting
 
 ### Changing current route
diff --git a/src/Pecee/Http/Middleware/IpBlockAccess.php b/src/Pecee/Http/Middleware/IpRestrictAccess.php
similarity index 94%
rename from src/Pecee/Http/Middleware/IpBlockAccess.php
rename to src/Pecee/Http/Middleware/IpRestrictAccess.php
index f19d821..483ce22 100644
--- a/src/Pecee/Http/Middleware/IpBlockAccess.php
+++ b/src/Pecee/Http/Middleware/IpRestrictAccess.php
@@ -5,7 +5,7 @@ namespace Pecee\Http\Middleware;
 use Pecee\Http\Request;
 use Pecee\SimpleRouter\Exceptions\HttpException;
 
-abstract class IpBlockAccess implements IMiddleware
+abstract class IpRestrictAccess implements IMiddleware
 {
     protected $ipBlacklist = [];
     protected $ipWhitelist = [];
diff --git a/tests/Pecee/SimpleRouter/CustomMiddlewareTest.php b/tests/Pecee/SimpleRouter/CustomMiddlewareTest.php
index bf19094..7345986 100644
--- a/tests/Pecee/SimpleRouter/CustomMiddlewareTest.php
+++ b/tests/Pecee/SimpleRouter/CustomMiddlewareTest.php
@@ -1,7 +1,7 @@
 <?php
 
 require_once 'Dummy/DummyController.php';
-require_once 'Dummy/Middleware/IpBlockMiddleware.php';
+require_once 'Dummy/Middleware/IpRestrictMiddleware.php';
 
 class CustomMiddlewareTest extends \PHPUnit\Framework\TestCase
 {
@@ -16,7 +16,7 @@ class CustomMiddlewareTest extends \PHPUnit\Framework\TestCase
 
         $_SERVER['remote-addr'] = '5.5.5.5';
 
-        TestRouter::group(['middleware' => IpBlockMiddleware::class], function() {
+        TestRouter::group(['middleware' => IpRestrictMiddleware::class], function() {
             TestRouter::get('/fail', 'DummyController@method1');
         });
 
@@ -28,7 +28,7 @@ class CustomMiddlewareTest extends \PHPUnit\Framework\TestCase
 
         TestRouter::router()->reset();
 
-        TestRouter::group(['middleware' => IpBlockMiddleware::class], function() {
+        TestRouter::group(['middleware' => IpRestrictMiddleware::class], function() {
             TestRouter::get('/fail', 'DummyController@method1');
         });
 
@@ -46,7 +46,7 @@ class CustomMiddlewareTest extends \PHPUnit\Framework\TestCase
 
         TestRouter::router()->reset();
 
-        TestRouter::group(['middleware' => IpBlockMiddleware::class], function() {
+        TestRouter::group(['middleware' => IpRestrictMiddleware::class], function() {
             TestRouter::get('/success', 'DummyController@method1');
         });
 
@@ -58,7 +58,7 @@ class CustomMiddlewareTest extends \PHPUnit\Framework\TestCase
 
         TestRouter::router()->reset();
 
-        TestRouter::group(['middleware' => IpBlockMiddleware::class], function() {
+        TestRouter::group(['middleware' => IpRestrictMiddleware::class], function() {
             TestRouter::get('/success', 'DummyController@method1');
         });
 
diff --git a/tests/Pecee/SimpleRouter/Dummy/Middleware/IpBlockMiddleware.php b/tests/Pecee/SimpleRouter/Dummy/Middleware/IpRestrictMiddleware.php
similarity index 64%
rename from tests/Pecee/SimpleRouter/Dummy/Middleware/IpBlockMiddleware.php
rename to tests/Pecee/SimpleRouter/Dummy/Middleware/IpRestrictMiddleware.php
index ee525cf..df0d526 100644
--- a/tests/Pecee/SimpleRouter/Dummy/Middleware/IpBlockMiddleware.php
+++ b/tests/Pecee/SimpleRouter/Dummy/Middleware/IpRestrictMiddleware.php
@@ -1,6 +1,6 @@
 <?php
 
-class IpBlockMiddleware extends \Pecee\Http\Middleware\IpBlockAccess {
+class IpRestrictMiddleware extends \Pecee\Http\Middleware\IpRestrictAccess {
 
     protected $ipBlacklist = [
         '5.5.5.5',