Fixing issue 109 - Allow requests with empty body (#114)

Support OPTIONS method

src/Exception/EmptyBodyException.php

@@ -0,0 +1,10 @@
+<?php
+namespace Raml\Exception;
+
+class EmptyBodyException extends \Exception
+{
+    public function __construct($message = "", $code = 0, $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/Method.php

@@ -1,6 +1,8 @@
 <?php
 namespace Raml;
 
+use Raml\Exception\EmptyBodyException;
+
 /**
  * Method
  *
@@ -10,10 +12,9 @@ class Method implements ArrayInstantiationInterface, MessageSchemaInterface
 {
     /**
      * Valid METHODS
-     * - Currently missing OPTIONS as this is unlikely to be specified in RAML
      * @var array
      */
-    public static $validMethods = ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'PATCH'];
+    public static $validMethods = ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'PATCH', 'OPTIONS'];
 
     // ---
 
@@ -381,8 +382,12 @@ public function addQueryParameter(NamedParameter $queryParameter)
      */
     public function getBodyByType($type)
     {
+        if (empty($this->getBodies())){
+            throw new EmptyBodyException();
+        }
+
         if (!isset($this->bodyList[$type])) {
-            throw new \Exception('No body of type "' . $type . '"');
+            throw new \Exception("No body of type '$type'");
         }
 
         return $this->bodyList[$type];

src/Validator/ValidatorSchemaHelper.php

@@ -5,6 +5,7 @@
 use Raml\ApiDefinition;
 use Raml\Body;
 use Raml\Exception\BadParameter\ResourceNotFoundException;
+use Raml\Exception\EmptyBodyException;
 use Raml\MessageSchemaInterface;
 use Raml\Method;
 use Raml\NamedParameter;
@@ -142,20 +143,23 @@ public function getResponseHeaders($method, $path, $statusCode, $requiredOnly =
      * @param string $path
      * @param string $contentType
      * @return Body
+     * @throws EmptyBodyException
      * @throws ValidatorSchemaException
      */
     private function getBody(MessageSchemaInterface $schema, $method, $path, $contentType)
     {
         try {
             $body = $schema->getBodyByType($contentType);
+        } catch (EmptyBodyException $e) {
+            throw new EmptyBodyException($e->getMessage());
         } catch (Exception $exception) {
             $message = sprintf(
                 'Schema for %s %s with content type %s was not found in API definition',
                 strtoupper($method),
                 $path,
                 $contentType
             );
-            
+
             throw new ValidatorSchemaException($message, 0, $exception);
         }
 

test/MethodTest.php

@@ -12,6 +12,9 @@ public function shouldGetTheTypeInUpperCase()
 
         $method = \Raml\Method::createFromArray('Post', [], $apiDefinition);
         $this->assertSame('POST', $method->getType());
+
+        $method = \Raml\Method::createFromArray('options', [], $apiDefinition);
+        $this->assertSame('OPTIONS', $method->getType());
     }
 
     /** @test */

test/Validator/RequestValidatorTest.php

@@ -136,6 +136,22 @@ public function shouldCatchInvalidBody()
         $validator->validateRequest($this->request);
     }
 
+    /** @test */
+    public function shouldAllowEmptyRequestBody()
+    {
+        $body = $this->getMock('\Psr\Http\Message\StreamInterface');
+        $body->method('getContents')->willReturn('');
+
+        $this->request->method('getMethod')->willReturn('get');
+        $this->uri->method('getPath')->willReturn('/songs');
+        $this->request->method('getHeaderLine')->with('Content-Type')->willReturn('application/json');
+        $this->request->method('getBody')->willReturn($body);
+
+        $validator = $this->getValidatorForSchema(__DIR__ . '/../fixture/validator/requestBody.raml');
+        $validator->validateRequest($this->request);
+
+    }
+
     /**
      * @param string $fixturePath
      * @return RequestValidator

test/fixture/validator/requestBody.raml

@@ -3,6 +3,11 @@ title: Example API
 version: v1
 
 /songs:
+
+  get:
+      responses:
+        200:
+
   post:
     body:
       application/json: