return vars with ensureVars

Author: wilr

README.md

@@ -91,19 +91,20 @@ class MyProjectsApi extends FullscreenInteractive\Restful\Controllers\ApiControl
     public function createProject()
     {
         $this->ensurePOST();
-        $this->ensureLoggedIn([
+        $this->ensureUserLoggedIn([
             'ADMIN'
         ]);
 
-        $this->ensureVars([
+        list($title, $date) = $this->ensureVars([
             'Title',
             'Date' => function($value) {
                 return strtotime($value) > 0
             }
         ]);
 
         $project = new Project();
-        $project->Title = $this->getVar('Title');
+        $project->Title = $title;
+        $project->Date = $title;
         $project->write();
 
         return $this->success([
@@ -114,15 +115,15 @@ class MyProjectsApi extends FullscreenInteractive\Restful\Controllers\ApiControl
     public function deleteProject()
     {
         $this->ensurePOST();
-        $this->ensureLoggedIn([
+        $this->ensureUserLoggedIn([
             'ADMIN'
         ]);
 
-        $this->ensureVars([
+        list($id) = $this->ensureVars([
             'id'
         ]);
 
-        $project = Project::get()->byID($this->getVar('id));
+        $project = Project::get()->byID($id);
 
         if (!$project) {
             return $this->failure([

phpunit.xml.dist

@@ -0,0 +1,24 @@
+<phpunit bootstrap="../../silverstripe/framework/tests/bootstrap.php" colors="true">
+    <testsuite name="Default">
+        <directory>tests</directory>
+    </testsuite>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src/</directory>
+            <exclude>
+                <directory suffix=".php">tests/</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+
+    <php>
+        <env name="SS_DATABASE_CLASS" value="SQLite3Database" force="true" />
+        <env name="SS_DATABASE_PATH" value=":memory:" force="true" />
+        <env name="SS_ENVIRONMENT_TYPE" value="dev" force="true" />
+        <env name="SS_DATABASE_CHOOSE_NAME" value="true" force="true" />
+        <env name="SS_DEFAULT_ADMIN_USERNAME" value="admin" force="true" />
+        <env name="SS_DEFAULT_ADMIN_PASSWORD" value="password" force="true" />
+        <env name="SS_BASE_URL" value="http://localhost" force="true" />
+    </php>
+</phpunit>

src/Controllers/ApiController.php

@@ -52,7 +52,7 @@ public function index()
      *
      * @param array $context
      */
-    protected function success(array $context = []): HTTPResponse
+    public function success(array $context = []): HTTPResponse
     {
         $this->getResponse()->setBody(json_encode(array_merge([
             'timestamp' => time(),
@@ -67,7 +67,7 @@ protected function success(array $context = []): HTTPResponse
      *
      * @param array $context
      */
-    protected function failure(array $context = [])
+    public function failure(array $context = [])
     {
         $response = $this->getResponse();
 
@@ -289,7 +289,7 @@ public function httpError($errorCode = 404, $errorMessage = '')
      *
      * @return mixed
      */
-    protected function getVar($name)
+    public function getVar($name)
     {
         $key = strtolower($name);
 
@@ -301,48 +301,58 @@ protected function getVar($name)
      *
      * @return boolean
      */
-    protected function hasVar($name)
+    public function hasVar($name)
     {
         $key = strtolower($name);
 
         return (isset($this->vars[$key]));
     }
 
     /**
+     * Returns an array of all the variables listed from the POST or GET vars
+     *
+     *
      * @param array
      *
-     * @return boolean
+     * @return array
+     *
      * @throws HTTPResponse_Exception
      */
-    protected function ensureVars(array $vars = [])
+    public function ensureVars(array $vars = [])
     {
+        $output = [];
+
         foreach ($vars as $k => $v) {
             if ($v && is_callable($v)) {
                 if (!$this->hasVar($k) || !$v($this->getVar($k))) {
                     throw $this->httpError(400, 'Missing required variable: '. $v);
                 }
+
+                $output[] = $this->getVar($k);
             } elseif (!$this->hasVar($v)) {
                 throw $this->httpError(400, 'Missing required variable: '. $v);
+            } else {
+                $output[] = $this->getVar($v);
             }
         }
 
-        return true;
+        return $output;
     }
 
     /**
      * @param mixed
      *
      * @return HTTPResponse
      */
-    protected function returnJSON($arr)
+    public function returnJSON($arr)
     {
         return $this->getResponse()->setBody(json_encode($arr));
     }
 
     /**
      * @throws HTTPResponse_Exception
      */
-    protected function ensureGET()
+    public function ensureGET()
     {
         if (!$this->request->isGet()) {
             $this->httpError(400, 'Request must be provided as a GET request');
@@ -352,7 +362,7 @@ protected function ensureGET()
     /**
      * @throws HTTPResponse_Exception
      */
-    protected function ensurePOST()
+    public function ensurePOST()
     {
         if (!$this->request->isPost()) {
             $this->httpError(400, 'Request must be provided as a POST request');

tests/ApiControllerTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace FullscreenInteractive\Restful\Tests;
+
+use FullscreenInteractive\Restful\Controllers\ApiController;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\Session;
+use SilverStripe\Dev\SapphireTest;
+
+class ApiControllerTest extends SapphireTest
+{
+    public function testGetVar()
+    {
+        $api = new ApiController();
+        $response = $api->handleRequest((new HTTPRequest('GET', '/api/', [
+            'foo' => 1
+        ]))->setSession(new Session([])));
+
+        $this->assertEquals(1, $api->getVar('foo'));
+        $this->assertNull($api->getVar('bar'));
+    }
+
+    public function testHasVar()
+    {
+        $api = new ApiController();
+        $response = $api->handleRequest((new HTTPRequest('GET', '/api/', [
+            'foo' => 1
+        ]))->setSession(new Session([])));
+
+        $this->assertTrue($api->hasVar('foo'));
+        $this->assertFalse($api->hasVar('bar'));
+    }
+
+    public function testEnsureVars()
+    {
+        $api = new ApiController();
+        $response = $api->handleRequest((new HTTPRequest('GET', '/api/', [
+            'foo' => 1
+        ]))->setSession(new Session([])));
+
+        list($foo) = $api->ensureVars([
+            'foo'
+        ]);
+
+        $this->assertEquals(1, $foo);
+    }
+}