HC-1363: Configuration setting changes

Api/Data/HawkSearchFieldInterface.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -67,9 +67,9 @@ interface HawkSearchFieldInterface
     /**#@-*/
 
     /**
-     * @return string
+     * @return int
      */
-    public function getFieldId() : string;
+    public function getFieldId() : int;
 
     /**
      * @param string $value

Gateway/Config/ApiConfigInterface.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -20,14 +20,16 @@ interface ApiConfigInterface
     /**
      * Returns API url
      *
+     * @param null|int|string $store
      * @return string
      */
-    public function getApiUrl(): string;
+    public function getApiUrl($store = null): string;
 
     /**
      * Returns API Bearer connection token
      *
+     * @param null|int|string $store
      * @return string
      */
-    public function getApiKey(): string;
+    public function getApiKey($store = null): string;
 }

Gateway/Config/DashboardApiConfig.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -20,8 +20,8 @@ class DashboardApiConfig extends SharedApiKeyConfig
     /**
      * @inheritDoc
      */
-    public function getApiUrl(): string
+    public function getApiUrl($store = null): string
     {
-        return $this->apiSettingsProvider->getDashboardApiUrl();
+        return $this->apiSettingsProvider->getDashboardApiUrl($store);
     }
 }

Gateway/Config/IndexingApiConfig.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -20,8 +20,8 @@ class IndexingApiConfig extends SharedApiKeyConfig
     /**
      * @inheritDoc
      */
-    public function getApiUrl(): string
+    public function getApiUrl($store = null): string
     {
-        return $this->apiSettingsProvider->getIndexingApiUrl();
+        return $this->apiSettingsProvider->getIndexingApiUrl($store);
     }
 }

Gateway/Config/SearchApiConfig.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -20,8 +20,8 @@ class SearchApiConfig extends SharedApiKeyConfig
     /**
      * @inheritDoc
      */
-    public function getApiUrl(): string
+    public function getApiUrl($store = null): string
     {
-        return $this->apiSettingsProvider->getSearchApiUrl();
+        return $this->apiSettingsProvider->getSearchApiUrl($store);
     }
 }

Gateway/Config/SharedApiKeyConfig.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -37,16 +37,16 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function getApiUrl(): string
+    public function getApiUrl($store = null): string
     {
         return '';
     }
 
     /**
      * @inheritDoc
      */
-    public function getApiKey(): string
+    public function getApiKey($store = null): string
     {
-        return $this->apiSettingsProvider->getApiKey();
+        return $this->apiSettingsProvider->getApiKey($store);
     }
 }

Gateway/Http/TransferFactory.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -20,6 +20,7 @@
 use HawkSearch\Connector\Gateway\Http\Uri\UriBuilderInterface;
 use HawkSearch\Connector\Gateway\Request\BuilderInterface;
 use HawkSearch\Connector\Gateway\Request\BuilderInterfaceFactory;
+use HawkSearch\Connector\Model\ConnectionScopeResolver;
 use Magento\Framework\App\RequestInterface;
 
 class TransferFactory implements TransferFactoryInterface
@@ -59,6 +60,11 @@ class TransferFactory implements TransferFactoryInterface
      */
     private $httpRequest;
 
+    /**
+     * @var ConnectionScopeResolver
+     */
+    private ConnectionScopeResolver $connectionScopeResolver;
+
     /**
      * @param TransferBuilder $transferBuilder
      * @param ApiConfigInterface $apiConfig
@@ -75,6 +81,7 @@ public function __construct(
         RequestInterface $httpRequest,
         UriBuilderFactory $uriBuilderFactory,
         BuilderInterfaceFactory $builderInterfaceFactory,
+        ConnectionScopeResolver $connectionScopeResolver,
         $path = '',
         $method = 'GET',
         BuilderInterface $headersBuilder = null,
@@ -87,6 +94,7 @@ public function __construct(
         $this->method = $method;
         $this->headersBuilder = $headersBuilder ?? $builderInterfaceFactory->create();
         $this->uriBuilder = $uriBuilder ?? $uriBuilderFactory->create();
+        $this->connectionScopeResolver = $connectionScopeResolver;
     }
 
     /**
@@ -117,6 +125,9 @@ public function create(array $request)
      */
     private function buildFullApiUrl()
     {
-        return $this->uriBuilder->build($this->apiConfig->getApiUrl(), $this->path);
+        return $this->uriBuilder->build(
+            $this->apiConfig->getApiUrl($this->connectionScopeResolver->resolve()->getId()),
+            $this->path
+        );
     }
 }

Gateway/Request/ApiKeyAuthHeader.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -15,6 +15,7 @@
 namespace HawkSearch\Connector\Gateway\Request;
 
 use HawkSearch\Connector\Gateway\Config\ApiConfigInterface;
+use HawkSearch\Connector\Model\ConnectionScopeResolver;
 
 class ApiKeyAuthHeader implements BuilderInterface
 {
@@ -23,14 +24,23 @@ class ApiKeyAuthHeader implements BuilderInterface
      */
     private $apiConfig;
 
+    /**
+     * @var ConnectionScopeResolver
+     */
+    private ConnectionScopeResolver $connectionScopeResolver;
+
     /**
      * HawkGetHeaders constructor.
+     *
      * @param ApiConfigInterface $apiConfig
+     * @param ConnectionScopeResolver $connectionScopeResolver
      */
     public function __construct(
-        ApiConfigInterface $apiConfig
+        ApiConfigInterface $apiConfig,
+        ConnectionScopeResolver $connectionScopeResolver
     ) {
         $this->apiConfig = $apiConfig;
+        $this->connectionScopeResolver = $connectionScopeResolver;
     }
 
     /**
@@ -40,7 +50,7 @@ public function __construct(
     public function build(array $buildSubject)
     {
         return [
-            'X-HawkSearch-ApiKey' => $this->apiConfig->getApiKey()
+            'X-HawkSearch-ApiKey' => $this->apiConfig->getApiKey($this->connectionScopeResolver->resolve()->getId())
         ];
     }
 }

Model/ConnectionScopeResolver.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * Copyright (c) 2021 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+declare(strict_types=1);
+
+namespace HawkSearch\Connector\Model;
+
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Api\Data\StoreInterface;
+use Magento\Store\Model\Store;
+use Magento\Store\Model\StoreManagerInterface;
+
+class ConnectionScopeResolver
+{
+    /**
+     * @var RequestInterface
+     */
+    private $request;
+
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * ConfigurationStoreViewResolver constructor.
+     * @param RequestInterface $request
+     * @param StoreManagerInterface $storeManager
+     */
+    public function __construct(
+        RequestInterface $request,
+        StoreManagerInterface $storeManager
+    ) {
+        $this->request = $request;
+        $this->storeManager = $storeManager;
+    }
+
+    /**
+     * Resolve store depending on Application area
+     *
+     * @return StoreInterface
+     * @throws NoSuchEntityException
+     */
+    public function resolve()
+    {
+        $storeId = $this->isBackendSystemConfigController()
+            ? $this->request->getParam('store', Store::DEFAULT_STORE_ID)
+            : null;
+
+        return $this->storeManager->getStore($storeId);
+    }
+
+    /**
+     * Get controller key
+     *
+     * @return string
+     */
+    protected function getControllerKey()
+    {
+        return $this->request->getRouteName() . '_' . $this->request->getControllerName();
+    }
+
+    /**
+     * Check if current controller is in System Configuration
+     *
+     * @return bool
+     */
+    protected function isBackendSystemConfigController()
+    {
+        return $this->getControllerKey() === 'adminhtml_system_config';
+    }
+}

Model/HawkSearchField.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 Hawksearch (www.hawksearch.com) - All Rights Reserved
+ * Copyright (c) 2023 Hawksearch (www.hawksearch.com) - All Rights Reserved
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
@@ -68,11 +68,11 @@ public function __construct(
     }
 
     /**
-     * @return string
+     * @return int
      */
-    public function getFieldId(): string
+    public function getFieldId(): int
     {
-        return $this->getData(static::FIELD_ID);
+        return (int)$this->getData(static::FIELD_ID);
     }
 
     /**