PhpcrNode serialization

Author: dantleech

.travis.yml

@@ -26,7 +26,9 @@ before_script:
   - composer require symfony/symfony:${SYMFONY_VERSION} --prefer-source
   - vendor/symfony-cmf/testing/bin/travis/phpcr_odm_doctrine_dbal.sh
 
-script: phpunit --coverage-text
+script:
+    - phpunit --coverage-text
+    - ./vendor/bin/behat
 
 notifications:
   irc: "irc.freenode.org#symfony-cmf"

CmfResourceRestBundle.php

@@ -13,8 +13,6 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\FactoryPass;
-use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\CompositeRepositoryPass;
 
 class CmfResourceRestBundle extends Bundle
 {

Controller/ResourceController.php

@@ -3,12 +3,8 @@
 namespace Symfony\Cmf\Bundle\ResourceRestBundle\Controller;
 
 use Symfony\Cmf\Component\Resource\RepositoryRegistryInterface;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\JsonResponse;
-use Hateoas\HateoasBuilder;
 use Symfony\Component\HttpFoundation\Response;
 use Hateoas\UrlGenerator\UrlGeneratorInterface;
-use JMS\Serializer\SerializerBuilder;
 use JMS\Serializer\SerializerInterface;
 use JMS\Serializer\SerializationContext;
 
@@ -24,6 +20,9 @@ class ResourceController
      */
     private $urlGenerator;
 
+    /**
+     * @var SerializerInterface
+     */
     private $serializer;
 
     /**
@@ -33,8 +32,7 @@ public function __construct(
         SerializerInterface $serializer,
         RepositoryRegistryInterface $registry,
         UrlGeneratorInterface $urlGenerator
-    )
-    {
+    ) {
         $this->serializer = $serializer;
         $this->registry = $registry;
         $this->urlGenerator = $urlGenerator;

DependencyInjection/CmfResourceRestExtension.php

@@ -13,11 +13,8 @@
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Config\FileLocator;
-use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
-use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 
 class CmfResourceRestExtension extends Extension implements PrependExtensionInterface

Helper/PathHelper.php

@@ -11,6 +11,17 @@
 
 namespace Symfony\Cmf\Bundle\ResourceRestBundle\Helper;
 
+/**
+ * Path helper.
+ *
+ * Used in the BazingaHateoasBundle expression language to provide
+ * the correct value for the route generator.
+ *
+ * Should be removed once BazingaHateoasBundle supports custom provider
+ * registration.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
 class PathHelper
 {
     /**
@@ -22,7 +33,6 @@ class PathHelper
      * @return string
      */
     public function relativize($path)
-
     {
         if (substr($path, 0, 1) == '/') {
             return substr($path, 1);

README.md

@@ -4,7 +4,9 @@
 [![Latest Stable Version](https://poser.pugx.org/symfony-cmf/resource-rest-bundle/version.png)](https://packagist.org/packages/symfony-cmf/resource-bundle)
 [![Total Downloads](https://poser.pugx.org/symfony-cmf/resource-rest-bundle/d/total.png)](https://packagist.org/packages/symfony-cmf/resource-bundle)
 
-WIP: This bundle provides a REST API for resources
+This Bundle provides a REST API to [Puli](https://github.com/puliphp/puli)
+resources as provided by the
+[CmfResource](https://github.com/symfony-cmf/Resource) component.
 
 ## Requirements 
 
@@ -18,6 +20,74 @@ Not yet.
 * [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
 * [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
 
+## Example
+
+````bash
+$ curl http://localhost:8000/api/phpcrodm_repo/foo | python -m json.tool
+{
+    "_links": {
+        "self": {
+            "href": "/api/phpcrodm_repo/foo"
+        }
+    },
+    "children": {
+        "bar": {
+            "_links": {
+                "self": {
+                    "href": "/api/phpcrodm_repo/foo/bar"
+                }
+            },
+            "children": [],
+            "document": {
+                "_links": {
+                    "self": {
+                        "href": "/path/to/this"
+                    }
+                },
+                "body": "This is my second article",
+                "id": "/tests/cmf/articles/foo/bar",
+                "title": "Article 2"
+            },
+            "path": "/foo/bar",
+            "repo_path": "/foo/bar"
+        },
+        "boo": {
+            "_links": {
+                "self": {
+                    "href": "/api/phpcrodm_repo/foo/boo"
+                }
+            },
+            "children": [],
+            "document": {
+                "_links": {
+                    "self": {
+                        "href": "/path/to/this"
+                    }
+                },
+                "body": "This is my third article",
+                "id": "/tests/cmf/articles/foo/boo",
+                "title": "Article 2"
+            },
+            "path": "/foo/boo",
+            "repo_path": "/foo/boo"
+        }
+    },
+    "document": {
+        "_links": {
+            "self": {
+                "href": "/path/to/this"
+            }
+        },
+        "body": "This is my article",
+        "id": "/tests/cmf/articles/foo",
+        "title": "Article 1"
+    },
+    "path": "/foo",
+    "repo_path": "/foo"
+}
+````
+
+
 ## Contributing
 
 Pull requests are welcome. Please see our

Resources/config/routing.yml

@@ -0,0 +1,7 @@
+_cmf_resource:
+    pattern: /api/{repositoryName}/{path}
+    requirements:
+        path: .*
+    defaults:
+        _controller: cmf_resource_rest.controller.resource:resourceAction
+        _format: json

Resources/config/serializer.xml

@@ -5,14 +5,23 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
-        <parameter key="cmf_resource_rest.serializer.collection_handler.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\CollectionHandler</parameter>
+        <parameter key="cmf_resource_rest.serializer.handler.collection.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\Handler\CollectionHandler</parameter>
+        <parameter key="cmf_resource_rest.serializer.handler.phpcr_node.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\Handler\PhpcrNodeHandler</parameter>
+        <parameter key="cmf_resource_rest.serializer.subscriber.phpcr_node.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\EventSubscriber\PhpcrNodeSubscriber</parameter>
     </parameters>
 
     <services>
 
-        <service id="jms_serializer.event_handler" class="%cmf_resource_rest.serializer.collection_handler.class%">
+        <service id="cmf_resource_rest.serializer.handler.collection" class="%cmf_resource_rest.serializer.handler.collection.class%">
             <tag name="jms_serializer.subscribing_handler"/>
         </service>
 
+        <service id="cmf_resource_rest.serializer.handler.phpcr_node" class="%cmf_resource_rest.serializer.handler.phpcr_node.class%">
+            <tag name="jms_serializer.subscribing_handler"/>
+        </service>
+
+        <service id="cmf_resource_rest.serializer.subscriber.phpcr_node" class="%cmf_resource_rest.serializer.subscriber.phpcr_node.class%">
+            <tag name="jms_serializer.event_subscriber" />
+        </service>
     </services>
 </container>

Resources/config/serializer/NodeInterface.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <serializer>
-    <class name="PHPCR\NodeInterface" xmlns:h="https://github.com/willdurand/Hateoas" exclude-policy="all" exclude="true">
+    <class name="PHPCR\NodeInterface" xmlns:h="https://github.com/willdurand/Hateoas">
     </class>
 </serializer>
-

Resources/config/serializer/PhpcrResource.xml

@@ -7,5 +7,6 @@
                 <h:parameter name="path" value="expr(service('cmf_resource_rest.path_helper').relativize(object.getPath()))" />
             </h:href>
         </h:relation>
+        <virtual-property serialized-name="children" max-depth="3" method="listChildren"/>
     </class>
 </serializer>