Call different actions for standard and automated newsletters on Send step

- converted save and setStatus method of Newsletters endpoint
- updated pause/resume mixin for notification & welcome listings
- use 'newsletter_id' instead of 'id' in SendingQueue endpoint (less confusing)
- added NOT_FOUND constant to APIError
- fixed unit test for Newsletters endpoint save and added test for setStatus

lib/API/Endpoints/Newsletters.php

@@ -1,5 +1,7 @@
 <?php
 namespace MailPoet\API\Endpoints;
+use MailPoet\API\Endpoint as APIEndpoint;
+use MailPoet\API\Error as APIError;
 
 use MailPoet\Listing;
 use MailPoet\Models\Newsletter;
@@ -18,10 +20,7 @@ if(!defined('ABSPATH')) exit;
 
 require_once(ABSPATH . 'wp-includes/pluggable.php');
 
-class Newsletters {
-  function __construct() {
-  }
-
+class Newsletters extends APIEndpoint {
   function get($id = false) {
     $newsletter = Newsletter::findOne($id);
     if($newsletter === false) {
@@ -55,10 +54,7 @@ class Newsletters {
     $errors = $newsletter->getErrors();
 
     if(!empty($errors)) {
-      return array(
-        'result' => false,
-        'errors' => $errors
-      );
+      return $this->badRequest($errors);
     } else {
       if(!empty($segment_ids)) {
         NewsletterSegment::where('newsletter_id', $newsletter->id)
@@ -92,32 +88,39 @@ class Newsletters {
         }
       }
 
-      return array(
-        'result' => true
+      return $this->successResponse(
+        Newsletter::findOne($newsletter->id)->asArray()
       );
     }
   }
 
   function setStatus($data = array()) {
-    $id = (isset($data['id'])) ? (int)$data['id'] : null;
+    $id = (isset($data['id'])) ? (int)$data['id'] : false;
     $newsletter = Newsletter::findOne($id);
     $status = (isset($data['status']) ? $data['status'] : null);
 
-    $result = false;
-    $errors = array();
-
-    if($newsletter !== false && $status !== null) {
-      $newsletter->setStatus($status);
-
-      $result = (
-        $newsletter->getErrors() === false && $newsletter->status === $status
-      );
+    if(!$status) {
+      return $this->badRequest(array(
+        APIError::BAD_REQUEST  => __('You need to specify a status.')
+      ));
     }
 
-    return array(
-      'result' => $result,
-      'status' => $newsletter->status
-    );
+    if($newsletter === false) {
+      return $this->errorResponse(array(
+        APIError::NOT_FOUND => __('This newsletter does not exist.')
+      ));
+    }
+
+    $newsletter->setStatus($status);
+    $errors = $newsletter->getErrors();
+
+    if(!empty($errors)) {
+      return $this->errorResponse($errors);
+    } else {
+      return $this->successResponse(
+        $newsletter->asArray()
+      );
+    }
   }
 
   function restore($id) {
@@ -189,7 +192,7 @@ class Newsletters {
   }
 
   function sendPreview($data = array()) {
-    $id = (isset($data['id'])) ? (int)$data['id'] : null;
+    $id = (isset($data['id'])) ? (int)$data['id'] : false;
     $newsletter = Newsletter::findOne($id);
 
     if($newsletter === false) {

lib/API/Endpoints/SendingQueue.php

@@ -18,10 +18,14 @@ if(!defined('ABSPATH')) exit;
 
 class SendingQueue extends APIEndpoint {
   function add($data = array()) {
-    $id = (isset($data['id']) ? (int)$data['id'] : null);
+    $newsletter_id = (isset($data['newsletter_id'])
+      ? (int)$data['newsletter_id']
+      : false
+    );
 
     // check that the newsletter exists
-    $newsletter = Newsletter::filter('filterWithOptions')->findOne($id);
+    $newsletter = Newsletter::filter('filterWithOptions')
+      ->findOne($newsletter_id);
 
     if($newsletter === false) {
       return $this->errorResponse(array(
@@ -38,94 +42,80 @@ class SendingQueue extends APIEndpoint {
       ));
     }
 
-    // Automated newsletters (welcome & post notification)
-    if($newsletter->type === Newsletter::TYPE_WELCOME ||
-       $newsletter->type === Newsletter::TYPE_NOTIFICATION
-    ) {
-      // set newsletter status to active
-      $result = $newsletter->setStatus(Newsletter::STATUS_ACTIVE);
-      $errors = $result->getErrors();
+    // add newsletter to the sending queue
+    $queue = SendingQueueModel::whereNull('status')
+    ->where('newsletter_id', $newsletter->id)
+    ->findOne();
 
-      if(!empty($errors)) {
-        return $this->errorResponse($errors);
-      } else {
-        return $this->successResponse(
-          Newsletter::findOne($newsletter->id)->asArray()
-        );
-      }
-    } else {
-      // Standard newsletters
-      $queue = SendingQueueModel::whereNull('status')
-      ->where('newsletter_id', $newsletter->id)
+    if(!empty($queue)) {
+      return $this->errorResponse(array(
+        APIError::NOT_FOUND => __('This newsletter is already being sent.')
+      ));
+    }
+
+    $queue = SendingQueueModel::where('newsletter_id', $newsletter->id)
+      ->where('status', SendingQueueModel::STATUS_SCHEDULED)
       ->findOne();
+    if(!$queue) {
+      $queue = SendingQueueModel::create();
+      $queue->newsletter_id = $newsletter->id;
+    }
 
-      if(!empty($queue)) {
+    if((bool)$newsletter->isScheduled) {
+      // set newsletter status
+      $newsletter->setStatus(Newsletter::STATUS_SCHEDULED);
+
+      // set queue status
+      $queue->status = SendingQueueModel::STATUS_SCHEDULED;
+      $queue->scheduled_at = Scheduler::scheduleFromTimestamp(
+        $newsletter->scheduledAt
+      );
+      $queue->subscribers = null;
+      $queue->count_total = $queue->count_to_process = 0;
+    } else {
+      $segments = $newsletter->segments()->findArray();
+      $segment_ids = array_map(function($segment) {
+        return $segment['id'];
+      }, $segments);
+      $subscribers = Subscriber::getSubscribedInSegments($segment_ids)
+        ->findArray();
+      $subscribers = Helpers::arrayColumn($subscribers, 'subscriber_id');
+      $subscribers = array_unique($subscribers);
+      if(!count($subscribers)) {
         return $this->errorResponse(array(
-          APIError::NOT_FOUND => __('This newsletter is already being sent.')
+          APIError::UNKNOWN => __('There are no subscribers in that list!')
         ));
       }
+      $queue->status = null;
+      $queue->scheduled_at = null;
+      $queue->subscribers = serialize(
+        array(
+          'to_process' => $subscribers
+        )
+      );
+      $queue->count_total = $queue->count_to_process = count($subscribers);
 
-      $queue = SendingQueueModel::where('newsletter_id', $newsletter->id)
-        ->where('status', SendingQueueModel::STATUS_SCHEDULED)
-        ->findOne();
-      if(!$queue) {
-        $queue = SendingQueueModel::create();
-        $queue->newsletter_id = $newsletter->id;
-      }
+      // set newsletter status
+      $newsletter->setStatus(Newsletter::STATUS_SENDING);
+    }
+    $queue->save();
 
-      if((bool)$newsletter->isScheduled) {
-        // set newsletter status
-        $newsletter->setStatus(Newsletter::STATUS_SCHEDULED);
-
-        // set queue status
-        $queue->status = SendingQueueModel::STATUS_SCHEDULED;
-        $queue->scheduled_at = Scheduler::scheduleFromTimestamp(
-          $newsletter->scheduledAt
-        );
-        $queue->subscribers = null;
-        $queue->count_total = $queue->count_to_process = 0;
-      } else {
-        $segments = $newsletter->segments()->findArray();
-        $segment_ids = array_map(function($segment) {
-          return $segment['id'];
-        }, $segments);
-        $subscribers = Subscriber::getSubscribedInSegments($segment_ids)
-          ->findArray();
-        $subscribers = Helpers::arrayColumn($subscribers, 'subscriber_id');
-        $subscribers = array_unique($subscribers);
-        if(!count($subscribers)) {
-          return $this->errorResponse(array(
-            APIError::UNKNOWN => __('There are no subscribers in that list!')
-          ));
-        }
-        $queue->status = null;
-        $queue->scheduled_at = null;
-        $queue->subscribers = serialize(
-          array(
-            'to_process' => $subscribers
-          )
-        );
-        $queue->count_total = $queue->count_to_process = count($subscribers);
-
-        // set newsletter status
-        $newsletter->setStatus(Newsletter::STATUS_SENDING);
-      }
-      $queue->save();
-
-      $errors = $queue->getErrors();
-      if(!empty($errors)) {
-        return $this->errorResponse($errors);
-      } else {
-        return $this->successResponse(
-          $newsletter->getQueue()->asArray()
-        );
-      }
+    $errors = $queue->getErrors();
+    if(!empty($errors)) {
+      return $this->errorResponse($errors);
+    } else {
+      return $this->successResponse(
+        $newsletter->getQueue()->asArray()
+      );
     }
   }
 
   function pause($data = array()) {
-    $id = (isset($data['id']) ? (int)$data['id'] : null);
-    $newsletter = Newsletter::findOne($id);
+    $newsletter_id = (isset($data['newsletter_id'])
+      ? (int)$data['newsletter_id']
+      : false
+    );
+    $newsletter = Newsletter::findOne($newsletter_id);
 
     if($newsletter === false) {
       return $this->errorResponse(array(
@@ -148,9 +138,11 @@ class SendingQueue extends APIEndpoint {
   }
 
   function resume($data = array()) {
-    $id = (isset($data['id']) ? (int)$data['id'] : null);
-    $newsletter = Newsletter::findOne($id);
-
+    $newsletter_id = (isset($data['newsletter_id'])
+      ? (int)$data['newsletter_id']
+      : false
+    );
+    $newsletter = Newsletter::findOne($newsletter_id);
     if($newsletter === false) {
       return $this->errorResponse(array(
         APIError::NOT_FOUND => __('This newsletter does not exist.')