Add artisan commands

Author: ivanvermeyen

README.md

@@ -74,11 +74,28 @@ Enable StageFront and choose a login and password:
 | `STAGEFRONT_PASSWORD`  | `string` | `stagefront` |
 | `STAGEFRONT_ENCRYPTED` | `bool`   | `false`      |
 
-By default StageFront is disabled and uses a plain text password when it's enabled.
+By default StageFront is disabled and uses a plain text password when it's enabled. If you set `STAGEFRONT_ENCRYPTED` to `true` the password should be a hashed value. You can generate this using Laravel's `\Hash::make('your password')` function.
 
-If you set `STAGEFRONT_ENCRYPTED` to `true` the password should be a hashed value.
+##### Artisan Commands for Quick Setup
 
-You can generate this using Laravel's `\Hash::make('your password')` function.
+You can also update the credentials in the `.env` file with our `artisan` command:
+
+```bash
+php artisan stagefront:credentials <username> <password> --encrypt
+```
+
+If you don't enter a username or password, the command will ask for your input step by step:
+
+```bash
+php artisan stagefront:credentials
+```
+
+Next, you can enable or disable StageFront:
+
+```bash
+php artisan stagefront:enable
+php artisan stagefront:disable
+```
 
 ## 👥 Database Logins
 

composer.json

@@ -15,7 +15,8 @@
         }
     ],
     "require": {
-        "php": ">=7.1"
+        "php": ">=7.1",
+        "codezero/dotenv-updater": "^1.1"
     },
     "require-dev": {
         "orchestra/testbench": ">=3.6",

src/Commands/DisableStageFront.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace CodeZero\StageFront\Commands;
+
+use CodeZero\DotEnvUpdater\DotEnvUpdater;
+use Illuminate\Console\Command;
+
+class DisableStageFront extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'stagefront:disable';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Update the .env file to disable StageFront.';
+
+    /**
+     * Execute the console command.
+     *
+     * @param \CodeZero\DotEnvUpdater\DotEnvUpdater $updater
+     *
+     * @return void
+     */
+    public function handle(DotEnvUpdater $updater)
+    {
+        $updater->set('STAGEFRONT_ENABLED', false);
+
+        $this->info("StageFront has been disabled.");
+    }
+}

src/Commands/EnableStageFront.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace CodeZero\StageFront\Commands;
+
+use CodeZero\DotEnvUpdater\DotEnvUpdater;
+use Illuminate\Console\Command;
+
+class EnableStageFront extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'stagefront:enable';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Update the .env file to enable StageFront.';
+
+    /**
+     * Execute the console command.
+     *
+     * @param \CodeZero\DotEnvUpdater\DotEnvUpdater $updater
+     *
+     * @return void
+     */
+    public function handle(DotEnvUpdater $updater)
+    {
+        $updater->set('STAGEFRONT_ENABLED', true);
+
+        $this->info("StageFront has been enabled.");
+    }
+}

src/Commands/SetCredentials.php

@@ -0,0 +1,118 @@
+<?php
+
+namespace CodeZero\StageFront\Commands;
+
+use CodeZero\DotEnvUpdater\DotEnvUpdater;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Hash;
+
+class SetCredentials extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'stagefront:credentials {username?} {password?} {--encrypt : Encrypt the password}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Set a username and password to login to the staging site.';
+
+    /**
+     * Execute the console command.
+     *
+     * @param \CodeZero\DotEnvUpdater\DotEnvUpdater $updater
+     *
+     * @return void
+     */
+    public function handle(DotEnvUpdater $updater)
+    {
+        $username = $this->argument('username') ?: $this->askUsername();
+        $password = $this->argument('password') ?: $this->askPassword();
+        $encrypt = $this->option('encrypt') ?: $this->askForEncryption();
+
+        if ($encrypt) {
+            $password = Hash::make($password);
+        }
+
+        $updater->set('STAGEFRONT_LOGIN', $username);
+        $updater->set('STAGEFRONT_PASSWORD', $password);
+        $updater->set('STAGEFRONT_ENCRYPT', $encrypt);
+
+        $this->info("StageFront credentials were written to [.env].");
+    }
+
+    /**
+     * Ask for a username.
+     *
+     * @return string
+     */
+    protected function askUsername()
+    {
+        $username = trim($this->ask('Choose a username:', 'stagefront'));
+
+        if ($username) {
+            return $username;
+        }
+
+        $this->error('Username can not be empty. Try again...');
+
+        return $this->askUsername();
+    }
+
+    /**
+     * Ask for a password and confirmation.
+     *
+     * @return string
+     */
+    protected function askPassword()
+    {
+        $password = $this->secret('Choose a password:');
+
+        if (trim($password)) {
+            return $this->askPasswordConfirmation($password);
+        }
+
+        $this->error('Password can not be empty. Try again...');
+
+        return $this->askPassword();
+    }
+
+    /**
+     * Ask for a password confirmation.
+     *
+     * @param string $password
+     *
+     * @return string
+     */
+    protected function askPasswordConfirmation($password)
+    {
+        $passwordConfirmation = $this->secret('Retype password:');
+
+        if ($password === $passwordConfirmation) {
+            return $password;
+        }
+
+        $this->error('Password did not match. Try again...');
+
+        return $this->askPassword();
+    }
+
+    /**
+     * Ask if the password should be encrypted.
+     *
+     * @return bool
+     */
+    protected function askForEncryption()
+    {
+        if ($this->argument('password')) {
+            return false;
+        }
+
+        return $this->confirm('Encrypt password?');
+    }
+}

src/StageFrontServiceProvider.php

@@ -2,6 +2,9 @@
 
 namespace CodeZero\StageFront;
 
+use CodeZero\StageFront\Commands\DisableStageFront;
+use CodeZero\StageFront\Commands\EnableStageFront;
+use CodeZero\StageFront\Commands\SetCredentials;
 use CodeZero\StageFront\Composers\ThrottleTimeRemaining;
 use Illuminate\Support\ServiceProvider;
 
@@ -26,6 +29,7 @@ public function boot()
         $this->loadViewComposers();
         $this->loadTranslations();
         $this->registerPublishableFiles();
+        $this->registerArtisanCommands();
     }
 
     /**
@@ -108,4 +112,20 @@ protected function mergeConfig()
     {
         $this->mergeConfigFrom(__DIR__."/../config/{$this->name}.php", $this->name);
     }
+
+    /**
+     * Register artisan commands.
+     *
+     * @return void
+     */
+    protected function registerArtisanCommands()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                SetCredentials::class,
+                EnableStageFront::class,
+                DisableStageFront::class,
+            ]);
+        }
+    }
 }

tests/Commands/CommandTestCase.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace CodeZero\StageFront\Tests\Commands;
+
+use CodeZero\DotEnvUpdater\DotEnvUpdater;
+use CodeZero\StageFront\Tests\TestCase;
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\File;
+
+class CommandTestCase extends TestCase
+{
+    /**
+     * DotEnvUpdater instance.
+     *
+     * @var \CodeZero\DotEnvUpdater\DotEnvUpdater
+     */
+    protected $updater;
+
+    /**
+     * Path to the test .env file.
+     *
+     * @var string
+     */
+    protected $envFile;
+
+    /**
+     * Setup the test environment.
+     *
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->envFile = __DIR__ . '/../Stubs/.env';
+
+        File::put($this->envFile, '');
+
+        $this->updater = new DotEnvUpdater($this->envFile);
+
+        App::instance(DotEnvUpdater::class, $this->updater);
+    }
+
+    /**
+     * Clean up the testing environment before the next test.
+     *
+     * @return void
+     */
+    protected function tearDown(): void
+    {
+        if (File::exists($this->envFile)) {
+            File::delete($this->envFile);
+        }
+
+        parent::tearDown();
+    }
+}

tests/Commands/DisableStageFrontTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace CodeZero\StageFront\Tests\Commands;
+
+class DisableStageFrontTest extends CommandTestCase
+{
+    /** @test */
+    public function it_sets_unencrypted_credentials()
+    {
+        $this->artisan('stagefront:disable')
+            ->assertExitCode(0);
+
+        $this->assertFalse($this->updater->get('STAGEFRONT_ENABLED'));
+    }
+}

tests/Commands/EnableStageFrontTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace CodeZero\StageFront\Tests\Commands;
+
+class EnableStageFrontTest extends CommandTestCase
+{
+    /** @test */
+    public function it_sets_unencrypted_credentials()
+    {
+        $this->artisan('stagefront:enable')
+            ->assertExitCode(0);
+
+        $this->assertTrue($this->updater->get('STAGEFRONT_ENABLED'));
+    }
+}