Initial Commit

Author: dbrancato-icc

DependencyInjection/Configuration.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+use SymfonyBundles\JsonRequestBundle\EventListener\RequestTransformerListener;
+
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfigTreeBuilder()
+    {
+        $builder = new TreeBuilder('sb_json_request');
+
+        if (\method_exists($builder, 'getRootNode')) {
+            $rootNode = $builder->getRootNode();
+        } else {
+            // BC layer for symfony/config 4.1 and older
+            $rootNode = $builder->root('maker');
+        }
+
+        $rootNode
+            ->children()
+                ->arrayNode('listener')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->scalarNode('request_transformer')
+                            ->defaultValue(RequestTransformerListener::class)
+                        ->end()
+                        ->scalarNode('priority')
+                            ->defaultValue(100)
+                        ->end()
+                    ->end()
+                ->end()
+            ->end();
+
+        return $builder;
+    }
+}

DependencyInjection/JsonRequestExtension.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\ConfigurableExtension;
+
+class JsonRequestExtension extends ConfigurableExtension
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function loadInternal(array $configs, ContainerBuilder $container)
+    {
+        $listener = new Definition($configs['listener']['request_transformer']);
+
+        $listener->addTag('kernel.event_listener', [
+            'event' => 'kernel.request',
+            'method' => 'onKernelRequest',
+            'priority' => $configs['listener']['priority'],
+        ]);
+
+        $container->setDefinition('sb_json_request.request_transformer', $listener);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAlias()
+    {
+        return 'sb_json_request';
+    }
+}

EventListener/RequestListenerInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+
+interface RequestListenerInterface
+{
+    /**
+     * @param RequestEvent $event
+     */
+    public function onKernelRequest(RequestEvent $event): void;
+}

EventListener/RequestTransformerListener.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\EventListener;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+
+class RequestTransformerListener implements RequestListenerInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function onKernelRequest(RequestEvent $event): void
+    {
+        $request = $event->getRequest();
+
+        if (false === $this->isAvailable($request)) {
+            return;
+        }
+
+        if (false === $this->transform($request)) {
+            $response = new Response('Unable to parse request.', Response::HTTP_BAD_REQUEST);
+
+            $event->setResponse($response);
+        }
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return bool
+     */
+    private function isAvailable(Request $request): bool
+    {
+        return 'json' === $request->getContentType() && $request->getContent();
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return bool
+     */
+    private function transform(Request $request): bool
+    {
+        $data = \json_decode($request->getContent(), true);
+
+        if (\json_last_error() !== \JSON_ERROR_NONE) {
+            return false;
+        }
+
+        if (\is_array($data)) {
+            $request->request->replace($data);
+        }
+
+        return true;
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Symfony Bundles (Dmitry Khaperets)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,60 @@
+SymfonyBundles JsonRequest Bundle
+=================================
+
+[![SensioLabsInsight][sensiolabs-insight-image]][sensiolabs-insight-link]
+
+[![Build Status][testing-image]][testing-link]
+[![Scrutinizer Code Quality][scrutinizer-code-quality-image]][scrutinizer-code-quality-link]
+[![Code Coverage][code-coverage-image]][code-coverage-link]
+[![Total Downloads][downloads-image]][package-link]
+[![Latest Stable Version][stable-image]][package-link]
+[![License][license-image]][license-link]
+
+What is JsonRequest Bundle?
+---------------------------
+This bundle will help you to work with json requests as standard requests without using «crutches».
+If previously for fetching of data from the request you did like this:
+`$data = json_decode($request->getContent())`,
+it is now in this already there is no need to.
+
+For example when sending json-request from AngularJS, Vue.js or etc.
+Early:
+``` php
+public function indexAction(Request $request)
+{
+    $data = json_decode($request->getContent(), true);
+
+    // uses request data
+    $name = isset($data['name']) ? $data['name'] : null;
+}
+```
+
+Now you can work with json-request as with standard request:
+``` php
+public function indexAction(Request $request)
+{
+    $name = $request->get('name');
+}
+```
+
+Installation
+------------
+* Require the bundle with composer:
+
+``` bash
+composer require symfony-bundles/json-request-bundle
+```
+
+[package-link]: https://packagist.org/packages/symfony-bundles/json-request-bundle
+[license-link]: https://github.com/symfony-bundles/json-request-bundle/blob/master/LICENSE
+[license-image]: https://poser.pugx.org/symfony-bundles/json-request-bundle/license
+[testing-link]: https://travis-ci.org/symfony-bundles/json-request-bundle
+[testing-image]: https://travis-ci.org/symfony-bundles/json-request-bundle.svg?branch=master
+[stable-image]: https://poser.pugx.org/symfony-bundles/json-request-bundle/v/stable
+[downloads-image]: https://poser.pugx.org/symfony-bundles/json-request-bundle/downloads
+[sensiolabs-insight-link]: https://insight.sensiolabs.com/projects/dea68633-2368-4e12-a516-89157d2c6b07
+[sensiolabs-insight-image]: https://insight.sensiolabs.com/projects/dea68633-2368-4e12-a516-89157d2c6b07/big.png
+[code-coverage-link]: https://scrutinizer-ci.com/g/symfony-bundles/json-request-bundle/?branch=master
+[code-coverage-image]: https://scrutinizer-ci.com/g/symfony-bundles/json-request-bundle/badges/coverage.png?b=master
+[scrutinizer-code-quality-link]: https://scrutinizer-ci.com/g/symfony-bundles/json-request-bundle/?branch=master
+[scrutinizer-code-quality-image]: https://scrutinizer-ci.com/g/symfony-bundles/json-request-bundle/badges/quality-score.png?b=master

SymfonyBundlesJsonRequestBundle.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class SymfonyBundlesJsonRequestBundle extends Bundle
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getContainerExtension()
+    {
+        return new DependencyInjection\JsonRequestExtension();
+    }
+}

Tests/DependencyInjection/ConfigurationTest.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\Tests\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Processor;
+use SymfonyBundles\JsonRequestBundle\Tests\TestCase;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+use SymfonyBundles\JsonRequestBundle\DependencyInjection\Configuration;
+
+class ConfigurationTest extends TestCase
+{
+    public function testConfiguration()
+    {
+        $processor = new Processor();
+        $configuration = new Configuration();
+
+        $this->assertInstanceOf(ConfigurationInterface::class, $configuration);
+
+        $configs = $processor->processConfiguration($configuration, []);
+
+        $this->assertArraySubset([], $configs);
+    }
+}

Tests/DependencyInjection/JsonRequestExtensionTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace SymfonyBundles\JsonRequestBundle\Tests\DependencyInjection;
+
+use SymfonyBundles\JsonRequestBundle\Tests\TestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use SymfonyBundles\JsonRequestBundle\DependencyInjection\JsonRequestExtension;
+
+class JsonRequestExtensionTest extends TestCase
+{
+    public function testHasListener()
+    {
+        $container = new ContainerBuilder();
+        $extension = new JsonRequestExtension();
+        $listenerService = 'sb_json_request.request_transformer';
+
+        $this->assertInstanceOf(Extension::class, $extension);
+
+        $extension->load([], $container);
+
+        $this->assertTrue($container->has($listenerService));
+    }
+
+    public function testAlias()
+    {
+        $extension = new JsonRequestExtension();
+
+        $this->assertStringEndsWith('json_request', $extension->getAlias());
+    }
+}