feat(api): add Episode create and publish endpoints (a90cdfdc) · Commits · Ad Aures / Castopod

.gitignore

+1 −0

Original line number	Diff line number	Diff line
		@@ -128,6 +128,7 @@ nb-configuration.xml

		# Visual Studio Code
		.vscode/
		.history/
		tmp/

		/results/

app/Config/Filters.php

+5 −1

Original line number	Diff line number	Diff line
		@@ -73,7 +73,11 @@ class Filters extends BaseConfig
		'before' => [
		// 'honeypot',
		'csrf' => [
		'except' => ['@[a-zA-Z0-9\_]{1,32}/inbox'],
		'except' => [
		'@[a-zA-Z0-9\_]{1,32}/inbox',
		'api/rest/v1/episodes',
		'api/rest/v1/episodes/[0-9]+/publish',
		],
		],
		// 'invalidchars',
		],

modules/Api/Rest/V1/Config/Routes.php

+2 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,8 @@ $routes->group(
		],
		static function ($routes): void {
		$routes->get('/', 'EpisodeController::list');
		$routes->post('/', 'EpisodeController::attemptCreate');
		$routes->post('(:num)/publish', 'EpisodeController::attemptPublish/$1');
		$routes->get('(:num)', 'EpisodeController::view/$1');
		$routes->get('(:any)', 'ExceptionController::notFound');
		}

modules/Api/Rest/V1/Controllers/EpisodeController.php

+225 −0

Original line number	Diff line number	Diff line
		@@ -5,11 +5,18 @@ declare(strict_types=1);
		namespace Modules\Api\Rest\V1\Controllers;

		use App\Entities\Episode;
		use App\Entities\Location;
		use App\Entities\Podcast;
		use App\Entities\Post;
		use App\Models\EpisodeModel;
		use App\Models\PodcastModel;
		use App\Models\PostModel;
		use CodeIgniter\API\ResponseTrait;
		use CodeIgniter\Controller;
		use CodeIgniter\HTTP\ResponseInterface;
		use CodeIgniter\I18n\Time;
		use Modules\Api\Rest\V1\Config\Services;
		use Modules\Auth\Models\UserModel;

		class EpisodeController extends Controller
		{
		@@ -68,6 +75,224 @@ class EpisodeController extends Controller
		return $this->respond(static::mapEpisode($episode));
		}

		public function attemptCreate(): ResponseInterface
		{
		$rules = [
		'created_by' => 'required\|is_natural_no_zero',
		'updated_by' => 'required\|is_natural_no_zero',
		'title' => 'required',
		'slug' => 'required\|max_length[128]',
		'podcast_id' => 'required\|is_natural_no_zero',
		'audio_file' => 'uploaded[audio_file]\|ext_in[audio_file,mp3,m4a]',
		'cover' => 'permit_empty\|is_image[cover]\|ext_in[cover,jpg,jpeg,png]\|min_dims[cover,1400,1400]\|is_image_ratio[cover,1,1]',
		'transcript_file' => 'permit_empty\|ext_in[transcript_file,srt,vtt]',
		'chapters_file' => 'permit_empty\|ext_in[chapters_file,json]\|is_json[chapters_file]',
		'transcript-choice' => 'permit_empty\|in_list[upload-file,remote-url]',
		'chapters-choice' => 'permit_empty\|in_list[upload-file,remote-url]',
		];

		if (! $this->validate($rules)) {
		return $this->failValidationErrors(array_values($this->validator->getErrors()));
		}

		$podcastId = $this->request->getPost('podcast_id');

		$podcast = (new PodcastModel())->getPodcastById($podcastId);

		if (! $podcast instanceof Podcast) {
		return $this->failNotFound('Podcast not found');
		}

		$createdByUserId = $this->request->getPost('created_by');

		$userModel = new UserModel();
		$createdByUser = $userModel->find($createdByUserId);

		if (! $createdByUser) {
		return $this->failNotFound('User not found');
		}

		$updatedByUserId = $this->request->getPost('updated_by');

		$updatedByUser = $userModel->find($updatedByUserId);

		if (! $updatedByUser) {
		return $this->failNotFound('Updated by user not found');
		}

		if ($podcast->type === 'serial' && $this->request->getPost('type') === 'full') {
		$rules['episode_number'] = 'required';
		}

		if (! $this->validate($rules)) {
		return $this->failValidationErrors(array_values($this->validator->getErrors()));
		}

		$validData = $this->validator->getValidated();

		if ((new EpisodeModel())
		->where([
		'slug' => $validData['slug'],
		'podcast_id' => $podcast->id,
		])
		->first() instanceof Episode) {
		return $this->fail('An episode with the same slug already exists in this podcast.', 409);
		}

		$newEpisode = new Episode([
		'created_by' => $createdByUserId,
		'updated_by' => $updatedByUserId,
		'podcast_id' => $podcast->id,
		'title' => $validData['title'],
		'slug' => $validData['slug'],
		'guid' => null,
		'audio' => $this->request->getFile('audio_file'),
		'cover' => $this->request->getFile('cover'),
		'description_markdown' => $this->request->getPost('description'),
		'location' => in_array($this->request->getPost('location_name'), ['', null], true)
		? null
		: new Location($this->request->getPost('location_name')),
		'parental_advisory' => $this->request->getPost('parental_advisory') !== 'undefined'
		? $this->request->getPost('parental_advisory')
		: null,
		'number' => $this->request->getPost('episode_number') ? (int) $this->request->getPost(
		'episode_number'
		) : null,
		'season_number' => $this->request->getPost('season_number') ? (int) $this->request->getPost(
		'season_number'
		) : null,
		'type' => $this->request->getPost('type'),
		'is_blocked' => $this->request->getPost('block') === 'yes',
		'custom_rss_string' => $this->request->getPost('custom_rss'),
		'is_premium' => $this->request->getPost('premium') === 'yes',
		'published_at' => null,
		]);

		$transcriptChoice = $this->request->getPost('transcript-choice');
		if ($transcriptChoice === 'upload-file') {
		$newEpisode->setTranscript($this->request->getFile('transcript_file'));
		} elseif ($transcriptChoice === 'remote-url') {
		$newEpisode->transcript_remote_url = $this->request->getPost(
		'transcript_remote_url'
		) === '' ? null : $this->request->getPost('transcript_remote_url');
		}

		$chaptersChoice = $this->request->getPost('chapters-choice');
		if ($chaptersChoice === 'upload-file') {
		$newEpisode->setChapters($this->request->getFile('chapters_file'));
		} elseif ($chaptersChoice === 'remote-url') {
		$newEpisode->chapters_remote_url = $this->request->getPost(
		'chapters_remote_url'
		) === '' ? null : $this->request->getPost('chapters_remote_url');
		}

		$episodeModel = new EpisodeModel();
		if (! ($newEpisodeId = $episodeModel->insert($newEpisode, true))) {
		return $this->fail($episodeModel->errors(), 400);
		}

		$episode = $episodeModel->find($newEpisodeId)
		->toRawArray();

		return $this->respond($episode);
		}

		public function attemptPublish(int $id): ResponseInterface
		{
		$episodeModel = new EpisodeModel();
		$episode = $episodeModel->getEpisodeById($id);

		if (! $episode instanceof Episode) {
		return $this->failNotFound('Episode not found');
		}

		if ($episode->publication_status !== 'not_published') {
		return $this->fail('Episode is already published or scheduled for publication', 409);
		}

		$rules = [
		'publication_method' => 'required',
		'created_by' => 'required\|is_natural_no_zero',
		];

		if (! $this->validate($rules)) {
		return $this->failValidationErrors(array_values($this->validator->getErrors()));
		}

		if ($this->request->getPost('publication_method') === 'schedule') {
		$rules['scheduled_publication_date'] = 'required\|valid_date[Y-m-d H:i]';
		}

		if (! $this->validate($rules)) {
		return $this->failValidationErrors(array_values($this->validator->getErrors()));
		}

		$createdByUserId = $this->request->getPost('created_by');

		$userModel = new UserModel();
		$createdByUser = $userModel->find($createdByUserId);

		if (! $createdByUser) {
		return $this->failNotFound('User not found');
		}

		$validData = $this->validator->getValidated();

		$db = db_connect();
		$db->transStart();

		$newPost = new Post([
		'actor_id' => $episode->podcast->actor_id,
		'episode_id' => $episode->id,
		'message' => $this->request->getPost('message') ?? '',
		'created_by' => $createdByUserId,
		]);

		$clientTimezone = $this->request->getPost('client_timezone') ?? app_timezone();

		if ($episode->podcast->publication_status === 'published') {
		$publishMethod = $validData['publication_method'];
		if ($publishMethod === 'schedule') {
		$scheduledPublicationDate = $validData['scheduled_publication_date'] ?? null;
		if ($scheduledPublicationDate) {
		$episode->published_at = Time::createFromFormat(
		'Y-m-d H:i',
		$scheduledPublicationDate,
		$clientTimezone
		)->setTimezone(app_timezone());
		} else {
		$db->transRollback();
		return $this->fail('Scheduled publication date is required', 400);
		}
		} else {
		$episode->published_at = Time::now();
		}
		} elseif ($episode->podcast->publication_status === 'scheduled') {
		// podcast publication date has already been set
		$episode->published_at = $episode->podcast->published_at->addSeconds(1);
		} else {
		$episode->published_at = Time::now();
		}

		$newPost->published_at = $episode->published_at;

		$postModel = new PostModel();
		if (! $postModel->addPost($newPost)) {
		$db->transRollback();
		return $this->fail($postModel->errors(), 400);
		}

		if (! $episodeModel->update($episode->id, $episode)) {
		$db->transRollback();
		return $this->fail($episodeModel->errors(), 400);
		}

		$db->transComplete();

		// @phpstan-ignore-next-line
		return $this->respond(self::mapEpisode($episode));
		}

		protected static function mapEpisode(Episode $episode): Episode
		{
		$episode->cover_url = $episode->getCover()

modules/Api/Rest/V1/Filters/ApiFilter.php

+7 −0

Original line number	Diff line number	Diff line
		@@ -29,6 +29,13 @@ class ApiFilter implements FilterInterface
		throw PageNotFoundException::forPageNotFound();
		}

		if ($request->getMethod() === 'POST' && ! $restApiConfig->basicAuth) {
		/** @var Response $response */
		$response = service('response');
		$response->setStatusCode(401);
		return $response;
		}

		if ($restApiConfig->basicAuth) {
		/** @var Response $response */
		$response = service('response');