Add Docker, partial user relationships, JSON API spec, api blueprint in partial files. change Aglio theme.

Author: joselfonseca

.dockerignore

@@ -0,0 +1,6 @@
+Dockerfile
+node_modules/
+.git
+.gitignore
+.DS_Store
+.env

.env.example

@@ -8,10 +8,10 @@ API_PREFIX=api
 API_VERSION=v1
 API_DEBUG=true
 
-DB_HOST=localhost
-DB_DATABASE=laravel_api
-DB_USERNAME=homestead
-DB_PASSWORD=secret
+DB_HOST=mysql
+DB_DATABASE=api
+DB_USERNAME=root
+DB_PASSWORD=root
 
 CACHE_DRIVER=file
 SESSION_DRIVER=file

Dockerfile

@@ -0,0 +1,21 @@
+FROM joselfonsecadt/php7.0:1.0.0
+
+MAINTAINER Jose Fonseca <jose@ditecnologia.com>
+
+COPY docker/default /etc/nginx/sites-available/default
+
+COPY docker/php-fpm.conf /etc/php/7.0/fpm/php-fpm.conf
+
+COPY docker/www.conf /etc/php/7.0/fpm/pool.d/www.conf
+
+COPY . /var/www/html/
+
+EXPOSE 80
+
+COPY docker/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+WORKDIR /var/www/html/
+
+RUN cp .env.example .env
+
+CMD ["/usr/bin/supervisord"]

app/Contracts/Users/UsersServiceContract.php

@@ -36,10 +36,11 @@ public function create(array $attributes = []);
     /**
      * @param int|string $id
      * @param array $attributes
+     * @param bool $partial
      * @return User
      * @throws ValidationException
      */
-    public function update($id, array $attributes = []);
+    public function update($id, array $attributes = [], $partial = false);
 
     /**
      * @param int|string $id

app/Http/Controllers/Users/UsersController.php

@@ -83,6 +83,17 @@ public function update(Request $request, $uuid)
         return $this->response->array($this->service->transform($user));
     }
 
+    /**
+     * @param Request $request
+     * @param $uuid
+     * @return mixed
+     */
+    public function partialUpdate(Request $request, $uuid)
+    {
+        $user = $this->service->update($uuid, $request->all(), true);
+        return $this->response->array($this->service->transform($user));
+    }
+
 
     /**
      * @param Request $request

app/Services/Installation/InstallAppHandler.php

@@ -2,6 +2,7 @@
 
 namespace App\Services\Installation;
 
+use Artisan;
 use App\Entities\Role;
 use App\Entities\Permission;
 use App\Contracts\Users\UsersServiceContract;
@@ -71,6 +72,7 @@ public function __construct()
      */
     public function handle(InstallAppCommand $command)
     {
+        Artisan::call('passport:install');
         $this->createRoles()
             ->createPermissions()
             ->createAdminUser((array) $command)

app/Services/Users/UsersService.php

@@ -3,6 +3,8 @@
 namespace App\Services\Users;
 
 use App\Entities\User;
+use League\Fractal\Serializer\JsonApiSerializer;
+use League\Fractal\Serializer\SerializerAbstract;
 use League\Fractal\TransformerAbstract;
 use Dingo\Api\Exception\ResourceException;
 use App\Transformers\Users\UserTransformer;
@@ -37,8 +39,8 @@ class UsersService implements FractalAble, ValidateAble, UsersServiceContract
      * @var array
      */
     protected $validationUpdateRules = [
-        'name' => 'sometimes|required',
-        'password' => 'sometimes|required|min:8|confirmed'
+        'name' => 'required',
+        'email' => 'required|unique:users,email'
     ];
 
     /**
@@ -62,7 +64,7 @@ class UsersService implements FractalAble, ValidateAble, UsersServiceContract
      * Declare the includes to use in the with query
      * @var array
      */
-    protected $includes = [];
+    protected $includes = ['roles.permissions'];
 
     /**
      * UsersService constructor.
@@ -76,18 +78,26 @@ public function __construct(User $model)
     /**
      * @return mixed
      */
-    public function setTransformer() : TransformerAbstract
+    public function setTransformer(): TransformerAbstract
     {
         return app(UserTransformer::class);
     }
 
+    /**
+     * Sets the serializer to be used in the transformation
+     * @return SerializerAbstract
+     */
+    public function setSerializer()
+    {
+        return new JsonApiSerializer(url('api'));
+    }
 
     /**
      * @param array $attributes
      * @param int $limit
      * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator|\Illuminate\Database\Eloquent\Collection|static[]
      */
-    public function get(Array $attributes = [], $limit = 20)
+    public function get(array $attributes = [], $limit = 20)
     {
         $model = $this->model->with($this->includes);
         $this->addFilter($attributes);
@@ -127,17 +137,26 @@ public function create(array $attributes = [])
     /**
      * @param int|string $id
      * @param array $attributes
+     * @param bool $partial
      * @return User
      * @throws ResourceException
      */
-    public function update($id, array $attributes = [])
+    public function update($id, array $attributes = [], $partial = false)
     {
         $model = $this->find($id);
-        if (isset($attributes['email']) && $attributes['email'] != $model->email) {
-            $this->validationUpdateRules['email'] = 'sometimes|required|unique:users,email,'.$model->id;
+        if (array_key_exists('email', $attributes)) {
+            $this->validationUpdateRules['email'] = 'required|unique:users,email,' . $model->id;
+        }
+        if (array_key_exists('password', $attributes)) {
+            $this->validationUpdateRules['password'] = 'required|min:8|confirmed';
+        }
+        if ($partial) {
+            $this->validationUpdateRules = array_map(function ($value) {
+                return "sometimes|" . $value;
+            }, $this->validationUpdateRules);
         }
         $this->runValidator($attributes, $this->validationUpdateRules, $this->validationMessages);
-        if(isset($attributes['password'])) {
+        if (isset($attributes['password'])) {
             $attributes['password'] = bcrypt($attributes['password']);
         }
         $model->fill($attributes);

app/Transformers/Users/PermissionTransformer.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Transformers\Users;
+
+use App\Entities\Permission;
+use League\Fractal\TransformerAbstract;
+
+/**
+ * Class PermissionTransformer
+ * @package App\Transformers\Users
+ */
+class PermissionTransformer extends TransformerAbstract
+{
+
+    /**
+     * @param Permission $model
+     * @return array
+     */
+    public function transform(Permission $model)
+    {
+        return [
+            'id' => $model->uuid,
+            'name' => $model->name,
+            'created_at' => $model->created_at->toIso8601String(),
+            'updated_at' => $model->updated_at->toIso8601String(),
+        ];
+    }
+
+}

app/Transformers/Users/RoleTransformer.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Transformers\Users;
+
+use App\Entities\Role;
+use League\Fractal\TransformerAbstract;
+
+/**
+ * Class RolTransformer
+ * @package App\Transformers\Users
+ */
+class RoleTransformer extends TransformerAbstract
+{
+
+    /**
+     * @var array
+     */
+    protected $availableIncludes = ['permissions'];
+
+    /**
+     * @param Role $model
+     * @return array
+     */
+    public function transform(Role $model)
+    {
+        return [
+            'id' => $model->uuid,
+            'name' => $model->name,
+            'created_at' => $model->created_at->toIso8601String(),
+            'updated_at' => $model->updated_at->toIso8601String(),
+        ];
+    }
+
+    /**
+     * @param Role $model
+     * @return \League\Fractal\Resource\Collection
+     */
+    public function includePermissions(Role $model)
+    {
+        return $this->collection($model->permissions, new PermissionTransformer(), 'permissions');
+    }
+
+}

app/Transformers/Users/UserTransformer.php

@@ -11,6 +11,12 @@
  */
 class UserTransformer extends TransformerAbstract
 {
+
+    /**
+     * @var array
+     */
+    protected $defaultIncludes = ['roles'];
+
     /**
      * @param User $model
      * @return array
@@ -22,7 +28,16 @@ public function transform(User $model)
             'name' => $model->name,
             'email' => $model->email,
             'created_at' => $model->created_at->toIso8601String(),
-            'updated_at' => $model->updated_at->toIso8601String(),
+            'updated_at' => $model->updated_at->toIso8601String()
         ];
     }
+
+    /**
+     * @param User $model
+     * @return \League\Fractal\Resource\Collection
+     */
+    public function includeRoles(User $model)
+    {
+        return $this->collection($model->roles, new RoleTransformer(), 'roles');
+    }
 }

composer.json

@@ -18,11 +18,11 @@
         "dingo/api": "1.0.*@dev",
         "laravel/tinker": "~1.0",
         "joselfonseca/laravel-tactician" : "0.3.*",
+        "joselfonseca/laravel-api-tools" : "3.0.*",
         "spatie/laravel-fractal": "^3.3",
         "laravel/passport": "^2.0",
         "webpatser/laravel-uuid": "^2.0",
-        "spatie/laravel-permission": "^1.7",
-        "joselfonseca/laravel-api-tools" : "dev-master"
+        "spatie/laravel-permission": "^1.7"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",