Merge pull request #16 from Vectorface/dev

jdpanderson · web-flow · commit c109042040fb · 2017-11-08T08:32:51.000-05:00
v0.2.0 Release Changes
diff --git a/.travis.yml b/.travis.yml
@@ -3,18 +3,21 @@ sudo: false
 cache: bundler
 
 php:
+  - 7.1
   - 7.0
   - 5.6
   - 5.5
   - 5.4
-  - 5.3
-  - 7.0
   - hhvm
 
 matrix:
   allow_failures:
-    - php: hhvm, 7.0
+    - php: hhvm
   fast_finish: true
+  include:
+    - php: 5.3
+      dist: precise
+
 
 before_script:
   - composer self-update
diff --git a/composer.json b/composer.json
@@ -31,7 +31,8 @@
         "php": ">=5.3.0",
         "vectorface/whip": "~0.2",
         "twig/twig": "~1.0",
-        "danbruce/fast-route":"~0.6"
+        "danbruce/fast-route":"~0.6",
+        "psr/log": "~1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "4.2.*",
diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -65,7 +65,7 @@ Create the file `tutorial/composer.json` with the following contents:
     "name": "vectorface/snappy-tutorial",
     "autoload": {
         "psr-4": {
-            "Vectorface\\SnappyTutorial": "./app"
+            "Vectorface\\SnappyTutorial\\": "./app"
         }
     },
     "require": {
@@ -219,11 +219,10 @@ Note that there are many ways to pass variables to the view.
 3. Directly rendering the view with `$this->renderView`. More details for this
    method can be found [here](handlers/controller_handler/#integration-with-twig).
 
-We will divide our view into two files. The first file `layout.twig` will
+We will divide our view into two files. The first file `app/Views/layout.twig` will
 provide common boilerplate that we could reuse across multiple pages.
 
 ```html
-<!-- app/Views/layout.twig -->
 <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -242,10 +241,9 @@ provide common boilerplate that we could reuse across multiple pages.
 </html>
 ```
 
-And a very simple view for our `indexAction`.
+And a very simple view for our `indexAction` in `app/Views/index/index.twig`:
 
 ```html
-<!-- app/Views/index/index.twig -->
 {% extends 'layout.twig' %}
 
 {% block content %}
@@ -254,5 +252,6 @@ And a very simple view for our `indexAction`.
 </div>
 {% endblock %}
 ```
+
 Once you add the `tutorial` folder to your standard web root, you should have
 a working application at `http://localhost/tutorial/`.
diff --git a/src/Vectorface/SnappyRouter/Handler/ControllerHandler.php b/src/Vectorface/SnappyRouter/Handler/ControllerHandler.php
@@ -94,8 +94,10 @@ public function isAppropriate($path, $query, $post, $verb)
         $this->request = new HttpRequest(
             ucfirst($controller).'Controller',
             $action.'Action',
-            $verb
+            $verb,
+            'php://input'
         );
+
         $this->request->setQuery($query);
         $this->request->setPost($post);
 
diff --git a/src/Vectorface/SnappyRouter/Handler/RestHandler.php b/src/Vectorface/SnappyRouter/Handler/RestHandler.php
@@ -45,16 +45,11 @@ public function isAppropriate($path, $query, $post, $verb)
         if ($routeInfo[1] & self::MATCHES_ID) {
             $this->routeParams[] = intval($routeInfo[2]['objectId']);
         }
-        return true;
-    }
 
-    /**
-     * Returns the active response encoder.
-     * @return EncoderInterface Returns the response encoder.
-     */
-    public function getEncoder()
-    {
-        return new JsonEncoder();
+        // use JSON encoder by default
+        $this->encoder = new JsonEncoder();
+
+        return true;
     }
 
     /**
diff --git a/src/Vectorface/SnappyRouter/Request/HttpRequest.php b/src/Vectorface/SnappyRouter/Request/HttpRequest.php
@@ -2,6 +2,8 @@
 
 namespace Vectorface\SnappyRouter\Request;
 
+use Vectorface\SnappyRouter\Exception\InternalErrorException;
+
 /**
  * A class representing an controller-modelled web request.
  * @copyright Copyright (c) 2014, VectorFace, Inc.
@@ -15,10 +17,15 @@ class HttpRequest extends AbstractRequest implements HttpRequestInterface
     /** Holds the contents of the various inputs ($_GET, $_POST, etc) */
     private $input;
 
+    /** The input stream (stream or location string) */
+    private $stream;
+
     /** Array key for query parameters */
     const INPUT_METHOD_QUERY = 'QUERY';
     /** Array key for post parameters */
     const INPUT_METHOD_POST = 'POST';
+    /** Array key for input stream body */
+    const INPUT_METHOD_BODY = 'BODY';
 
     // mappings between magic filter strings and the filter functions
     private static $filterCallbacks = array(
@@ -35,14 +42,18 @@ class HttpRequest extends AbstractRequest implements HttpRequestInterface
      * @param string $controller The controller being requested.
      * @param string $action The action being invoked.
      * @param string $verb The HTTP verb used in the request.
+     * @param mixed $stream A stream or a string describing a stream location.
      */
-    public function __construct($controller, $action, $verb)
+    public function __construct($controller, $action, $verb, $stream = 'php://input')
     {
         parent::__construct($controller, $action);
         $this->setVerb($verb);
+        $this->setStream($stream);
+
         $this->input = array(
             self::INPUT_METHOD_QUERY  => array(),
-            self::INPUT_METHOD_POST   => array()
+            self::INPUT_METHOD_POST   => array(),
+            self::INPUT_METHOD_BODY   => null
         );
     }
 
@@ -66,6 +77,17 @@ public function setVerb($verb)
         return $this;
     }
 
+    /**
+     * Sets the stream used in the request.
+     * @param mixed $stream The stream used in the request.
+     * @return RequestInterface Returns $this.
+     */
+    public function setStream($stream)
+    {
+        $this->stream = $stream;
+        return $this;
+    }
+
     /**
      * Returns true if the request is a GET request and false otherwise.
      * @return bool Returns true if the request is a GET request and false
@@ -144,6 +166,42 @@ public function setPost($postData)
         return $this;
     }
 
+    /**
+     * Returns the input stream data for the current request
+     * @return string The input stream data
+     */
+    public function getBody()
+    {
+        // If this value has been read from the stream, retrieve it from storage
+        if (null !== $this->input[self::INPUT_METHOD_BODY]) {
+            return $this->input[self::INPUT_METHOD_BODY];
+        }
+
+        if (is_resource($this->stream) && 'stream' === get_resource_type($this->stream)) {
+            $streamData = stream_get_contents($this->stream);
+        } elseif (is_string($this->stream)) {
+            $stream = @fopen($this->stream, "r");
+
+            if (false === $stream) {
+                throw new InternalErrorException('Unable to open request input stream.');
+            }
+
+            $streamData = stream_get_contents($stream);
+
+            fclose($stream);
+        } else {
+            $streamData = false;
+        }
+
+        if (false === $streamData) {
+            throw new InternalErrorException('Unable to open request input stream.');
+        }
+
+        $this->input[self::INPUT_METHOD_BODY] = $streamData;
+
+        return $this->input[self::INPUT_METHOD_BODY];
+    }
+
     /**
      * Returns an array of all the input parameters from the query and post data.
      * @return array An array of all input.
diff --git a/src/Vectorface/SnappyRouter/Request/JsonRpcRequest.php b/src/Vectorface/SnappyRouter/Request/JsonRpcRequest.php
@@ -33,7 +33,7 @@ public function __construct($controller, $payload, $verb = 'POST')
         if (is_object($payload) && isset($payload->method)) {
             $action = $payload->method;
         }
-        parent::__construct($controller, $action, $verb);
+        parent::__construct($controller, $action, $verb, 'php://input');
         $this->payload = $payload;
     }
 
diff --git a/src/Vectorface/SnappyRouter/SnappyRouter.php b/src/Vectorface/SnappyRouter/SnappyRouter.php
@@ -3,6 +3,8 @@
 namespace Vectorface\SnappyRouter;
 
 use \Exception;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Vectorface\SnappyRouter\Config\Config;
 use Vectorface\SnappyRouter\Config\ConfigInterface;
 use Vectorface\SnappyRouter\Di\Di;
@@ -26,6 +28,11 @@ class SnappyRouter
     private $config; // the configuration
     private $handlers; // array of registered handlers
 
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * The constructor for the service router.
      * @param array $config The configuration array.
@@ -34,6 +41,17 @@ public function __construct(ConfigInterface $config)
     {
         $this->config = $config;
         $this->parseConfig();
+        $this->logger = new NullLogger();
+    }
+
+    /**
+     * Configure SnappyRouter to log its actions.
+     *
+     * @param LoggerInterface $logger
+     */
+    public function setLogger(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
     }
 
     /**
@@ -85,6 +103,7 @@ public function handleRoute($environment = null)
      */
     public function handleHttpRoute($path, $query, $post, $verb)
     {
+        $this->logger->debug("SnappyRouter: Handling HTTP route: $path");
         return $this->invokeHandler(false, array($path, $query, $post, $verb));
     }
 
@@ -95,6 +114,7 @@ public function handleHttpRoute($path, $query, $post, $verb)
      */
     public function handleCliRoute($pathComponents)
     {
+        $this->logger->debug("SnappyRouter: Handling CLI route: " . implode("/", $pathComponents));
         return $this->invokeHandler(true, array($pathComponents));
     }
 
@@ -111,39 +131,61 @@ private function invokeHandler($isCli, $handlerParams)
         try {
             // determine which handler should handle this path
             $activeHandler = $this->determineHandler($isCli, $handlerParams);
+            $this->logger->debug("SnappyRouter: Selected handler: " . get_class($activeHandler));
             // invoke the initial plugin hook
             $activeHandler->invokePluginsHook(
                 'afterHandlerSelected',
                 array($activeHandler)
             );
+            $this->logger->debug("SnappyRouter: routing");
             $response = $activeHandler->performRoute();
             $activeHandler->invokePluginsHook(
                 'afterFullRouteInvoked',
                 array($activeHandler)
             );
             return $response;
         } catch (Exception $e) {
-            // if we have a valid handler give it a chance to handle the error
-            if (null !== $activeHandler) {
-                $activeHandler->invokePluginsHook(
-                    'errorOccurred',
-                    array($activeHandler, $e)
-                );
-                return $activeHandler->getEncoder()->encode(
-                    new Response($activeHandler->handleException($e))
-                );
-            }
+            return $this->handleInvocationException($e, $activeHandler, $isCli);
+        }
+    }
+
+    /**
+     * Attempts to mop up after an exception during handler invocation.
+     *
+     * @param \Exception $exception The exception that occurred during invocation.
+     * @param HandlerInterface $activeHandler The active handler, or null.
+     * @param bool $isCli True for CLI handlers, false otherwise.
+     * @return mixed Returns a handler-dependent response type, usually a string.
+     */
+    private function handleInvocationException($exception, $activeHandler, $isCli)
+    {
+        $this->logger->debug(sprintf(
+            "SnappyRouter: caught exception while invoking handler: %s (%d)",
+            $exception->getMessage(),
+            $exception->getCode()
+        ));
 
-            // if not on the command line, set an HTTP response code
-            if (!$isCli) {
-                $responseCode = AbstractResponse::RESPONSE_SERVER_ERROR;
-                if ($e instanceof RouterExceptionInterface) {
-                    $responseCode = $e->getAssociatedStatusCode();
-                }
-                \Vectorface\SnappyRouter\http_response_code($responseCode);
+        // if we have a valid handler give it a chance to handle the error
+        if (null !== $activeHandler) {
+            $activeHandler->invokePluginsHook(
+                'errorOccurred',
+                array($activeHandler, $exception)
+            );
+            return $activeHandler->getEncoder()->encode(
+                new Response($activeHandler->handleException($exception))
+            );
+        }
+
+        // if not on the command line, set an HTTP response code
+        if (!$isCli) {
+            $responseCode = AbstractResponse::RESPONSE_SERVER_ERROR;
+            if ($exception instanceof RouterExceptionInterface) {
+                $responseCode = $exception->getAssociatedStatusCode();
             }
-            return $e->getMessage();
+            \Vectorface\SnappyRouter\http_response_code($responseCode);
         }
+        return $exception->getMessage();
+
     }
 
     /**
diff --git a/tests/Vectorface/SnappyRouterTests/Request/HttpRequestTest.php b/tests/Vectorface/SnappyRouterTests/Request/HttpRequestTest.php
diff --git a/tests/Vectorface/SnappyRouterTests/SnappyRouterTest.php b/tests/Vectorface/SnappyRouterTests/SnappyRouterTest.php

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __construct($controller, $payload, $verb = 'POST')`
`33`	`33`	`if (is_object($payload) && isset($payload->method)) {`
`34`	`34`	`$action = $payload->method;`
`35`	`35`	`}`
`36`		`- parent::__construct($controller, $action, $verb);`
	`36`	`+ parent::__construct($controller, $action, $verb, 'php://input');`
`37`	`37`	`$this->payload = $payload;`
`38`	`38`	`}`
`39`	`39`