working roles endpoint #4

Author: joselfonseca

app/Http/Controllers/Api/Users/RolesController.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace App\Http\Controllers\Api\Users;
+
+use App\Entities\Role;
+use Illuminate\Http\Request;
+use Dingo\Api\Routing\Helpers;
+use App\Http\Controllers\Controller;
+use App\Transformers\Users\RoleTransformer;
+
+class RolesController extends Controller
+{
+    use Helpers;
+
+    /**
+     * @var
+     */
+    protected $model;
+
+    /**
+     * UsersController constructor.
+     * @param Role $model
+     */
+    public function __construct(Role $model)
+    {
+        $this->model = $model;
+        $this->middleware('permission:List roles')->only('index');
+        $this->middleware('permission:List roles')->only('show');
+        $this->middleware('permission:Create roles')->only('store');
+        $this->middleware('permission:Update roles')->only('update');
+        $this->middleware('permission:Delete roles')->only('destroy');
+    }
+
+
+    /**
+     * @param Request $request
+     * @return mixed
+     */
+    public function index(Request $request)
+    {
+        $paginator = $this->model->with('permissions')
+            ->paginate($request->get('limit', config('app.pagination_limit')));
+        return $this->response->paginator($paginator, new RoleTransformer());
+    }
+
+
+    /**
+     * @param $id
+     * @return mixed
+     */
+    public function show($id)
+    {
+        $role = $this->model->with('permissions')->byUuid($id)->firstOrFail();
+        return $this->response->item($role, new RoleTransformer());
+    }
+
+
+    /**
+     * @param Request $request
+     * @return mixed
+     */
+    public function store(Request $request)
+    {
+        $this->validate($request, [
+            'name' => 'required'
+        ]);
+        $role = $this->model->create($request->all());
+        return $this->response->created(url('api/roles/'.$role->uuid));
+    }
+
+
+    /**
+     * @param Request $request
+     * @param $uuid
+     * @return mixed
+     */
+    public function update(Request $request, $uuid)
+    {
+        $role = $this->model->byUuid($uuid)->firstOrFail();
+        $rules = [
+            'name' => 'required'
+        ];
+        $this->validate($request, $rules);
+        $role->update($request->except('_token'));
+        return $this->response->item($role->fresh(), new RoleTransformer());
+    }
+
+    /**
+     * @param Request $request
+     * @param $uuid
+     * @return mixed
+     */
+    public function destroy(Request $request, $uuid)
+    {
+        $user = $this->model->byUuid($uuid)->firstOrFail();
+        $user->delete();
+        return $this->response->noContent();
+    }
+}

app/Http/Controllers/Api/Users/UsersController.php

@@ -96,7 +96,7 @@ public function update(Request $request, $uuid)
         }
         $this->validate($request, $rules);
         $user->update($request->except('_token'));
-        return $this->response->item($user, new UserTransformer());
+        return $this->response->item($user->fresh(), new UserTransformer());
     }
 
     /**

app/Transformers/Users/RoleTransformer.php

@@ -15,7 +15,7 @@ class RoleTransformer extends TransformerAbstract
     /**
      * @var array
      */
-    protected $availableIncludes = ['permissions'];
+    protected $defaultIncludes = ['permissions'];
 
     /**
      * @param Role $model

routes/api.php

@@ -19,6 +19,15 @@
                 $api->delete('/{uuid}', 'Api\Users\UsersController@destroy');
             });
 
+            $api->group(['prefix' => 'roles'], function ($api) {
+                $api->get('/', 'Api\Users\RolesController@index');
+                $api->post('/', 'Api\Users\RolesController@store');
+                $api->get('/{uuid}', 'Api\Users\RolesController@show');
+                $api->put('/{uuid}', 'Api\Users\RolesController@update');
+                $api->patch('/{uuid}', 'Api\Users\RolesController@update');
+                $api->delete('/{uuid}', 'Api\Users\RolesController@destroy');
+            });
+
         });
 
     });

tests/Feature/Users/RolesEndpointsTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Tests\Feature\Users;
+
+use App\Entities\Role;
+use App\Entities\User;
+use Laravel\Passport\Passport;
+use Tests\TestCase;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+
+class RolesEndpointsTest extends TestCase
+{
+
+    use DatabaseMigrations;
+
+    function setUp()
+    {
+        parent::setUp();
+        $this->installApp();
+    }
+
+
+    public function test_it_list_roles()
+    {
+        factory(Role::class, 10)->create();
+        Passport::actingAs(User::first());
+        $response = $this->json('GET', 'api/roles');
+        $response->assertStatus(200);
+        $response->assertJson([
+            'data' => [
+                ['name' => 'Administrator']
+            ],
+            'meta' => [
+                'pagination' => [
+                    'total' => 11
+                ]
+            ]
+        ]);
+    }
+
+    public function test_it_prevents_unauthorized_roles_listing()
+    {
+        $user = factory(User::class)->create();
+        Passport::actingAs($user);
+        $response = $this->json('GET', 'api/roles');
+        $response->assertStatus(403);
+    }
+
+    public function test_it_can_create_a_role()
+    {
+        Passport::actingAs(User::first());
+        $response = $this->json('POST', 'api/roles', [
+            'name' => 'Guest'
+        ]);
+        $response->assertStatus(201);
+        $response->assertHeader('location');
+        $this->assertDatabaseHas('roles', [
+            'name' => 'Guest'
+        ]);
+    }
+
+    public function test_it_validates_input_for_roles()
+    {
+        Passport::actingAs(User::first());
+        $response = $this->json('POST', 'api/roles', [
+
+        ]);
+        $response->assertStatus(422);
+    }
+}