add sunset header field annotation handler

Author: Alessandro Chitolina

src/Annotation/Sunset.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Annotation;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @Annotation()
+ */
+class Sunset implements ConfigurationInterface
+{
+    /**
+     * @var string
+     *
+     * @Required()
+     */
+    public $date;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAliasName(): string
+    {
+        return 'rest_sunset';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function allowArray(): bool
+    {
+        return false;
+    }
+}

src/Annotation/View.php

@@ -6,7 +6,7 @@
 use Symfony\Component\HttpFoundation\Response;
 
 /**
- * @Annotation
+ * @Annotation()
  */
 class View implements ConfigurationInterface
 {

src/DependencyInjection/ApiPlatformExtension.php

@@ -32,6 +32,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         if ($config['view']['enabled']) {
             $loader->load('view.xml');
+            $loader->load('sunset.xml');
             $loader->load('exception_listeners.xml');
         }
 

src/HttpKernel/SunsetHandler.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\HttpKernel;
+
+use Fazland\ApiPlatformBundle\Annotation\Sunset;
+use Fazland\ApiPlatformBundle\Annotation\View as ViewAnnotation;
+use Fazland\ApiPlatformBundle\HttpKernel\View\Context;
+use Fazland\ApiPlatformBundle\HttpKernel\View\View;
+use Kcs\Serializer\Exception\UnsupportedFormatException;
+use Kcs\Serializer\Type\Type;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * Adds Sunset header field if Sunset annotation is found.
+ *
+ * @see https://tools.ietf.org/html/draft-wilde-sunset-header-10
+ */
+class SunsetHandler implements EventSubscriberInterface
+{
+    /**
+     * Modify the response adding a Sunset header if needed.
+     *
+     * @param FilterResponseEvent $event
+     */
+    public function onResponse(FilterResponseEvent $event): void
+    {
+        $request = $event->getRequest();
+
+        $annotation = $request->attributes->get('_rest_sunset');
+        if (! $annotation instanceof Sunset) {
+            return;
+        }
+
+        $date = new \DateTimeImmutable($annotation->date);
+
+        $response = $event->getResponse();
+        $response->headers->set('Sunset', $date->format(\DateTime::RFC2822));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            KernelEvents::RESPONSE => 'onResponse',
+        ];
+    }
+}

src/Resources/config/sunset.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<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">
+
+    <services>
+        <service class="Fazland\ApiPlatformBundle\HttpKernel\SunsetHandler" id="Fazland\ApiPlatformBundle\HttpKernel\SunsetHandler">
+            <tag name="kernel.event_subscriber" />
+        </service>
+    </services>
+</container>

tests/Fixtures/Sunset/.gitignore

@@ -0,0 +1,2 @@
+logs/
+cache/

tests/Fixtures/Sunset/AppBundle.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Tests\Fixtures\Sunset;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class AppBundle extends Bundle
+{
+}

tests/Fixtures/Sunset/AppKernel.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Tests\Fixtures\Sunset;
+
+use Fazland\ApiPlatformBundle\Tests\Fixtures\TestKernel;
+use Kcs\Serializer\Bundle\SerializerBundle;
+use Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\SecurityBundle\SecurityBundle;
+use Symfony\Component\Config\Loader\LoaderInterface;
+
+class AppKernel extends TestKernel
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function registerBundles(): iterable
+    {
+        return [
+            new FrameworkBundle(),
+            new SensioFrameworkExtraBundle(),
+            new SecurityBundle(),
+            new SerializerBundle(),
+            new AppBundle(),
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        $loader->load(__DIR__.'/config.yml');
+    }
+}

tests/Fixtures/Sunset/Controller/TestController.php

@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace Fazland\ApiPlatformBundle\Tests\Fixtures\Sunset\Controller;
+
+use Fazland\ApiPlatformBundle\Annotation\Sunset;
+use Fazland\ApiPlatformBundle\Annotation\View;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+class TestController extends Controller
+{
+    /**
+     * @return mixed
+     *
+     * @View()
+     * @Sunset("2019-03-01")
+     */
+    public function indexAction(): array
+    {
+        return [
+            'test_foo' => 'foo.test',
+        ];
+    }
+}

tests/Fixtures/Sunset/config.yml

@@ -0,0 +1,36 @@
+imports:
+    - { resource: ../../../src/Resources/config/view.xml }
+    - { resource: ../../../src/Resources/config/sunset.xml }
+    - { resource: ../../../src/Resources/config/serializer.xml }
+    - { resource: ../../../src/Resources/config/exception_listeners.xml }
+
+parameters:
+    fazland_api.response_charset: UTF-8
+
+framework:
+    test: ~
+    secret: secret
+    form: ~
+    csrf_protection: false
+    router:
+        resource: "%kernel.root_dir%/routing.yml"
+
+security:
+    providers:
+        in_memory:
+            memory: ~
+
+    firewalls:
+        dev:
+            pattern: ^/(_(profiler|wdt))/
+            security: false
+        main:
+            anonymous: ~
+
+sensio_framework_extra:
+    router:      { annotations: false }
+    request:     { converters: true, auto_convert: true }
+    view:        { annotations: false }
+    cache:       { annotations: true }
+    security:    { annotations: true }
+    psr_message: { enabled: false }