Merge branch 'release/1.2.0'

Author: adrenth

Plugin.php

@@ -13,6 +13,7 @@
 use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
 use System\Classes\PluginBase;
 use Vdlp\BasicAuthentication\Classes\Helper\AuthorizationHelper;
+use Vdlp\BasicAuthentication\Console\CreateCredentialsCommand;
 use Vdlp\BasicAuthentication\Models\Credential;
 use Vdlp\BasicAuthentication\ServiceProviders\BasicAuthenticationServiceProvider;
 
@@ -42,6 +43,8 @@ public function pluginDetails(): array
     public function register(): void
     {
         $this->app->register(BasicAuthenticationServiceProvider::class);
+
+        $this->registerConsoleCommand(CreateCredentialsCommand::class, CreateCredentialsCommand::class);
     }
 
     /**

README.md

@@ -8,15 +8,15 @@ Allows users to manage Basic Authentication credentials for multiple hostnames a
 
 ## Installation
 
-*CLI:*
-
 ```
-php artisan plugin:install Vdlp.BasicAuthentication
+composer require vdlp/oc-basicauthentication-plugin
 ```
 
-*October CMS:*
+Or:
 
-Go to Settings > Updates & Plugins > Install plugins and search for 'BasicAuthentication'.
+```
+php artisan plugin:install Vdlp.BasicAuthentication
+```
 
 ## Configuration
 
@@ -26,12 +26,11 @@ To configure this plugin execute the following command:
 php artisan vendor:publish --provider="Vdlp\BasicAuthentication\ServiceProviders\BasicAuthenticationServiceProvider" --tag="config"
 ```
 
-This will create a `config/basicauthentication.php` file in your app where you can modify the configuration if you don't
-want to use .env variables.
+This will create a `config/basicauthentication.php` file in your app where you can modify the configuration if you don't want to use .env variables.
 
 ## Enable / disable plugin
 
-By default basic authentication is disabled. 
+By default basic authentication is disabled.
 
 To enable basic authentication, you have to set the env variable to `BASIC_AUTHENTICATION_ENABLED` to `true` in your `.env` file or edit the published config file.
 

composer.json

@@ -9,6 +9,9 @@
             "email": "octobercms@vdlp.nl"
         }
     ],
+    "support": {
+        "email": "octobercms@vdlp.nl"
+    },
     "require": {
         "php": "^7.1||^8.0",
         "composer/installers": "^1.0"

console/CreateCredentialsCommand.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vdlp\BasicAuthentication\Console;
+
+use Illuminate\Console\Command;
+use Throwable;
+use Vdlp\BasicAuthentication\Models\Credential;
+
+final class CreateCredentialsCommand extends Command
+{
+    public function __construct()
+    {
+        $this->signature = 'vdlp:basicauthentication:create-credentials {hostname} {realm} {username} {password}';
+        $this->description = 'Create Basic Authentication credentials.';
+
+        parent::__construct();
+    }
+
+    public function handle(): void
+    {
+        try {
+            Credential::query()
+                ->updateOrInsert([
+                    'hostname' => $this->argument('hostname'),
+                ], [
+                    'realm' => $this->argument('realm'),
+                    'username' => $this->argument('username'),
+                    'password' => $this->argument('password'),
+                    'is_enabled' => true,
+                    'updated_at' => now(),
+                    'created_at' => now(),
+                ]);
+
+            $this->info('Basic Authentication credentials have been added to the database.');
+        } catch (Throwable $e) {
+            $this->error('Could not create Basic Authentication credentials: ' . $e->getMessage());
+        }
+    }
+}

models/Credential.php

@@ -4,17 +4,12 @@
 
 namespace Vdlp\BasicAuthentication\Models;
 
-use Eloquent;
 use October\Rain\Database\Model;
 
-/** @noinspection ClassOverridesFieldOfSuperClassInspection */
-/** @noinspection LongInheritanceChainInspection */
-
 /**
  * Class Credential
  *
  * @package Vdlp\BasicAuthentication\Models
- * @mixin Eloquent
  */
 class Credential extends Model
 {

models/ExcludedUrl.php

@@ -4,17 +4,12 @@
 
 namespace Vdlp\BasicAuthentication\Models;
 
-use Eloquent;
 use October\Rain\Database\Model;
 
-/** @noinspection ClassOverridesFieldOfSuperClassInspection */
-/** @noinspection LongInheritanceChainInspection */
-
 /**
  * Class ExcludedUrl
  *
  * @package Vdlp\BasicAuthentication\Models
- * @mixin Eloquent
  */
 class ExcludedUrl extends Model
 {

updates/version.yaml

@@ -3,3 +3,5 @@
     - 20190123_000001_create_tables.php
 1.1.0:
     - Add notification to settings view when basic authentication is disabled
+1.2.0:
+    - Add console command for adding credentials