Feature data ingest

src/module-elasticsuite-core/Api/Client/ClientFactoryInterface.php

@@ -20,6 +20,8 @@
  * @category Smile_Elasticsuite
  * @package  Smile\ElasticsuiteCore
  * @author   Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ *
+ * @deprecated Use Smile\ElasticsuiteCore\Api\Client\ClientInterface instead.
  */
 interface ClientFactoryInterface
 {

src/module-elasticsuite-core/Api/Client/ClientInterface.php

@@ -0,0 +1,162 @@
+<?php
+/**
+ * DISCLAIMER :
+ *
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile_Elasticsuite
+ * @package   Smile\ElasticsuiteCore
+ * @author    Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ * @copyright 2016 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCore\Api\Client;
+
+/**
+ * ElasticSearch injectable client.
+ *
+ * @category Smile_Elasticsuite
+ * @package  Smile\ElasticsuiteCore
+ * @author   Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ */
+interface ClientInterface
+{
+    /**
+     * Returns server information.
+     *
+     * @return array
+     */
+    public function info();
+
+    /**
+     * Try to connect the server and returns :
+     * - true if succeed
+     * - false if failed
+     *
+     * @return boolean
+     */
+    public function ping();
+
+    /**
+     * Create an index.
+     *
+     * @param string $indexName     Index name.
+     * @param array  $indexSettings Index settings.
+     *
+     * @return void
+     */
+    public function createIndex($indexName, $indexSettings);
+
+    /**
+     * Delete an index.
+     *
+     * @param string $indexName Index name.
+     *
+     * @return void
+     */
+    public function deleteIndex($indexName);
+
+    /**
+     * Check if an index exists.
+     *
+     * @param string $indexName Index name.
+     *
+     * @return boolean
+     */
+    public function indexExists($indexName);
+
+    /**
+     * Update index settings.
+     *
+     * @param string $indexName     Index name.
+     * @param array  $indexSettings Index settings.
+     *
+     * @return void
+     */
+    public function putIndexSettings($indexName, $indexSettings);
+
+    /**
+     * Update index mapping.
+     *
+     * @param string $indexName Index name.
+     * @param string $type      Type.
+     * @param array  $mapping   Mapping definition.
+     *
+     * @return void
+     */
+    public function putMapping($indexName, $type, $mapping);
+
+    /**
+     * Optimize an index (force segment merging).
+     *
+     * @param string $indexName Index name.
+     *
+     * @return void
+     */
+    public function forceMerge($indexName);
+
+    /**
+     * Force index refresh.
+     *
+     * @param string $indexName Index name.
+     *
+     * @return void
+     */
+    public function refreshIndex($indexName);
+
+    /**
+     * Retrieve the list of all index having a specified alias.
+     *
+     * @param string $indexAlias Index alias.
+     *
+     * @return string[]
+     */
+    public function getIndicesNameByAlias($indexAlias);
+
+    /**
+     * Update alias definition.
+     *
+     * @param array $aliasActions Alias actions.
+     *
+     * @return void
+     */
+    public function updateAliases($aliasActions);
+
+    /**
+     * Run a bulk request.
+     *
+     * @param array $bulkParams Bulk data.
+     *
+     * return array
+     */
+    public function bulk($bulkParams);
+
+    /**
+     * Run a search request.
+     *
+     * @param array $params Search request params.
+     *
+     * @return array
+     */
+    public function search($params);
+
+    /**
+     * Returns index stats.
+     *
+     * @param string $indexName Index name.
+     *
+     * @return array
+     */
+    public function indexStats($indexName);
+
+    /**
+     * Run a termvectors request.
+     *
+     * @param array $params Term vectors request params.
+     *
+     * @return array
+     */
+    public function termvectors($params);
+}

src/module-elasticsuite-core/Client/Client.php

@@ -0,0 +1,171 @@
+<?php
+/**
+ * DISCLAIMER :
+ *
+ * Do not edit or add to this file if you wish to upgrade Smile Elastic Suite to newer
+ * versions in the future.
+ *
+ * @category  Smile_Elasticsuite
+ * @package   Smile\ElasticsuiteCore
+ * @author    Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ * @copyright 2016 Smile
+ * @license   Open Software License ("OSL") v. 3.0
+ */
+
+namespace Smile\ElasticsuiteCore\Client;
+
+use Smile\ElasticsuiteCore\Api\Client\ClientInterface;
+
+/**
+ * ElasticSearch client implementation.
+ *
+ * @category  Smile
+ * @package   Smile\ElasticsuiteCore
+ * @author    Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ *
+ * @SuppressWarnings(TooManyPublicMethods)
+ */
+class Client implements ClientInterface
+{
+    /**
+     * @var \Elasticsearch\Client
+     */
+    private $esClient;
+
+    /**
+     * Constructor.
+     *
+     * @param ClientFactory $esClientFactory ElasticSearch client factory.
+     */
+    public function __construct(ClientFactory $esClientFactory)
+    {
+        $this->esClient = $esClientFactory->createClient();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function info()
+    {
+        return $this->esClient->info();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function ping()
+    {
+        return $this->esClient->ping();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function createIndex($indexName, $indexSettings)
+    {
+        $this->esClient->indices()->create(['index' => $indexName, 'body' => $indexSettings]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function deleteIndex($indexName)
+    {
+        $this->esClient->indices()->delete(['index' => $indexName]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function indexExists($indexName)
+    {
+        return $this->esClient->indices()->exists(['index' => $indexName]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function putIndexSettings($indexName, $indexSettings)
+    {
+        $this->esClient->indices()->putSettings(['index' => $indexName, 'body' => $indexSettings]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function putMapping($indexName, $type, $mapping)
+    {
+        $this->esClient->indices()->putMapping(['index' => $indexName, 'type'  => $type, 'body'  => [$type => $mapping]]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function forceMerge($indexName)
+    {
+        $this->esClient->indices()->forceMerge(['index' => $indexName]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function refreshIndex($indexName)
+    {
+        $this->esClient->indices()->refresh(['index' => $indexName]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getIndicesNameByAlias($indexAlias)
+    {
+        $indices = [];
+        try {
+            $indices = $this->esClient->indices()->getMapping(['index' => $indexAlias]);
+        } catch (\Elasticsearch\Common\Exceptions\Missing404Exception $e) {
+            ;
+        }
+
+        return array_keys($indices);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function updateAliases($aliasActions)
+    {
+        $this->esClient->indices()->updateAliases(['body' => ['actions' => $aliasActions]]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function bulk($bulkParams)
+    {
+        return $this->esClient->bulk($bulkParams);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function search($params)
+    {
+        return $this->esClient->search($params);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function indexStats($indexName)
+    {
+        return $this->esClient->indices()->stats(['index' => $indexName]);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function termvectors($params)
+    {
+        return $this->esClient->termvectors($params);
+    }
+}

src/module-elasticsuite-core/Client/ClientFactory.php

@@ -22,6 +22,8 @@
  * @category  Smile
  * @package   Smile\ElasticsuiteCore
  * @author    Aurelien FOUCRET <aurelien.foucret@smile.fr>
+ *
+ * @deprecated Use Smile\ElasticsuiteCore\Api\Client\ClientInterface instead.
  */
 class ClientFactory implements ClientFactoryInterface
 {

src/module-elasticsuite-core/Cluster/ClusterInfo.php

@@ -26,7 +26,7 @@
 class ClusterInfo implements ClusterInfoInterface
 {
     /**
-     * @var \Elasticsearch\Client
+     * @var \Smile\ElasticsuiteCore\Api\Client\ClientInterface
      */
     private $client;
 
@@ -38,11 +38,11 @@ class ClusterInfo implements ClusterInfoInterface
     /**
      * Constructor.
      *
-     * @param \Smile\ElasticsuiteCore\Api\Client\ClientFactoryInterface $clientFactory ElasticSearch client factory.
+     * @param \Smile\ElasticsuiteCore\Api\Client\ClientInterface $client ElasticSearch client.
      */
-    public function __construct(\Smile\ElasticsuiteCore\Api\Client\ClientFactoryInterface $clientFactory)
+    public function __construct(\Smile\ElasticsuiteCore\Api\Client\ClientInterface $client)
     {
-        $this->client = $clientFactory->createClient();
+        $this->client = $client;
     }
 
     /**