Merge branch 'master' into request-headers

Author: peej

README.markdown

@@ -374,6 +374,47 @@ can amend the front controller to catch these exceptions and handle them.
     $response->output();
 
 
+User authentication
+-------------------
+
+Need to secure a resource? Something like the following is a good pattern.
+
+    /**
+     * @uri /secret
+     */
+    class SecureResource extends Tonic\Resource {
+
+        /**
+         * @method GET
+         * @secure aUser aPassword
+         */
+        function secret() {
+            return 'My secret';
+        }
+
+        function secure($username, $password) {
+            if (
+                isset($_SERVER['PHP_AUTH_USER']) && $_SERVER['PHP_AUTH_USER'] == $username &&
+                isset($_SERVER['PHP_AUTH_PW']) && $_SERVER['PHP_AUTH_PW'] == $password
+            ) {
+                return;
+            }
+            throw new Tonic\UnauthorizedException;
+        }
+    }
+
+    $app = new Tonic\Application();
+    $request = new Tonic\Request();
+    $resource = $app->getResource($request);
+    try {
+        $response = $resource->exec();
+    } catch(Tonic\UnauthorizedException $e) {
+        $response = new Tonic\Response(401);
+        $response->wwwAuthenticate = 'Basic realm="My Realm"';
+    }
+    $response->output();
+
+
 
 For more information, read the code. Start with the dispatcher "web/dispatch.php"
 and the Hello world in the "src/Tyrell" directory.

features/bootstrap/FeatureContext.php

@@ -213,7 +213,7 @@ public function loadTheResource()
     public function theLoadedResourceShouldHaveAClassOf($className)
     {
         $loadedClassName = get_class($this->resource);
-        if ($loadedClassName != $className) throw new Exception($loadedClassName);
+        if ($loadedClassName != $className) throw new Exception($loadedClassName.' != '.$className);
     }
 
     /**
@@ -416,4 +416,17 @@ public function theResourceShouldHaveTheURI($resourceName, $url)
         if (!$found) throw new Exception;
     }
 
+    /**
+     * @Then /^the resource "([^"]*)" should have the condition "([^"]*)" with the parameters "([^"]*)"$/
+     */
+    public function theResourceShouldHaveTheConditionWithTheParameters($className, $conditionName, $parameters)
+    {
+        $metadata = $this->app->getResourceMetadata($className);
+        if ($parameters != join(',', $metadata['methods']['test']['foo'])) throw new Exception('Condition method not found');
+
+        $resource = new $className($this->app, new Request, array());
+        $condition = call_user_func_array(array($resource, $conditionName), explode(',', $parameters));
+        if ($condition != explode(',', $parameters)) throw new Exception('Condition parameters not returned');
+    }
+
 }

features/resource.feature

@@ -93,4 +93,24 @@ Feature: HTTP resource object
     And a resource definition "child1" with URI "/child1" and priority of 1
     When I create an application object
     And I create a request object
-    Then the loaded resource "child1" should respond with the method "method1"
+    Then the loaded resource "child1" should respond with the method "method1"
+
+  Scenario: Condition methods should be passed all of the annotation parameters
+    Given a class definition:
+      """
+      /**
+       * @uri /resource6
+       */
+      class Resource6 extends Tonic\Resource {
+        /**
+         * @method get
+         * @foo bar baz quux
+         */
+        function test() {}
+        function foo($bar, $baz, $quux) {
+          return array($bar, $baz, $quux);
+        }
+      }
+      """
+    When I create an application object
+    Then the resource "Resource6" should have the condition "foo" with the parameters "bar,baz,quux"

src/Tonic/Application.php

@@ -7,6 +7,11 @@
  */
 class Application
 {
+    /**
+     * Application configuration options
+     */
+    private $options = array();
+
     /**
      * Metadata of the loaded resources
      */
@@ -15,6 +20,7 @@ class Application
     public function __construct($options = array())
     {
         $this->baseUri = dirname($_SERVER['SCRIPT_NAME']);
+        $this->options = $options;
 
         // load resource metadata passed in via options array
         if (isset($options['resources']) && is_array($options['resources'])) {
@@ -88,7 +94,7 @@ public function loadResourceMetadata($uriSpace = NULL)
     public function mount($namespaceName, $uriSpace)
     {
         foreach ($this->resources as $className => $metadata) {
-            if ($metadata['namespace'] == $namespaceName) {
+            if ($metadata['namespace'][0] == $namespaceName) {
                 foreach ($metadata['uri'] as $index => $uri) {
                     $this->resources[$className]['uri'][$index][0] = '|^'.$uriSpace.substr($uri[0], 2);
                 }
@@ -211,9 +217,9 @@ private function readResourceAnnotations($className)
         $classReflector = new \ReflectionClass($className);
 
         $metadata['class'] = '\\'.$classReflector->getName();
-        $metadata['namespace'] = $classReflector->getNamespaceName();
+        $metadata['namespace'] = array($classReflector->getNamespaceName());
         $metadata['filename'] = $classReflector->getFileName();
-        $metadata['priority'] = 1;
+        $metadata['priority'] = array(1);
 
         // get data from docComment
         $docComment = $this->parseDocComment($classReflector->getDocComment());
@@ -236,8 +242,9 @@ private function readResourceAnnotations($className)
      */
     private function uriTemplateToRegex($uri)
     {
-        preg_match_all('#((?<!\?):[^/]+|{[^0-9][^}]*}|\(.+?\))#', $uri, $params, PREG_PATTERN_ORDER);
-        $return = array($uri);
+        preg_match_all('#((?<!\?):[^/]+|{[^0-9][^}]*}|\(.+?\))#', $uri[0], $params, PREG_PATTERN_ORDER);
+        #$return = array($uri);
+        $return = $uri;
         if (isset($params[1])) {
             foreach ($params[1] as $index => $param) {
                 if (substr($param, 0, 1) == ':') {
@@ -273,7 +280,7 @@ public function readMethodAnnotations($className)
                 foreach ($docComment as $annotationName => $value) {
                     $methodName = substr($annotationName, 1);
                     if (method_exists($className, $methodName)) {
-                        $methodMetadata[$methodName] = $value;
+                        $methodMetadata[$methodName] = $value[0];
                     }
                 }
                 $metadata[$methodReflector->getName()] = $methodMetadata;
@@ -298,9 +305,11 @@ private function parseDocComment($comment)
                 if ($parts) {
                     $key = array_shift($parts);
                     if (isset($data[$key])) {
-                        $data[$key][] = trim(join(' ', $parts));
+                        //$data[$key][] = trim(join(' ', $parts));
+                        $data[$key][] = $parts;
                     } else {
-                        $data[$key] = array(trim(join(' ', $parts)));
+                        //$data[$key] = array(trim(join(' ', $parts)));
+                        $data[$key] = array($parts);
                     }
                 }
             }

src/Tonic/ConditionException.php

@@ -5,4 +5,7 @@
 /**
  * Exception to be thrown when a resource method condition fails
  */
-class ConditionException extends Exception {}
+class ConditionException extends Exception
+{
+    protected $message = 'A method condition failed';
+}

src/Tonic/MetadataCache.php

@@ -4,49 +4,33 @@
 
 /**
  * Cache resource metadata between invocations
- *
- * This class serializes the resource metadata and writes it to disk for reading in a later request.
  */
-class MetadataCache
+interface MetadataCache
 {
-    private $filename;
-
-    public function __construct($filename)
-    {
-        $this->filename = $filename;
-    }
-
     /**
      * Is there already cache file
      * @return boolean
      */
-    public function isCached()
-    {
-        return is_readable($this->filename);
-    }
+    public function isCached();
 
     /**
      * Load the resource metadata from disk
      * @return str[]
      */
-    public function load()
-    {
-        return unserialize(file_get_contents($this->filename));
-    }
+    public function load();
 
     /**
      * Save resource metadata to disk
      * @param  str[]   $resources Resource metadata
      * @return boolean
      */
-    public function save($resources)
-    {
-        return file_put_contents($this->filename, serialize($resources));
-    }
+    public function save($resources);
+
+    /**
+     * Clear the cache
+     */
+    public function clear();
 
-    public function __toString()
-    {
-        return $this->filename;
-    }
+    public function __toString();
 
 }

src/Tonic/MetadataCacheAPC.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Tonic;
+
+/**
+ * Cache resource metadata between invocations
+ *
+ * This class writes the resource metadata to APC for reading in a later request.
+ */
+class MetadataCacheAPC implements MetadataCache
+{
+    const CACHENAME = 'tonicCache';
+
+    /**
+     * Is there already cache file
+     * @return boolean
+     */
+    public function isCached()
+    {
+        return apc_exists(self::CACHENAME);
+    }
+
+    /**
+     * Load the resource metadata from disk
+     * @return str[]
+     */
+    public function load()
+    {
+        return apc_fetch(self::CACHENAME);
+    }
+
+    /**
+     * Save resource metadata to disk
+     * @param  str[]   $resources Resource metadata
+     * @return boolean
+     */
+    public function save($resources)
+    {
+        return apc_store(self::CACHENAME, $resources);
+    }
+
+    public function clear()
+    {
+        apc_delete(self::CACHENAME);
+    }
+
+    public function __toString()
+    {
+        $info = apc_cache_info('user');
+        return 'Metadata for '.count($this->load()).' resources stored in APC at '.date('r', $info['cache_list'][0]['creation_time']);
+    }
+
+}

src/Tonic/MetadataCacheFile.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Tonic;
+
+/**
+ * Cache resource metadata between invocations
+ *
+ * This class serializes the resource metadata and writes it to disk for reading in a later request.
+ */
+class MetadataCacheFile implements MetadataCache
+{
+    private $filename;
+
+    public function __construct($filename)
+    {
+        $this->filename = $filename;
+    }
+
+    /**
+     * Is there already cache file
+     * @return boolean
+     */
+    public function isCached()
+    {
+        return is_readable($this->filename);
+    }
+
+    /**
+     * Load the resource metadata from disk
+     * @return str[]
+     */
+    public function load()
+    {
+        return unserialize(file_get_contents($this->filename));
+    }
+
+    /**
+     * Save resource metadata to disk
+     * @param  str[]   $resources Resource metadata
+     * @return boolean
+     */
+    public function save($resources)
+    {
+        return file_put_contents($this->filename, serialize($resources));
+    }
+
+    public function clear()
+    {
+        @unlink($this->filename);
+    }
+
+    public function __toString()
+    {
+        return 'Metadata for '.count($this->load()).' resources stored in file "'.$this->filename.'" at '.date('r', filemtime($this->filename));
+    }
+
+}

src/Tonic/MethodNotAllowedException.php

@@ -5,4 +5,5 @@
 class MethodNotAllowedException extends Exception
 {
     protected $code = 405;
+    protected $message = 'The HTTP method specified in the Request-Line is not allowed for the resource identified by the Request-URI';
 }

src/Tonic/NotAcceptableException.php

@@ -5,4 +5,5 @@
 class NotAcceptableException extends Exception
 {
     protected $code = 406;
+    protected $message = 'The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request';
 }