Merge branch 'master' into release/v0.1.0.1

mattjanssen · web-flow · commit 4b132fa15140 · 2017-02-01T19:14:06.000-06:00
diff --git a/README.md b/README.md
@@ -33,6 +33,25 @@ public function registerBundles()
 }
 ```
 
+## Configure
+
+``` yml
+api_response:
+    defaults:
+        serializer: json_encode
+        serialize_groups: []
+        cors_allow_origin_regex: https://.*\.mydomain\.com
+        cors_allow_headers: Authorization, Content-Type
+        cors_max_age: 86400
+    paths:
+        somename:
+            pattern: ^/api/v1/
+            serializer: jms_serializer
+        othername:
+            pattern: ^/api/v2/
+            cors_allow_origin_regex: https://.*\.(mydomain|theirdomain)\.com
+```
+
 ## Usage
 
 In your API controllers, just return whatever you want serialized in the response. The ApiResponseBundle takes care of
diff --git a/src/Compiler/ApiConfigCompiler.php b/src/Compiler/ApiConfigCompiler.php
@@ -5,6 +5,7 @@
 use MattJanssen\ApiResponseBundle\Annotation\ApiResponse;
 use MattJanssen\ApiResponseBundle\Model\ApiConfig;
 use MattJanssen\ApiResponseBundle\Model\ApiConfigInterface;
+use MattJanssen\ApiResponseBundle\Model\ApiPathConfig;
 use Symfony\Component\HttpFoundation\Request;
 
 /**
@@ -26,7 +27,7 @@ class ApiConfigCompiler
      *
      * Each relative URL path has its own CORS configuration settings in this array.
      *
-     * @var ApiConfig[]
+     * @var ApiPathConfig[]
      */
     private $pathConfigs;
 
@@ -43,8 +44,8 @@ public function __construct(
         $defaultConfig = $this->generateApiConfig($defaultConfigArray);
 
         $pathConfigs = [];
-        foreach ($pathConfigArrays as $path => $configArray) {
-            $pathConfigs[$path] = $this->generateApiConfig($configArray);
+        foreach ($pathConfigArrays as $configArray) {
+            $pathConfigs[] = $this->generateApiPathConfig($configArray);
         }
 
         $this->defaultConfig = $defaultConfig;
@@ -74,7 +75,8 @@ public function compileApiConfig(Request $request)
 
         // Try to match the request origin to a path in the config.yml.
         $originPath = $request->getPathInfo();
-        foreach ($this->pathConfigs as $pathRegex => $pathConfig) {
+        foreach ($this->pathConfigs as $pathConfig) {
+            $pathRegex = $pathConfig->getPattern();
             if (!preg_match('#' . str_replace('#', '\#', $pathRegex) . '#', $originPath)) {
                 // No path match.
                 continue;
@@ -113,8 +115,14 @@ public function compileApiConfig(Request $request)
      * @param ApiConfig $compiledConfig
      * @param ApiConfigInterface $configToMerge
      */
-    private function mergeConfig($compiledConfig, $configToMerge)
+    private function mergeConfig(ApiConfig $compiledConfig, ApiConfigInterface $configToMerge)
     {
+        if (null !== $configToMerge->getSerializer()) {
+            $compiledConfig->setSerializer($configToMerge->getSerializer());
+        }
+        if (null !== $configToMerge->getGroups()) {
+            $compiledConfig->setGroups($configToMerge->getGroups());
+        }
         if (null !== $configToMerge->getCorsAllowOriginRegex()) {
             $compiledConfig->setCorsAllowOriginRegex($configToMerge->getCorsAllowOriginRegex());
         }
@@ -132,9 +140,39 @@ private function mergeConfig($compiledConfig, $configToMerge)
      * @return ApiConfig $this
      */
     private function generateApiConfig(array $configArray)
+    {
+        $apiConfig = new ApiConfig();
+
+        $this->applyApiConfig($configArray, $apiConfig);
+
+        return $apiConfig;
+    }
+
+    /**
+     * @param array $configArray
+     *
+     * @return ApiConfig $this
+     */
+    private function generateApiPathConfig(array $configArray)
+    {
+        $apiPathConfig = new ApiPathConfig();
+
+        $this->applyApiConfig($configArray, $apiPathConfig);
+
+        // @TODO Use PHP 7 null coalescing operator.
+        $apiPathConfig->setPattern(isset($configArray['pattern']) ? $configArray['pattern'] : null);
+
+        return $apiPathConfig;
+    }
+
+    /**
+     * @param array $configArray
+     * @param ApiConfig $apiConfig
+     */
+    private function applyApiConfig(array $configArray, ApiConfig $apiConfig)
     {
         // @TODO Use PHP 7 null coalescing operator.
-        return (new ApiConfig())
+        $apiConfig
             ->setSerializer(isset($configArray['serializer']) ? $configArray['serializer'] : null)
             ->setGroups(isset($configArray['serialize_groups']) ? $configArray['serialize_groups'] : null)
             ->setCorsAllowHeaders(isset($configArray['cors_allow_headers']) ? $configArray['cors_allow_headers'] : null)
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -14,6 +14,7 @@
  */
 class Configuration implements ConfigurationInterface
 {
+    const SERIALIZER_ARRAY = 'array';
     const SERIALIZER_JSON_ENCODE = 'json_encode';
     const SERIALIZER_JSON_GROUP_ENCODE = 'json_group_encode';
     const SERIALIZER_JMS_SERIALIZER = 'jms_serializer';
@@ -27,47 +28,50 @@ public function getConfigTreeBuilder()
         $rootNode = $treeBuilder->root('api_response');
 
         $this->buildConfigNode(
-            $rootNode
-                ->children()
-                    ->arrayNode('defaults')
+            $rootNode->children()
+                ->arrayNode('defaults')
+                    ->children()
+                        ->arrayNode('pattern')
+                            ->prototype('scalar')->isRequired()->end()
+                        ->end()
         );
 
         $this->buildConfigNode(
-            $rootNode
-                ->children()
-                    ->arrayNode('paths')
-                        ->normalizeKeys(false)
-                        ->prototype('array')
+            $rootNode->children()
+                ->arrayNode('paths')
+                    ->useAttributeAsKey('name')
+                    ->prototype('array')
+                        ->children()
+                        ->scalarNode('pattern')->end()
         );
 
         return $treeBuilder;
     }
 
     /**
-     * @param ArrayNodeDefinition $arrayNode
+     * @param NodeBuilder $nodeBuilder
      *
      * @return ArrayNodeDefinition
      */
-    private function buildConfigNode(ArrayNodeDefinition $arrayNode)
+    private function buildConfigNode(NodeBuilder $nodeBuilder)
     {
-        return $arrayNode
-            ->children()
-                ->enumNode('serializer')
-                    ->values([
-                        self::SERIALIZER_JSON_ENCODE,
-                        self::SERIALIZER_JSON_GROUP_ENCODE,
-                        self::SERIALIZER_JMS_SERIALIZER,
-                    ])
-                ->end()
-                ->arrayNode('serialize_groups')
-                    ->prototype('scalar')->end()
-                ->end()
-                ->scalarNode('cors_allow_origin_regex')->end()
-                ->arrayNode('cors_allow_headers')
-                    ->prototype('scalar')->end()
-                ->end()
-                ->integerNode('cors_max_age')->end()
+        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('cors_allow_origin_regex')->end()
+            ->arrayNode('cors_allow_headers')
+                ->prototype('scalar')->end()
+            ->end()
+            ->integerNode('cors_max_age')->end()
         ;
     }
 }
diff --git a/src/Factory/SerializerAdapterFactory.php b/src/Factory/SerializerAdapterFactory.php
@@ -48,6 +48,10 @@ public function __construct(ContainerInterface $container)
     public function createSerializerAdapter($serializerName)
     {
         switch ($serializerName) {
+            case Configuration::SERIALIZER_ARRAY:
+                $serializerAdapter = new Adapter\ArraySerializerAdapter();
+                break;
+
             case Configuration::SERIALIZER_JSON_ENCODE:
                 $serializerAdapter = new Adapter\JsonEncodeSerializerAdapter();
                 break;
diff --git a/src/Model/ApiConfigInterface.php b/src/Model/ApiConfigInterface.php
@@ -16,7 +16,6 @@ interface ApiConfigInterface
      */
     public function getSerializer();
 
-
     /**
      * Get Serializer Groups to Use
      *
diff --git a/src/Model/ApiPathConfig.php b/src/Model/ApiPathConfig.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace MattJanssen\ApiResponseBundle\Model;
+
+/**
+ * @author Matt Janssen <matt@mattjanssen.com>
+ */
+class ApiPathConfig extends ApiConfig
+{
+    /**
+     * @var string
+     */
+    private $pattern;
+
+    /**
+     * @return string
+     */
+    public function getPattern()
+    {
+        return $this->pattern;
+    }
+
+    /**
+     * @param string $pattern
+     *
+     * @return $this
+     */
+    public function setPattern($pattern)
+    {
+        $this->pattern = $pattern;
+
+        return $this;
+    }
+}
diff --git a/src/Model/ApiResponseResponseModel.php b/src/Model/ApiResponseResponseModel.php
@@ -2,6 +2,8 @@
 
 namespace MattJanssen\ApiResponseBundle\Model;
 
+use MattJanssen\ApiResponseBundle\Serializer\ArraySerializable;
+
 /**
  * API Response Response Model
  *
@@ -10,7 +12,7 @@
  *
  * @author Matt Janssen <matt@mattjanssen.com>
  */
-class ApiResponseResponseModel implements \JsonSerializable
+class ApiResponseResponseModel implements \JsonSerializable, ArraySerializable
 {
     /**
      * Serializable API Response Data
@@ -29,14 +31,22 @@ class ApiResponseResponseModel implements \JsonSerializable
     /**
      * {@inheritdoc}
      */
-    function jsonSerialize()
+    public function jsonSerialize(): array
     {
         return [
             'data' => $this->data,
             'error' => $this->error,
         ];
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function arraySerialize(array $group = [])
+    {
+        return $this->jsonSerialize();
+    }
+
     /**
      * Get the API Response Data
      *
diff --git a/src/Serializer/Adapter/ArraySerializerAdapter.php b/src/Serializer/Adapter/ArraySerializerAdapter.php
@@ -0,0 +1,84 @@
+<?php
+
+namespace MattJanssen\ApiResponseBundle\Serializer\Adapter;
+
+use MattJanssen\ApiResponseBundle\Serializer\ArraySerializable;
+
+/**
+ * Adapter for Serialization Using PHP json_encode
+ *
+ * Serialized classes should implement ArraySerializable.
+ *
+ * @see ArraySerializable
+ *
+ * @author Matt Janssen <matt@mattjanssen.com>
+ */
+class ArraySerializerAdapter implements SerializerAdapterInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function serialize($data, array $groups = [])
+    {
+        $jsonString = json_encode($this->serializedMixed($data, $groups));
+
+        $jsonError = json_last_error();
+
+        if ($jsonError !== JSON_ERROR_NONE) {
+            throw new \RuntimeException(sprintf(
+                'ArraySerializerAdapter failed to serialize due to json_serialize error %s.',
+                $jsonError
+            ));
+        }
+
+        return $jsonString;
+    }
+
+    /**
+     * Create Serializable Array
+     *
+     * Similar to json_encode's traversal, but uses ArraySerializable interface.
+     *
+     * @param mixed $data
+     * @param string[] $groups
+     *
+     * @return \stdClass|mixed[] Serializable array for json_encode()
+     */
+    private function serializedMixed($data, array $groups)
+    {
+        if (is_array($data)) {
+            return $this->serializeArray($data, $groups);
+        }
+
+        if (is_object($data)) {
+            if ($data instanceof ArraySerializable) {
+                return $this->serializedMixed($data->arraySerialize($groups), $groups);
+            }
+
+            // A non-serializable object returns as an empty \stdClass object.
+            // This gets converted to {} by json_encode, where as an empty array is converted to [].
+            return new \stdClass();
+        }
+
+        // Scalar data is returned as-is.
+        return $data;
+    }
+
+    /**
+     * Map Array Back to Recursive Serialize Function
+     *
+     * @param mixed[] $array
+     * @param string[] $groups
+     *
+     * @return mixed[]
+     */
+    private function serializeArray(array $array, array $groups)
+    {
+        return array_map(
+            function ($value) use ($groups) {
+                return $this->serializedMixed($value, $groups);
+            },
+            $array
+        );
+    }
+}
diff --git a/src/Serializer/ArraySerializable.php b/src/Serializer/ArraySerializable.php
diff --git a/tests/Fixtures/TestBadSerializer.php b/tests/Fixtures/TestBadSerializer.php
diff --git a/tests/Generator/ApiResponseGeneratorTest.php b/tests/Generator/ApiResponseGeneratorTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ interface ApiConfigInterface`
`16`	`16`	`*/`
`17`	`17`	`public function getSerializer();`
`18`	`18`
`19`		`-`
`20`	`19`	`/**`
`21`	`20`	`* Get Serializer Groups to Use`
`22`	`21`	`*`