first commit

Author: 39ff

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -0,0 +1,52 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=laravel
+DB_USERNAME=root
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailhog
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_APP_CLUSTER=mt1
+
+MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.gitattributes

@@ -0,0 +1,10 @@
+* text=auto
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore

.gitignore

@@ -0,0 +1,17 @@
+/node_modules
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.testing
+.env.backup
+.phpunit.result.cache
+docker-compose.override.yml
+Homestead.json
+Homestead.yaml
+npm-debug.log
+yarn-error.log
+/.idea
+/.vscode
+/.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,46 @@
+<?php declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__ . '/app',
+        __DIR__ . '/config',
+        __DIR__ . '/database/factories',
+        __DIR__ . '/database/seeders',
+        __DIR__ . '/routes',
+        __DIR__ . '/tests',
+    ]);
+
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PhpCsFixer:risky' => true,
+        'blank_line_after_opening_tag' => false,
+        'linebreak_after_opening_tag' => false,
+        'phpdoc_types_order' => [
+            'null_adjustment' => 'always_last',
+            'sort_algorithm' => 'none',
+        ],
+        'no_superfluous_phpdoc_tags' => false,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'php_unit_test_case_static_method_calls' => [
+            'call_type' => 'this'
+        ],
+        'phpdoc_align' => [
+            'align' => 'left',
+        ],
+        'not_operator_with_successor_space' => true,
+        'blank_line_after_namespace' => true,
+        'date_time_immutable' => true,
+        'declare_parentheses' => true,
+        'final_public_method_for_abstract_class' => true,
+        'mb_str_functions' => true,
+        'simplified_if_return' => false,
+        'simplified_null_return' => false,
+    ])
+    ->setFinder($finder);

.styleci.yml

@@ -0,0 +1,13 @@
+php:
+  preset: laravel
+  version: 8
+  disabled:
+    - no_unused_imports
+  finder:
+    not-name:
+      - index.php
+js:
+  finder:
+    not-name:
+      - webpack.mix.js
+css: true

README.md

@@ -8,14 +8,25 @@ next generation squid user-management WebUI alternative proxymin,Squid Users Man
 - Make sure squid is compiled with --enable-basic-auth-helpers=DB option.
 - Use MySQL driver settings in the squid.conf file
 https://wiki.squid-cache.org/ConfigExamples/Authenticate/Mysql
+  
+- Additional Module
+  - https://github.com/39ff/squid-db-auth-ip
+  
 
 ## Installation
 PHP8+
 
 
 ## Todo
+- [x] WebAPI
+- [ ] WebGUI
 - [x] Basic User Management
-- [ ] IP Address Management  
-- [ ] Customize ACL Rules
+- [x] IP Address Management  
+- [ ] Customize ACL Rules (ansible?)
 - [ ] Documentation
-- [ ] Tests
+- [ ] WebAPI Documentation  
+- [x] Feature Tests
+- [ ] E2E Tests  
+- [ ] create docker-compose
+- [ ] Multiple Server Management
+- [ ] Metrics

app/Console/Kernel.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    /**
+     * Define the application's command schedule.
+     *
+     * @param \Illuminate\Console\Scheduling\Schedule $schedule
+     * @return void
+     */
+    protected function schedule(Schedule $schedule)
+    {
+        // $schedule->command('inspire')->hourly();
+    }
+
+    /**
+     * Register the commands for the application.
+     *
+     * @return void
+     */
+    protected function commands()
+    {
+        $this->load(__DIR__.'/Commands');
+
+        require base_path('routes/console.php');
+    }
+}

app/Exceptions/Handler.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Exceptions;
+
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Throwable;
+
+class Handler extends ExceptionHandler
+{
+    /**
+     * A list of the exception types that are not reported.
+     *
+     * @var array<int, class-string<Throwable>>
+     */
+    protected $dontReport = [
+        //
+    ];
+
+    /**
+     * A list of the inputs that are never flashed for validation exceptions.
+     *
+     * @var array<int, string>
+     */
+    protected $dontFlash = [
+        'current_password',
+        'password',
+        'password_confirmation',
+    ];
+
+    /**
+     * Register the exception handling callbacks for the application.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->reportable(function (Throwable $e) {
+            //
+        });
+    }
+}

app/Http/Controllers/Api/SquidUserController.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Http\Controllers\Api;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\SquidUser\CreateRequest;
+use App\Http\Requests\SquidUser\DestroyRequest;
+use App\Http\Requests\SquidUser\ModifyRequest;
+use App\Http\Requests\SquidUser\SearchRequest;
+use App\Http\Resources\SquidUserCollection;
+use App\Http\Resources\SquidUserResource;
+use App\UseCases\SquidUser\CreateAction;
+use App\UseCases\SquidUser\DestroyAction;
+use App\UseCases\SquidUser\ModifyAction;
+use App\UseCases\SquidUser\SearchAction;
+
+class SquidUserController extends Controller
+{
+    public function search(SearchRequest $request, SearchAction $action) : SquidUserCollection{
+        $user=  $request->searchSquidUser();
+        $query = $request->validated();
+
+        return new SquidUserCollection($action($user,$query));
+    }
+
+    public function create(CreateRequest $request, CreateAction $action) : SquidUserResource{
+        $user = $request->createSquidUser();
+
+        return new SquidUserResource($action($user));
+    }
+
+    public function modify(ModifyRequest $request, ModifyAction $action) : SquidUserResource{
+        $user = $request->modifySquidUser();
+
+        return new SquidUserResource($action($user));
+    }
+
+    public function destroy(DestroyRequest $request, DestroyAction $action) : SquidUserResource{
+        $user = $request->destroySquidUser();
+
+        return new SquidUserResource($action($user));
+    }
+}

app/Http/Controllers/Api/UserController.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Http\Controllers\Api;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\User\SearchRequest;
+use App\Http\Requests\User\CreateRequest;
+use App\Http\Requests\User\DestroyRequest;
+use App\Http\Requests\User\ModifyRequest;
+use App\Http\Resources\UserCollection;
+use App\Http\Resources\UserResource;
+use App\UseCases\User\SearchAction;
+use App\UseCases\User\CreateAction;
+use App\UseCases\User\DestroyAction;
+use App\UseCases\User\ModifyAction;
+
+class UserController extends Controller
+{
+    public function search(SearchRequest $request, SearchAction $action) : UserCollection{
+        $user = $request->searchUser();
+        $query = $request->validated();
+
+        return new UserCollection($action($user,$query));
+    }
+
+    public function create(CreateRequest $request, CreateAction $action) : UserResource{
+        $user = $request->createUser();
+
+        return new UserResource($action($user));
+    }
+
+    public function modify(ModifyRequest $request, ModifyAction $action) : UserResource{
+        $user = $request->modifyUser();
+
+        return new UserResource($action($user));
+    }
+
+    public function destroy(DestroyRequest $request, DestroyAction $action) : UserResource{
+        $user = $request->destroyUser();
+
+        return new UserResource($action($user));
+    }
+}

app/Http/Controllers/Controller.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Routing\Controller as BaseController;
+
+class Controller extends BaseController
+{
+    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+}