re load dingo and responses with tests in Green :)

Author: joselfonseca

app/Exceptions/Handler.php

@@ -52,15 +52,6 @@ public function report(Exception $exception)
      */
     public function render($request, Exception $exception)
     {
-        if($exception instanceof NotFoundHttpException){
-            return $this->renderNotFoundException($exception);
-        }
-        if($exception instanceof ModelNotFoundException) {
-            return $this->renderModelNotFoundException($exception);
-        }
-        if($exception instanceof AccessDeniedHttpException) {
-            return $this->renderAccessDeniedException($exception);
-        }
         return parent::render($request, $exception);
     }
 
@@ -73,72 +64,11 @@ public function render($request, Exception $exception)
      */
     protected function unauthenticated($request, AuthenticationException $exception)
     {
+
         if ($request->expectsJson()) {
             return response()->json(['message' => 'Unauthenticated.'], 401);
         }
 
         return redirect()->guest('login');
     }
-
-    /**
-     * Create a response object from the given validation exception.
-     *
-     * @param  \Illuminate\Validation\ValidationException  $e
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Symfony\Component\HttpFoundation\Response
-     */
-    protected function convertValidationExceptionToResponse(ValidationException $e, $request)
-    {
-        if ($e->response) {
-            return $e->response;
-        }
-
-        $errors = $e->validator->errors()->getMessages();
-
-        if ($request->expectsJson()) {
-            return response()->json([
-                'message' => 'Validation error',
-                'errors' => $errors
-            ], 422);
-        }
-
-        return redirect()->back()->withInput(
-            $request->input()
-        )->withErrors($errors);
-    }
-
-    /**
-     * @return \Illuminate\Http\JsonResponse
-     */
-    protected function renderNotFoundException($e)
-    {
-        if(request()->expectsJson()){
-            return response()->json(['message' => 'Not Found'], 404);
-        }
-        return $this->renderHttpException($e);
-    }
-
-    /**
-     * @param $e
-     * @return \Illuminate\Http\JsonResponse
-     */
-    protected function renderModelNotFoundException($e)
-    {
-        if(request()->expectsJson()){
-            return response()->json(['message' => 'Not Found'], 404);
-        }
-        throw new NotFoundHttpException();
-    }
-
-    /**
-     * @param $e
-     * @return \Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
-     */
-    protected function renderAccessDeniedException($e)
-    {
-        if(request()->expectsJson()){
-            return response()->json(['message' => 'Forbidden'], 403);
-        }
-        return $this->renderHttpException($e);
-    }
 }

app/Http/Controllers/Api/PingController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Api;
 
+use Dingo\Api\Routing\Helpers;
 use App\Http\Controllers\Controller;
 
 /**
@@ -10,12 +11,14 @@
  */
 class PingController extends Controller
 {
+
+    use Helpers;
     /**
      * @return \Illuminate\Http\JsonResponse
      */
     public function index()
     {
-        return response()->json([
+        return $this->response->array([
             'status' => 'ok',
             'timestamp' => \Carbon\Carbon::now()
         ]);

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

@@ -4,9 +4,9 @@
 
 use App\Entities\User;
 use Illuminate\Http\Request;
+use Dingo\Api\Routing\Helpers;
 use App\Http\Controllers\Controller;
 use App\Transformers\Users\UserTransformer;
-use League\Fractal\Pagination\IlluminatePaginatorAdapter;
 
 /**
  * Class UsersController
@@ -15,6 +15,8 @@
 class UsersController extends Controller
 {
 
+    use Helpers;
+
     /**
      * @var User
      */
@@ -43,9 +45,7 @@ public function index(Request $request)
     {
         $paginator = $this->model->with('roles.permissions')
             ->paginate($request->get('limit', config('app.pagination_limit')));
-        return fractal()->collection($paginator->getCollection(), new UserTransformer())
-            ->paginateWith(new IlluminatePaginatorAdapter($paginator))
-            ->respond();
+        return $this->response->paginator($paginator, new UserTransformer());
     }
 
 
@@ -56,7 +56,7 @@ public function index(Request $request)
     public function show($id)
     {
         $user = $this->model->with('roles.permissions')->byUuid($id)->firstOrFail();
-        return fractal($user, new UserTransformer())->respond();
+        return $this->response->item($user, new UserTransformer());
     }
 
 
@@ -72,9 +72,7 @@ public function store(Request $request)
             'password' => 'required|min:8|confirmed'
         ]);
         $user = $this->model->create($request->all());
-        return fractal($user, new UserTransformer())
-            ->respond(201)
-            ->header('location', url('api/users/'.$user->uuid));
+        return $this->response->created(url('api/users/'.$user->uuid));
     }
 
 
@@ -98,7 +96,7 @@ public function update(Request $request, $uuid)
         }
         $this->validate($request, $rules);
         $user->update($request->except('_token'));
-        return fractal($user->fresh(), new UserTransformer())->respond();
+        return $this->response->item($user, new UserTransformer());
     }
 
     /**
@@ -110,6 +108,6 @@ public function destroy(Request $request, $uuid)
     {
         $user = $this->model->byUuid($uuid)->firstOrFail();
         $user->delete();
-        return response(null, 204);
+        return $this->response->noContent();
     }
 }

app/Http/Controllers/Controller.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers;
 
 use Illuminate\Http\Request;
+use Dingo\Api\Exception\ResourceException;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Routing\Controller as BaseController;
 use Illuminate\Foundation\Validation\ValidatesRequests;
@@ -22,10 +23,7 @@ class Controller extends BaseController
     protected function buildFailedValidationResponse(Request $request, array $errors)
     {
         if ($request->expectsJson()) {
-            return response([
-                'message' => 'Validation Error',
-                'errors' => $errors
-            ], 422);
+            throw new ResourceException("Validation Error", $errors);
         }
 
         return redirect()->to($this->getRedirectUrl())

app/Http/Kernel.php

@@ -36,11 +36,6 @@ class Kernel extends HttpKernel
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
             \Laravel\Passport\Http\Middleware\CreateFreshApiToken::class,
         ],
-
-        'api' => [
-            'throttle:60,1',
-            'bindings',
-        ],
     ];
 
     /**

app/Providers/ErrorHandlerServiceProvider.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Providers;
+
+use Dingo\Api\Routing\Helpers;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Auth\AuthenticationException;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+
+class ErrorHandlerServiceProvider extends ServiceProvider
+{
+
+    use Helpers;
+
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register the application error handlers.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        // register the error handler for the authentication exception.
+        app('Dingo\Api\Exception\Handler')->register(function (AuthenticationException $exception) {
+            return $this->response->errorUnauthorized('Unauthenticated.');
+        });
+        app('Dingo\Api\Exception\Handler')->register(function (ModelNotFoundException $exception) {
+            return $this->response->errorNotFound('404 Not Found');
+        });
+    }
+}

app/Providers/RouteServiceProvider.php

@@ -58,16 +58,14 @@ protected function mapWebRoutes()
 
     /**
      * Define the "api" routes for the application.
+     * Since we are using Dingo, the web middleware group will not apply
      *
      * These routes are typically stateless.
      *
      * @return void
      */
     protected function mapApiRoutes()
     {
-        Route::prefix('api')
-            ->middleware('api')
-            ->namespace($this->namespace)
-            ->group(base_path('routes/api.php'));
+        require base_path('routes/api.php');
     }
 }

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "joselfonseca/laravel-api",
     "description": "Laravel API starter Kit will give you most of the boilerplate that you need for creating Laravel API's",
-    "keywords": ["framework", "laravel", "Api", "REST", "oAuth2"],
+    "keywords": ["framework", "laravel", "Api", "REST", "oAuth2", "Dingo API"],
     "license": "MIT",
     "type": "project",
     "authors": [
@@ -19,7 +19,7 @@
         "joselfonseca/laravel-tactician": "0.3.*",
         "laravel/tinker": "~1.0",
         "predis/predis": "^1.1",
-        "spatie/laravel-fractal": "^3.3",
+        "dingo/api": "1.0.*@dev",
         "spatie/laravel-permission": "^1.7",
         "webpatser/laravel-uuid": "^2.0"
     },