Added API/Endpoint abstract class

- (re)Added Endpoints folder to both API and Router
- fixed syntax in namespaces
- xhr.responseJSON is returned to the fail()
- fixed Router endpoints (view in browser, cron,...)

assets/js/src/ajax.js

@@ -16,9 +16,6 @@ define('ajax', ['mailpoet', 'jquery', 'underscore'], function(MailPoet, jQuery,
       post: function(options) {
         return this.request('post', options);
       },
-      delete: function(options) {
-        return this.request('delete', options);
-      },
       init: function(options) {
         // merge options
         this.options = jQuery.extend({}, this.defaults, options);
@@ -48,7 +45,7 @@ define('ajax', ['mailpoet', 'jquery', 'underscore'], function(MailPoet, jQuery,
 
         // set request params
         var params = this.getParams();
-        var jqXHR;
+        var deferred = jQuery.Deferred();
 
         // remove null values from the data object
         if (_.isObject(params.data)) {
@@ -59,25 +56,29 @@ define('ajax', ['mailpoet', 'jquery', 'underscore'], function(MailPoet, jQuery,
 
         // make ajax request depending on method
         if(method === 'get') {
-          jqXHR = jQuery.get(
+          jQuery.get(
             this.options.url,
             params,
-            this.options.onSuccess,
+            null,
             'json'
           );
         } else {
-          jqXHR = jQuery.ajax({
-            url: this.options.url,
-            type : 'post',
-            data: params,
-            dataType: 'json'
+          jQuery.post(
+            this.options.url,
+            params,
+            null,
+            'json'
+          ).then(function(data) {
+            deferred.resolve();
+          }, function(xhr) {
+            deferred.reject(xhr.responseJSON);
           });
         }
 
         // clear options
         this.options = {};
 
-        return jqXHR;
+        return deferred;
       }
   };
 });

lib/API/API.php

@@ -36,19 +36,19 @@ class API {
 
   function setupAdmin() {
     if($this->checkToken() === false) {
-      $this->errorResponse(
+      (new ErrorResponse(
         array('unauthorized' => __('This request is not authorized.')),
         array(),
-        APIResponse::STATUS_UNAUTHORIZED
-      )->send();
+        Response::STATUS_UNAUTHORIZED
+      ))->send();
     }
 
     if($this->checkPermissions() === false) {
-      $this->errorResponse(
+      (new ErrorResponse(
         array('forbidden' => __('You do not have the required permissions.')),
         array(),
-        APIResponse::STATUS_FORBIDDEN
-      )->send();
+        Response::STATUS_FORBIDDEN
+      ))->send();
     }
 
     $this->processRoute();
@@ -56,9 +56,9 @@ class API {
 
   function setupPublic() {
     if($this->checkToken() === false) {
-      $response = new APIErrorResponse(array(
+      $response = new ErrorResponse(array(
         'unauthorized' => __('This request is not authorized.')
-      ), APIResponse::STATUS_UNAUTHORIZED);
+      ), Response::STATUS_UNAUTHORIZED);
       $response->send();
     }
 
@@ -67,7 +67,7 @@ class API {
 
   function processRoute() {
     $class = ucfirst($_POST['endpoint']);
-    $endpoint =  __NAMESPACE__ . "\\" . $class;
+    $endpoint =  __NAMESPACE__ . "\\Endpoints\\" . $class;
     $method = $_POST['method'];
 
     $doing_ajax = (bool)(defined('DOING_AJAX') && DOING_AJAX);
@@ -101,9 +101,7 @@ class API {
         wp_send_json($response);
       }
     } catch(\Exception $e) {
-      $this->errorResponse(array(
-        $e->getMessage()
-      ))->send();
+      (new ErrorResponse(array($e->getMessage())))->send();
     }
   }
 
@@ -125,22 +123,4 @@ class API {
       wp_verify_nonce($_POST['token'], 'mailpoet_token')
     );
   }
-
-  function successResponse(
-    $data = array(), $meta = array(), $status = APIResponse::STATUS_OK
-  ) {
-
-    return new APISuccessResponse($data, $meta, $status);
-  }
-
-  function errorResponse(
-    $errors = array(), $meta = array(), $status = APIResponse::STATUS_NOT_FOUND
-  ) {
-
-    return new APIErrorResponse($errors, $meta, $status);
-  }
-
-  function badRequest($errors = array(), $meta = array()) {
-    return new APIErrorResponse($errors, $meta, APIResponse::STATUS_BAD_REQUEST);
-  }
 }

lib/API/Endpoint.php

@@ -0,0 +1,25 @@
+<?php
+namespace MailPoet\API;
+
+if(!defined('ABSPATH')) exit;
+
+abstract class Endpoint {
+
+  function successResponse(
+    $data = array(), $meta = array(), $status = Response::STATUS_OK
+  ) {
+
+    return new SuccessResponse($data, $meta, $status);
+  }
+
+  function errorResponse(
+    $errors = array(), $meta = array(), $status = Response::STATUS_NOT_FOUND
+  ) {
+
+    return new ErrorResponse($errors, $meta, $status);
+  }
+
+  function badRequest($errors = array(), $meta = array()) {
+    return new ErrorResponse($errors, $meta, Response::STATUS_BAD_REQUEST);
+  }
+}

lib/API/Endpoints/AutomatedLatestContent.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 if(!defined('ABSPATH')) exit;
 

lib/API/Endpoints/Cron.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Cron\CronHelper;
 use MailPoet\Cron\Supervisor;

lib/API/Endpoints/CustomFields.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use \MailPoet\Models\CustomField;
 

lib/API/Endpoints/Forms.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use \MailPoet\Models\Form;
 use \MailPoet\Models\StatisticsForms;

lib/API/Endpoints/ImportExport.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Subscribers\ImportExport\Import\MailChimp;
 use MailPoet\Models\CustomField;

lib/API/Endpoints/Mailer.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 if(!defined('ABSPATH')) exit;
 

lib/API/Endpoints/NewsletterTemplates.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Models\NewsletterTemplate;
 

lib/API/Endpoints/Newsletters.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Listing;
 use MailPoet\Models\Newsletter;

lib/API/Endpoints/Segments.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use \MailPoet\Models\Segment;
 use \MailPoet\Models\SubscriberSegment;

lib/API/Endpoints/SendingQueue.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Mailer\Mailer;
 use MailPoet\Models\Newsletter;

lib/API/Endpoints/Settings.php

@@ -1,10 +1,11 @@
 <?php
-namespace MailPoet\API;
+namespace MailPoet\API\Endpoints;
+use \MailPoet\API\Endpoint as APIEndpoint;
 use \MailPoet\Models\Setting;
 
 if(!defined('ABSPATH')) exit;
 
-class Settings extends API {
+class Settings extends APIEndpoint {
   function __construct() {
   }
 
@@ -20,7 +21,7 @@ class Settings extends API {
       foreach($settings as $name => $value) {
         Setting::setValue($name, $value);
       }
-      return $this->successResponse();
+      return $this->successResponse(Setting::getAll());
     }
   }
 }

lib/API/Endpoints/Setup.php

@@ -1,7 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
-
+namespace MailPoet\API\Endpoints;
 use \MailPoet\Config\Activator;
 
 if(!defined('ABSPATH')) exit;

lib/API/Endpoints/Subscribers.php

@@ -1,6 +1,5 @@
 <?php
-namespace MailPoet\API
-    ;
+namespace MailPoet\API\Endpoints;
 
 use MailPoet\Listing;
 use MailPoet\Models\Subscriber;

lib/API/ErrorResponse.php

@@ -3,7 +3,7 @@ namespace MailPoet\API;
 
 if(!defined('ABSPATH')) exit;
 
-class APIErrorResponse extends APIResponse {
+class ErrorResponse extends Response {
   public $errors;
 
   function __construct($errors = array(), $meta = array(), $status = self::STATUS_NOT_FOUND) {

lib/API/Response.php

@@ -3,7 +3,7 @@ namespace MailPoet\API;
 
 if(!defined('ABSPATH')) exit;
 
-abstract class APIResponse {
+abstract class Response {
   const STATUS_OK = 200;
   const STATUS_BAD_REQUEST = 400;
   const STATUS_UNAUTHORIZED = 401;

lib/API/SuccessResponse.php

@@ -3,7 +3,7 @@ namespace MailPoet\API;
 
 if(!defined('ABSPATH')) exit;
 
-class APISuccessResponse extends APIResponse {
+class SuccessResponse extends Response {
   public $data;
 
   function __construct($data = array(), $meta = array(), $status = self::STATUS_OK) {

lib/Config/Populator.php

@@ -74,13 +74,6 @@ class Populator {
   private function createDefaultSettings() {
     $current_user = wp_get_current_user();
 
-    if(!Setting::getValue('task_scheduler')) {
-      // disable task scheduler (cron) be default
-      Setting::setValue('task_scheduler', array(
-        'method' => 'WordPress'
-      ));
-    }
-
     // default sender info based on current user
     $sender = array(
       'name' => $current_user->display_name,

lib/Cron/CronHelper.php

@@ -2,7 +2,7 @@
 namespace MailPoet\Cron;
 
 use MailPoet\Router\Front as FrontRouter;
-use MailPoet\Router\Queue as QueueEndpoint;
+use MailPoet\Router\Endpoints\Queue as QueueEndpoint;
 use MailPoet\Models\Setting;
 use MailPoet\Util\Security;
 

lib/Models/Setting.php

@@ -38,6 +38,9 @@ class Setting extends Model {
           'interval' => self::DEFAULT_SENDING_FREQUENCY_INTERVAL
         )
       ),
+      'task_scheduler' => array(
+        'method' => 'WordPress'
+      ),
       'signup_confirmation' => array(
         'enabled' => true,
         'subject' => sprintf(__('Confirm your subscription to %1$s'), get_option('blogname')),

lib/Newsletter/Links/Links.php

@@ -2,7 +2,7 @@
 namespace MailPoet\Newsletter\Links;
 
 use MailPoet\Router\Front as FrontRouter;
-use MailPoet\Router\Track as TrackEndpoint;
+use MailPoet\Router\Endpoints\Track as TrackEndpoint;
 use MailPoet\Models\NewsletterLink;
 use MailPoet\Newsletter\Shortcodes\Shortcodes;
 use MailPoet\Util\Security;

lib/Newsletter/Url.php

@@ -2,7 +2,7 @@
 namespace MailPoet\Newsletter;
 
 use MailPoet\Router\Front as FrontRouter;
-use MailPoet\Router\ViewInBrowser as ViewInBrowserEndpoint;
+use MailPoet\Router\Endpoints\ViewInBrowser as ViewInBrowserEndpoint;
 use MailPoet\Models\Subscriber;
 
 class Url {

lib/Router/Endpoints/Queue.php

@@ -1,5 +1,5 @@
 <?php
-namespace MailPoet\Router;
+namespace MailPoet\Router\Endpoints;
 
 use MailPoet\Cron\Daemon;
 

lib/Router/Endpoints/Subscription.php

@@ -1,5 +1,5 @@
 <?php
-namespace MailPoet\Router;
+namespace MailPoet\Router\Endpoints;
 
 use MailPoet\Subscription as UserSubscription;
 

lib/Router/Endpoints/Track.php

@@ -1,5 +1,5 @@
 <?php
-namespace MailPoet\Router;
+namespace MailPoet\Router\Endpoints;
 
 use MailPoet\Statistics\Track\Clicks;
 use MailPoet\Statistics\Track\Opens;

lib/Router/Endpoints/ViewInBrowser.php

@@ -1,5 +1,5 @@
 <?php
-namespace MailPoet\Router;
+namespace MailPoet\Router\Endpoints;
 
 use MailPoet\Newsletter\ViewInBrowser as NewsletterViewInBrowser;
 

lib/Router/Front.php

@@ -1,6 +1,5 @@
 <?php
 namespace MailPoet\Router;
-
 use MailPoet\Util\Helpers;
 
 if(!defined('ABSPATH')) exit;
@@ -28,13 +27,14 @@ class Front {
   }
 
   function init() {
-    $endpoint = ucfirst($this->endpoint);
+    $class =  __NAMESPACE__ . "\\Endpoints\\" . ucfirst($this->endpoint);
+
     if(!$this->api_request) return;
-    if(!$this->endpoint || !class_exists($endpoint)) {
+    if(!$this->endpoint || !class_exists($class)) {
       self::terminateRequest(self::RESPONSE_ERROR, __('Invalid Router endpoint.'));
     }
     $this->callEndpoint(
-      $endpoint,
+      $class,
       $this->action,
       $this->data
     );

lib/Subscription/Pages.php

@@ -1,7 +1,6 @@
 <?php
 namespace MailPoet\Subscription;
 
-use \MailPoet\Router\Subscribers;
 use \MailPoet\Models\Subscriber;
 use \MailPoet\Models\SubscriberSegment;
 use \MailPoet\Models\CustomField;

lib/Subscription/Url.php

@@ -2,7 +2,7 @@
 namespace MailPoet\Subscription;
 
 use MailPoet\Router\Front as FrontRouter;
-use MailPoet\Router\Subscription as SubscriptionEndpoint;
+use MailPoet\Router\Endpoints\Subscription as SubscriptionEndpoint;
 use MailPoet\Models\Subscriber;
 use MailPoet\Models\Setting;
 

tests/unit/API/CustomFieldsTest.php

@@ -1,6 +1,6 @@
 <?php
 
-use \MailPoet\API\CustomFields;
+use \MailPoet\API\Endpoints\CustomFields;
 use \MailPoet\Models\CustomField;
 
 class CustomFieldsTest extends MailPoetTest {

tests/unit/API/FormsTest.php

@@ -1,5 +1,5 @@
 <?php
-use \MailPoet\API\Forms;
+use \MailPoet\API\Endpoints\Forms;
 use \MailPoet\Models\Form;
 use \MailPoet\Models\Segment;
 

tests/unit/API/NewsletterTemplatesTest.php

@@ -1,5 +1,5 @@
 <?php
-use \MailPoet\API\NewsletterTemplates;
+use \MailPoet\API\Endpoints\NewsletterTemplates;
 use \MailPoet\Models\NewsletterTemplate;
 
 class NewsletterTemplatesTest extends MailPoetTest {

tests/unit/API/NewslettersTest.php

@@ -1,5 +1,5 @@
 <?php
-use \MailPoet\API\Newsletters;
+use \MailPoet\API\Endpoints\Newsletters;
 use \MailPoet\Models\Newsletter;
 use \MailPoet\Models\NewsletterSegment;
 use \MailPoet\Models\NewsletterTemplate;

tests/unit/API/SegmentsTest.php

@@ -1,5 +1,5 @@
 <?php
-use \MailPoet\API\Segments;
+use \MailPoet\API\Endpoints\Segments;
 use \MailPoet\Models\Segment;
 
 class SegmentsTest extends MailPoetTest {

tests/unit/API/SettingsTest.php

@@ -1,6 +1,6 @@
 <?php
-use \MailPoet\API\APIResponse;
-use \MailPoet\API\Settings;
+use \MailPoet\API\Response;
+use \MailPoet\API\Endpoints\Settings;
 use \MailPoet\Models\Setting;
 
 class SettingsTest extends MailPoetTest {
@@ -12,14 +12,14 @@ class SettingsTest extends MailPoetTest {
     $router = new Settings();
 
     $response = $router->get();
-    expect($response->status)->equals(APIResponse::STATUS_OK);
+    expect($response->status)->equals(Response::STATUS_OK);
 
     expect($response->data)->notEmpty();
     expect($response->data['some']['setting']['key'])->true();
 
     Setting::deleteMany();
     $response = $router->get();
-    expect($response->status)->equals(APIResponse::STATUS_OK);
+    expect($response->status)->equals(Response::STATUS_OK);
     expect($response->data)->equals(Setting::getDefaults());
   }
 
@@ -36,13 +36,13 @@ class SettingsTest extends MailPoetTest {
     $router = new Settings();
 
     $response = $router->set(/* missing data */);
-    expect($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
+    expect($response->status)->equals(Response::STATUS_BAD_REQUEST);
 
     $response = $router->set($new_settings);
-    expect($response->status)->equals(APIResponse::STATUS_OK);
+    expect($response->status)->equals(Response::STATUS_OK);
 
     $response = $router->get();
-    expect($response->status)->equals(APIResponse::STATUS_OK);
+    expect($response->status)->equals(Response::STATUS_OK);
     expect($response->data['some']['setting'])->hasntKey('key');
     expect($response->data['some']['setting']['new_key'])->true();
     expect($response->data['some']['new_setting'])->true();

tests/unit/API/SetupTest.php

@@ -1,5 +1,5 @@
 <?php
-use \MailPoet\API\Setup;
+use \MailPoet\API\Endpoints\Setup;
 use \MailPoet\Models\Setting;
 
 class SetupTest extends MailPoetTest {

tests/unit/API/SubscribersTest.php

@@ -1,6 +1,6 @@
 <?php
 
-use \MailPoet\API\Subscribers;
+use \MailPoet\API\Endpoints\Subscribers;
 use \MailPoet\Models\Subscriber;
 use \MailPoet\Models\Segment;
 

views/settings.html

@@ -77,14 +77,13 @@
             endpoint: 'settings',
             action: 'set',
             data: settings_data
-          }).done(function() {
+          }).done(function(response) {
             MailPoet.Notice.success(
               "<%= __('Settings saved') %>",
               { scroll: true }
             );
             MailPoet.Modal.loading(false);
-          }).error(function(xhr) {
-            var response = xhr.responseJSON;
+          }).fail(function(response) {
             if (response.errors !== undefined) {
               MailPoet.Notice.error(
                 response.errors.map(function(error) { return error.message; }),