Merge pull request #1 from NewwayLibs/master

respect resource key + default serializer

Author: arrilot

README.md

@@ -118,6 +118,13 @@ use League\Fractal\TransformerAbstract;
 
 class UserTransformer extends TransformerAbstract
 {
+    /**
+     * Resource key.
+     *
+     * @var string
+     */
+    protected $resourceKey = null;
+    
     /**
      * Turn this item object into a generic array.
      *

src/Generator/stubs/controller.stub

@@ -6,6 +6,13 @@ use {{transformer.fullName}};
 
 class {{controller.name}} extends Controller
 {
+    /**
+     * Resource key.
+     *
+     * @var string
+     */
+    protected $resourceKey = null;
+
     /**
      * Eloquent model.
      *

src/Skeleton/BaseController.php

@@ -70,6 +70,13 @@ abstract class BaseController extends LaravelController
      */
     protected $maximumLimit = false;
 
+    /**
+     * Resource key.
+     *
+     * @var string
+     */
+    protected $resourceKey = null;
+
     /**
      * Constructor.
      *
@@ -82,6 +89,8 @@ public function __construct(Request $request)
         $this->fractal = new Manager();
         $this->request = $request;
 
+        $this->fractal->setSerializer($this->serializer());
+
         if ($this->request->has('include')) {
             $this->fractal->parseIncludes(camel_case($this->request->input('include')));
         }
@@ -101,6 +110,16 @@ abstract protected function model();
      */
     abstract protected function transformer();
 
+    /**
+     * Serializer for the current model.
+     *
+     * @return \League\Fractal\Serializer\SerializerAbstract
+     */
+    protected function serializer()
+    {
+        return new Serializer();
+    }
+
     /**
      * Display a listing of the resource.
      * GET /api/{resource}.
@@ -109,6 +128,8 @@ abstract protected function transformer();
      */
     public function index()
     {
+        $this->resourceKey = empty($this->resourceKey) ? 'data' : str_plural($this->resourceKey);
+
         $with = $this->getEagerLoad();
         $skip = (int) $this->request->input('skip', 0);
         $limit = $this->calculateLimit();
@@ -128,7 +149,10 @@ public function index()
      */
     public function store()
     {
-        $data = $this->request->json()->get('data');
+        $key = empty($this->resourceKey) ? 'data' : str_singular($this->resourceKey);
+
+        $data = $this->request->json()->get($key);
+
         if (!$data) {
             return $this->errorWrongArgs('Empty data');
         }
@@ -175,7 +199,10 @@ public function show($id)
      */
     public function update($id)
     {
-        $data = $this->request->json()->get('data');
+        $key = empty($this->resourceKey) ? 'data' : str_singular($this->resourceKey);
+
+        $data = $this->request->json()->get($key);
+
         if (!$data) {
             return $this->errorWrongArgs('Empty data');
         }
@@ -274,7 +301,7 @@ protected function setStatusCode($statusCode)
      */
     protected function respondWithItem($item)
     {
-        $resource = new Item($item, $this->transformer);
+        $resource = new Item($item, $this->transformer, $this->resourceKey);
 
         $rootScope = $this->prepareRootScope($resource);
 
@@ -292,7 +319,7 @@ protected function respondWithItem($item)
      */
     protected function respondWithCollection($collection, $skip = 0, $limit = 0)
     {
-        $resource = new Collection($collection, $this->transformer);
+        $resource = new Collection($collection, $this->transformer, $this->resourceKey);
 
         if ($limit) {
             $cursor = new Cursor($skip, $skip + $limit, $collection->count());
@@ -495,4 +522,4 @@ protected function calculateLimit()
 
         return ($this->maximumLimit && $this->maximumLimit < $limit) ? $this->maximumLimit : $limit;
     }
-}
+}

src/Skeleton/Serializer.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Arrilot\Api\Skeleton;
+
+use League\Fractal\Resource\ResourceInterface;
+use League\Fractal\Serializer\JsonApiSerializer;
+
+class Serializer extends JsonApiSerializer
+{
+    /**
+     * Serialize the included data.
+     *
+     * @param \League\Fractal\Resource\ResourceInterface $resource
+     * @param array $data
+     *
+     * @return array
+     */
+    public function includedData(ResourceInterface $resource, array $data)
+    {
+        $serializedData = parent::includedData($resource, $data);
+
+        return isset($serializedData['linked']) ? $serializedData['linked'] : [];
+    }
+}