Merge pull request #100 from julienloizelet/feat/refacto-construct

Feat/refacto construct

Author: julienloizelet

.github/workflows/test-suite.yml

@@ -93,19 +93,19 @@ jobs:
           tar -xf GeoLite2-City.tar.gz
           rm GeoLite2-Country.tar.gz GeoLite2-Country.tar.gz.sha256.txt GeoLite2-City.tar.gz GeoLite2-City.tar.gz.sha256.txt
 
-      - name: Run PHP UNIT tests (IP verification)
+      - name: Run "IP verification with file_get_contents" test
         run: |
           ddev exec BOUNCER_KEY=${{ env.BOUNCER_KEY }} LAPI_URL=http://crowdsec:8080 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php ./${{env.EXTENSION_PATH}}/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./${{env.EXTENSION_PATH}}/tests/Integration/IpVerificationTest.php
 
-      - name: Run PHP UNIT tests (IP verification with cURL)
+      - name: Run "IP verification with cURL" test
         run: |
           ddev exec BOUNCER_KEY=${{ env.BOUNCER_KEY }} USE_CURL=1 LAPI_URL=http://crowdsec:8080 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php ./${{env.EXTENSION_PATH}}/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./${{env.EXTENSION_PATH}}/tests/Integration/IpVerificationTest.php
 
-      - name: Run PHP UNIT tests (Geolocation)
+      - name: Run "Geolocation with file_get_contents" test
         run: |
           ddev exec BOUNCER_KEY=${{ env.BOUNCER_KEY }} LAPI_URL=http://crowdsec:8080  /usr/bin/php ./${{env.EXTENSION_PATH}}/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./${{env.EXTENSION_PATH}}/tests/Integration/GeolocationTest.php
 
-      - name: Run PHP UNIT tests (Geolocation with cURL)
+      - name: Run "Geolocation with cURL" test
         run: |
           ddev exec BOUNCER_KEY=${{ env.BOUNCER_KEY }} USE_CURL=1 LAPI_URL=http://crowdsec:8080  /usr/bin/php ./${{env.EXTENSION_PATH}}/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./${{env.EXTENSION_PATH}}/tests/Integration/GeolocationTest.php    
 

CHANGELOG.md

@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
+## [0.26.0] - 2022-07-28
+
+### Changed
+- *Breaking change*: Modify all constructors (`Bouncer`, `ApiCache`, `ApiClient`, `RestClient`) to use only 
+  configurations and logger as parameters
+- Use `shouldBounceCurrentIp` method of Standalone before bouncer instantiation
+- Modify logger constructor
+
 ## [0.25.0] - 2022-07-22
 
 ### Added

docs/DEVELOPER.md

@@ -502,12 +502,12 @@ Fortunately, this library allows you to cap the remediation to a certain level.
 Let's add the `max_remediation_level` configuration with `captcha` value:
 
 ```php
-$bouncer->configure([
+$configs = [
     'api_key' => $bouncerKey,
     'api_url' => 'http://crowdsec:8080',
-    'max_remediation_level' => 'captcha' // <== ADD THIS LINE!
-    ]
-);
+    'fs_cache_path' => __DIR__ . '/.cache'
+    'max_remediation_level' => 'captcha' // <== ADD THIS LINE
+    ];
 ```
 
 Now if you call one more time:
@@ -526,52 +526,33 @@ Now update the `check-ip.php`script to replace the `PhpFilesAdapter` with the `R
 Replace:
 
 ```php
-<?php
-
-require __DIR__ . '/vendor/autoload.php';
-
-use CrowdSecBouncer\Bouncer;
-use Symfony\Component\Cache\Adapter\RedisAdapter;
-
-// Init cache adapter
-$cacheAdapter = new TagAwareAdapter(new PhpFilesAdapter('', 0, __DIR__.'/.cache'));
-
-...
+$configs = [
+    'api_key' => $bouncerKey,
+    'api_url' => 'http://crowdsec:8080',
+    'fs_cache_path' => __DIR__ . '/.cache',
+];
 ```
 
 with:
 
 ```php
-<?php
-
-require __DIR__ . '/vendor/autoload.php';
-
-use CrowdSecBouncer\Bouncer;
-use Symfony\Component\Cache\Adapter\RedisAdapter;
-
-// Init cache adapter
-
-$cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://redis:6379'));
-
-...
+$configs = [
+    'api_key' => $bouncerKey,
+    'api_url' => 'http://crowdsec:8080',
+    'cache_system' => 'redis',
+    'redis_dsn' => 'redis://redis:6379'
+];
 ```
 
 Or, if `Memcached` is more adapted than `Redis` to your needs:
 
 ```php
-<?php
-
-require __DIR__ . '/vendor/autoload.php';
-
-use CrowdSecBouncer\Bouncer;
-use Symfony\Component\Cache\Adapter\MemcachedAdapter;
-
-// Init cache adapter
-
-$cacheAdapter =
-new TagAwareAdapter(new MemcachedAdapter(MemcachedAdapter::createConnection('memcached://memcached:11211')));
-
-...
+$configs = [
+    'api_key' => $bouncerKey,
+    'api_url' => 'http://crowdsec:8080',
+    'cache_system' => 'memcached',
+    'memcached_dsn' => 'memcached://memcached:11211'
+];
 ```
 
 You will still be able to verify IPs, but the cache system will be more efficient.
@@ -580,8 +561,6 @@ You will still be able to verify IPs, but the cache system will be more efficien
 ddev exec php my-own-modules/crowdsec-php-lib/scripts/check-ip.php 1.2.3.4 <BOUNCER_KEY>
 ```
 
-> Note: You can try more cache systems but we did not test them for now (Apcu, Filesystem, Doctrine, Couchbase, Pdo). The [full list is here](https://symfony.com/doc/current/components/cache.html#available-cache-adapters).
-
 ### Clear cache script
 
 To clear your LAPI cache, you can use the [`clear-php`](../scripts/clear-cache.php) script: 

docs/USER_GUIDE.md

@@ -124,7 +124,7 @@ Here is the list of available settings:
 - `api_url`: Define the URL to your LAPI server, default to `http://localhost:8080`.
 
 - `api_timeout`: In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
-- `api_user_agent`: HTTP user agent used to call CLAPI. Default to this library name/current version.
+
 - `use_curl`: By default, this lib call the REST LAPI using `file_get_contents` method (`allow_url_fopen` is required).
   You can set `use_curl` to `true` in order to use `cURL` request instead (`curl` is in then required)
 

scripts/auto-prepend/refresh-cache.php

@@ -16,7 +16,7 @@
 }elseif($crowdSecStandaloneBouncerConfig['bouncing_level'] === 'flex_boucing'){
     $crowdSecStandaloneBouncerConfig['bouncing_level'] = 'flex_bouncing';
 }
-
+$bounce->initLogger($crowdSecStandaloneBouncerConfig);
 $bouncer = $bounce->init($crowdSecStandaloneBouncerConfig);
 $bouncer->refreshBlocklistCache();
 echo 'Cache has been refreshed'.PHP_EOL;

scripts/auto-prepend/settings.example.php

@@ -25,9 +25,6 @@
      */
     'use_curl' => false,
 
-    // HTTP user agent used to call LAPI. Default to this library name/current version.
-    'api_user_agent'=> 'CrowdSec PHP Library/x.x.x',
-
     // true to enable verbose debug log.
     'debug_mode' => false,
 

scripts/check-ip.php

@@ -3,18 +3,12 @@
 require_once __DIR__ . '/../vendor/autoload.php';
 
 use CrowdSecBouncer\Bouncer;
-use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
-use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 
 
-// Init cache adapter
-
-$cacheAdapter = new TagAwareAdapter(new PhpFilesAdapter('', 0, __DIR__ . '/.cache'));
-
 // Parse argument
 
 $requestedIp = $argv[1];
@@ -35,13 +29,12 @@
 $logger->pushHandler($fileHandler);
 
 // Init
-$bouncer = new Bouncer($cacheAdapter, $logger);
-
-$config = [
+$configs = [
     'api_key' => $bouncerKey,
     'api_url' => 'http://crowdsec:8080',
+    'fs_cache_path' => __DIR__ . '/.cache',
 ];
-$bouncer->configure($config);
+$bouncer = new Bouncer($configs, $logger);
 
 // Ask remediation to LAPI
 

scripts/clear-cache.php

@@ -7,8 +7,6 @@
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
-use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
-use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 
 
 
@@ -25,13 +23,6 @@
 
 // Configure paths
 $logPath = __DIR__.'/.crowdsec.log';
-$cachePath = __DIR__ . '/.cache';
-
-// Instantiate the "PhpFilesAdapter" cache adapter
-$cacheAdapter = new TagAwareAdapter(new Symfony\Component\Cache\Adapter\PhpFilesAdapter('', 0, $cachePath));
-// 0Or Redis: $cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://your-redis-host:6379'));
-// Or Memcached: $cacheAdapter = new TagAwareAdapter(new MemcachedAdapter(MemcachedAdapter::createConnection
-//('memcached://your-memcached-host:11211')));
 
 // Instantiate the Stream logger with info level(optional)
 $logger = new Logger('example');
@@ -46,8 +37,12 @@
 $logger->pushHandler($fileHandler);
 
 // Instantiate the bouncer
-$bouncer = new Bouncer($cacheAdapter, $logger);
-$bouncer->configure(['api_key' => $bouncerApiKey, 'api_url' => $apiUrl]);
+$configs = [
+    'api_key' => $bouncerApiKey,
+    'api_url' => 'http://crowdsec:8080',
+    'fs_cache_path' => __DIR__ . '/.cache',
+];
+$bouncer = new Bouncer($configs, $logger);
 
 // Clear the cache.
 $bouncer->clearCache();

scripts/full-example-live-mode.php

@@ -7,8 +7,6 @@
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
-use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
-use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 
 // Parse arguments
 $bouncerApiKey = $argv[1]; // required
@@ -22,14 +20,7 @@
 echo "\nVerify $requestedIp with $apiUrl...\n";
 
 // Configure paths
-$logPath = __DIR__.'/../crowdsec.log';
-$cachePath = __DIR__ . '/../.cache';
-
-// Instantiate the "PhpFilesAdapter" cache adapter
-$cacheAdapter = new TagAwareAdapter(new Symfony\Component\Cache\Adapter\PhpFilesAdapter('', 0, $cachePath));
-// 0Or Redis: $cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://your-redis-host:6379'));
-// Or Memcached: $cacheAdapter = new TagAwareAdapter(new MemcachedAdapter(MemcachedAdapter::createConnection
-//('memcached://your-memcached-host:11211')));
+$logPath = __DIR__.'/crowdsec.log';
 
 // Instantiate the Stream logger with info level(optional)
 $logger = new Logger('example');
@@ -44,17 +35,19 @@
 $logger->pushHandler($fileHandler);
 
 // Instantiate the bouncer
-$bouncer = new Bouncer($cacheAdapter, $logger);
-$bouncer->configure([
+$configs = [
     'api_key' => $bouncerApiKey,
     'api_url' => $apiUrl,
     'api_user_agent' => 'MyCMS CrowdSec Bouncer/1.0.0',
     'api_timeout' => 1,
     'stream_mode' => false,
     'max_remediation_level' => 'ban',
-    'cache_expiration_for_clean_ip' => 300,
-    'cache_expiration_for_bad_ip' => 30,
-]);
+    'clean_ip_cache_duration' => 300,
+    'bad_ip_cache_duration' => 30,
+    'fs_cache_path' => __DIR__ . '/../.cache'
+];
+$bouncer = new Bouncer($configs, $logger);
+
 
 // Ask remediation to LAPI
 $remediation = $bouncer->getRemediationForIp($requestedIp);

scripts/refresh-cache.php

@@ -5,19 +5,9 @@
 use CrowdSecBouncer\Bouncer;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
-use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;
-use Symfony\Component\Cache\Adapter\TagAwareAdapter;
 
 // Configure paths
-$logPath = __DIR__.'/.crowdsec.log';
-$cachePath = __DIR__ . '/.cache';
-
-// Instantiate the "PhpFilesAdapter" cache adapter
-$cacheAdapter = new TagAwareAdapter(new Symfony\Component\Cache\Adapter\PhpFilesAdapter('', 0, $cachePath));
-// Or Redis: $cacheAdapter = new RedisTagAwareAdapter(RedisAdapter::createConnection('redis://your-redis-host:6379'));
-// Or Memcached: $cacheAdapter = new TagAwareAdapter(new MemcachedAdapter(MemcachedAdapter::createConnection
-//('memcached://your-memcached-host:11211')));
-// Parse argument
+$logPath = __DIR__ . '/.crowdsec.log';
 
 $bouncerKey = $argv[1];
 if (!$bouncerKey) {
@@ -26,16 +16,16 @@
 
 // Instantiate the Stream logger with info level(optional)
 $logger = new Logger('example');
-$fileHandler = new RotatingFileHandler(__DIR__.'/crowdsec.log', 0, Logger::WARNING);
+$fileHandler = new RotatingFileHandler(__DIR__ . '/crowdsec.log', 0, Logger::WARNING);
 $logger->pushHandler($fileHandler);
 
 // Instantiate the bouncer
-$bouncer = new Bouncer($cacheAdapter, $logger);
-$bouncer->configure([
-        'api_key' => $bouncerKey,
-        'api_url' => 'http://crowdsec:8080'
-    ]
-);
+$configs = [
+    'api_key' => $bouncerKey,
+    'api_url' => 'http://crowdsec:8080',
+    'fs_cache_path' => __DIR__ . '/.cache'
+];
+$bouncer = new Bouncer($configs, $logger);
 
 // Refresh the blocklist cache
 $bouncer->refreshBlocklistCache();