Provides Virtual Hosting of Buckets (#630)

* Provides Virtual Hosting of Buckets

* Merge S3Configuration with Configuration

* Fix SimpleS3 test

* Rename pathStyleEndpoint

* Improve doc and changelog

* Fix FlySystem tests

Author: jderusse

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Add a `PsrCacheProvider` and `SymfonyCacheProvider` to persists crendentials in a cache pool
 - Add a `Credential::adjustExpireDate` method for adjusting the time according to the time difference with AWS clock
 - Support for global and regional endpoints
+- Add a `Configuration::optionExists` to allow third parties to check if an option is available (needed by libraries supporting several versions of core)
 
 ### Deprecation
 

src/AbstractApi.php

@@ -189,7 +189,7 @@ protected function getEndpointMetadata(?string $region): array
      * @param array   $query  parameters that should go in the query string
      * @param ?string $region region provided by the user in the `@region` parameter of the Input
      */
-    private function getEndpoint(string $uri, array $query, ?string $region): string
+    protected function getEndpoint(string $uri, array $query, ?string $region): string
     {
         /** @var string $region */
         $region = $region ?? $this->configuration->isDefault('region') ? null : $this->configuration->get('region');

src/Configuration.php

@@ -29,6 +29,9 @@ final class Configuration
     public const OPTION_ROLE_SESSION_NAME = 'roleSessionName';
     public const OPTION_CONTAINER_CREDENTIALS_RELATIVE_URI = 'containerCredentialsRelativeUri';
 
+    // S3 specific option
+    public const OPTION_PATH_STYLE_ENDPOINT = 'pathStyleEndpoint';
+
     private const AVAILABLE_OPTIONS = [
         self::OPTION_REGION => true,
         self::OPTION_PROFILE => true,
@@ -42,6 +45,7 @@ final class Configuration
         self::OPTION_WEB_IDENTITY_TOKEN_FILE => true,
         self::OPTION_ROLE_SESSION_NAME => true,
         self::OPTION_CONTAINER_CREDENTIALS_RELATIVE_URI => true,
+        self::OPTION_PATH_STYLE_ENDPOINT => true,
     ];
 
     // Put fallback options into groups to avoid mixing of provided config and environment variables
@@ -70,6 +74,7 @@ final class Configuration
         self::OPTION_SHARED_CONFIG_FILE => '~/.aws/config',
         // https://docs.aws.amazon.com/general/latest/gr/rande.html
         self::OPTION_ENDPOINT => 'https://%service%.%region%.amazonaws.com',
+        self::OPTION_PATH_STYLE_ENDPOINT => 'false',
     ];
 
     private $data = [];
@@ -82,6 +87,10 @@ public static function create(array $options)
             throw new InvalidArgument(\sprintf('Invalid option(s) "%s" passed to "%s::%s". ', \implode('", "', \array_keys($invalidOptions)), __CLASS__, __METHOD__));
         }
 
+        $options = \array_map(static function ($value) {
+            return null !== $value ? (string) $value : $value;
+        }, $options);
+
         foreach (self::FALLBACK_OPTIONS as $fallbackGroup) {
             // prevent mixing env variables with config keys
             foreach ($fallbackGroup as $option => $envVariableNames) {
@@ -123,6 +132,11 @@ public static function create(array $options)
         return $configuration;
     }
 
+    public static function optionExists(string $optionName): bool
+    {
+        return isset(self::AVAILABLE_OPTIONS[$optionName]);
+    }
+
     public function get(string $name): ?string
     {
         if (!isset(self::AVAILABLE_OPTIONS[$name])) {

tests/Unit/ConfigurationTest.php

@@ -76,5 +76,7 @@ public function provideConfiguration(): iterable
         yield 'config with env group 2' => [['accessKeySecret' => 'secret'], [], ['accessKeySecret' => 'secret', 'accessKeyId' => null, 'sessionToken' => null]];
         yield 'mix config and env' => [['accessKeyId' => 'key'], ['AWS_SESSION_TOKEN' => 'token'], ['accessKeyId' => 'key', 'sessionToken' => null]];
         yield 'null config with env group' => [['accessKeyId' => null], ['AWS_SESSION_TOKEN' => 'token'], ['accessKeyId' => null, 'sessionToken' => 'token']];
+
+        yield 'boolean value' => [['pathStyleEndpoint' => true], [], ['pathStyleEndpoint' => '1']];
     }
 }