first commit

modules/ps_accounts/classes/Api/Client/FirebaseClient.php

@@ -0,0 +1,120 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+namespace PrestaShop\Module\PsAccounts\Api\Client;
+
+use GuzzleHttp\Client;
+use PrestaShop\Module\PsAccounts\Configuration\ConfigOptionsResolver;
+use PrestaShop\Module\PsAccounts\Exception\OptionResolutionException;
+
+/**
+ * Handle firebase signIn/signUp.
+ */
+class FirebaseClient extends GenericClient
+{
+    /**
+     * Firebase api key.
+     *
+     * @var string
+     */
+    protected $apiKey;
+
+    /**
+     * FirebaseClient constructor.
+     *
+     * @param array $config
+     *
+     * @throws OptionResolutionException
+     */
+    public function __construct(array $config)
+    {
+        parent::__construct();
+
+        $config = $this->resolveConfig($config);
+
+        $client = new Client([
+            'defaults' => [
+                'timeout' => $this->timeout,
+                'exceptions' => $this->catchExceptions,
+                'allow_redirects' => false,
+                'query' => [
+                    'key' => $config['api_key'],
+                ],
+                'headers' => [
+                    'Accept' => 'application/json',
+                    'Content-Type' => 'application/json',
+                ],
+            ],
+        ]);
+
+        $this->setClient($client);
+    }
+
+    /**
+     * @param string $customToken
+     *
+     * @return array response
+     */
+    public function signInWithCustomToken($customToken)
+    {
+        $this->setRoute('https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken');
+
+        return $this->post([
+            'json' => [
+                'token' => $customToken,
+                'returnSecureToken' => true,
+            ],
+        ]);
+    }
+
+    /**
+     * @see https://firebase.google.com/docs/reference/rest/auth#section-refresh-token Firebase documentation
+     *
+     * @param string $refreshToken
+     *
+     * @return array response
+     */
+    public function exchangeRefreshTokenForIdToken($refreshToken)
+    {
+        $this->setRoute('https://securetoken.googleapis.com/v1/token');
+
+        return $this->post([
+            'json' => [
+                'grant_type' => 'refresh_token',
+                'refresh_token' => $refreshToken,
+            ],
+        ]);
+    }
+
+    /**
+     * @param array $config
+     * @param array $defaults
+     *
+     * @return array
+     *
+     * @throws OptionResolutionException
+     */
+    public function resolveConfig(array $config, array $defaults = [])
+    {
+        return (new ConfigOptionsResolver([
+            'api_key',
+        ]))->resolve($config, $defaults);
+    }
+}

modules/ps_accounts/classes/Api/Client/GenericClient.php

@@ -0,0 +1,287 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+namespace PrestaShop\Module\PsAccounts\Api\Client;
+
+use GuzzleHttp\Client;
+use PrestaShop\Module\PsAccounts\Configuration\Configurable;
+use PrestaShop\Module\PsAccounts\Handler\Response\ApiResponseHandler;
+
+/**
+ * Construct the client used to make call to maasland.
+ */
+abstract class GenericClient implements Configurable
+{
+    /**
+     * If set to false, you will not be able to catch the error
+     * guzzle will show a different error message.
+     *
+     * @var bool
+     */
+    protected $catchExceptions = false;
+    /**
+     * Guzzle Client.
+     *
+     * @var Client
+     */
+    protected $client;
+
+    /**
+     * Class Link in order to generate module link.
+     *
+     * @var \Link
+     */
+    protected $link;
+
+    /**
+     * Api route.
+     *
+     * @var string
+     */
+    protected $route;
+
+    /**
+     * Set how long guzzle will wait a response before end it up.
+     *
+     * @var int
+     */
+    protected $timeout = 10;
+
+    /**
+     * GenericClient constructor.
+     */
+    public function __construct()
+    {
+    }
+
+    /**
+     * Getter for client.
+     *
+     * @return Client
+     */
+    protected function getClient()
+    {
+        return $this->client;
+    }
+
+    /**
+     * Getter for exceptions mode.
+     *
+     * @return bool
+     */
+    protected function getExceptionsMode()
+    {
+        return $this->catchExceptions;
+    }
+
+    /**
+     * Getter for Link.
+     *
+     * @return \Link
+     */
+    protected function getLink()
+    {
+        return $this->link;
+    }
+
+    /**
+     * Getter for route.
+     *
+     * @return string
+     */
+    protected function getRoute()
+    {
+        return $this->route;
+    }
+
+    /**
+     * Getter for timeout.
+     *
+     * @return int
+     */
+    protected function getTimeout()
+    {
+        return $this->timeout;
+    }
+
+    /**
+     * Wrapper of method post from guzzle client.
+     *
+     * @param array $options payload
+     *
+     * @return array return response or false if no response
+     */
+    protected function post(array $options = [])
+    {
+        $response = $this->getClient()->post($this->getRoute(), $options);
+        $responseHandler = new ApiResponseHandler();
+        $response = $responseHandler->handleResponse($response);
+        // If response is not successful only
+        if (\Configuration::get('PS_ACCOUNTS_DEBUG_LOGS_ENABLED') && !$response['status']) {
+            /**
+             * @var \Ps_accounts
+             */
+            $module = \Module::getInstanceByName('ps_accounts');
+            $logger = $module->getLogger();
+            $logger->debug('route ' . $this->getRoute());
+            $logger->debug('options ' . var_export($options, true));
+            $logger->debug('response ' . var_export($response, true));
+        }
+
+        return $response;
+    }
+
+    /**
+     * Wrapper of method patch from guzzle client.
+     *
+     * @param array $options payload
+     *
+     * @return array return response or false if no response
+     */
+    protected function patch(array $options = [])
+    {
+        $response = $this->getClient()->patch($this->getRoute(), $options);
+        $responseHandler = new ApiResponseHandler();
+        $response = $responseHandler->handleResponse($response);
+        // If response is not successful only
+        if (\Configuration::get('PS_ACCOUNTS_DEBUG_LOGS_ENABLED') && !$response['status']) {
+            /**
+             * @var \Ps_accounts
+             */
+            $module = \Module::getInstanceByName('ps_accounts');
+            $logger = $module->getLogger();
+            $logger->debug('route ' . $this->getRoute());
+            $logger->debug('options ' . var_export($options, true));
+            $logger->debug('response ' . var_export($response, true));
+        }
+
+        return $response;
+    }
+
+    /**
+     * Wrapper of method post from guzzle client.
+     *
+     * @param array $options payload
+     *
+     * @return array return response or false if no response
+     */
+    protected function get(array $options = [])
+    {
+        $response = $this->getClient()->get($this->getRoute(), $options);
+        $responseHandler = new ApiResponseHandler();
+        $response = $responseHandler->handleResponse($response);
+        // If response is not successful only
+        if (\Configuration::get('PS_ACCOUNTS_DEBUG_LOGS_ENABLED') && !$response['status']) {
+            /**
+             * @var \Ps_accounts
+             */
+            $module = \Module::getInstanceByName('ps_accounts');
+            $logger = $module->getLogger();
+            $logger->debug('route ' . $this->getRoute());
+            $logger->debug('options ' . var_export($options, true));
+            $logger->debug('response ' . var_export($response, true));
+        }
+
+        return $response;
+    }
+
+    /**
+     * Wrapper of method delete from guzzle client.
+     *
+     * @param array $options payload
+     *
+     * @return array return response array
+     */
+    protected function delete(array $options = [])
+    {
+        $response = $this->getClient()->delete($this->getRoute(), $options);
+        $responseHandler = new ApiResponseHandler();
+        $response = $responseHandler->handleResponse($response);
+        // If response is not successful only
+        if (\Configuration::get('PS_ACCOUNTS_DEBUG_LOGS_ENABLED') && !$response['status']) {
+            /**
+             * @var \Ps_accounts
+             */
+            $module = \Module::getInstanceByName('ps_accounts');
+            $logger = $module->getLogger();
+            $logger->debug('route ' . $this->getRoute());
+            $logger->debug('options ' . var_export($options, true));
+            $logger->debug('response ' . var_export($response, true));
+        }
+
+        return $response;
+    }
+
+    /**
+     * Setter for client.
+     *
+     * @return void
+     */
+    protected function setClient(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Setter for exceptions mode.
+     *
+     * @param bool $bool
+     *
+     * @return void
+     */
+    protected function setExceptionsMode($bool)
+    {
+        $this->catchExceptions = $bool;
+    }
+
+    /**
+     * Setter for link.
+     *
+     * @return void
+     */
+    protected function setLink(\Link $link)
+    {
+        $this->link = $link;
+    }
+
+    /**
+     * Setter for route.
+     *
+     * @param string $route
+     *
+     * @return void
+     */
+    protected function setRoute($route)
+    {
+        $this->route = $route;
+    }
+
+    /**
+     * Setter for timeout.
+     *
+     * @param int $timeout
+     *
+     * @return void
+     */
+    protected function setTimeout($timeout)
+    {
+        $this->timeout = $timeout;
+    }
+}

modules/ps_accounts/classes/Api/Client/ServicesAccountsClient.php

@@ -0,0 +1,189 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+namespace PrestaShop\Module\PsAccounts\Api\Client;
+
+use GuzzleHttp\Client;
+use PrestaShop\Module\PsAccounts\Adapter\Link;
+use PrestaShop\Module\PsAccounts\Configuration\ConfigOptionsResolver;
+use PrestaShop\Module\PsAccounts\Exception\OptionResolutionException;
+use PrestaShop\Module\PsAccounts\Exception\TokenNotFoundException;
+use PrestaShop\Module\PsAccounts\Provider\ShopProvider;
+use PrestaShop\Module\PsAccounts\Service\ShopTokenService;
+
+/**
+ * Class ServicesAccountsClient
+ */
+class ServicesAccountsClient extends GenericClient
+{
+    /**
+     * @var ShopProvider
+     */
+    private $shopProvider;
+
+    /**
+     * @var ShopTokenService
+     */
+    private $shopTokenService;
+
+    /**
+     * ServicesAccountsClient constructor.
+     *
+     * @param array $config
+     * @param ShopProvider $shopProvider
+     * @param ShopTokenService $shopTokenService
+     * @param Link $link
+     * @param Client|null $client
+     *
+     * @throws OptionResolutionException
+     * @throws TokenNotFoundException
+     * @throws \PrestaShopException
+     * @throws \Exception
+     */
+    public function __construct(
+        array $config,
+        ShopProvider $shopProvider,
+        ShopTokenService $shopTokenService,
+        Link $link,
+        Client $client = null
+    ) {
+        parent::__construct();
+
+        $config = $this->resolveConfig($config);
+
+        $this->shopProvider = $shopProvider;
+        $this->shopTokenService = $shopTokenService;
+
+        $shopId = (int) $this->shopProvider->getCurrentShop()['id'];
+        $token = $this->shopTokenService->getOrRefreshToken();
+
+        $this->setLink($link->getLink());
+
+        if (!$token) {
+            throw new TokenNotFoundException('Firebase token not found');
+        }
+
+        // Client can be provided for tests
+        if (null === $client) {
+            $client = new Client([
+                'base_url' => $config['api_url'],
+                'defaults' => [
+                    'timeout' => $this->timeout,
+                    'exceptions' => $this->catchExceptions,
+                    'headers' => [
+                        // Commented, else does not work anymore with API.
+                        //'Content-Type' => 'application/vnd.accounts.v1+json', // api version to use
+                        'Accept' => 'application/json',
+                        'Authorization' => 'Bearer ' . $token,
+                        'Shop-Id' => $shopId,
+                        'Module-Version' => \Ps_accounts::VERSION, // version of the module
+                        'Prestashop-Version' => _PS_VERSION_, // prestashop version
+                    ],
+                ],
+            ]);
+        }
+
+        $this->setClient($client);
+    }
+
+    /**
+     * @param mixed $shopUuidV4
+     * @param array $bodyHttp
+     *
+     * @return array | false
+     */
+    public function updateShopUrl($shopUuidV4, $bodyHttp)
+    {
+        $this->setRoute('/shops/' . $shopUuidV4 . '/url');
+
+        return $this->patch([
+            'body' => $bodyHttp,
+        ]);
+    }
+
+    /**
+     * @param string $shopUuidV4
+     *
+     * @return array
+     */
+    public function deleteShop($shopUuidV4)
+    {
+        $this->setRoute('/shop/' . $shopUuidV4);
+
+        return $this->delete();
+    }
+
+    /**
+     * @param array $headers
+     * @param array $body
+     *
+     * @return array
+     *
+     * @throws \PrestaShopException
+     */
+    public function verifyWebhook(array $headers, array $body)
+    {
+        $correlationId = $headers['correlationId'];
+
+        $this->setRoute('/webhooks/' . $correlationId . '/verify');
+
+        $shopId = (int) $this->shopProvider->getCurrentShop()['id'];
+        $hookUrl = $this->link->getModuleLink('ps_accounts', 'DispatchWebHook', [], true, null, $shopId);
+
+        $res = $this->post([
+            'headers' => [
+                'correlationId' => $correlationId,
+                'Hook-Url' => $hookUrl,
+            ],
+            'json' => $body,
+        ]);
+
+        if (!$res || $res['httpCode'] < 200 || $res['httpCode'] > 299) {
+            return [
+                'httpCode' => $res['httpCode'],
+                'body' => $res['body']
+                && is_array($res['body'])
+                && array_key_exists('message', $res['body'])
+                    ? $res['body']['message']
+                    : 'Unknown error',
+            ];
+        }
+
+        return [
+            'httpCode' => 200,
+            'body' => 'ok',
+        ];
+    }
+
+    /**
+     * @param array $config
+     * @param array $defaults
+     *
+     * @return array
+     *
+     * @throws OptionResolutionException
+     */
+    public function resolveConfig(array $config, array $defaults = [])
+    {
+        return (new ConfigOptionsResolver([
+            'api_url',
+        ]))->resolve($config, $defaults);
+    }
+}

modules/ps_accounts/classes/Api/Client/ServicesBillingClient.php

@@ -0,0 +1,158 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+namespace PrestaShop\Module\PsAccounts\Api\Client;
+
+use GuzzleHttp\Client;
+use PrestaShop\Module\PsAccounts\Adapter\Link;
+use PrestaShop\Module\PsAccounts\Configuration\ConfigOptionsResolver;
+use PrestaShop\Module\PsAccounts\Exception\OptionResolutionException;
+use PrestaShop\Module\PsAccounts\Provider\ShopProvider;
+use PrestaShop\Module\PsAccounts\Service\PsAccountsService;
+
+/**
+ * Handle call api Services
+ */
+class ServicesBillingClient extends GenericClient
+{
+    /**
+     * ServicesBillingClient constructor.
+     *
+     * @param array $config
+     * @param PsAccountsService $psAccountsService
+     * @param ShopProvider $shopProvider
+     * @param Link $link
+     * @param Client|null $client
+     *
+     * @throws OptionResolutionException
+     * @throws \PrestaShopException
+     * @throws \Exception
+     */
+    public function __construct(
+        array $config,
+        PsAccountsService $psAccountsService,
+        ShopProvider $shopProvider,
+        Link $link,
+        Client $client = null
+    ) {
+        parent::__construct();
+
+        $config = $this->resolveConfig($config);
+
+        $shopId = $shopProvider->getCurrentShop()['id'];
+
+        $token = $psAccountsService->getOrRefreshToken();
+
+        $this->setLink($link->getLink());
+
+        // Client can be provided for tests
+        if (null === $client) {
+            $client = new Client([
+                'base_url' => $config['api_url'],
+                'defaults' => [
+                    'timeout' => $this->timeout,
+                    'exceptions' => $this->catchExceptions,
+                    'headers' => [
+                        // Commented, else does not work anymore with API.
+                        //'Content-Type' => 'application/vnd.accounts.v1+json', // api version to use
+                        'Accept' => 'application/json',
+                        'Authorization' => 'Bearer ' . $token,
+                        'Shop-Id' => $shopId,
+                        'Module-Version' => \Ps_accounts::VERSION, // version of the module
+                        'Prestashop-Version' => _PS_VERSION_, // prestashop version
+                    ],
+                ],
+            ]);
+        }
+
+        $this->setClient($client);
+    }
+
+    /**
+     * @param mixed $shopUuidV4
+     *
+     * @return array | false
+     */
+    public function getBillingCustomer($shopUuidV4)
+    {
+        $this->setRoute('/shops/' . $shopUuidV4);
+
+        return $this->get();
+    }
+
+    /**
+     * @param mixed $shopUuidV4
+     * @param array $bodyHttp
+     *
+     * @return array | false
+     */
+    public function createBillingCustomer($shopUuidV4, $bodyHttp)
+    {
+        $this->setRoute('/shops/' . $shopUuidV4);
+
+        return $this->post([
+            'body' => $bodyHttp,
+        ]);
+    }
+
+    /**
+     * @param mixed $shopUuidV4
+     * @param string $module
+     *
+     * @return array | false
+     */
+    public function getBillingSubscriptions($shopUuidV4, $module)
+    {
+        $this->setRoute('/shops/' . $shopUuidV4 . '/subscriptions/' . $module);
+
+        return $this->get();
+    }
+
+    /**
+     * @param mixed $shopUuidV4
+     * @param string $module
+     * @param array $bodyHttp
+     *
+     * @return array | false
+     */
+    public function createBillingSubscriptions($shopUuidV4, $module, $bodyHttp)
+    {
+        $this->setRoute('/shops/' . $shopUuidV4 . '/subscriptions/' . $module);
+
+        return $this->post([
+            'body' => $bodyHttp,
+        ]);
+    }
+
+    /**
+     * @param array $config
+     * @param array $defaults
+     *
+     * @return array
+     *
+     * @throws OptionResolutionException
+     */
+    public function resolveConfig(array $config, array $defaults = [])
+    {
+        return (new ConfigOptionsResolver([
+            'api_url',
+        ]))->resolve($config, $defaults);
+    }
+}

modules/ps_accounts/classes/Api/Client/index.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;