Merge pull request #22 from crowdsecurity/new-lib-features

Lint pass

Author: mobula9

README.md

@@ -49,8 +49,8 @@ $bouncerApiKey = 'YOUR_BOUNCER_API_KEY';
 /* Select the best cache adapter for your needs (Memcached, Redis, PhpFiles, ...) */
 $cacheAdapter = new Symfony\Component\Cache\Adapter\PhpFilesAdapter();
 
-$bouncer = new CrowdSecBouncer\Bouncer();
-$bouncer->configure(['api_key'=> $bouncerApiKey], $cacheAdapter);
+$bouncer = new CrowdSecBouncer\Bouncer($cacheAdapter);
+$bouncer->configure(['api_key'=> $bouncerApiKey]);
 
 $remediation = $bouncer->getRemediationForIp($blockedIp);// Return "ban", "captcha" or "bypass"
 ```

docs/api/ApiCache.md

@@ -154,9 +154,7 @@ public pullUpdates (void)
 Used in stream mode only. 
 
 Pull decisions updates from the API and update the cached remediations.  
-Used for the stream mode when we have to update the remediations list.  
-  
-TODO P2 test for overlapping decisions strategy (ex: max expires) 
+Used for the stream mode when we have to update the remediations list. 
 
 **Parameters**
 

docs/api/Bouncer.md

@@ -19,8 +19,6 @@ The main Class of this package. This is the first entry point of any PHP Bouncer
 |[getCaptchaHtmlTemplate](#bouncergetcaptchahtmltemplate)|Returns a default "CrowdSec Captcha" HTML template to display to a web browser using a captchable IP.|
 |[getLogger](#bouncergetlogger)|Returns the logger instance.|
 |[getRemediationForIp](#bouncergetremediationforip)|Get the remediation for the specified IP. This method use the cache layer.|
-|[loadPaginatedBlocklistFromCache](#bouncerloadpaginatedblocklistfromcache)|Browse the remediations cache.|
-|[loadPaginatedLogs](#bouncerloadpaginatedlogs)|Browse the bouncer technical logs.|
 |[pruneCache](#bouncerprunecache)|This method prune the cache: it removes all the expired cache items.|
 |[refreshBlocklistCache](#bouncerrefreshblocklistcache)|Used in stream mode only.|
 |[warmBlocklistCacheUp](#bouncerwarmblocklistcacheup)|Used in stream mode only.|
@@ -247,54 +245,6 @@ the cache system will call the API to check if there is a decision.
 <hr />
 
 
-### Bouncer::loadPaginatedBlocklistFromCache  
-
-**Description**
-
-```php
-public loadPaginatedBlocklistFromCache (void)
-```
-
-Browse the remediations cache. 
-
- 
-
-**Parameters**
-
-`This function has no parameters.`
-
-**Return Values**
-
-`void`
-
-
-<hr />
-
-
-### Bouncer::loadPaginatedLogs  
-
-**Description**
-
-```php
-public loadPaginatedLogs (void)
-```
-
-Browse the bouncer technical logs. 
-
- 
-
-**Parameters**
-
-`This function has no parameters.`
-
-**Return Values**
-
-`void`
-
-
-<hr />
-
-
 ### Bouncer::pruneCache  
 
 **Description**

docs/complete-guide.md

@@ -377,11 +377,11 @@ $fileHandler = new RotatingFileHandler(__DIR__.'/crowdsec.log', 0, Logger::WARNI
 $logger->pushHandler($fileHandler);
 
 // Instanciate the bouncer
-$bouncer = new Bouncer($logger);
+$bouncer = new Bouncer($cacheAdapter, $logger);
 $bouncer->configure([
     'api_key' => getenv('BOUNCER_KEY'),
     'api_url' => 'http://crowdsec:8080'
-    ], $cacheAdapter
+    ]
 );
 
 // Refresh the blocklist cache

docs/configuration-reference.md

@@ -30,6 +30,6 @@
        'cache_expiration_for_bad_ip'=> '20',
    ]
    $cacheAdapter = (...)
-   $bouncer = new Bouncer();
-   $bouncer->configure($config, $cacheAdapter);
+   $bouncer = new Bouncer($cacheAdapter);
+   $bouncer->configure($config);
 ```

docs/contribute.md

@@ -53,22 +53,23 @@ Full details here: https://github.com/github/super-linter/blob/master/docs/run-l
 docker-compose run --rm app vendor/bin/phpdoc-md
 ```
 
-## The git workflow we use
+### Git workflow cheat sheet
 
 We use the git workflow [Github Flow](https://guides.github.com/introduction/flow/).
 
-### Cheatsheet
-
 #### New feature
 
 ```bash
-git checkout -b new-feature # the name is not important now.
+git checkout -b <basic-name> # the name is not important now, you can type "new-features"
 git commit # as mush as necessary.
-git branch -m <name-of-the-branch> # to rename the branch to what has really be done
-git push -u origin <name-of-the-branch>
+docker-compose run --rm app vendor/bin/phpdoc-md # regenerate php doc
+git branch -m <name-of-the-branch> # to rename the branch to what has really be done.
+git push origin :<basic-name> && git push origin <name-of-the-branch> # Only if already pushed
 gh pr create --fill
 ```
 
+After the merge, don't forget to delete to branch.
+
 #### New release
 
 ```bash

examples/clear-cache.php

@@ -39,8 +39,8 @@
 $logger->pushHandler($fileHandler);
 
 // Instanciate the bouncer
-$bouncer = new Bouncer($logger);
-$bouncer->configure(['api_key' => $bouncerApiKey, 'api_url' => $apiUrl], $cacheAdapter);
+$bouncer = new Bouncer($cacheAdapter, $logger);
+$bouncer->configure(['api_key' => $bouncerApiKey, 'api_url' => $apiUrl]);
 
 // Clear the cache.
 $bouncer->clearCache();

examples/live-mode/full-example-live-mode.php

@@ -41,7 +41,7 @@
 $logger->pushHandler($fileHandler);
 
 // Instanciate the bouncer
-$bouncer = new Bouncer($logger);
+$bouncer = new Bouncer($cacheAdapter, $logger);
 $bouncer->configure([
     'api_key' => $bouncerApiKey,
     'api_url' => $apiUrl,
@@ -51,7 +51,7 @@
     'max_remediation_level' => 'ban',
     'cache_expiration_for_clean_ip' => 2,
     'cache_expiration_for_bad_ip' => 30
-], $cacheAdapter,);
+]);
 
 // Ask remediation to LAPI
 $remediation = $bouncer->getRemediationForIp($requestedIp);

src/ApiCache.php

@@ -43,17 +43,17 @@ class ApiCache
     /** @var bool */
     private $warmedUp;
 
-    public function __construct(ApiClient $apiClient = null, LoggerInterface $logger)
+    public function __construct(LoggerInterface $logger, ApiClient $apiClient = null, AbstractAdapter $adapter = null)
     {
         $this->logger = $logger;
         $this->apiClient = $apiClient ?: new ApiClient($logger);
+        $this->adapter = $adapter ?: new FilesystemAdapter();
     }
 
     /**
      * Configure this instance.
      */
     public function configure(
-        ?AbstractAdapter $adapter,
         bool $liveMode,
         string $apiUrl,
         int $timeout,
@@ -62,18 +62,16 @@ public function configure(
         int $cacheExpirationForCleanIp,
         int $cacheExpirationForBadIp
     ): void {
-        $adapter = $adapter ?: new FilesystemAdapter();
-        $this->adapter = $adapter;
         $this->liveMode = $liveMode;
         $this->cacheExpirationForCleanIp = $cacheExpirationForCleanIp;
         $this->cacheExpirationForBadIp = $cacheExpirationForBadIp;
         $cacheConfigItem = $this->adapter->getItem('cacheConfig');
         $cacheConfig = $cacheConfigItem->get();
-        $warmedUp = (is_array($cacheConfig) && isset($cacheConfig['warmed_up']) && $cacheConfig['warmed_up'] === true);
-        $this->warmedUp = $warmedUp;
+        $this->warmedUp = (is_array($cacheConfig) && isset($cacheConfig['warmed_up'])
+            && $cacheConfig['warmed_up'] === true);
         $this->logger->debug(null, [
             'type' => 'API_CACHE_INIT',
-            'adapter' => get_class($adapter),
+            'adapter' => get_class($this->adapter),
             'mode' => ($liveMode ? 'live' : 'stream'),
             'exp_clean_ips' => $cacheExpirationForCleanIp,
             'exp_bad_ips' => $cacheExpirationForBadIp,
@@ -174,21 +172,14 @@ private function removeDecisionFromRemediationItem(string $ip, int $decisionId):
 
     /**
      * Parse "duration" entries returned from API to a number of seconds.
-     *
-     * TODO P3 Test parseDurationToSeconds 
-     *   9999h59m56.603445s
-     *   10m33.3465483s
-     *   33.3465483s
-     *   -285.876962ms
-     *   33s'// should break!;
      */
     private static function parseDurationToSeconds(string $duration): int
     {
         $re = '/(-?)(?:(?:(\d+)h)?(\d+)m)?(\d+).\d+(m?)s/m';
         preg_match($re, $duration, $matches);
         if (!count($matches)) {
             throw new BouncerException("Unable to parse the following duration: ${$duration}.");
-        };
+        }
         $seconds = 0;
         if (isset($matches[2])) {
             $seconds += ((int) $matches[2]) * 3600; // hours
@@ -206,17 +197,14 @@ private static function parseDurationToSeconds(string $duration): int
             $seconds *= -1;
         }
 
-        $seconds = (int)round($seconds);
-        return $seconds;
+        return (int)round($seconds);
     }
 
 
 
     /**
      * Format a remediation item of a cache item.
      * This format use a minimal amount of data allowing less cache data consumption.
-     *
-     * TODO P3 test formatRemediationFromDecision
      */
     private function formatRemediationFromDecision(?array $decision): array
     {
@@ -361,8 +349,6 @@ public function warmUp(): int
      * Pull decisions updates from the API and update the cached remediations.
      * Used for the stream mode when we have to update the remediations list.
      * 
-     * TODO P2 test for overlapping decisions strategy (ex: max expires)
-     * 
      * @return array number of deleted and new decisions.
      * 
      */
@@ -419,15 +405,12 @@ private function miss(string $ip): string
     private function hit(string $ip): string
     {
         $remediations = $this->adapter->getItem($ip)->get();
-        // TODO P1 foreach $remediations, control if exp date is not expired.
-        // If true, update cache item by removing this expired remediation.
 
         // We apply array values first because keys are ids.
         $firstRemediation = array_values($remediations)[0];
-        /** @var string */
-        $firstRemediationString = $firstRemediation[0];
 
-        return $firstRemediationString;
+        /** @var string */
+        return $firstRemediation[0];
     }
 
     /**
@@ -463,16 +446,12 @@ public function get(string $ip): string
 
     public function prune(): bool
     {
-        $isPrunable = ($this->adapter instanceof PruneableInterface);
-        if (!$isPrunable) {
-            throw new BouncerException("Cache Adapter" . get_class($this->adapter) . " is not prunable.");
+        if ($this->adapter instanceof PruneableInterface) {
+            $pruned = $this->adapter->prune();
+            $this->logger->debug(null, ['type' => 'CACHE_PRUNED']);
+            return $pruned;
         }
-        /** @var PruneableInterface */
-        $adapter = $this->adapter;
-        $pruned = $adapter->prune();
-        $this->logger->debug(null, ['type' => 'CACHE_PRUNED']);
-
-        // TODO P3 Prune remediation inside cache items.
-        return $pruned;
+        
+        throw new BouncerException("Cache Adapter" . get_class($this->adapter) . " is not prunable.");
     }
 }

src/ApiClient.php

@@ -53,11 +53,7 @@ public function configure(string $baseUri, int $timeout, string $userAgent, stri
      */
     public function getFilteredDecisions(array $filter): array
     {
-        // TODO P1 filter results for scope=ip or scope=range (we can't do anything with other scopes)
-        $decisions = $this->restClient->request('/v1/decisions', $filter);
-        $decisions = $decisions ?: [];
-
-        return $decisions;
+        return $this->restClient->request('/v1/decisions', $filter) ?: [];
     }
 
     /**
@@ -66,10 +62,7 @@ public function getFilteredDecisions(array $filter): array
      */
     public function getStreamedDecisions(bool $startup = false): array
     {
-        // TODO P1 filter results for scope=ip or scope=range (we can't do anything with other scopes)
         /** @var array */
-        $decisionsDiff = $this->restClient->request('/v1/decisions/stream', $startup ? ['startup' => 'true'] : null);
-
-        return $decisionsDiff;
+        return $this->restClient->request('/v1/decisions/stream', $startup ? ['startup' => 'true'] : null);
     }
 }