First readme

Author: Bruno Cabral

README.md

@@ -1,88 +1,91 @@
-# Project Title
+# Laravel Block Bots
 
-One Paragraph of project description goes here
 
-## Getting Started
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Total Downloads][ico-downloads]][link-downloads]
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
 
-### Prerequisites
+## Introduction
+Laravel Block bots is a pacakge that block bad crawlers, people trying to scrape your website or high-usage users, but lets good and important crawlers such as GoogleBot and Bing pass-thu. 
 
-What things you need to install the software and how to install them
 
-```
-Give examples
-```
+## Features
+- ULTRA fast, less than 1ms increase in each request.
+- Verify Crawlers using reverse DNS
+- Highly configurable
+- Redirect users to a page when they got blocked
+- Allow Logged users to always bypass blocks
 
-### Installing
 
-A step by step series of examples that tell you how to get a development env running
 
-Say what the step will be
+## Install
 
+Via Composer
+``` bash
+composer require potelo/laravel-block-bots
 ```
-Give the example
-```
+#### Requirement
+- This package rely on heavly on Redis. To use it, make sure that Redis is configured and ready. (see [Laravel Redis Configuration](https://laravel.com/docs/5.6/redis#configuration))
+
 
-And repeat
+#### Before Laravel 5.5
+In Laravel 5.4. you'll manually need to register the `\Potelo\LaravelBlockBots\BlockBots::class` service provider in `config/app.php`.
 
+#### Config
+To adjust the library, you can publish the config file to your project using:
 ```
-until finished
+php artisan vendor:publish --provider="\Potelo\LaravelBlockBots\BlockBotsServiceProvider"
 ```
 
-End with an example of getting some data out of the system or using it for a little demo
-
-## Running the tests
-
-Explain how to run the automated tests for this system
-
-### Break down into end to end tests
-
-Explain what these tests test and why
+## Usage
 
+It's simple. Go to `Kernel.php` and add to the `$routeMiddleware` block as : 
 ```
-Give an example
+protected $routeMiddleware = [
+        ...
+        'block' => \Potelo\LaravelBlockBots\BlockBots::class,
+    ];
 ```
 
-### And coding style tests
+Than you can put in the desired groups. For exemple, lets set to the Wrb group:
 
-Explain what these tests test and why
-
-```
-Give an example
 ```
 
-## Deployment
+ protected $middlewareGroups = [
+        'web' => [
+            ...
+            \App\Http\Middleware\VerifyCsrfToken::class,
+            'block:100,/limit'
+        ],
+```
 
-Add additional notes about how to deploy this on a live system
+Where:
+- **100**: is the number of pages an IP can access every day
+- **/limit**: Is the route we going to redirect the IP after the limit
 
-## Built With
 
-* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
-* [Maven](https://maven.apache.org/) - Dependency Management
-* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
+## Change log
 
-## Contributing
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
 
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+## Contributing
 
-## Authors
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
 
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
+## Credits
 
-See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+- [Potelo][link-author]
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
-
-## Acknowledgments
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
-* Hat tip to anyone whose code was used
-* Inspiration
-* etc
+[ico-version]: https://img.shields.io/packagist/v/potelo/laravel-block-bots.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/potelo/laravel-block-bots.svg?style=flat-square
 
+[link-packagist]: https://packagist.org/packages/potelo/laravel-block-bots
+[link-downloads]: https://packagist.org/packages/potelo/laravel-block-bots
+[link-author]: https://github.com/potelo

src/Middleware/BlockBots.php

@@ -11,7 +11,7 @@
 use Carbon\Carbon;
 use Potelo\LaravelBlockBots\CheckIfBotIsReal;
 
-class BlockBots extends Middleware
+class BlockBots
 {
     protected $config;
 
@@ -20,6 +20,11 @@ public function __construct()
         $this->config = config('block');
     }
 
+    private function enabled()
+    {
+        return $this->config['enabled'];
+    }
+
     /**
      * Register all visits in Redis
      *
@@ -154,7 +159,7 @@ public function isWhitelisted($ip, $user_agent)
                 return true;
 
             // If we got here, it is an unverified bot. Lets create a job to test it
-            \Potelo\LaravelBlockBots\Jobs\CheckIfBotIsReal::dispatchNow($ip, $user_agent);
+            \Potelo\LaravelBlockBots\Jobs\CheckIfBotIsReal::dispatch($ip, $user_agent);
 
         }
 

src/Middleware/Middleware.php

@@ -8,7 +8,6 @@
      */
 
     'enabled' => env('BLOCK_BOTS_ENABLED', true),
-
     /*
      * Whitelisted  IP addresses
      *      '127.0.0.1',
@@ -20,7 +19,7 @@
     ],
 
     'allow_logged_user' => env('BLOCK_BOTS_ALLOW_LOGGED_USER', true),
-    'fake_mode' => env('BLOCK_BOTS_FAKE_MODE', true), // minutes - disabled by default
+    'fake_mode' => env('BLOCK_BOTS_FAKE_MODE', true), //
 
     /*
      * Send suspicious events to log?