support for basic auth and api key in combi with cloud id

Author: philkra

docs/configuration.asciidoc

@@ -94,34 +94,22 @@ If you want to connect to Elastic Cloud, you can use your Cloud ID and use basic
 
 [source,php]
 ----
-use Elasticsearch\Helper\ElasticCloudHelper;
-
-$cloud = new ElasticCloudHelper('elastic-cloud-id'); <1>
-$cloud->setBasicAuthentication('username', 'secure-password'); <2>
-
 $client = ClientBuilder::create()
-            ->setHosts($cloud->getHost()) <3>
-            ->setElasticCloudConnectionParams() <4>
-            ->build(); 
+            ->setElasticCloudId('<elastic-cloud-id>', '<username>', '<secure-password>') <1>, <2>
+            ->build();
 ----
 <1> Your Cloud ID provided by the Elastic Cloud platform
 <2> Your basic authentication credentials
-<3> Let the `ElasticCloudHelper` unwrap the Cloud ID to a hostname
-<3> Activate the best practises for communicating with Elastic Cloud
 
 [source,php]
 ----
-use Elasticsearch\Helper\ElasticCloudHelper;
-
-$cloud = new ElasticCloudHelper('elastic-cloud-id');
-
 $client = ClientBuilder::create()
-            ->setHosts($cloud->getHost())
-            ->setElasticCloudConnectionParams()
-            ->setApiKeyPairAuthentication('id', 'api_key') <1>
-            ->build(); 
+            ->setElasticCloudId('<elastic-cloud-id>') <1>
+            ->setApiKeyPairAuthentication('<id>', '<api_key>') <2>
+            ->build();
 ----
-<1> Your ApiKey pair as described https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/security.html[here]
+<1> Your Cloud ID provided by the Elastic Cloud platform
+<2> Your ApiKey pair as described https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/security.html[here]
 
 === Authorization and Encryption
 

src/Elasticsearch/ClientBuilder.php

@@ -17,6 +17,7 @@
 use Elasticsearch\Serializers\SerializerInterface;
 use Elasticsearch\ConnectionPool\Selectors;
 use Elasticsearch\Serializers\SmartSerializer;
+use Elasticsearch\Helper\ElasticCloudIdParser;
 use GuzzleHttp\Ring\Client\CurlHandler;
 use GuzzleHttp\Ring\Client\CurlMultiHandler;
 use GuzzleHttp\Ring\Client\Middleware;
@@ -372,23 +373,43 @@ public function setConnectionParams(array $params): ClientBuilder
     }
 
     /**
-     * Set Elastic Cloud's best Practices Connection Parameters
+     * Set Elastic Cloud ID to connect to Elastic Cloud
      * 
-     * <i>Add custom/additional Params as parameter</i>
+     * <b>No authentication is provided</b>
      * 
-     * @param array $additional
+     * - set Hostname
+     * - set best practices for the connection
+     * 
+     * @param string $cloudId
+     * @param string $username, optional if using Basic Authentication
+     * @param string $password, optional if using Basic Authentication
+     * 
+     * @throws Elasticsearch\Common\Exceptions\ElasticCloudIdParseException
      */
-    public function setElasticCloudConnectionParams(array $additional = [])
+    public function setElasticCloudId(string $cloudId, ?string $username = null, ?string $password = null)
     {
-        $this->setConnectionParams(
+        $cloud = new ElasticCloudIdParser($cloudId);
+        $hosts = [
             [
-                'client' => [
-                    'curl' => [
-                        CURLOPT_ENCODING => 1,
-                    ],
-                ]
-            ] + $additional
-        );
+                'host'   => $cloud->getClusterDns(),
+                'port'   => '',
+                'scheme' => 'https',
+                'user'   => $username,
+                'pass'   => $password,
+            ]
+        ];
+
+        // Register the Hosts array
+        $this->setHosts($hosts);
+
+        // Merge best practices for the connection
+        $this->setConnectionParams([
+            'client' => [
+                'curl' => [
+                    CURLOPT_ENCODING => 1,
+                ],
+            ]
+        ]);
 
         return $this;
     }

src/Elasticsearch/Helper/ElasticCloudHelper.php renamed to src/Elasticsearch/Helper/ElasticCloudIdParser.php

@@ -9,15 +9,15 @@
 use Elasticsearch\Common\Exceptions\ElasticCloudIdParseException;
 
 /**
- * Class ElasticCloudHelper
+ * Class ElasticCloudIdParser
  *
  * @category Elasticsearch
  * @package  Elasticsearch\Helper
  * @author   Philip Krauss <[email protected]>
  * @license  http://www.apache.org/licenses/LICENSE-2.0 Apache2
  * @link     http://elastic.co
  */
-class ElasticCloudHelper
+class ElasticCloudIdParser
 {
 
     /**
@@ -35,11 +35,6 @@ class ElasticCloudHelper
      */
     private $clusterDns;
 
-    /**
-     * @var array
-     */
-    private $basicAuth = [];
-
     /**
      * @param string $cloudId
      */
@@ -79,40 +74,6 @@ public function getClusterDns(): string
         return $this->clusterDns;
     }
 
-    /**
-     * Get Elastic Cloud Host Array
-     * 
-     * @link https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/configuration.html#_extended_host_configuration
-     * 
-     * @return array
-     */
-    public function getHost(): array
-    {
-        return [ 
-            [
-                'host'   => $this->clusterDns,
-                'port'   => '',
-                'scheme' => 'https',
-            ] + $this->basicAuth
-        ];
-    }
-
-    /**
-     * Set the Basic Authentication Credentials
-     * 
-     * @param string $username
-     * @param string $password
-     * 
-     * @return void
-     */
-    public function setBasicAuthentication(string $username, string $password): void
-    {
-        $this->basicAuth = [
-            'user' => $username, 
-            'pass' => $password,
-        ];
-    }
-
     /**
      * Parse the Elastic Cloud Params from the CloudId
      *