Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Add API endpoint to delete a setting

Browse Source 
[MAILPOET-4814]
This commit is contained in:
Rodrigo Primo
2023-01-18 15:10:30 -03:00
committed by Aschepikov
parent 8a4f5c13da
commit ad4247a241
2 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
mailpoet/lib/API/JSON/v1/Settings.php
View File

@ -4,6 +4,7 @@ namespace MailPoet\API\JSON\v1;
use MailPoet\API\JSON\Endpoint as APIEndpoint; use MailPoet\API\JSON\Endpoint as APIEndpoint;
use MailPoet\API\JSON\Error as APIError; use MailPoet\API\JSON\Error as APIError;
use MailPoet\API\JSON\Response;
use MailPoet\Config\AccessControl; use MailPoet\Config\AccessControl;
use MailPoet\Config\ServicesChecker; use MailPoet\Config\ServicesChecker;
use MailPoet\Cron\Workers\SubscribersEngagementScore; use MailPoet\Cron\Workers\SubscribersEngagementScore;
@ -169,6 +170,32 @@ class Settings extends APIEndpoint {
} }
} }
public function delete(string $settingName): Response {
if (empty($settingName)) {
return $this->badRequest(
[
APIError::BAD_REQUEST =>
__('You have not specified any setting to be deleted.', 'mailpoet'),
]
);
}
$setting = $this->settings->get($settingName);
if (is_null($setting)) {
return $this->badRequest(
[
APIError::BAD_REQUEST =>
__('Setting doesn\'t exist.', 'mailpoet'),
]
);
}
$this->settings->delete($settingName);
return $this->successResponse();
}
public function recalculateSubscribersScore() { public function recalculateSubscribersScore() {
$this->statisticsOpensRepository->resetSubscribersScoreCalculation(); $this->statisticsOpensRepository->resetSubscribersScoreCalculation();
$this->statisticsOpensRepository->resetSegmentsScoreCalculation(); $this->statisticsOpensRepository->resetSegmentsScoreCalculation();

17
mailpoet/tests/integration/API/JSON/v1/SettingsTest.php
View File

@ -5,7 +5,9 @@ namespace MailPoet\Test\API\JSON\v1;
use Codeception\Stub\Expected; use Codeception\Stub\Expected;
use Codeception\Util\Fixtures; use Codeception\Util\Fixtures;
use MailPoet\API\JSON\Error as APIError; use MailPoet\API\JSON\Error as APIError;
use MailPoet\API\JSON\ErrorResponse;
use MailPoet\API\JSON\Response as APIResponse; use MailPoet\API\JSON\Response as APIResponse;
use MailPoet\API\JSON\SuccessResponse;
use MailPoet\API\JSON\v1\Settings; use MailPoet\API\JSON\v1\Settings;
use MailPoet\Config\ServicesChecker; use MailPoet\Config\ServicesChecker;
use MailPoet\Cron\Workers\InactiveSubscribers; use MailPoet\Cron\Workers\InactiveSubscribers;
@ -296,6 +298,21 @@ class SettingsTest extends \MailPoetTest {
expect($response->meta['showNotice'])->equals(false); expect($response->meta['showNotice'])->equals(false);
} }
public function testItCanDeleteSetting() {
$this->settings->set('setting_to_be_deleted', true);
$response = $this->endpoint->delete('setting_to_be_deleted');
expect($response)->isInstanceOf(SuccessResponse::class);
expect($this->settings->get('setting_to_be_deleted'))->null();
}
public function testDeleteReturnErrorForEmptySettingName() {
expect($this->endpoint->delete(''))->isInstanceOf(ErrorResponse::class);
}
public function testDeleteReturnErrorIfSettingDoesntExist() {
expect($this->endpoint->delete('unexistent_setting'))->isInstanceOf(ErrorResponse::class);
}
private function createNewsletter(string $type, string $status = NewsletterEntity::STATUS_DRAFT, $parent = null): NewsletterEntity { private function createNewsletter(string $type, string $status = NewsletterEntity::STATUS_DRAFT, $parent = null): NewsletterEntity {
$newsletter = new NewsletterEntity(); $newsletter = new NewsletterEntity();
$newsletter->setType($type); $newsletter->setType($type);