opencloud/tests/acceptance/TestHelpers/AuthAppHelper.php

<?php declare(strict_types=1);
/**
 * @author Niraj Acharya <niraj@jankaritech.com>
 * @copyright Copyright (c) 2024 Niraj Acharya niraj@jankaritech.com
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License,
 * as published by the Free Software Foundation;
 * either version 3 of the License, or any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace TestHelpers;

use Psr\Http\Message\ResponseInterface;

/**
 * A helper class for managing Auth App API requests
 */
class AuthAppHelper {
	/**
	 * @return string
	 */
	public static function getAuthAppEndpoint(): string {
		return "/auth-app/tokens";
	}

	/**
	 * @param string $baseUrl
	 * @param string $user
	 * @param string $password
	 *
	 * @return ResponseInterface
	 */
	public static function listAllAppAuthTokensForUser(
		string $baseUrl,
		string $user,
		string $password
	): ResponseInterface {
		$url = $baseUrl . self::getAuthAppEndpoint();
		return HttpRequestHelper::sendRequest(
			$url,
			null,
			"GET",
			$user,
			$password,
		);
	}

	/**
	 * @param string $baseUrl
	 * @param string $user
	 * @param string $password
	 * @param array $params
	 *
	 * @return ResponseInterface
	 */
	public static function createAppAuthToken(
		string $baseUrl,
		string $user,
		string $password,
		array $params,
	): ResponseInterface {
		$url = $baseUrl . self::getAuthAppEndpoint() . "?"
		. http_build_query($params);
		return HttpRequestHelper::sendRequest(
			$url,
			null,
			"POST",
			$user,
			$password,
		);
	}

	/**
	 * @param string $baseUrl
	 * @param string $user
	 * @param string $password
	 * @param string $token
	 *
	 * @return ResponseInterface
	 */
	public static function deleteAppAuthToken(
		string $baseUrl,
		string $user,
		string $password,
		string $token
	): ResponseInterface {
		$url = $baseUrl . self::getAuthAppEndpoint() . "?token=$token";
		return HttpRequestHelper::sendRequest(
			$url,
			null,
			"DELETE",
			$user,
			$password,
		);
	}
}