Introduce the Subscriber API. Closes #787

app/Http/Controllers/Api/SubscriberController.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Http\Controllers\Api;
+
+use CachetHQ\Cachet\Events\CustomerHasSubscribedEvent;
+use CachetHQ\Cachet\Models\Subscriber;
+use Exception;
+use GrahamCampbell\Binput\Facades\Binput;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+class SubscriberController extends AbstractApiController
+{
+    /**
+     * Get all subscribers.
+     *
+     * @param \Symfony\Component\HttpFoundation\Request $request
+     *
+     * @return \Illuminate\Database\Eloquent\Collection
+     */
+    public function getSubscribers(Request $request)
+    {
+        $subscribers = Subscriber::paginate(Binput::get('per_page', 20));
+
+        return $this->paginator($subscribers, $request);
+    }
+
+    /**
+     * Create a new subscriber.
+     *
+     * @return \CachetHQ\Cachet\Models\Subscriber
+     */
+    public function postSubscribers()
+    {
+        $subscriberData = Binput::except('verify');
+
+        try {
+            $subscriber = Subscriber::create($subscriberData);
+        } catch (Exception $e) {
+            throw new BadRequestHttpException();
+        }
+
+        if ($subscriber->isValid()) {
+            // If we're auto-verifying the subscriber, don't bother with this event.
+            if (!(Binput::get('verify'))) {
+                event(new CustomerHasSubscribedEvent($subscriber));
+            }
+
+            return $this->item($subscriber);
+        }
+
+        throw new BadRequestHttpException();
+    }
+
+    /**
+     * Delete a subscriber.
+     *
+     * @param \CachetHQ\Cachet\Models\Subscriber $subscriber
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function deleteSubscriber(Subscriber $subscriber)
+    {
+        $subscriber->delete();
+
+        return $this->noContent();
+    }
+}

app/Http/Routes/ApiRoutes.php

@@ -45,10 +45,13 @@ class ApiRoutes
 
             // Api protected
             $router->group(['middleware' => 'auth.api'], function ($router) {
+                $router->get('subscribers', 'SubscriberController@getSubscribers');
+
                 $router->post('components', 'ComponentController@postComponents');
                 $router->post('incidents', 'IncidentController@postIncidents');
                 $router->post('metrics', 'MetricController@postMetrics');
                 $router->post('metrics/{metric}/points', 'MetricPointController@postMetricPoints');
+                $router->post('subscribers', 'SubscriberController@postSubscribers');
 
                 $router->put('components/{component}', 'ComponentController@putComponent');
                 $router->put('incidents/{incident}', 'IncidentController@putIncident');
@@ -59,6 +62,7 @@ class ApiRoutes
                 $router->delete('incidents/{incident}', 'IncidentController@deleteIncident');
                 $router->delete('metrics/{metric}', 'MetricController@deleteMetric');
                 $router->delete('metrics/{metric}/points/{metric_point}', 'MetricPointController@deleteMetricPoint');
+                $router->delete('subscribers/{subscriber}', 'SubscriberController@deleteSubscriber');
             });
         });
     }

app/Models/Subscriber.php

@@ -11,11 +11,13 @@
 
 namespace CachetHQ\Cachet\Models;
 
+use CachetHQ\Cachet\Presenters\SubscriberPresenter;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use McCool\LaravelAutoPresenter\HasPresenter;
 use Watson\Validating\ValidatingTrait;
 
-class Subscriber extends Model
+class Subscriber extends Model implements HasPresenter
 {
     use SoftDeletes, ValidatingTrait;
 
@@ -75,4 +77,14 @@ class Subscriber extends Model
     {
         return str_random(42);
     }
+
+    /**
+     * Get the presenter class.
+     *
+     * @return string
+     */
+    public function getPresenterClass()
+    {
+        return SubscriberPresenter::class;
+    }
 }

app/Presenters/SubscriberPresenter.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Presenters;
+
+use CachetHQ\Cachet\Presenters\Traits\TimestampsTrait;
+
+class SubscriberPresenter extends AbstractPresenter
+{
+    use TimestampsTrait;
+
+    /**
+     * Convert the presenter instance to an array.
+     *
+     * @return string[]
+     */
+    public function toArray()
+    {
+        return array_merge($this->wrappedObject->toArray(), [
+            'created_at'  => $this->created_at(),
+            'updated_at'  => $this->updated_at(),
+            'verified_at' => $this->verified_at(),
+        ]);
+    }
+}

app/Presenters/Traits/TimestampsTrait.php

@@ -47,4 +47,15 @@ trait TimestampsTrait
         return (new Date($this->wrappedObject->deleted_at))
             ->setTimezone($this->setting->get('app_timezone'))->toDateTimeString();
     }
+
+    /**
+     * Present formatted date time.
+     *
+     * @return string
+     */
+    public function verified_at()
+    {
+        return (new Date($this->wrappedObject->verified_at))
+            ->setTimezone($this->setting->get('app_timezone'))->toDateTimeString();
+    }
 }