Merge pull request #670 from StephaneDiot/impl/EZP-21678_Make_unimplemented_REST_features_return_a_501

Implement EZP-21678: Make unimplemented rest features return a 501 error code

Author: bdunogier

eZ/Bundle/EzPublishRestBundle/Resources/config/routing.yml

@@ -230,12 +230,23 @@ ezpublish_rest_createView:
         _controller: ezpublish_rest.controller.content:createView
     methods: [POST]
 
-# @todo this doesn't actually exist. Must generate a 404.
-ezpublish_rest_loadView:
-    path: /content/views/{viewId}
+ezpublish_rest_listView:
+    path: /content/views
+    defaults:
+        _controller: ezpublish_rest.controller.content:listView
+    methods: [GET]
+
+ezpublish_rest_getView:
+    path : /content/views/{viewId}
+    defaults:
+        _controller: ezpublish_rest.controller.content:getView
+    methods: [GET]
 
 ezpublish_rest_loadViewResults:
     path: /content/views/{viewId}/results
+    defaults:
+        _controller: ezpublish_rest.controller.content:loadViewResults
+    methods: [GET]
 
 # Object states
 

eZ/Bundle/EzPublishRestBundle/Resources/config/value_object_visitors.yml

@@ -9,6 +9,7 @@ parameters:
     ezpublish_rest.output.value_object_visitor.BadRequestException.class: eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\BadRequestException
     ezpublish_rest.output.value_object_visitor.ForbiddenException.class: eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ForbiddenException
     ezpublish_rest.output.value_object_visitor.Exception.class: eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\Exception
+    ezpublish_rest.output.value_object_visitor.NotImplementedException.class: eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\NotImplementedException
 
     # Section
     ezpublish_rest.output.value_object_visitor.SectionList.class: eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\SectionList
@@ -168,6 +169,13 @@ services:
         tags:
             - { name: ezpublish_rest.output.value_object_visitor, type: eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException }
 
+    ezpublish_rest.output.value_object_visitor.NotImplementedException:
+        parent: ezpublish_rest.output.value_object_visitor.base
+        class: %ezpublish_rest.output.value_object_visitor.NotImplementedException.class%
+        arguments: [ true  ]
+        tags:
+            - { name: ezpublish_rest.output.value_object_visitor, type: eZ\Publish\API\Repository\Exceptions\NotImplementedException }
+
     ezpublish_rest.output.value_object_visitor.Exception:
         parent: ezpublish_rest.output.value_object_visitor.base
         class: %ezpublish_rest.output.value_object_visitor.Exception.class%

eZ/Publish/Core/REST/Server/Controller/Content.php

@@ -19,6 +19,7 @@
 use eZ\Publish\API\Repository\Exceptions\NotFoundException;
 use eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException;
 use eZ\Publish\API\Repository\Exceptions\ContentValidationException;
+use eZ\Publish\API\Repository\Exceptions\NotImplementedException;
 use eZ\Publish\Core\REST\Server\Exceptions\ForbiddenException;
 use eZ\Publish\Core\REST\Server\Exceptions\BadRequestException;
 
@@ -760,4 +761,34 @@ public function createView()
             )
         );
     }
+
+    /**
+     * List content views
+     *
+     * @return NotImplementedException;
+     */
+    public function listView()
+    {
+        return new NotImplementedException( 'ezpublish_rest.controller.content:listView' );
+    }
+
+    /**
+     * Get a content view
+     *
+     * @return NotImplementedException;
+     */
+    public function getView()
+    {
+        return new NotImplementedException( 'ezpublish_rest.controller.content:getView' );
+    }
+
+    /**
+     * Get a content view results
+     *
+     * @return NotImplementedException;
+     */
+    public function loadViewResults()
+    {
+        return new NotImplementedException( 'ezpublish_rest.controller.content:loadViewResults' );
+    }
 }

eZ/Publish/Core/REST/Server/Output/ValueObjectVisitor/NotImplementedException.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * File containing the NotImplementedException ValueObjectVisitor class
+ *
+ * @copyright Copyright (C) 1999-2013 eZ Systems AS. All rights reserved.
+ * @license http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License v2
+ * @version //autogentag//
+ */
+
+namespace eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor;
+
+/**
+ * NotImplementedException value object visitor
+ */
+class NotImplementedException extends Exception
+{
+    /**
+     * Returns HTTP status code
+     *
+     * @return int
+     */
+    protected function getStatus()
+    {
+        return 501;
+    }
+}

eZ/Publish/Core/REST/Server/Tests/Output/ValueObjectVisitor/NotImplementedExceptionTest.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * File containing a test class
+ *
+ * @copyright Copyright (C) 1999-2013 eZ Systems AS. All rights reserved.
+ * @license http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License v2
+ * @version //autogentag//
+ */
+
+namespace eZ\Publish\Core\REST\Server\Tests\Output\ValueObjectVisitor;
+
+use eZ\Publish\API\Repository\Exceptions\NotImplementedException;
+use eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor;
+use eZ\Publish\Core\REST\Common;
+
+class NotImplementedExceptionTest extends ExceptionTest
+{
+    /**
+     * Get expected status code
+     *
+     * @return int
+     */
+    protected function getExpectedStatusCode()
+    {
+        return 501;
+    }
+
+    /**
+     * Get expected message
+     *
+     * @return string
+     */
+    protected function getExpectedMessage()
+    {
+        return "Not Implemented";
+    }
+
+    /**
+     * Gets the exception
+     *
+     * @return \Exception
+     */
+    protected function getException()
+    {
+        return new NotImplementedException( "Test" );
+
+    }
+
+    /**
+     * Gets the exception visitor
+     *
+     * @return \eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\NotImplementedException
+     */
+    protected function internalGetVisitor()
+    {
+        return new ValueObjectVisitor\NotImplementedException;
+    }
+}