feat(*): Remove configurations that are used as settings and not configs

Author: julienloizelet

docs/configuration-reference.md

@@ -1,6 +1,7 @@
 # Full configuration reference
 
 ```php
+   use CrowdSecBouncer\StandAloneBounce;
    $config = [
        // Required. The bouncer api key to access LAPI or CAPI.
        'api_key'=> 'YOUR_BOUNCER_API_KEY',
@@ -14,13 +15,13 @@
        // Optional. In seconds. The timeout when calling CAPI/LAPI. Defaults to 1 sec.
        'api_timeout'=> 1,
 
-       // Optional. Select from 'bouncing_disabled', 'normal_bouncing' or 'flex_bouncing'. Default to 'normal_bouncing'
+       // Optional. Select from 'bouncing_disabled', 'normal_bouncing' or 'flex_bouncing'.
        'bouncing_level' => 'normal_bouncing',
 
        // Optional. Absolute path to store log files.
        'log_directory_path' => __DIR__.'/.logs',
 
-       // Optional. Select from 'phpfs' (File system cache), 'redis' or 'memcached'. Default to 'phpcs'
+       // Optional. Select from 'phpfs' (File system cache), 'redis' or 'memcached'.
        'cache_system' => 'phpfs',
 
        // Optional. Will be used only if you choose File system as cache_system
@@ -34,19 +35,18 @@
 
        // Optional. If you use a CDN, a reverse proxy or a load balancer, set an array of IPs.
        // For other IPs, the bouncer will not trust the X-Forwarded-For header.
-       // Default to empty array
        'trust_ip_forward_array' => [],
 
        // Optional. true to enable stream mode, true to enable the stream mode. Default to false.
        'stream_mode'=> false,
 
-       // Optional. true to enable verbose debug log. Default to false
+       // Optional. true to enable verbose debug log.
        'debug_mode' => false,
 
-       // Optional. true to stop the process and display errors if any. Default to false.
+       // Optional. true to stop the process and display errors if any.
        'display_errors' => false,
 
-       // Optional. true to hide CrowdSec mentions on ban and captcha walls. Default to false.
+       // Optional. true to hide CrowdSec mentions on ban and captcha walls.
        'hide_mentions' => false,
 
        // Optional. Only for test or debug purpose.
@@ -93,6 +93,7 @@
              ]
         ]       
    ]
-   $bouncer = new Bouncer();
-   $bouncer->configure($config);
+   $bouncer = new StandAloneBounce();
+   $bouncer->init($config);
+   $bouncer->safelyBounce();
 ```

src/Configuration.php

@@ -33,23 +33,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('api_user_agent')->defaultValue(Constants::BASE_USER_AGENT)->end()
                 ->integerNode('api_timeout')->defaultValue(Constants::API_TIMEOUT)->end()
                 ->booleanNode('stream_mode')->defaultValue(false)->end()
-                ->booleanNode('debug_mode')->defaultValue(false)->end()
-                ->booleanNode('display_errors')->defaultValue(false)->end()
-                ->booleanNode('hide_mentions')->defaultValue(false)->end()
                 ->scalarNode('forced_test_ip')->defaultValue('')->end()
-                ->scalarNode('log_directory_path')->end()
-                ->enumNode('bouncing_level')
-                    ->values([Constants::BOUNCING_LEVEL_DISABLED, Constants::BOUNCING_LEVEL_NORMAL, Constants::BOUNCING_LEVEL_FLEX])
-                    ->defaultValue(Constants::BOUNCING_LEVEL_NORMAL)
-                ->end()
-                ->enumNode('cache_system')
-                    ->values([Constants::CACHE_SYSTEM_PHPFS, Constants::CACHE_SYSTEM_REDIS, Constants::CACHE_SYSTEM_MEMCACHED])
-                    ->defaultValue(Constants::CACHE_SYSTEM_PHPFS)
-                ->end()
-                ->scalarNode('fs_cache_path')->end()
-                ->scalarNode('redis_dsn')->end()
-                ->scalarNode('memcached_dsn')->end()
-                ->arrayNode('trust_ip_forward_array')->defaultValue([])->end()
                 ->enumNode('max_remediation_level')
                     ->values(Constants::ORDERED_REMEDIATIONS)
                     ->defaultValue(Constants::REMEDIATION_BAN)

src/StandAloneBounce.php

@@ -104,7 +104,6 @@ public function getBouncerInstance(): Bouncer
         }
 
         // Parse options.
-
         if (empty($this->getStringSettings('api_url'))) {
             throw new BouncerException('Bouncer enabled but no API URL provided');
         }
@@ -120,20 +119,19 @@ public function getBouncerInstance(): Bouncer
         $forcedTestIp = $this->getStringSettings('forced_test_ip');
 
         // Init Bouncer instance
-
         switch ($bouncingLevel) {
-        case Constants::BOUNCING_LEVEL_DISABLED:
-            $maxRemediationLevel = Constants::REMEDIATION_BYPASS;
-            break;
-        case Constants::BOUNCING_LEVEL_FLEX:
-            $maxRemediationLevel = Constants::REMEDIATION_CAPTCHA;
-            break;
-        case Constants::BOUNCING_LEVEL_NORMAL:
-            $maxRemediationLevel = Constants::REMEDIATION_BAN;
-            break;
-        default:
-            throw new BouncerException("Unknown $bouncingLevel");
-    }
+            case Constants::BOUNCING_LEVEL_DISABLED:
+                $maxRemediationLevel = Constants::REMEDIATION_BYPASS;
+                break;
+            case Constants::BOUNCING_LEVEL_FLEX:
+                $maxRemediationLevel = Constants::REMEDIATION_CAPTCHA;
+                break;
+            case Constants::BOUNCING_LEVEL_NORMAL:
+                $maxRemediationLevel = Constants::REMEDIATION_BAN;
+                break;
+            default:
+                throw new BouncerException("Unknown $bouncingLevel");
+        }
 
         // Instantiate the bouncer
         try {