Merge branch 'master' into exception_response_http_status_code

Author: mattjanssen

README.md

@@ -41,17 +41,20 @@ api_response:
         serializer: json_encode
         serialize_groups: []
         cors_allow_origin_regex: https://.*\.mydomain\.com
-        cors_allow_headers: Authorization, Content-Type
+        cors_allow_headers: [Authorization, Content-Type]
         cors_max_age: 86400
     paths:
         somename:
-            pattern: ^/api/v1/
+            prefix: /api/v1/
             serializer: jms_serializer
         othername:
-            pattern: ^/api/v2/
-            cors_allow_origin_regex: https://.*\.(mydomain|theirdomain)\.com
+            pattern: ^/api/v[2-4]/
+            cors_allow_origin_regex: .*
 ```
 
+The serializer can be empty, 'array', 'json_encode', 'json_group_encode', 'jms_serializer',
+or the name of a service which must implement the SerializerAdapterInterface. It defaults to 'json_encode'.
+
 ## Usage
 
 In your API controllers, just return whatever you want serialized in the response. The ApiResponseBundle takes care of

src/Compiler/ApiConfigCompiler.php

@@ -77,7 +77,13 @@ public function compileApiConfig(Request $request)
         $originPath = $request->getPathInfo();
         foreach ($this->pathConfigs as $pathConfig) {
             $pathRegex = $pathConfig->getPattern();
-            if (!preg_match('#' . str_replace('#', '\#', $pathRegex) . '#', $originPath)) {
+            if ($pathRegex !== null && !preg_match('#' . str_replace('#', '\#', $pathRegex) . '#', $originPath)) {
+                // No path match.
+                continue;
+            }
+
+            $pathPrefix = $pathConfig->getPrefix();
+            if ($pathPrefix !== null && strpos($originPath, $pathPrefix) !== 0) {
                 // No path match.
                 continue;
             }
@@ -161,6 +167,7 @@ private function generateApiPathConfig(array $configArray)
 
         // @TODO Use PHP 7 null coalescing operator.
         $apiPathConfig->setPattern(isset($configArray['pattern']) ? $configArray['pattern'] : null);
+        $apiPathConfig->setPrefix(isset($configArray['prefix']) ? $configArray['prefix'] : null);
 
         return $apiPathConfig;
     }
@@ -174,7 +181,7 @@ private function applyApiConfig(array $configArray, ApiConfig $apiConfig)
         // @TODO Use PHP 7 null coalescing operator.
         $apiConfig
             ->setSerializer(isset($configArray['serializer']) ? $configArray['serializer'] : null)
-            ->setGroups(isset($configArray['serialize_groups']) ? $configArray['serialize_groups'] : null)
+            ->setGroups(isset($configArray['serialize_groups']) && is_array($configArray['serialize_groups']) ? $configArray['serialize_groups'] : null)
             ->setCorsAllowHeaders(isset($configArray['cors_allow_headers']) ? $configArray['cors_allow_headers'] : null)
             ->setCorsAllowOriginRegex(isset($configArray['cors_allow_origin_regex']) ? $configArray['cors_allow_origin_regex'] : null)
             ->setCorsMaxAge(isset($configArray['cors_max_age']) ? $configArray['cors_max_age'] : null)

src/DependencyInjection/Configuration.php

@@ -31,9 +31,6 @@ public function getConfigTreeBuilder()
             $rootNode->children()
                 ->arrayNode('defaults')
                     ->children()
-                        ->arrayNode('pattern')
-                            ->prototype('scalar')->isRequired()->end()
-                        ->end()
         );
 
         $this->buildConfigNode(
@@ -42,7 +39,8 @@ public function getConfigTreeBuilder()
                     ->useAttributeAsKey('name')
                     ->prototype('array')
                         ->children()
-                        ->scalarNode('pattern')->end()
+                            ->scalarNode('pattern')->end()
+                            ->scalarNode('prefix')->end()
         );
 
         return $treeBuilder;
@@ -56,17 +54,8 @@ public function getConfigTreeBuilder()
     private function buildConfigNode(NodeBuilder $nodeBuilder)
     {
         return $nodeBuilder
-            ->enumNode('serializer')
-                ->values([
-                    self::SERIALIZER_ARRAY,
-                    self::SERIALIZER_JSON_ENCODE,
-                    self::SERIALIZER_JSON_GROUP_ENCODE,
-                    self::SERIALIZER_JMS_SERIALIZER,
-                ])
-            ->end()
-            ->arrayNode('serialize_groups')
-                ->prototype('scalar')->end()
-            ->end()
+            ->scalarNode('serializer')->end()
+            ->variableNode('serialize_groups')->end()
             ->scalarNode('cors_allow_origin_regex')->end()
             ->arrayNode('cors_allow_headers')
                 ->prototype('scalar')->end()

src/Factory/SerializerAdapterFactory.php

@@ -3,7 +3,7 @@
 namespace MattJanssen\ApiResponseBundle\Factory;
 
 use MattJanssen\ApiResponseBundle\DependencyInjection\Configuration;
-use MattJanssen\ApiResponseBundle\Serializer\Adapter as Adapter;
+use MattJanssen\ApiResponseBundle\Serializer\Adapter;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -66,7 +66,17 @@ public function createSerializerAdapter($serializerName)
                 break;
 
             default:
-                throw new \RuntimeException('Unrecognized serializer configured.');
+                if ($this->container->has($serializerName)) {
+                    $serializerAdapter = $this->container->get($serializerName);
+                    if (!$serializerAdapter instanceof Adapter\SerializerAdapterInterface) {
+                        throw new \RuntimeException(sprintf(
+                            'Serializer adapter "%s" does not implement SerializerAdapterInterface.',
+                            $serializerName
+                        ));
+                    }
+                } else {
+                    throw new \RuntimeException(sprintf('Unrecognized serializer "%s".', $serializerName));
+                }
         }
 
         return $serializerAdapter;

src/Generator/ApiResponseGenerator.php

@@ -2,10 +2,12 @@
 
 namespace MattJanssen\ApiResponseBundle\Generator;
 
+use MattJanssen\ApiResponseBundle\Compiler\ApiConfigCompiler;
 use MattJanssen\ApiResponseBundle\DependencyInjection\Configuration;
 use MattJanssen\ApiResponseBundle\Factory\SerializerAdapterFactory;
 use MattJanssen\ApiResponseBundle\Model\ApiResponseErrorModel;
 use MattJanssen\ApiResponseBundle\Model\ApiResponseResponseModel;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 
 /**
@@ -15,6 +17,16 @@
  */
 class ApiResponseGenerator
 {
+    /**
+     * @var RequestStack
+     */
+    private $requestStack;
+
+    /**
+     * @var ApiConfigCompiler
+     */
+    private $configCompiler;
+
     /**
      * Serializer Adapter Factory
      *
@@ -25,11 +37,17 @@ class ApiResponseGenerator
     /**
      * Constructor
      *
+     * @param RequestStack $requestStack
+     * @param ApiConfigCompiler $configCompiler
      * @param SerializerAdapterFactory $serializerAdapterFactory
      */
     public function __construct(
+        RequestStack $requestStack,
+        ApiConfigCompiler $configCompiler,
         SerializerAdapterFactory $serializerAdapterFactory
     ) {
+        $this->requestStack = $requestStack;
+        $this->configCompiler = $configCompiler;
         $this->serializerAdapterFactory = $serializerAdapterFactory;
     }
 
@@ -39,8 +57,8 @@ public function __construct(
      * Defaults to json_encode serializer.
      *
      * @param mixed $data
-     * @param int $httpCode
-     * @param array $serializeGroups
+     * @param int|null $httpCode
+     * @param string[]|null $serializeGroups
      * @param string|null $serializerName Name of serializer to use instead of the default.
      *
      * @return Response
@@ -52,17 +70,23 @@ public function generateSuccessResponse(
         array $serializeGroups = null,
         $serializerName = null
     ) {
-        // Set defaults.
-        if (null === $httpCode) {
+        if ($httpCode === null) {
             $httpCode = Response::HTTP_OK;
         }
 
-        if (null === $serializeGroups) {
-            $serializeGroups = [];
+        $request = $this->requestStack->getMasterRequest();
+        $pathConfig = $request ? $this->configCompiler->compileApiConfig($request) : null;
+
+        if ($serializeGroups === null && $pathConfig !== null) {
+            $serializeGroups = $pathConfig->getGroups();
         }
 
-        if (null === $serializerName) {
-            $serializerName = Configuration::SERIALIZER_JSON_ENCODE;
+        if ($serializerName === null) {
+            if  ($pathConfig !== null) {
+                $serializerName = $pathConfig->getSerializer();
+            } else {
+                $serializerName = Configuration::SERIALIZER_JSON_ENCODE;
+            }
         }
 
         $serializerAdapter = $this->serializerAdapterFactory->createSerializerAdapter($serializerName);
@@ -83,7 +107,7 @@ public function generateSuccessResponse(
      * This assumes the json_encode serializer.
      *
      * @param int $httpCode
-     * @param int $errorCode
+     * @param string $errorCode
      * @param string|null $errorTitle
      * @param mixed|null $errorData
      *

src/Model/ApiConfigTrait.php

@@ -14,17 +14,17 @@ trait ApiConfigTrait
     /**
      * Serializer Adapter to Use
      *
-     * One of the Configuration::SERIALIZER_* constants.
+     * One of the Configuration::SERIALIZER_* constants or a service name.
      * @see MattJanssen\ApiResponseBundle\DependencyInjection\Configuration::SERIALIZER_JSON_ENCODE
      *
      * @var string
      */
     private $serializer;
 
     /**
-     * Optional Groups Names for JMS Serializer
+     * Optional Groups Names for Serializer
      *
-     * @var string[]
+     * @var string[]|null
      */
     private $groups;
 
@@ -72,7 +72,7 @@ public function getGroups()
     }
 
     /**
-     * @param string[] $groups
+     * @param string[]|null $groups
      *
      * @return $this
      */

src/Model/ApiPathConfig.php

@@ -12,6 +12,11 @@ class ApiPathConfig extends ApiConfig
      */
     private $pattern;
 
+    /**
+     * @var string
+     */
+    private $prefix;
+
     /**
      * @return string
      */
@@ -31,4 +36,24 @@ public function setPattern($pattern)
 
         return $this;
     }
+
+    /**
+     * @return string
+     */
+    public function getPrefix()
+    {
+        return $this->prefix;
+    }
+
+    /**
+     * @param string $prefix
+     *
+     * @return $this
+     */
+    public function setPrefix($prefix)
+    {
+        $this->prefix = $prefix;
+
+        return $this;
+    }
 }

src/Model/ApiResponseErrorModel.php

@@ -12,7 +12,7 @@ class ApiResponseErrorModel implements \JsonSerializable
     /**
      * Application-specific API Error Code
      *
-     * @var int
+     * @var string
      */
     private $code;
 
@@ -33,7 +33,7 @@ class ApiResponseErrorModel implements \JsonSerializable
     /**
      * {@inheritdoc}
      */
-    function jsonSerialize()
+    public function jsonSerialize()
     {
         return [
             'code' => $this->code,
@@ -45,7 +45,7 @@ function jsonSerialize()
     /**
      * Set the API Error Code
      *
-     * @return int
+     * @return string
      */
     public function getCode()
     {
@@ -55,7 +55,7 @@ public function getCode()
     /**
      * Get the API Error Code
      *
-     * @param int $code
+     * @param string $code
      *
      * @return $this
      */

src/Model/ApiResponseResponseModel.php

@@ -31,7 +31,7 @@ class ApiResponseResponseModel implements \JsonSerializable, ArraySerializable
     /**
      * {@inheritdoc}
      */
-    public function jsonSerialize(): array
+    public function jsonSerialize()
     {
         return [
             'data' => $this->data,

src/Resources/config/services.yml

@@ -1,12 +1,8 @@
 services:
-    # Seralizer Adapter
-    api_response.serializer_adapter:
-        class: MattJanssen\ApiResponseBundle\Serializer\Adapter\SerializerAdapterInterface
-        synthetic: true
-
     # Compiler
     api_response.compiler.api_config: # Generated in ApiResponseExtension compile pass.
         class: MattJanssen\ApiResponseBundle\Compiler\ApiConfigCompiler
+        public: false
         arguments:
             - %api_response.defaults%
             - %api_response.paths%
@@ -18,16 +14,20 @@ services:
         arguments:
             - "@api_response.generator.api_response"
             - "@api_response.compiler.api_config"
+            - "@logger"
             - %kernel.debug%
 
     # Factory
     api_response.factory.serializer_adapter:
         class: MattJanssen\ApiResponseBundle\Factory\SerializerAdapterFactory
+        public: false
         arguments:
             - "@service_container"
 
     # Generator
     api_response.generator.api_response:
         class: MattJanssen\ApiResponseBundle\Generator\ApiResponseGenerator
         arguments:
+            - "@request_stack"
+            - "@api_response.compiler.api_config"
             - "@api_response.factory.serializer_adapter"