feat(*): Prepare release 0.23.0

Author: julienloizelet

CHANGELOG.md

@@ -5,6 +5,11 @@ 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.23.0] - 2022-07-07
+
+### Added
+- Add test configuration to mock IPs and proxy behavior
+
 ## [0.22.1] - 2022-06-03
 
 ### Fixed

src/ApiCache.php

@@ -398,7 +398,9 @@ private function saveRemediationsForCacheKey(array $decisions, string $cacheKey)
     /**
      * Cache key convention.
      *
-     * @throws Exception
+     * @param string $scope
+     * @param string $value
+     * @return string
      */
     private function getCacheKey(string $scope, string $value): string
     {
@@ -638,7 +640,7 @@ public function clear(): bool
      *
      * @return array "count": number of decisions added, "errors": decisions not added
      *
-     * @throws InvalidArgumentException
+     * @throws InvalidArgumentException|\Psr\Cache\CacheException
      */
     public function warmUp(): array
     {
@@ -968,7 +970,7 @@ private function getIpCachedVariables(string $cacheTag, string $ip)
      * @return array
      * @throws InvalidArgumentException
      */
-    public function getIpVariables($cacheTag, $names, $ip): array
+    public function getIpVariables(string $cacheTag, array $names, string $ip): array
     {
         $cachedVariables = $this->getIpCachedVariables($cacheTag, $ip);
         $variables = [];
@@ -998,13 +1000,7 @@ public function setIpVariables(string $cacheTag, array $pairs, string $ip)
         foreach ($pairs as $name => $value) {
             $cachedVariables[$name] = $value;
         }
-        $duration = (Constants::CACHE_TAG_CAPTCHA === $cacheTag)
-            ? $this->cacheExpirationForCaptcha : $this->cacheExpirationForGeo;
-        $item = $this->adapter->getItem(base64_encode($cacheKey));
-        $item->set($cachedVariables);
-        $item->expiresAt(new DateTime("+$duration seconds"));
-        $item->tag($cacheTag);
-        $this->adapter->save($item);
+        $this->saveCacheItem($cacheTag, $cacheKey, $cachedVariables);
     }
 
     /**
@@ -1024,6 +1020,19 @@ public function unsetIpVariables(string $cacheTag, array $pairs, string $ip)
         foreach ($pairs as $name => $value) {
             unset($cachedVariables[$name]);
         }
+        $this->saveCacheItem($cacheTag, $cacheKey, $cachedVariables);
+    }
+
+    /**
+     * @param string $cacheTag
+     * @param string $cacheKey
+     * @param $cachedVariables
+     * @return void
+     * @throws InvalidArgumentException
+     * @throws \Psr\Cache\CacheException
+     */
+    protected function saveCacheItem(string $cacheTag, string $cacheKey, $cachedVariables): void
+    {
         $duration = (Constants::CACHE_TAG_CAPTCHA === $cacheTag)
             ? $this->cacheExpirationForCaptcha : $this->cacheExpirationForGeo;
         $item = $this->adapter->getItem(base64_encode($cacheKey));

src/Constants.php

@@ -20,7 +20,7 @@ class Constants
     public const DEFAULT_LAPI_URL = 'http://localhost:8080';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.22.1';
+    public const VERSION = 'v0.23.0';
 
     /** @var string The user agent used to send request to LAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/' . self::VERSION;
@@ -97,6 +97,6 @@ class Constants
     /** @var string The Maxmind "City" database type */
     public const MAXMIND_CITY = 'city';
 
-    /** @var string The "disabled" bouncing level */
+    /** @var string The "disabled" x-forwarded-for setting */
     public const X_FORWARDED_DISABLED = 'no_forward';
 }