Merge pull request #6 from paysera/remove_config_whitelist

added ability to pass any configuration to the client without whitelisting

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.4.0
+### Added
+- Added ability to pass any configuration without whitelisting to the client
+### Removed
+- Removed `ConfigHandler::appendConfiguration`, instead options are appended with configurations in `ClientFactoryAbstract::createApiClient:65`
+
 ## 2.3.1
 ### Added
 - If request body contains JSON, `Content-Type: application/json` will be set

src/Authentication/AuthenticationProvider.php

@@ -5,6 +5,9 @@
 use Paysera\Component\RestClientCommon\Exception\AuthenticationConfigurationException;
 use Paysera\Component\RestClientCommon\Middleware\Authentication\AuthenticationMiddlewareInterface;
 
+/**
+ * @internal 
+ */
 class AuthenticationProvider
 {
     /**

src/Client/ApiClient.php

@@ -12,6 +12,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @api
+ */
 class ApiClient
 {
     private $client;

src/Decoder/ResponseBodyDecoder.php

@@ -6,6 +6,9 @@
 use Paysera\Component\RestClientCommon\Exception\UnsupportedContentTypeException;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal
+ */
 class ResponseBodyDecoder
 {
     /**

src/Decoder/ResponseDecoder/JsonResponseDecoder.php

@@ -4,6 +4,9 @@
 
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal 
+ */
 class JsonResponseDecoder implements ResponseDecoderInterface
 {
     public function decode(ResponseInterface $response)

src/Decoder/ResponseDecoder/ResponseDecoderInterface.php

@@ -4,6 +4,9 @@
 
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal
+ */
 interface ResponseDecoderInterface
 {
     /**

src/Entity/Entity.php

@@ -4,6 +4,9 @@
 
 use ArrayAccess;
 
+/**
+ * @api
+ */
 class Entity implements ArrayAccess
 {
     protected $data;

src/Entity/Filter.php

@@ -2,6 +2,9 @@
 
 namespace Paysera\Component\RestClientCommon\Entity;
 
+/**
+ * @api
+ */
 class Filter extends Entity
 {
     /**

src/Entity/Result.php

@@ -5,6 +5,9 @@
 use Countable;
 use Iterator;
 
+/**
+ * @api
+ */
 abstract class Result extends Entity implements Iterator, Countable
 {
     const METADATA_KEY = '_metadata';

src/Exception/AuthenticationConfigurationException.php

@@ -2,6 +2,9 @@
 
 namespace Paysera\Component\RestClientCommon\Exception;
 
+/**
+ * @api
+ */
 class AuthenticationConfigurationException extends \Exception
 {
 

src/Exception/ClientException.php

@@ -2,6 +2,9 @@
 
 namespace Paysera\Component\RestClientCommon\Exception;
 
+/**
+ * @api
+ */
 class ClientException extends RequestException
 {
 

src/Exception/ConfigurationException.php

@@ -4,6 +4,9 @@
 
 use Exception;
 
+/**
+ * @api
+ */
 class ConfigurationException extends Exception
 {
 

src/Exception/RequestException.php

@@ -7,6 +7,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @api
+ */
 class RequestException extends \Exception
 {
     private $request;

src/Exception/ServerException.php

@@ -2,6 +2,9 @@
 
 namespace Paysera\Component\RestClientCommon\Exception;
 
+/**
+ * @api
+ */
 class ServerException extends RequestException
 {
 

src/Exception/UnsupportedContentTypeException.php

@@ -2,6 +2,9 @@
 
 namespace Paysera\Component\RestClientCommon\Exception;
 
+/**
+ * @api
+ */
 class UnsupportedContentTypeException extends \Exception
 {
 

src/Middleware/Authentication/AuthenticationMiddlewareInterface.php

@@ -5,6 +5,9 @@
 use GuzzleHttp\Promise\PromiseInterface;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @api
+ */
 interface AuthenticationMiddlewareInterface
 {
     /**

src/Middleware/Authentication/BasicAuthentication.php

@@ -6,6 +6,9 @@
 use Paysera\Component\RestClientCommon\Util\ConfigHandler;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @internal
+ */
 class BasicAuthentication implements AuthenticationMiddlewareInterface
 {
     const TYPE = 'basic';

src/Middleware/Authentication/BearerAuthentication.php

@@ -6,6 +6,9 @@
 use Paysera\Component\RestClientCommon\Util\ConfigHandler;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @internal
+ */
 class BearerAuthentication implements AuthenticationMiddlewareInterface
 {
     const TYPE = 'bearer';

src/Middleware/Authentication/ClientCertificateAuthentication.php

@@ -7,6 +7,9 @@
 use Paysera\Component\RestClientCommon\Util\ConfigHandler;
 use Paysera\Component\RestClientCommon\Exception\AuthenticationConfigurationException;
 
+/**
+ * @internal
+ */
 class ClientCertificateAuthentication implements AuthenticationMiddlewareInterface
 {
     const TYPE = 'client_certificate';

src/Middleware/Authentication/MacAuthentication.php

@@ -7,6 +7,9 @@
 use Paysera\Component\RestClientCommon\Util\ConfigHandler;
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * @internal
+ */
 class MacAuthentication implements AuthenticationMiddlewareInterface
 {
     const TYPE = 'mac';

src/Middleware/Authentication/OAuthAuthentication.php

@@ -12,6 +12,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal
+ */
 class OAuthAuthentication implements AuthenticationMiddlewareInterface
 {
     const TYPE = 'oauth';

src/Middleware/Exception/RequestExceptionMiddleware.php

@@ -8,6 +8,9 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
+/**
+ * @internal
+ */
 class RequestExceptionMiddleware
 {
     public function __invoke(callable $nextHandler, RequestInterface $request, array $options)

src/Util/ClientFactoryAbstract.php

@@ -16,6 +16,9 @@
 use Paysera\Component\RestClientCommon\Client\ApiClient;
 use Paysera\Component\RestClientCommon\Middleware\Exception\RequestExceptionMiddleware;
 
+/**
+ * @api
+ */
 abstract class ClientFactoryAbstract
 {
     const DEFAULT_BASE_URL = '';
@@ -62,7 +65,7 @@ public function createApiClient(array $options)
             }
         }
 
-        ConfigHandler::appendConfiguration($config, $options);
+        $config = array_merge($config, $options);
 
         return $this->buildClient($baseUrl, $authBaseUrl, $config, $options);
     }

src/Util/ConfigHandler.php

@@ -2,17 +2,14 @@
 
 namespace Paysera\Component\RestClientCommon\Util;
 
+/**
+ * @internal 
+ */
 class ConfigHandler
 {
     const CONFIG_NAMESPACE = 'paysera';
     const KEY_AUTHENTICATION = 'authentication';
 
-    private static $whitelistedConfiguration = [
-        'proxy',
-        'cookies',
-        'headers',
-    ];
-
     /**
      * @param array $config
      * @param string $parameter
@@ -46,17 +43,4 @@ public static function setAuthentication(array &$config, array $auth)
     {
         $config[self::CONFIG_NAMESPACE][self::KEY_AUTHENTICATION] = $auth;
     }
-
-    public static function appendConfiguration(array &$config, array $options)
-    {
-        $optionsToAppend = [];
-
-        foreach ($options as $option => $value) {
-            if (in_array($option, self::$whitelistedConfiguration, true)) {
-                $optionsToAppend[$option] = $value;
-            }
-        }
-
-        $config = array_merge($config, $optionsToAppend);
-    }
 }