Laravel Airlock Support

Laravel Airlock Support

Author: Lupacescu Eduard

config/config.php

@@ -6,15 +6,29 @@
 return [
     'auth' => [
         /*
-    |--------------------------------------------------------------------------
-    | Table containing authenticatable resource
-    |--------------------------------------------------------------------------
-    |
-    | This configuration contain the name of the table used for the authentication.
-    |
-    */
+        |--------------------------------------------------------------------------
+        | Table containing authenticatable resource
+        |--------------------------------------------------------------------------
+        |
+        | This configuration contain the name of the table used for the authentication.
+        |
+        */
 
         'table' => 'users',
+
+        /*
+        |--------------------------------------------------------------------------
+        |
+        |--------------------------------------------------------------------------
+        |
+        | Next you may configure the package you're using for the personal tokens generation,
+        | this will be used for the verification of the authenticatable model and provide the
+        | authorizable functionality
+        |
+        | Supported: "passport", "airlock"
+        */
+
+        'provider' => 'airlock',
     ],
 
     /*

phpunit.xml.dist

@@ -8,7 +8,7 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false">
+         stopOnFailure="true">
     <testsuites>
         <testsuite name="Test Suite">
             <directory>tests</directory>

src/Contracts/Airlockable.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Contracts;
+
+use Illuminate\Database\Query\Builder;
+
+interface Airlockable
+{
+    /**
+     * Create a new personal access token for the user.
+     *
+     * @param  string  $name
+     * @param  array  $abilities
+     * @return \Laravel\Airlock\NewAccessToken
+     */
+    public function createToken(string $name, array $abilities = ['*']);
+
+    /**
+     * @return Builder
+     */
+    public function tokens();
+}

src/Exceptions/AirlockUserException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Exceptions;
+
+use Exception;
+
+/**
+ * @author Eduard Lupacescu <[email protected]>
+ */
+class AirlockUserException extends Exception
+{
+}

src/Services/AuthService.php

@@ -2,9 +2,11 @@
 
 namespace Binaryk\LaravelRestify\Services;
 
+use Binaryk\LaravelRestify\Contracts\Airlockable;
 use Binaryk\LaravelRestify\Contracts\Passportable;
 use Binaryk\LaravelRestify\Events\UserLoggedIn;
 use Binaryk\LaravelRestify\Events\UserLogout;
+use Binaryk\LaravelRestify\Exceptions\AirlockUserException;
 use Binaryk\LaravelRestify\Exceptions\AuthenticatableUserException;
 use Binaryk\LaravelRestify\Exceptions\CredentialsDoesntMatch;
 use Binaryk\LaravelRestify\Exceptions\Eloquent\EntityNotFoundException;
@@ -59,6 +61,7 @@ class AuthService extends RestifyService
      * @throws CredentialsDoesntMatch
      * @throws UnverifiedUser
      * @throws PassportUserException
+     * @throws AirlockUserException
      */
     public function login(array $credentials = [])
     {
@@ -69,7 +72,7 @@ public function login(array $credentials = [])
         }
 
         /**
-         * @var Authenticatable|Passportable
+         * @var Authenticatable|Passportable|Airlockable
          */
         $user = Auth::user();
 
@@ -79,7 +82,7 @@ public function login(array $credentials = [])
 
         $this->validateUserModel($user);
 
-        if ($user instanceof Passportable) {
+        if (method_exists($user, 'createToken')) {
             $token = $user->createToken('Login')->accessToken;
             event(new UserLoggedIn($user));
         }
@@ -88,13 +91,14 @@ public function login(array $credentials = [])
     }
 
     /**
-     * @param  array  $payload
+     * @param array $payload
      * @return \Illuminate\Database\Eloquent\Builder|Model|mixed
      * @throws AuthenticatableUserException
      * @throws EntityNotFoundException
      * @throws PassportUserException
      * @throws ValidationException
      * @throws BindingResolutionException
+     * @throws AirlockUserException
      */
     public function register(array $payload)
     {
@@ -218,6 +222,7 @@ public function broker()
      *
      * @throws EntityNotFoundException
      * @throws PassportUserException
+     * @throws AirlockUserException
      * @return Model
      */
     public function userQuery()
@@ -239,12 +244,17 @@ public function userQuery()
     /**
      * @param $userInstance
      * @throws PassportUserException
+     * @throws AirlockUserException
      */
     public function validateUserModel($userInstance)
     {
-        if (false === $userInstance instanceof Passportable) {
+        if (config('restify.auth.provider') === 'passport' && false === $userInstance instanceof Passportable) {
             throw new PassportUserException(__("User is not implementing Binaryk\LaravelRestify\Contracts\Passportable contract. User can use 'Laravel\Passport\HasApiTokens' trait"));
         }
+
+        if (config('restify.auth.provider') === 'airlock' && false === $userInstance instanceof Airlockable) {
+            throw new AirlockUserException(__("User is not implementing Binaryk\LaravelRestify\Contracts\Airlockable contract. User should use 'Laravel\Airlock\HasApiTokens' trait to provide"));
+        }
     }
 
     /**
@@ -302,9 +312,16 @@ public function logout()
          * @var User
          */
         $user = Auth::user();
-        if ($user instanceof Authenticatable && $user instanceof Passportable) {
-            $user->tokens()->get()->each->revoke();
-            event(new UserLogout($user));
+        if ($user instanceof Authenticatable) {
+            if ($user instanceof Passportable) {
+                $user->tokens()->get()->each->revoke();
+                event(new UserLogout($user));
+            }
+
+            if ($user instanceof Airlockable) {
+                $user->tokens->each->delete();
+                event(new UserLogout($user));
+            }
         } else {
             throw new AuthenticatableUserException(__('User is not authenticated.'));
         }

tests/AuthServiceLoginTest.php

@@ -5,6 +5,7 @@
 use Binaryk\LaravelRestify\Contracts\Passportable;
 use Binaryk\LaravelRestify\Events\UserLoggedIn;
 use Binaryk\LaravelRestify\Events\UserLogout;
+use Binaryk\LaravelRestify\Exceptions\AirlockUserException;
 use Binaryk\LaravelRestify\Exceptions\AuthenticatableUserException;
 use Binaryk\LaravelRestify\Exceptions\CredentialsDoesntMatch;
 use Binaryk\LaravelRestify\Exceptions\PassportUserException;
@@ -75,6 +76,7 @@ public function test_user_did_not_verified_email()
 
     public function test_login_user_did_not_user_passport_trait_or_not_implement_pasportable()
     {
+        $this->app['config']->set('restify.auth.provider', 'passport');
         $this->expectException(PassportUserException::class);
         $userMustVerify = (new class extends User implements MustVerifyEmail {
             use \Illuminate\Auth\MustVerifyEmail;
@@ -94,6 +96,28 @@ public function test_login_user_did_not_user_passport_trait_or_not_implement_pas
         $this->authService->login();
     }
 
+    public function test_login_user_did_not_user_passport_trait_or_not_implement_airlockable()
+    {
+        $this->app['config']->set('restify.auth.provider', 'airlock');
+        $this->expectException(AirlockUserException::class);
+        $userMustVerify = (new class extends User implements MustVerifyEmail {
+            use \Illuminate\Auth\MustVerifyEmail;
+        });
+
+        $userMustVerify->fill([
+            'email' => '[email protected]',
+            'email_verified_at' => Carbon::now(),
+        ]);
+
+        Auth::shouldReceive('attempt')
+            ->andReturnTrue();
+
+        Auth::shouldReceive('user')
+            ->andReturn($userMustVerify);
+
+        $this->authService->login();
+    }
+
     public function test_login_with_success()
     {
         Event::fake([
@@ -127,6 +151,8 @@ public function test_login_with_success()
     public function test_logout_success()
     {
         Event::fake();
+        $this->app['config']->set('restify.auth.provider', 'passport');
+
         $user = (new class extends \Binaryk\LaravelRestify\Tests\Fixtures\User {
             public function tokens()
             {