Refactor code and fix tests.

2026-01-10 20:34:48 +00:00 · 2018-05-21 09:40:19 +02:00
parent 714b54ed06
commit ebf97f710f
16 changed files with 63 additions and 52 deletions
--- a/app/Support/Import/JobConfiguration/Spectre/DoAuthenticateHandler.php
+++ b/app/Support/Import/JobConfiguration/Spectre/DoAuthenticateHandler.php
@@ -0,0 +1,194 @@
+<?php
+/**
+ * AuthenticateConfig.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Support\Import\JobConfiguration\Spectre;
+
+use FireflyIII\Exceptions\FireflyException;
+use FireflyIII\Models\ImportJob;
+use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
+use FireflyIII\Services\Spectre\Object\Customer;
+use FireflyIII\Services\Spectre\Object\Token;
+use FireflyIII\Services\Spectre\Request\CreateTokenRequest;
+use FireflyIII\Services\Spectre\Request\ListCustomersRequest;
+use FireflyIII\Services\Spectre\Request\NewCustomerRequest;
+use Illuminate\Support\MessageBag;
+use Log;
+
+/**
+ * Class AuthenticateConfig
+ *
+ */
+class DoAuthenticateHandler implements SpectreConfigurationInterface
+{
+    /** @var ImportJob */
+    private $importJob;
+    /** @var ImportJobRepositoryInterface */
+    private $repository;
+
+    /**
+     * Return true when this stage is complete.
+     *
+     * always returns false.
+     *
+     * @return bool
+     */
+    public function configurationComplete(): bool
+    {
+        Log::debug('AuthenticateConfig::configurationComplete() will always return false');
+
+        return false;
+    }
+
+    /**
+     * Store the job configuration.
+     *
+     * @param array $data
+     *
+     * @return MessageBag
+     */
+    public function configureJob(array $data): MessageBag
+    {
+        Log::debug('AuthenticateConfig::configureJob() will do nothing.');
+
+        return new MessageBag;
+    }
+
+    /**
+     * Get data for config view.
+     *
+     * @return array
+     * @throws FireflyException
+     */
+    public function getNextData(): array
+    {
+        Log::debug('Now in AuthenticateConfig::getNextData()');
+        // next data only makes sure the job is ready for the next stage.
+        $this->repository->setStatus($this->importJob, 'ready_to_run');
+        $this->repository->setStage($this->importJob, 'authenticated');
+        $config = $this->importJob->configuration;
+        $token  = isset($config['token']) ? new Token($config['token']) : null;
+        if (null !== $token) {
+            Log::debug(sprintf('Return "%s" from token in config.', $token->getConnectUrl()));
+
+            return ['token-url' => $token->getConnectUrl()];
+        }
+        Log::debug('No existing token, get a new one.');
+        // get a new token from Spectre.
+        $customer = $this->getCustomer();
+        $token = $this->getToken($customer);
+        return ['token-url' => $token->getConnectUrl()];
+    }
+
+    /**
+     * Get the view for this stage.
+     *
+     * @return string
+     */
+    public function getNextView(): string
+    {
+        return 'import.spectre.redirect';
+    }
+
+    /**
+     * Set the import job.
+     *
+     * @param ImportJob $importJob
+     */
+    public function setImportJob(ImportJob $importJob): void
+    {
+        $this->importJob  = $importJob;
+        $this->repository = app(ImportJobRepositoryInterface::class);
+        $this->repository->setUser($importJob->user);
+    }
+
+    /**
+     * @return Customer
+     * @throws FireflyException
+     */
+    private function getCustomer(): Customer
+    {
+        Log::debug('Now in AuthenticateConfig::getCustomer()');
+        $customer = $this->getExistingCustomer();
+        if (null === $customer) {
+            Log::debug('The customer is NULL, will fire a newCustomerRequest.');
+            $newCustomerRequest = new NewCustomerRequest($this->importJob->user);
+            $customer           = $newCustomerRequest->getCustomer();
+
+        }
+        Log::debug('The customer is not null.');
+
+        return $customer;
+    }
+
+    /**
+     * @return Customer|null
+     * @throws FireflyException
+     */
+    private function getExistingCustomer(): ?Customer
+    {
+        Log::debug('Now in AuthenticateConfig::getExistingCustomer()');
+        $preference = app('preferences')->getForUser($this->importJob->user, 'spectre_customer');
+        if (null !== $preference) {
+            Log::debug('Customer is in user configuration');
+            $customer = new Customer($preference->data);
+
+            return $customer;
+        }
+        Log::debug('Customer is not in user config');
+        $customer           = null;
+        $getCustomerRequest = new ListCustomersRequest($this->importJob->user);
+        $getCustomerRequest->call();
+        $customers = $getCustomerRequest->getCustomers();
+
+        Log::debug(sprintf('Found %d customer(s)', \count($customers)));
+        /** @var Customer $current */
+        foreach ($customers as $current) {
+            if ('default_ff3_customer' === $current->getIdentifier()) {
+                $customer = $current;
+                Log::debug('Found the correct customer.');
+                app('preferences')->setForUser($this->importJob->user, 'spectre_customer', $customer->toArray());
+                break;
+            }
+        }
+
+        return $customer;
+    }
+
+    /**
+     * @param Customer $customer
+     *
+     * @throws FireflyException
+     * @return Token
+     */
+    private function getToken(Customer $customer): Token
+    {
+        Log::debug('Now in AuthenticateConfig::getToken()');
+        $request = new CreateTokenRequest($this->importJob->user);
+        $request->setUri(route('import.job.status.index', [$this->importJob->key]));
+        $request->setCustomer($customer);
+        $request->call();
+        Log::debug('Call to get token is finished');
+
+        return $request->getToken();
+    }
+}