adding "noSSL" config key and env var to enable http vs https determination

dcarbone · dcarbone · commit 31c7a1a107b0 · 2019-06-14T10:39:47.000-05:00
diff --git a/composer.json b/composer.json
@@ -11,6 +11,8 @@
   ],
   "require": {
     "php": ">=7.1",
+    "ext-json": "*",
+    "ext-curl": "*",
     "guzzlehttp/guzzle": "6.3.*",
     "psr/log": "1.*"
   },
diff --git a/files/constants.php b/files/constants.php
@@ -26,6 +26,7 @@
 
 // Attempt to load config from ENV if not otherwise defined
 const ENV_RGW_API_HTTP_ADDR = 'RGW_API_HTTP_ADDR';
+const ENV_RGW_API_NO_SSL = 'RGW_API_NO_SSL';
 const ENV_RGW_API_ADMIN_PATH = 'RGW_API_ADMIN_PATH';
 const ENV_RGW_API_KEY = 'RGW_API_KEY';
 const ENV_RGW_API_SECRET = 'RGW_API_SECRET';
diff --git a/files/funcs.php b/files/funcs.php
@@ -282,4 +282,44 @@ function tryGetEnvParam(string $param, string $default = ''): string
     } else {
         return $default;
     }
+}
+
+/**
+ * @param string $param
+ * @param string $default
+ * @return bool
+ */
+function tryGetBoolEnvParam(string $param, string $default = ''): bool
+{
+    $p = tryGetEnvParam($param, $default);
+    if ('' === $p) {
+        return false;
+    }
+
+    $p = strtolower($p);
+    if ('true' === $p) {
+        return true;
+    }
+    if ('false' === $p) {
+        return false;
+    }
+    if (ctype_digit($p)) {
+        return 0 < (int)$p;
+    }
+
+    return false;
+}
+
+/**
+ * @param string $param
+ * @param string $default
+ * @return int
+ */
+function tryGetIntEnvParam(string $param, string $default = ''): int
+{
+    $p = tryGetEnvParam($param, $default);
+    if (ctype_digit($p)) {
+        return (int)$p;
+    }
+    return 0;
 }
diff --git a/src/Client.php b/src/Client.php
@@ -140,6 +140,7 @@ private function compilePSR7(Request $r): RequestInterface
                 }
             }
             $uri = $uri->withQuery(implode('&', $params));
+            $this->config->getLogger()->debug(sprintf('Compiled URL: %s', $uri));
         }
         $psrRequest = new PSR7Request($r->method(), $uri, $r->headers(), $r->body());
         if ($r->authenticated()) {
@@ -155,7 +156,8 @@ private function serviceAddress(): string
     {
         if (!isset($this->address)) {
             $this->address = sprintf(
-                'https://%s/%s',
+                '%s://%s/%s',
+                $this->config->isNoSSL() ? 'http' : 'https',
                 $this->config->getAddress(),
                 $this->config->getAdminPath()
             );
diff --git a/src/Config.php b/src/Config.php
@@ -22,6 +22,15 @@ class Config implements LoggerAwareInterface
     const DEFAULT_CLIENT_TIMEOUT  = 10;
     const DEFAULT_SKIP_SSL_VERIFY = false;
 
+    const FIELD_CLIENT_TIMEOUT = 'clientTimeout';
+    const FIELD_ADDRESS        = 'address';
+    const FIELD_ADMIN_PATH     = 'adminPath';
+    const FIELD_API_KEY        = 'apiKey';
+    const FIELD_API_SECRET     = 'apiSecret';
+    const FIELD_NO_SSL         = 'noSSL';
+    const FIELD_HTTP_CLIENT    = 'httpClient';
+    const FIELD_SILENT         = 'silent';
+
     /** @var int */
     private $clientTimeout = self::DEFAULT_CLIENT_TIMEOUT;
     /** @var string */
@@ -32,6 +41,8 @@ class Config implements LoggerAwareInterface
     private $apiKey = '';
     /** @var string */
     private $apiSecret = '';
+    /** @var bool */
+    private $noSSL = false;
 
     /** @var \GuzzleHttp\ClientInterface */
     private $httpClient;
@@ -52,12 +63,29 @@ public function __construct(array $config = [], ClientInterface $httpClient = nu
             $logger = new NullLogger();
         }
         $this->setLogger($logger);
-        foreach ($config as $k => $v) {
-            $k = sanitizeName($k, '_', true);
-            if ('httpClient' === $k) {
-                $httpClient = $v;
+        foreach ($config + self::getConfigFromEnvironment() as $rawK => $v) {
+            $k = sanitizeName($rawK, '_', true);
+            if (self::FIELD_CLIENT_TIMEOUT === $k) {
+                $this->setClientTimeout($config[self::FIELD_CLIENT_TIMEOUT]);
+            } elseif (self::FIELD_ADDRESS === $k) {
+                $this->setAddress($config[self::FIELD_ADDRESS]);
+            } elseif (self::FIELD_ADMIN_PATH === $k) {
+                $this->setAdminPath($config[self::FIELD_ADMIN_PATH]);
+            } elseif (self::FIELD_API_KEY === $k) {
+                $this->setApiKey($config[self::FIELD_API_KEY]);
+            } elseif (self::FIELD_API_SECRET === $k) {
+                $this->setApiSecret($config[self::FIELD_API_SECRET]);
+            } elseif (self::FIELD_NO_SSL === $k) {
+                $this->setNoSSL($config[self::FIELD_NO_SSL]);
+            } elseif (self::FIELD_HTTP_CLIENT === $k) {
+                $httpClient = $config[self::FIELD_HTTP_CLIENT];
+            } elseif (self::FIELD_SILENT === $k) {
+                $this->setSilent($config[self::FIELD_SILENT]);
             } else {
-                $this->{'set' . ucfirst($k)}($v);
+                throw new \OutOfBoundsException(sprintf(
+                    'Unknown configuration key "%s" seen.',
+                    $rawK
+                ));
             }
         }
         if (null === $httpClient) {
@@ -77,10 +105,11 @@ public static function getEnvironmentConfig(): array
         $ret = [];
         foreach ([
                      ENV_RGW_API_HTTP_ADDR  => tryGetEnvParam(ENV_RGW_API_HTTP_ADDR, '127.0.0.1'),
+                     ENV_RGW_API_NO_SSL     => tryGetBoolEnvParam(ENV_RGW_API_NO_SSL, '0'),
                      ENV_RGW_API_ADMIN_PATH => tryGetEnvParam(ENV_RGW_API_ADMIN_PATH, 'admin'),
                      ENV_RGW_API_KEY        => tryGetEnvParam(ENV_RGW_API_KEY),
                      ENV_RGW_API_SECRET     => tryGetEnvParam(ENV_RGW_API_SECRET),
-                     ENV_RGW_LOG_SILENT     => tryGetEnvParam(ENV_RGW_LOG_SILENT, '0'),
+                     ENV_RGW_LOG_SILENT     => tryGetBoolEnvParam(ENV_RGW_LOG_SILENT, '0'),
                  ] as $k => $v) {
             if ('' !== $v) {
                 $ret[$k] = $v;
@@ -90,27 +119,37 @@ public static function getEnvironmentConfig(): array
     }
 
     /**
-     * @param \GuzzleHttp\Client|null $client
-     * @param null|\Psr\Log\LoggerInterface $logger
-     * @return \MyENA\RGW\Config
+     * @return array
      */
-    public static function defaultConfig(?GuzzleClient $client = null, ?LoggerInterface $logger = null): Config
+    public static function getConfigFromEnvironment(): array
     {
         $conf = [];
         foreach (self::getEnvironmentConfig() as $k => $v) {
             if (ENV_RGW_API_HTTP_ADDR === $k) {
-                $conf['address'] = $v;
+                $conf[self::FIELD_ADDRESS] = $v;
+            } elseif (ENV_RGW_API_NO_SSL === $k) {
+                $conf[self::FIELD_NO_SSL] = $v;
             } elseif (ENV_RGW_API_ADMIN_PATH === $k) {
-                $conf['adminPath'] = $v;
+                $conf[self::FIELD_ADMIN_PATH] = $v;
             } elseif (ENV_RGW_API_KEY === $k) {
-                $conf['apiKey'] = $v;
+                $conf[self::FIELD_API_KEY] = $v;
             } elseif (ENV_RGW_API_SECRET === $k) {
-                $conf['apiSecret'] = $v;
+                $conf[self::FIELD_API_SECRET] = $v;
             } elseif (ENV_RGW_LOG_SILENT === $k) {
-                $conf['silent'] = (bool)$v;
+                $conf[self::FIELD_SILENT] = $v;
             }
         }
-        return new static($conf, $client, $logger);
+        return $conf;
+    }
+
+    /**
+     * @param \GuzzleHttp\Client|null $client
+     * @param null|\Psr\Log\LoggerInterface $logger
+     * @return \MyENA\RGW\Config
+     */
+    public static function defaultConfig(?GuzzleClient $client = null, ?LoggerInterface $logger = null): Config
+    {
+        return new static(self::getConfigFromEnvironment(), $client, $logger);
     }
 
     /**
@@ -193,6 +232,22 @@ public function setApiSecret(string $apiSecret): void
         $this->apiSecret = $apiSecret;
     }
 
+    /**
+     * @return bool
+     */
+    public function isNoSSL(): bool
+    {
+        return $this->noSSL;
+    }
+
+    /**
+     * @param bool $noSSL
+     */
+    public function setNoSSL(bool $noSSL): void
+    {
+        $this->noSSL = $noSSL;
+    }
+
     /**
      * @return \GuzzleHttp\ClientInterface
      */
diff --git a/src/Models/MetadataBucketInstanceResponse.php b/src/Models/MetadataBucketInstanceResponse.php
@@ -6,12 +6,16 @@
  * @OA\Schema(
  *     schema="RGWMetadataBucketInstanceResponse",
  *     type="object",
- *     ref="$/definitions/RGWMetadataResponse",
- *     @OA\Property(
- *          property="data",
- *          type="object",
- *          ref="#/components/schemas/RGWMetadataBucketInstanceResponseData"
- *     )
+ *     allOf={
+ *          @OA\Schema(ref="#/components/schemas/RGWMetadataResponse"),
+ *          @OA\Schema(
+ *              @OA\Property(
+ *                  property="data",
+ *                  type="object",
+ *                  ref="#/components/schemas/RGWMetadataBucketInstanceResponseData"
+ *              )
+ *          )
+ *      }
  * )
  */
 
diff --git a/src/Models/MetadataBucketResponse.php b/src/Models/MetadataBucketResponse.php
@@ -6,12 +6,16 @@
  * @OA\Schema(
  *     schema="RGWMetadataBucketResponse",
  *     type="object",
- *     ref="$/definitions/RGWMetadataResponse",
- *     @OA\Property(
- *          property="data",
- *          type="object",
- *          ref="#/components/schemas/RGWMetadataBucketResponseData"
- *     )
+ *     allOf={
+ *          @OA\Schema(ref="#/components/schemas/RGWMetadataResponse"),
+ *          @OA\Schema(
+ *              @OA\Property(
+ *                  property="data",
+ *                  type="object",
+ *                  ref="#/components/schemas/RGWMetadataBucketResponseData"
+ *              )
+ *          )
+ *     }
  * )
  */
 
diff --git a/src/Models/MetadataUserInfo.php b/src/Models/MetadataUserInfo.php
@@ -6,48 +6,52 @@
  * @OA\Schema(
  *     schema="RGWMetadataUserInfo",
  *     type="object",
- *     ref="$/definitions/RGWUserInfo",
- *     @OA\Property(
- *          property="auid",
- *          type="integer"
- *     ),
- *     @OA\Property(
- *          property="op_mask",
- *          type="string"
- *     ),
- *     @OA\Property(
- *          property="default_placement",
- *          type="string"
- *     ),
- *     @OA\Property(
- *          property="placement_tags",
- *          type="array",
- *          @OA\Items(type="string"),
- *     ),
- *     @OA\Property(
- *          property="bucket_quota",
- *          type="object",
- *          ref="#/components/schemas/RGWQuotaMeta"
- *     ),
- *     @OA\Property(
- *          property="user_quota",
- *          type="object",
- *          ref="#/components/schemas/RGWQuotaMeta"
- *     ),
- *     @OA\Property(
- *          property="temp_url_keys",
- *          type="array",
- *          @OA\Items(type="string"),
- *     ),
- *     @OA\Property(
- *          property="type",
- *          type="string"
- *     ),
- *     @OA\Property(
- *          property="attrs",
- *          type="array",
- *          @OA\Items(ref="#/components/schemas/RGWMetadataAttribute")
- *     )
+ *     allOf={
+ *          @OA\Schema(ref="#/components/schemas/RGWUserInfo"),
+ *          @OA\Schema(
+ *              @OA\Property(
+ *                  property="auid",
+ *                  type="integer"
+ *              ),
+ *              @OA\Property(
+ *                  property="op_mask",
+ *                  type="string"
+ *               ),
+ *              @OA\Property(
+ *                  property="default_placement",
+ *                  type="string"
+ *              ),
+ *              @OA\Property(
+ *                  property="placement_tags",
+ *                  type="array",
+ *                  @OA\Items(type="string"),
+ *              ),
+ *              @OA\Property(
+ *                  property="bucket_quota",
+ *                  type="object",
+ *                  ref="#/components/schemas/RGWQuotaMeta"
+ *              ),
+ *              @OA\Property(
+ *                  property="user_quota",
+ *                  type="object",
+ *                  ref="#/components/schemas/RGWQuotaMeta"
+ *              ),
+ *              @OA\Property(
+ *                  property="temp_url_keys",
+ *                  type="array",
+ *                  @OA\Items(type="string"),
+ *              ),
+ *              @OA\Property(
+ *                  property="type",
+ *                  type="string"
+ *              ),
+ *              @OA\Property(
+ *                  property="attrs",
+ *                  type="array",
+ *                  @OA\Items(ref="#/components/schemas/RGWMetadataAttribute")
+ *              )
+ *          )
+ *     }
  * )
  */
 
diff --git a/src/Models/MetadataUserResponse.php b/src/Models/MetadataUserResponse.php
@@ -6,12 +6,16 @@
  * @OA\Schema(
  *     schema="RGWMetadataUserResponse",
  *     type="object",
- *     ref="$/definitions/RGWMetadataResponse",
- *     @OA\Property(
- *          property="data",
- *          type="object",
- *          ref="#/components/schemas/RGWMetadataUserInfo"
- *     )
+ *     allOf={
+ *          @OA\Schema(ref="#/components/schemas/RGWMetadataResponse"),
+ *          @OA\Schema(
+ *              @OA\Property(
+ *                  property="data",
+ *                  type="object",
+ *                  ref="#/components/schemas/RGWMetadataUserInfo"
+ *              )
+ *          )
+ *      }
  * )
  */
 
diff --git a/src/Validator/InstanceOfValidator.php b/src/Validator/InstanceOfValidator.php
@@ -46,6 +46,6 @@ public function test($value): bool
      */
     public function expectedStatement(): string
     {
-        return 'object that is an instance of '.$this->class;
+        return 'object that is an instance of ' . $this->class;
     }
 }
diff --git a/tests/OpenApiTest.php b/tests/OpenApiTest.php

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ private function compilePSR7(Request $r): RequestInterface`
`140`	`140`	`}`
`141`	`141`	`}`
`142`	`142`	`$uri = $uri->withQuery(implode('&', $params));`
	`143`	`+ $this->config->getLogger()->debug(sprintf('Compiled URL: %s', $uri));`
`143`	`144`	`}`
`144`	`145`	`$psrRequest = new PSR7Request($r->method(), $uri, $r->headers(), $r->body());`
`145`	`146`	`if ($r->authenticated()) {`
`@@ -155,7 +156,8 @@ private function serviceAddress(): string`
`155`	`156`	`{`
`156`	`157`	`if (!isset($this->address)) {`
`157`	`158`	`$this->address = sprintf(`
`158`		`- 'https://%s/%s',`
	`159`	`+ '%s://%s/%s',`
	`160`	`+ $this->config->isNoSSL() ? 'http' : 'https',`
`159`	`161`	`$this->config->getAddress(),`
`160`	`162`	`$this->config->getAdminPath()`
`161`	`163`	`);`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,6 @@ public function test($value): bool`
`46`	`46`	`*/`
`47`	`47`	`public function expectedStatement(): string`
`48`	`48`	`{`
`49`		`- return 'object that is an instance of '.$this->class;`
	`49`	`+ return 'object that is an instance of ' . $this->class;`
`50`	`50`	`}`
`51`	`51`	`}`