chore: refactor responses (#18)

* chore: refactor responses

* chore: update test

* chore: update readme

Author: ricklambrechts

README.md

@@ -60,17 +60,17 @@ The package provides a pre-configured login route for OpenID Connect authenticat
 To enable or disable the login route, you can update the `OIDC_LOGIN_ROUTE_ENABLED` variable in your environment configuration. Set it to true to enable the login route or false to disable it.
 To change the URL of the login route, you can update the `OIDC_LOGIN_ROUTE` variable in your environment configuration. The default value is `/oidc/login`.
 
-### Customizing Login Response
-The package includes a default LoginResponse class that returns a JSON response containing user information. However, you have the flexibility to customize the login response according to your project's needs.
+### Customizing Login Response Handler
+The package includes a default LoginResponseHandler class that returns a JSON response containing user information. However, you have the flexibility to customize the login response according to your project's needs.
 
-To bind your own implementation of the LoginResponseInterface, you can use the following code in your Laravel application:
+To bind your own implementation of the LoginResponseHandlerInterface, you can use the following code in your Laravel application:
 ```php
-$this->app->bind(LoginResponseInterface::class, YourCustomLoginResponse::class);
+$this->app->bind(LoginResponseHandlerInterface::class, YourCustomLoginResponse::class);
 ```
 
 Replace `YourCustomLoginResponse` with the class name of your custom implementation. By binding your own response class, you can define the desired behavior and format of the login response.
 
-Make sure to implement the `LoginResponseInterface` in your custom response class to ensure compatibility.
+Make sure to implement the `LoginResponseHandlerInterface` in your custom response handler class to ensure compatibility.
 
 ## Contributing
 If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository of this package.

src/Http/Controllers/Controller.php

@@ -5,22 +5,24 @@
 namespace MinVWS\OpenIDConnectLaravel\Http\Controllers;
 
 use Exception;
-use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
 use Jumbojett\OpenIDConnectClientException;
-use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponseInterface;
+use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponseHandlerInterface;
 use MinVWS\OpenIDConnectLaravel\OpenIDConnectClient;
-use MinVWS\OpenIDConnectLaravel\Services\OpenIDConnectExceptionHandlerInterface;
+use MinVWS\OpenIDConnectLaravel\Services\ExceptionHandlerInterface;
+use Symfony\Component\HttpFoundation\Response;
 
 class LoginController extends Controller
 {
     public function __construct(
         protected OpenIDConnectClient $client,
-        protected OpenIDConnectExceptionHandlerInterface $exceptionHandler,
+        protected ExceptionHandlerInterface $exceptionHandler,
+        protected LoginResponseHandlerInterface $responseHandler,
     ) {
     }
 
-    public function __invoke(Request $request): Responsable
+    public function __invoke(Request $request): Response
     {
         // This redirects to the client and handles the redirect back
         try {
@@ -42,8 +44,8 @@ public function __invoke(Request $request): Responsable
             return $this->exceptionHandler->handleException($e);
         }
 
-        // Return the user information in a response
-        return app(LoginResponseInterface::class, ['userInfo' => $userInfo]);
+        // Return the user information to response handler
+        return $this->responseHandler->handleLoginResponse($userInfo);
     }
 
     /**

src/Http/Controllers/LoginController.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MinVWS\OpenIDConnectLaravel\Http\Responses;
+
+use Illuminate\Http\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+
+class LoginResponseHandler implements LoginResponseHandlerInterface
+{
+    public function handleLoginResponse(object $userInfo): Response
+    {
+        return new JsonResponse([
+            'userInfo' => $userInfo,
+        ]);
+    }
+}

src/Http/Responses/LoginResponse.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MinVWS\OpenIDConnectLaravel\Http\Responses;
+
+use Symfony\Component\HttpFoundation\Response;
+
+interface LoginResponseHandlerInterface
+{
+    public function handleLoginResponse(object $userInfo): Response;
+}

src/Http/Responses/LoginResponseHandler.php

@@ -8,13 +8,13 @@
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 use Jose\Component\KeyManagement\JWKFactory;
-use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponse;
-use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponseInterface;
+use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponseHandler;
+use MinVWS\OpenIDConnectLaravel\Http\Responses\LoginResponseHandlerInterface;
 use MinVWS\OpenIDConnectLaravel\OpenIDConfiguration\OpenIDConfigurationLoader;
 use MinVWS\OpenIDConnectLaravel\Services\JWE\JweDecryptInterface;
 use MinVWS\OpenIDConnectLaravel\Services\JWE\JweDecryptService;
-use MinVWS\OpenIDConnectLaravel\Services\OpenIDConnectExceptionHandler;
-use MinVWS\OpenIDConnectLaravel\Services\OpenIDConnectExceptionHandlerInterface;
+use MinVWS\OpenIDConnectLaravel\Services\ExceptionHandler;
+use MinVWS\OpenIDConnectLaravel\Services\ExceptionHandlerInterface;
 
 class OpenIDConnectServiceProvider extends ServiceProvider
 {
@@ -26,7 +26,7 @@ public function register(): void
         $this->registerConfigurationLoader();
         $this->registerClient();
         $this->registerExceptionHandler();
-        $this->registerResponses();
+        $this->registerResponseHandler();
     }
 
     public function boot(): void
@@ -130,10 +130,10 @@ protected function registerJweDecryptInterface(): void
 
     protected function registerExceptionHandler(): void
     {
-        $this->app->bind(OpenIDConnectExceptionHandlerInterface::class, OpenIDConnectExceptionHandler::class);
+        $this->app->bind(ExceptionHandlerInterface::class, ExceptionHandler::class);
     }
-    protected function registerResponses(): void
+    protected function registerResponseHandler(): void
     {
-        $this->app->bind(LoginResponseInterface::class, LoginResponse::class);
+        $this->app->bind(LoginResponseHandlerInterface::class, LoginResponseHandler::class);
     }
 }

src/Http/Responses/LoginResponseHandlerInterface.php

@@ -5,12 +5,12 @@
 namespace MinVWS\OpenIDConnectLaravel\Services;
 
 use Exception;
-use Illuminate\Contracts\Support\Responsable;
 use Jumbojett\OpenIDConnectClientException;
+use Symfony\Component\HttpFoundation\Response;
 
-class OpenIDConnectExceptionHandler implements OpenIDConnectExceptionHandlerInterface
+class ExceptionHandler implements ExceptionHandlerInterface
 {
-    public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $exception): Responsable
+    public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $exception): Response
     {
         if (str_starts_with($exception->getMessage(), 'Error: ')) {
             return $this->handleRequestError($exception);
@@ -26,14 +26,14 @@ public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $e
     /**
      * Called when request to userinfo endpoint fails, jwt signature is invalid, or userinfo is not an object.
      * @param OpenIDConnectClientException $exception
-     * @return Responsable
+     * @return Response
      */
-    public function handleExceptionWhileRequestUserInfo(OpenIDConnectClientException $exception): Responsable
+    public function handleExceptionWhileRequestUserInfo(OpenIDConnectClientException $exception): Response
     {
         return $this->defaultResponse($exception);
     }
 
-    public function handleException(Exception $exception): Responsable
+    public function handleException(Exception $exception): Response
     {
         return $this->defaultResponseGenericException($exception);
     }
@@ -42,34 +42,34 @@ public function handleException(Exception $exception): Responsable
      * Called when url contains query parameter error.
      * For example user is sent back from idp with error=login_cancelled.
      * @param OpenIDConnectClientException $exception
-     * @return Responsable
+     * @return Response
      */
-    protected function handleRequestError(OpenIDConnectClientException $exception): Responsable
+    protected function handleRequestError(OpenIDConnectClientException $exception): Response
     {
         return $this->default400Response($exception);
     }
 
     /**
      * Called when url contains query parameter code and state, and state does not match with the value from session.
      * @param OpenIDConnectClientException $exception
-     * @return Responsable
+     * @return Response
      */
-    protected function handleUnableToDetermineState(OpenIDConnectClientException $exception): Responsable
+    protected function handleUnableToDetermineState(OpenIDConnectClientException $exception): Response
     {
         return $this->default400Response($exception);
     }
 
-    protected function defaultResponse(OpenIDConnectClientException $exception): Responsable
+    protected function defaultResponse(OpenIDConnectClientException $exception): Response
     {
         abort(500, $exception->getMessage());
     }
 
-    protected function defaultResponseGenericException(Exception $exception): Responsable
+    protected function defaultResponseGenericException(Exception $exception): Response
     {
         abort(500, $exception->getMessage());
     }
 
-    protected function default400Response(OpenIDConnectClientException $exception): Responsable
+    protected function default400Response(OpenIDConnectClientException $exception): Response
     {
         abort(400, $exception->getMessage());
     }

src/Http/Responses/LoginResponseInterface.php

@@ -5,12 +5,12 @@
 namespace MinVWS\OpenIDConnectLaravel\Services;
 
 use Exception;
-use Illuminate\Contracts\Support\Responsable;
 use Jumbojett\OpenIDConnectClientException;
+use Symfony\Component\HttpFoundation\Response;
 
-interface OpenIDConnectExceptionHandlerInterface
+interface ExceptionHandlerInterface
 {
-    public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $exception): Responsable;
-    public function handleExceptionWhileRequestUserInfo(OpenIDConnectClientException $exception): Responsable;
-    public function handleException(Exception $exception): Responsable;
+    public function handleExceptionWhileAuthenticate(OpenIDConnectClientException $exception): Response;
+    public function handleExceptionWhileRequestUserInfo(OpenIDConnectClientException $exception): Response;
+    public function handleException(Exception $exception): Response;
 }