Merge pull request #48 from tuyakhov/add_delete_action

Add actions for deleting resources and relationships.

Author: tuyakhov

src/actions/Action.php

@@ -26,7 +26,7 @@ class Action extends \yii\rest\Action
     /**
      * Links the relationships with primary model.
      * @param $model ActiveRecordInterface
-     * @param array $data
+     * @param array $data relationship links
      */
     protected function linkRelationships($model, array $data = [])
     {

src/actions/DeleteAction.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\actions;
+
+use Yii;
+use yii\db\BaseActiveRecord;
+use yii\web\NotFoundHttpException;
+use yii\web\ServerErrorHttpException;
+
+/**
+ * Implements the API endpoint for deleting resources.
+ * @link http://jsonapi.org/format/#crud-deleting
+ */
+class DeleteAction extends Action
+{
+    /**
+     * Deletes a resource.
+     * @param mixed $id id of the resource to be deleted.
+     * @throws NotFoundHttpException
+     * @throws ServerErrorHttpException on failure.
+     */
+    public function run($id)
+    {
+        /** @var BaseActiveRecord $model */
+        $model = $this->findModel($id);
+
+        if ($this->checkAccess) {
+            call_user_func($this->checkAccess, $this->id, $model);
+        }
+
+        if ($model->delete() === false) {
+            throw new ServerErrorHttpException('Failed to delete the resource for unknown reason.');
+        }
+
+        Yii::$app->getResponse()->setStatusCode(204);
+    }
+}

src/actions/DeleteRelationshipAction.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\actions;
+
+use Yii;
+use yii\data\ActiveDataProvider;
+use yii\db\ActiveRecordInterface;
+use yii\db\ActiveRelationTrait;
+use yii\db\BaseActiveRecord;
+use yii\helpers\ArrayHelper;
+use yii\web\ForbiddenHttpException;
+use yii\web\NotFoundHttpException;
+
+/**
+ * Deletes the specified members from a relationship
+ * @link http://jsonapi.org/format/#crud-updating-relationships
+ */
+class DeleteRelationshipAction extends Action
+{
+    /**
+     * Removes the relationships from primary model.
+     * @var callable
+     */
+    public $unlinkRelationships;
+
+    /**
+     * @param string $id an ID of the primary resource
+     * @param string $name a name of the related resource
+     * @return ActiveDataProvider
+     * @throws ForbiddenHttpException
+     * @throws NotFoundHttpException
+     * @throws \yii\base\InvalidConfigException
+     */
+    public function run($id, $name)
+    {
+        /** @var BaseActiveRecord $model */
+        $model = $this->findModel($id);
+
+        if (!$related = $model->getRelation($name, false)) {
+            throw new NotFoundHttpException('Relationship does not exist');
+        }
+
+        if (!$related->multiple) {
+            throw new ForbiddenHttpException('Unsupported request to update relationship');
+        }
+
+        if ($this->checkAccess) {
+            call_user_func($this->checkAccess, $this->id, $model, $name);
+        }
+
+        $this->unlinkRelationships($model, [$name => Yii::$app->getRequest()->getBodyParams()]);
+
+
+        return new ActiveDataProvider([
+            'query' => $related
+        ]);
+    }
+
+    /**
+     * Removes the relationships from primary model.
+     * @param $model ActiveRecordInterface
+     * @param array $data relationship links
+     */
+    protected function unlinkRelationships($model, array $data = [])
+    {
+        if ($this->unlinkRelationships !== null) {
+            call_user_func($this->unlinkRelationships, $this, $model, $data);
+            return;
+        }
+
+        foreach ($data as $name => $relationship) {
+            /** @var $related ActiveRelationTrait */
+            if (!$related = $model->getRelation($name, false)) {
+                continue;
+            }
+            /** @var BaseActiveRecord $relatedClass */
+            $relatedClass = new $related->modelClass;
+            $relationships = ArrayHelper::keyExists($relatedClass->formName(), $relationship) ? $relationship[$relatedClass->formName()] : [];
+
+            $ids = [];
+            foreach ($relationships as $index => $relObject) {
+                if (!isset($relObject['id'])) {
+                    continue;
+                }
+                $ids[] = $relObject['id'];
+            }
+
+            $records = $relatedClass::find()->andWhere(['in', $relatedClass::primaryKey(), $ids])->all();
+            foreach ($records as $record) {
+                $model->unlink($name, $record);
+            }
+        }
+    }
+}

src/actions/UpdateRelationshipAction.php

@@ -5,7 +5,6 @@
 
 namespace tuyakhov\jsonapi\actions;
 
-use tuyakhov\jsonapi\ResourceInterface;
 use yii\data\ActiveDataProvider;
 use yii\db\BaseActiveRecord;
 use yii\web\BadRequestHttpException;

src/actions/ViewAction.php

@@ -0,0 +1,12 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\actions;
+
+
+class ViewAction extends \yii\rest\ViewAction
+{
+
+}

tests/actions/DeleteActionTest.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\tests\actions;
+
+use tuyakhov\jsonapi\actions\DeleteAction;
+use tuyakhov\jsonapi\tests\data\ActiveQuery;
+use tuyakhov\jsonapi\tests\data\ResourceModel;
+use tuyakhov\jsonapi\tests\TestCase;
+use yii\web\Controller;
+
+class DeleteActionTest extends TestCase
+{
+    public function testSuccess()
+    {
+        \Yii::$app->controller = new Controller('test', \Yii::$app);
+        $action = new DeleteAction('test', \Yii::$app->controller, [
+            'modelClass' => ResourceModel::className(),
+        ]);
+
+        ResourceModel::$id = 124;
+        ActiveQuery::$models = new ResourceModel();
+
+        $action->run(124);
+        $this->assertTrue(\Yii::$app->getResponse()->getIsEmpty());
+    }
+}

tests/actions/DeleteRelationshipActionTest.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * @author Anton Tuyakhov <atuyakhov@gmail.com>
+ */
+
+namespace tuyakhov\jsonapi\tests\actions;
+
+use tuyakhov\jsonapi\actions\DeleteRelationshipAction;
+use tuyakhov\jsonapi\tests\data\ActiveQuery;
+use tuyakhov\jsonapi\tests\data\ResourceModel;
+use tuyakhov\jsonapi\tests\TestCase;
+use yii\data\ActiveDataProvider;
+use yii\web\Controller;
+use yii\web\ForbiddenHttpException;
+
+class DeleteRelationshipActionTest extends TestCase
+{
+    public function testSuccess()
+    {
+        $model = new ResourceModel();
+        $action = new DeleteRelationshipAction('test', new Controller('test', \Yii::$app), [
+            'modelClass' => ResourceModel::className()
+        ]);
+        ResourceModel::$related = [
+            'extraField1' => new ActiveQuery(ResourceModel::className(), ['multiple' => true]),
+            'extraField2' => new ActiveQuery(ResourceModel::className())
+        ];
+        $action->findModel = function ($id, $action) use($model) {
+            return $model;
+        };
+        $model->extraField1 = [new ResourceModel()];
+        \Yii::$app->request->setBodyParams(['ResourceModel' => ['type' => 'resource-models', 'id' => 123]]);
+        $this->assertInstanceOf(ActiveDataProvider::className(), $dataProvider = $action->run(1, 'extraField1'));
+        $this->expectException(ForbiddenHttpException::class);
+        $this->assertInstanceOf(ResourceModel::className(), $action->run(1, 'extraField2'));
+    }
+}

tests/data/ResourceModel.php

@@ -86,11 +86,21 @@ public function unlinkAll($name)
         $this->$name = null;
     }
 
+    public function unlink($name, $model)
+    {
+        array_pop($this->$name);
+    }
+
     public function save()
     {
         return true;
     }
 
+    public function delete()
+    {
+        return true;
+    }
+
     public function getLinks()
     {
         return [