From 0dc8883e0922d5865f9f4e271ea5a4ce0c1dfd34 Mon Sep 17 00:00:00 2001
From: William DURAND <william.durand1@gmail.com>
Date: Wed, 11 Apr 2012 20:00:21 +0200
Subject: [PATCH] Introduced ApiBundle

---
 Annotation/ApiDoc.php                      | 61 ++++++++++++++++++++++
 DependencyInjection/NelmioApiExtension.php | 21 ++++++++
 EventListener/RequestListener.php          | 57 ++++++++++++++++++++
 Formatter/ApiDocFormatter.php              | 53 +++++++++++++++++++
 NelmioApiBundle.php                        |  9 ++++
 Parser/FormTypeParser.php                  | 53 +++++++++++++++++++
 Resources/config/request_listener.xml      | 19 +++++++
 Resources/config/services.xml              | 20 +++++++
 8 files changed, 293 insertions(+)
 create mode 100644 Annotation/ApiDoc.php
 create mode 100644 DependencyInjection/NelmioApiExtension.php
 create mode 100644 EventListener/RequestListener.php
 create mode 100644 Formatter/ApiDocFormatter.php
 create mode 100644 NelmioApiBundle.php
 create mode 100644 Parser/FormTypeParser.php
 create mode 100644 Resources/config/request_listener.xml
 create mode 100644 Resources/config/services.xml

diff --git a/Annotation/ApiDoc.php b/Annotation/ApiDoc.php
new file mode 100644
index 000000000..006a40e48
--- /dev/null
+++ b/Annotation/ApiDoc.php
@@ -0,0 +1,61 @@
+<?php
+
+namespace Nelmio\ApiBundle\Annotation;
+
+/**
+ * @Annotation
+ */
+class ApiDoc
+{
+    /**
+     * @var array
+     */
+    private $filters  = array();
+
+    /**
+     * @var string
+     */
+    private $formType = null;
+
+    /**
+     * @var string
+     */
+    private $comment = null;
+
+    public function __construct(array $data)
+    {
+        if (isset($data['formType'])) {
+            $this->formType = $data['formType'];
+        } else if (isset($data['filters'])) {
+            foreach ($data['filters'] as $filter) {
+                if (!isset($filter['name'])) {
+                    throw new \InvalidArgumentException('A "filter" element has to contain a "name" attribute');
+                }
+
+                $name = $filter['name'];
+                unset($filter['name']);
+
+                $this->filters[$name] = $filter;
+            }
+        }
+
+        if (isset($data['comment'])) {
+            $this->comment = $data['comment'];
+        }
+    }
+
+    public function getFilters()
+    {
+        return $this->filters;
+    }
+
+    public function getFormType()
+    {
+        return $this->formType;
+    }
+
+    public function getComment()
+    {
+        return $this->comment;
+    }
+}
diff --git a/DependencyInjection/NelmioApiExtension.php b/DependencyInjection/NelmioApiExtension.php
new file mode 100644
index 000000000..15b249a29
--- /dev/null
+++ b/DependencyInjection/NelmioApiExtension.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Nelmio\ApiBundle\DependencyInjection;
+
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Config\FileLocator;
+
+class NelmioApiExtension extends Extension
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader->load('request_listener.xml');
+        $loader->load('services.xml');
+    }
+}
diff --git a/EventListener/RequestListener.php b/EventListener/RequestListener.php
new file mode 100644
index 000000000..fa73d12ae
--- /dev/null
+++ b/EventListener/RequestListener.php
@@ -0,0 +1,57 @@
+<?php
+
+namespace Nelmio\ApiBundle\EventListener;
+
+use Doctrine\Common\Annotations\Reader;
+use Nelmio\ApiBundle\Formatter\ApiDocFormatter;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\Routing\RouterInterface;
+
+class RequestListener
+{
+    protected $annotationClass = 'Nelmio\\ApiBundle\\Annotation\\ApiDoc';
+
+    protected $reader;
+
+    protected $router;
+
+    protected $formatter;
+
+    public function __construct(Reader $reader, RouterInterface $router, ApiDocFormatter $formatter)
+    {
+        $this->reader = $reader;
+        $this->router = $router;
+        $this->formatter = $formatter;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
+            return;
+        }
+
+        $request = $event->getRequest();
+
+        if (!$request->get('_doc')) {
+            return;
+        }
+
+        preg_match('#(.+)::([\w]+)#', $request->get('_controller'), $matches);
+        $method = new \ReflectionMethod($matches[1], $matches[2]);
+        $route  = $request->get('_route');
+
+        if ($annot = $this->reader->getMethodAnnotation($method, $this->annotationClass)) {
+            if ($route = $this->router->getRouteCollection()->get($route)) {
+                $result = $this->formatter->format($annot, $route);
+
+                $event->setResponse(new JsonResponse($result));
+            }
+        }
+    }
+}
diff --git a/Formatter/ApiDocFormatter.php b/Formatter/ApiDocFormatter.php
new file mode 100644
index 000000000..d44fbe517
--- /dev/null
+++ b/Formatter/ApiDocFormatter.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Nelmio\ApiBundle\Formatter;
+
+use Nelmio\ApiBundle\Annotation\ApiDoc;
+use Nelmio\ApiBundle\Parser\FormTypeParser;
+use Symfony\Component\Routing\Route;
+
+class ApiDocFormatter
+{
+    /**
+     * @var \Nelmio\ApiBundle\Parser\FormTypeParser
+     */
+    protected $parser;
+
+    public function __construct(FormTypeParser $parser)
+    {
+        $this->parser = $parser;
+    }
+
+    public function format(ApiDoc $apiDoc, Route $route)
+    {
+        $method = $route->getRequirement('_method');
+        $data   = array(
+            'method'        => $method,
+            'uri'           => $route->compile()->getPattern(),
+            'requirements'  => $route->compile()->getRequirements(),
+        );
+
+        unset($data['requirements']['_method']);
+
+        if (null !== $formType = $apiDoc->getFormType()) {
+            $data['parameters'] = $this->parser->parse(new $formType());
+
+            if ('PUT' === $method) {
+                // All parameters are optional with PUT (update)
+                array_walk($data['parameters'], function($val, $key) use (&$data) {
+                    $data['parameters'][$key]['is_required'] = false;
+                });
+            }
+        }
+
+        if ($filters = $apiDoc->getFilters()) {
+            $data['filters'] = $filters;
+        }
+
+        if ($comment = $apiDoc->getComment()) {
+            $data['comment'] = $comment;
+        }
+
+        return $data;
+    }
+}
diff --git a/NelmioApiBundle.php b/NelmioApiBundle.php
new file mode 100644
index 000000000..1791149ed
--- /dev/null
+++ b/NelmioApiBundle.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Nelmio\ApiBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class NelmioApiBundle extends Bundle
+{
+}
diff --git a/Parser/FormTypeParser.php b/Parser/FormTypeParser.php
new file mode 100644
index 000000000..824b97fc1
--- /dev/null
+++ b/Parser/FormTypeParser.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Nelmio\ApiBundle\Parser;
+
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\FormBuilder;
+use Symfony\Component\Form\FormFactoryInterface;
+
+class FormTypeParser
+{
+    protected $formFactory;
+
+    protected $mapTypes = array(
+        'text'      => 'string',
+        'date'      => 'date',
+        'datetime'  => 'datetime',
+        'checkbox'  => 'boolean',
+        'time'      => 'time',
+        'number'    => 'float',
+        'integer'   => 'int',
+        'textarea'  => 'string',
+    );
+
+    public function __construct(FormFactoryInterface $formFactory)
+    {
+        $this->formFactory = $formFactory;
+    }
+
+    public function parse(AbstractType $type)
+    {
+        $builder = $this->formFactory->createBuilder($type);
+
+        $parameters = array();
+        foreach ($builder->all() as $name => $child) {
+            $b = $builder->create($name, $child['type'], $child['options']);
+
+            $bestType = '';
+            foreach ($b->getTypes() as $type) {
+                if (isset($this->mapTypes[$type->getName()])) {
+                    $bestType = $this->mapTypes[$type->getName()];
+                }
+            }
+
+            $parameters[] = array(
+                'name'          => $name,
+                'type'          => $bestType,
+                'is_required'   => $b->getRequired()
+            );
+        }
+
+        return $parameters;
+    }
+}
diff --git a/Resources/config/request_listener.xml b/Resources/config/request_listener.xml
new file mode 100644
index 000000000..26279e627
--- /dev/null
+++ b/Resources/config/request_listener.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="nelmio.api.event_listener.request.class">Nelmio\ApiBundle\EventListener\RequestListener</parameter>
+    </parameters>
+
+    <services>
+        <service id="nelmio.api.event_listener.request" class="%nelmio.api.event_listener.request.class%">
+            <argument type="service" id="annotation_reader" />
+            <argument type="service" id="router" />
+            <argument type="service" id="nelmio.api.formatter.api_doc_formatter" />
+            <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" />
+        </service>
+    </services>
+
+</container>
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
new file mode 100644
index 000000000..370b52ebc
--- /dev/null
+++ b/Resources/config/services.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="nelmio.api.parser.form_type_parser.class">Nelmio\ApiBundle\Parser\FormTypeParser</parameter>
+        <parameter key="nelmio.api.formatter.api_doc_formatter.class">Nelmio\ApiBundle\Formatter\ApiDocFormatter</parameter>
+    </parameters>
+
+    <services>
+        <service id="nelmio.api.parser.form_type_parser" class="%nelmio.api.parser.form_type_parser.class%">
+            <argument type="service" id="form.factory" />
+        </service>
+        <service id="nelmio.api.formatter.api_doc_formatter" class="%nelmio.api.formatter.api_doc_formatter.class%">
+            <argument type="service" id="nelmio.api.parser.form_type_parser" />
+        </service>
+    </services>
+
+</container>