deck/lib/Service/Importer/Systems/TrelloApiService.php

<?php

/**
 * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Deck\Service\Importer\Systems;

use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUserManager;
use Psr\Log\LoggerInterface;

class TrelloApiService extends TrelloJsonService {
	/** @var string */
	public static $name = 'Trello API';
	protected bool $needValidateData = false;
	/** @var IClient */
	private $httpClient;
	/** @var LoggerInterface */
	protected $logger;
	/** @var string */
	private $baseApiUrl = 'https://api.trello.com/1';
	/** @var ?\stdClass[] */
	private $boards;

	public function __construct(
		IUserManager $userManager,
		IURLGenerator $urlGenerator,
		IL10N $l10n,
		LoggerInterface $logger,
		IClientService $httpClientService,
	) {
		parent::__construct($userManager, $urlGenerator, $l10n);
		$this->logger = $logger;
		$this->httpClient = $httpClientService->newClient();
	}

	public function bootstrap(): void {
		$this->populateBoard();
		$this->populateMembers();
		$this->populateLabels();
		$this->populateLists();
		$this->populateCheckLists();
		$this->populateCards();
		$this->populateActions();
		parent::bootstrap();
	}

	public function getJsonSchemaPath(): string {
		return implode(DIRECTORY_SEPARATOR, [
			__DIR__,
			'..',
			'fixtures',
			'config-trelloApi-schema.json',
		]);
	}

	private function populateActions(): void {
		$data = $this->getImportService()->getData();
		$data->actions = $this->doRequest(
			'/boards/' . $data->id . '/actions',
			[
				'filter' => 'commentCard,createCard',
				'fields=memberCreator,type,data,date',
				'memberCreator_fields' => 'username',
				'limit' => 1000
			]
		);
	}

	private function populateCards(): void {
		$data = $this->getImportService()->getData();
		$data->cards = $this->doRequest(
			'/boards/' . $data->id . '/cards',
			[
				'fields' => 'id,idMembers,dateLastActivity,closed,idChecklists,name,idList,pos,desc,due,labels',
				'attachments' => true,
				'attachment_fields' => 'name,url,date',
				'limit' => 1000
			]
		);
	}

	private function populateCheckLists(): void {
		$data = $this->getImportService()->getData();
		$data->checklists = $this->doRequest(
			'/boards/' . $data->id . '/checkLists',
			[
				'fields' => 'id,idCard,name',
				'checkItem_fields' => 'id,state,name',
				'limit' => 1000
			]
		);
	}

	private function populateLists(): void {
		$data = $this->getImportService()->getData();
		$data->lists = $this->doRequest(
			'/boards/' . $data->id . '/lists',
			[
				'fields' => 'id,name,closed',
				'limit' => 1000
			]
		);
	}

	private function populateLabels(): void {
		$data = $this->getImportService()->getData();
		$data->labels = $this->doRequest(
			'/boards/' . $data->id . '/labels',
			[
				'fields' => 'id,color,name',
				'limit' => 1000
			]
		);
	}

	private function populateMembers(): void {
		$data = $this->getImportService()->getData();
		$data->members = $this->doRequest(
			'/boards/' . $data->id . '/members',
			[
				'fields' => 'username',
				'limit' => 1000
			]
		);
	}

	private function populateBoard(): void {
		$toImport = $this->getImportService()->getConfig('board');
		$board = $this->doRequest(
			'/boards/' . $toImport,
			['fields' => 'id,name']
		);
		if ($board instanceof \stdClass) {
			$this->getImportService()->setData($board);
			return;
		}
		throw new \Exception('Invalid board id to import');
	}

	/**
	 * @return array|\stdClass
	 */
	private function doRequest(string $path = '', array $queryString = []) {
		$target = $this->baseApiUrl . $path;
		try {
			$result = $this->httpClient
				->get($target, $this->getQueryString($queryString))
				->getBody();
			if (is_string($result)) {
				$data = json_decode($result);
				if (is_array($data)) {
					$data = array_merge(
						$data,
						$this->paginate($path, $queryString, $data)
					);
				}
				return $data;
			}
			throw new \Exception('Invalid return of api');
		} catch (\Throwable $e) {
			$this->logger->critical(
				$e->getMessage(),
				['app' => 'deck']
			);
			throw new \Exception($e->getMessage());
		}
	}

	private function paginate(string $path = '', array $queryString = [], array $data = []): array {
		if (empty($queryString['limit'])) {
			return [];
		}
		if ((count($data) < $queryString['limit']) || (count($data) === 0)) {
			return [];
		}
		$queryString['before'] = end($data)->id;
		$return = $this->doRequest($path, $queryString);
		if (is_array($return)) {
			return $return;
		}
		throw new \Exception('Invalid return of api');
	}

	private function getQueryString(array $params = []): array {
		$apiSettings = $this->getImportService()->getConfig('api');
		$params['key'] = $apiSettings->key;
		$params['token'] = $apiSettings->token;
		return [
			'query' => $params
		];
	}
}