Merge branch 'develop'

Author: michaeldzjap

README.md

@@ -9,18 +9,14 @@ A two-factor authentication package for _Laravel_ >= 5.5
 ## Description
 This is a two-factor authentication package for _Laravel_. It is heavily inspired by the [Laravel Two-Factor Authentication](https://github.com/srmklive/laravel-twofactor-authentication) package. The main differences between this package and the aforementioned package are:
 
-- This package currently only works with the *MessageBird Verify* api or the `'null'` driver that goes through all the steps of the two-factor authentication process without actually doing any real verification. This could be useful for testing purposes.
+- This package currently only works out of the box with the *MessageBird Verify* api or the `'null'` driver that goes through all the steps of the two-factor authentication process without actually doing any real verification. This could be useful for testing purposes. You can however, specify a custom provider yourself.
 - This package uses throttling to limit the number of unsuccessful authentication attempts in a certain amount of time.
 - The current version of this package is only guaranteed to work with _Laravel_ >= 5.5. Version 1.* of this package works with _Laravel_ 5.4. Versions of _Laravel_ prior to 5.4 have not been tested.
 
 ## Important
-From _Laravel_ 5.8 and onwards, the default is to use `bigIncrements` instead of `increments` for the `id` column on the `users` table. As such, the default for this package is to use the same convention for the `user_id` column on the `two_factor_auths` table. If this is not what you want, you can change this in the published config file by setting the "big_int" option to `false`.
+From _Laravel_ 5.8 and onwards, the default is to use `bigIncrements` instead of `increments` for the `id` column on the `users` table. As such, the default for this package is to use the same convention for the `user_id` column on the `two_factor_auths` table. If this is not what you want, you can change this to your liking by modifying the migration files that are published for this package.
 
-For users who have already installed this package and hence, already have ran the migrations for this package there are essentially two different scenarios:
-
-1. You upgrade from _Laravel_ < 5.8 to 5.8 or later and have decided to keep using `increments` for the `id` column on the `users` table: You don't have to do anything. You might want to [change](#optional-correction) the signature of the `user_id` column on the `two_factor_auths` table from `increments` to `unsignedInteger` though.
-
-2. You upgrade from _Laravel_ < 5.8 to 5.8 or later and have decided to make the switch to `bigIncrements` for the `id` column on the `users` table: You will have to make and run your own migration in order to update the `user_id` column on the `two_factor_auths` table appropriately.
+Publishing the package's migration files allows for more flexibility with regards to customising your database structure. However, it could also cause complications if you already have ran migrations as part of installing previous versions of this package. In this case you simply might want to bypass running the migrations again or only run them when in a specific environment. The `Schema::hasColumn()` and `Schema::hasTable()` methods should be of use here.
 
 ### Optional correction
 Versions of this package prior to v2.3.0 incorrectly created the `user_id` column on the `two_factor_auths` table using `increments` instead of `unsignedInteger`. Practically speaking, this error is of no concern. Although there is no need to have a _primary_ key for the `user_id` column, it doesn't cause any problems either. However, if for some reason you don't like this idea, it is safe to remove the _primary_ key using a migration of the form
@@ -95,7 +91,7 @@ If you want to publish only one of these file groups, for instance if you don't
 
 4. **Important**: Make sure you do this step _before_ you run any migrations for this package, as otherwise it might give you unexpected results.
 
-    From _Laravel_ 5.8 and on, the default is to use `bigIncrements` instead of `increments` for the `id` column on the `users` table. As such, the default for this package is to use the same convention for the `user_id` column on the `two_factor_auths` table. If this is not what you want, you can change this in the published config file by setting the "big_int" option to `false`.
+    From _Laravel_ 5.8 and on, the default is to use `bigIncrements` instead of `increments` for the `id` column on the `users` table. As such, the default for this package is to use the same convention for the `user_id` column on the `two_factor_auths` table. If this is not what you want, you can modify the published migration files for this package.
 
 5. Run the following *artisan* command to run the database migrations
 ```
@@ -263,7 +259,9 @@ resolve(\MichaelDzjap\TwoFactorAuth\TwoFactorAuthManager)->extend('dummy', funct
 ```php
 ...
 'dummy' => [
+
     'driver' => 'dummy',
+
 ],
 ...
 ```

src/Contracts/SMSToken.php

@@ -9,8 +9,8 @@ interface SMSToken
     /**
      * Send a user a two-factor authentication token via SMS.
      *
-     * @param  User $user
+     * @param  \App\User  $user
      * @return void
      */
-    public function sendSMSToken(User $user);
+    public function sendSMSToken(User $user) : void;
 }

src/Contracts/TwoFactorProvider.php

@@ -9,32 +9,32 @@ interface TwoFactorProvider
     /**
      * Check if two-factor authentication is enabled for a user.
      *
-     * @param  User $user
+     * @param  \App\User  $user
      * @return bool
      */
     public function enabled(User $user);
 
     /**
      * Register a user with this provider.
      *
-     * @param  User $user
+     * @param  \App\User  $user
      * @return void
      */
-    public function register(User $user);
+    public function register(User $user) : void;
 
     /**
      * Unregister a user with this provider.
      *
-     * @param  User $user
+     * @param  \App\User  $user
      * @return bool
      */
     public function unregister(User $user);
 
     /**
      * Determine if the token is valid.
      *
-     * @param  User $user
-     * @param  string $token
+     * @param  \App\User  $user
+     * @param  string  $token
      * @return bool
      */
     public function verify(User $user, string $token);

src/Http/Controllers/ThrottlesTwoFactorAuths.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Foundation\Auth\ThrottlesLogins;
 use Illuminate\Http\Request;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 
 trait ThrottlesTwoFactorAuths
@@ -27,7 +28,7 @@ protected function hasTooManyTwoFactorAuthAttempts(Request $request)
      * @param  \Illuminate\Http\Request  $request
      * @return void
      */
-    protected function incrementTwoFactorAuthAttempts(Request $request)
+    protected function incrementTwoFactorAuthAttempts(Request $request) : void
     {
         self::incrementLoginAttempts($request);
     }
@@ -54,7 +55,7 @@ protected function sendLockoutResponse(Request $request)
 
         return redirect()->to('/login')
             ->withInput(
-                array_only($request->session()->get('two-factor:auth'), [$this->username(), 'remember'])
+                Arr::only($request->session()->get('two-factor:auth'), [$this->username(), 'remember'])
             )
             ->withErrors($errors);
     }
@@ -65,7 +66,7 @@ protected function sendLockoutResponse(Request $request)
      * @param  \Illuminate\Http\Request  $request
      * @return void
      */
-    protected function clearTwoFactorAuthAttempts(Request $request)
+    protected function clearTwoFactorAuthAttempts(Request $request) : void
     {
         self::clearLoginAttempts($request);
     }
@@ -76,7 +77,7 @@ protected function clearTwoFactorAuthAttempts(Request $request)
      * @param  \Illuminate\Http\Request  $request
      * @return string
      */
-    protected function throttleKey(Request $request)
+    protected function throttleKey(Request $request) : string
     {
         return Str::lower($request->session()->get('two-factor:auth')[$this->username()]).'|'.$request->ip();
     }

src/Http/Controllers/TwoFactorAuthenticatesUsers.php

@@ -160,7 +160,7 @@ protected function sendKillTwoFactorAuthResponse(Request $request)
      *
      * @return string
      */
-    public function username()
+    public function username() : string
     {
         return 'email';
     }

src/Providers/MessageBirdVerify.php

@@ -39,7 +39,7 @@ public function __construct(Client $client)
      * @param  \App\User  $user
      * @return void
      */
-    public function register(User $user)
+    public function register(User $user) : void
     {
         //
     }

src/TwoFactorAuthManager.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Manager;
 use MessageBird\Client;
+use MichaelDzjap\TwoFactorAuth\Contracts\TwoFactorProvider;
 use MichaelDzjap\TwoFactorAuth\Providers\MessageBirdVerify;
 use MichaelDzjap\TwoFactorAuth\Providers\NullProvider;
 
@@ -13,9 +14,9 @@ class TwoFactorAuthManager extends Manager
      * Get a driver instance.
      *
      * @param  string  $driver
-     * @return mixed
+     * @return \MichaelDzjap\TwoFactorAuth\Contracts\TwoFactorProvider
      */
-    public function provider($driver = null)
+    public function provider(string $driver = null) : TwoFactorProvider
     {
         return $this->driver($driver);
     }
@@ -25,7 +26,7 @@ public function provider($driver = null)
      *
      * @return \MichaelDzjap\TwoFactorAuth\Contracts\TwoFactorProvider
      */
-    protected function createMessageBirdDriver()
+    protected function createMessageBirdDriver() : TwoFactorProvider
     {
         return new MessageBirdVerify(
             new Client($this->app['config']['twofactor-auth.providers.messagebird.key'])
@@ -37,7 +38,7 @@ protected function createMessageBirdDriver()
      *
      * @return \MichaelDzjap\TwoFactorAuth\Contracts\TwoFactorProvider
      */
-    protected function createNullDriver()
+    protected function createNullDriver() : TwoFactorProvider
     {
         return new NullProvider;
     }
@@ -47,7 +48,7 @@ protected function createNullDriver()
      *
      * @return string
      */
-    public function getDefaultDriver()
+    public function getDefaultDriver() : string
     {
         return $this->app['config']['twofactor-auth.default'];
     }
@@ -58,7 +59,7 @@ public function getDefaultDriver()
      * @param  string  $name
      * @return void
      */
-    public function setDefaultDriver($name)
+    public function setDefaultDriver(string $name) : void
     {
         $this->app['config']['twofactor-auth.default'] = $name;
     }

src/TwoFactorAuthServiceProvider.php

@@ -13,7 +13,7 @@ class TwoFactorAuthServiceProvider extends ServiceProvider
      *
      * @return void
      */
-    public function boot()
+    public function boot() : void
     {
         $this->loadRoutesFrom(__DIR__.'/routes.php');
 
@@ -39,7 +39,7 @@ public function boot()
      *
      * @return void
      */
-    public function register()
+    public function register() : void
     {
         $this->mergeConfigFrom(
             __DIR__.'/config/twofactor-auth.php', 'twofactor-auth'
@@ -55,9 +55,11 @@ public function register()
     }
 
     /**
-     * Adds current timestamp prefix.
+     * Publish this package's migration files
+     *
+     * @return void
      */
-    protected function publishMigrations()
+    protected function publishMigrations() : void
     {
         $files = [
             'add_mobile_to_users_table.php',

src/TwoFactorAuthenticable.php

@@ -43,7 +43,7 @@ public function setTwoFactorAuthId(string $id) : void
     /**
      * Get the two-factor auth id.
      *
-     * @return string $id
+     * @return string
      */
     public function getTwoFactorAuthId() : string
     {