Extract newsletter validation to a service

[MAILPOET-4236]

mailpoet/lib/API/JSON/v1/SendingQueue.php

@@ -17,8 +17,8 @@ use MailPoet\Newsletter\NewslettersRepository;
 use MailPoet\Newsletter\Scheduler\Scheduler;
 use MailPoet\Newsletter\Sending\ScheduledTasksRepository;
 use MailPoet\Newsletter\Sending\SendingQueuesRepository;
+use MailPoet\Newsletter\Validator;
 use MailPoet\Segments\SubscribersFinder;
-use MailPoet\Services\Bridge;
 use MailPoet\Tasks\Sending as SendingTask;
 use MailPoet\Util\License\Features\Subscribers as SubscribersFeature;
 
@@ -36,9 +36,6 @@ class SendingQueue extends APIEndpoint {
   /** @var NewslettersRepository */
   private $newsletterRepository;
 
-  /** @var Bridge */
-  private $bridge;
-
   /** @var SendingQueuesRepository */
   private $sendingQueuesRepository;
 
@@ -51,24 +48,27 @@ class SendingQueue extends APIEndpoint {
   /** @var Scheduler */
   private $scheduler;
 
+  /** @var Validator */
+  private $validator;
+
   public function __construct(
     SubscribersFeature $subscribersFeature,
     NewslettersRepository $newsletterRepository,
     SendingQueuesRepository $sendingQueuesRepository,
-    Bridge $bridge,
     SubscribersFinder $subscribersFinder,
     ScheduledTasksRepository $scheduledTasksRepository,
     MailerFactory $mailerFactory,
-    Scheduler $scheduler
+    Scheduler $scheduler,
+    Validator $validator
   ) {
     $this->subscribersFeature = $subscribersFeature;
     $this->subscribersFinder = $subscribersFinder;
     $this->newsletterRepository = $newsletterRepository;
-    $this->bridge = $bridge;
     $this->sendingQueuesRepository = $sendingQueuesRepository;
     $this->scheduledTasksRepository = $scheduledTasksRepository;
     $this->mailerFactory = $mailerFactory;
     $this->scheduler = $scheduler;
+    $this->validator = $validator;
   }
 
   public function add($data = []) {
@@ -97,7 +97,7 @@ class SendingQueue extends APIEndpoint {
       ]);
     }
 
-    $validationError = $this->validateNewsletter($newsletterEntity);
+    $validationError = $this->validator->validate($newsletterEntity);
     if ($validationError) {
       return $this->errorResponse([
         APIError::BAD_REQUEST => $validationError,
@@ -178,30 +178,6 @@ class SendingQueue extends APIEndpoint {
     }
   }
 
-  private function validateNewsletter(NewsletterEntity $newsletterEntity): ?string {
-    if (
-      $newsletterEntity->getBody()
-      && is_array($newsletterEntity->getBody())
-      && $newsletterEntity->getBody()['content']
-    ) {
-      $body = json_encode($newsletterEntity->getBody()['content']);
-      if ($body === false) {
-        return __('Poet, please add prose to your masterpiece before you send it to your followers.');
-      }
-
-      if (
-        $this->bridge->isMailpoetSendingServiceEnabled()
-        && (strpos($body, '[link:subscription_unsubscribe_url]') === false)
-        && (strpos($body, '[link:subscription_unsubscribe]') === false)
-      ) {
-        return __('All emails must include an "Unsubscribe" link. Add a footer widget to your email to continue.');
-      }
-    } else {
-      return __('Poet, please add prose to your masterpiece before you send it to your followers.');
-    }
-    return null;
-  }
-
   public function pause($data = []) {
     $newsletterId = (isset($data['newsletter_id'])
       ? (int)$data['newsletter_id']

mailpoet/lib/DI/ContainerConfigurator.php

@@ -391,6 +391,7 @@ class ContainerConfigurator implements IContainerConfigurator {
     $container->autowire(\MailPoet\Newsletter\AutomaticEmailsRepository::class)->setPublic(true);
     $container->autowire(\MailPoet\Newsletter\NewsletterHtmlSanitizer::class)->setPublic(true);
     $container->autowire(\MailPoet\Newsletter\Url::class)->setPublic(true);
+    $container->autowire(\MailPoet\Newsletter\Validator::class)->setPublic(true);
     $container->autowire(\MailPoet\Newsletter\Links\Links::class)->setPublic(true);
     $container->autowire(\MailPoet\Newsletter\Listing\NewsletterListingRepository::class)->setPublic(true);
     $container->autowire(\MailPoet\Newsletter\Options\NewsletterOptionsRepository::class)->setPublic(true);

mailpoet/lib/Newsletter/Validator.php

@@ -0,0 +1,42 @@
+<?php declare(strict_types=1);
+
+namespace MailPoet\Newsletter;
+
+use MailPoet\Entities\NewsletterEntity;
+use MailPoet\Services\Bridge;
+
+class Validator {
+  
+  /** @var Bridge */
+  private $bridge;
+  
+  public function __construct(
+    Bridge $bridge
+  ) {
+    $this->bridge = $bridge;
+  }
+  
+  public function validate(NewsletterEntity $newsletterEntity): ?string {
+    if (
+      $newsletterEntity->getBody()
+      && is_array($newsletterEntity->getBody())
+      && $newsletterEntity->getBody()['content']
+    ) {
+      $body = json_encode($newsletterEntity->getBody()['content']);
+      if ($body === false) {
+        return __('Poet, please add prose to your masterpiece before you send it to your followers.');
+      }
+
+      if (
+        $this->bridge->isMailpoetSendingServiceEnabled()
+        && (strpos($body, '[link:subscription_unsubscribe_url]') === false)
+        && (strpos($body, '[link:subscription_unsubscribe]') === false)
+      ) {
+        return __('All emails must include an "Unsubscribe" link. Add a footer widget to your email to continue.');
+      }
+    } else {
+      return __('Poet, please add prose to your masterpiece before you send it to your followers.');
+    }
+    return null;
+  }
+}

mailpoet/tests/integration/API/JSON/v1/SendingQueueTest.php

@@ -18,6 +18,7 @@ use MailPoet\Newsletter\Options\NewsletterOptionsRepository;
 use MailPoet\Newsletter\Scheduler\Scheduler;
 use MailPoet\Newsletter\Sending\ScheduledTasksRepository;
 use MailPoet\Newsletter\Sending\SendingQueuesRepository;
+use MailPoet\Newsletter\Validator;
 use MailPoet\Segments\SubscribersFinder;
 use MailPoet\Services\Bridge;
 use MailPoet\Settings\SettingsController;
@@ -80,11 +81,11 @@ class SendingQueueTest extends \MailPoetTest {
       ]),
       $this->diContainer->get(NewslettersRepository::class),
       $this->diContainer->get(SendingQueuesRepository::class),
-      $this->diContainer->get(Bridge::class),
       $this->diContainer->get(SubscribersFinder::class),
       $this->diContainer->get(ScheduledTasksRepository::class),
       $this->diContainer->get(MailerFactory::class),
-      $this->diContainer->get(Scheduler::class)
+      $this->diContainer->get(Scheduler::class),
+      $this->diContainer->get(Validator::class)
     );
     $res = $sendingQueue->add(['newsletter_id' => $this->newsletter->getId()]);
     expect($res->status)->equals(APIResponse::STATUS_FORBIDDEN);
@@ -149,13 +150,13 @@ class SendingQueueTest extends \MailPoetTest {
       $this->diContainer->get(SubscribersFeature::class),
       $this->diContainer->get(NewslettersRepository::class),
       $this->diContainer->get(SendingQueuesRepository::class),
-      Stub::make(Bridge::class, [
-        'isMailpoetSendingServiceEnabled' => true,
-      ]),
       $this->diContainer->get(SubscribersFinder::class),
       $this->diContainer->get(ScheduledTasksRepository::class),
       $this->diContainer->get(MailerFactory::class),
-      $this->diContainer->get(Scheduler::class)
+      $this->diContainer->get(Scheduler::class),
+      new Validator(Stub::make(Bridge::class, [
+        'isMailpoetSendingServiceEnabled' => true,
+      ]))
     );
     $response = $sendingQueue->add(['newsletter_id' => $newsletter->getId()]);
     $response = $response->getData();