base and register (#3)

* base and register

* fix cs and phpstan

* remove package

* type check

* Fix cs

* deduplicate calls

* move base dto

* save site

* stan fix

* types

* fix nullable error on write

* push last_seen

---------

Co-authored-by: David Jardin <[email protected]>

Author: rdeutz

app/Http/Controllers/Api/V1/SiteController.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Controllers\Controller;
+use App\Jobs\CheckSiteHealth;
+use App\Models\Site;
+use App\RemoteSite\Connection;
+use App\Traits\ApiResponse;
+use Carbon\Carbon;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ServerException;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+/**
+ * Class SiteController
+ * @package  App\Http\Controllers\Api\V1
+ * @since    1.0
+ */
+class SiteController extends Controller
+{
+    use ApiResponse;
+
+    /**
+     * @param Request $request
+     *
+     * @return JsonResponse
+     * @throws \Exception
+     */
+    public function register(Request $request): JsonResponse
+    {
+        $url = $request->string('url');
+        $key = $request->string('key');
+
+        if ($url->isEmpty() && $key->isEmpty()) {
+            return $this->error('BadRequest');
+        }
+
+        $connectionService = new Connection($url, $key);
+
+        // Do a health check
+        try {
+            $healthResponse = $connectionService->checkHealth();
+        } catch (ServerException $e) {
+            return $this->error($e->getMessage(), 500);
+        } catch (ClientException|\Exception $e) {
+            return $this->error($e->getMessage());
+        }
+
+        // If successful save site
+        $site = new Site();
+
+        $site->key = $key;
+        $site->url = $url;
+        $site->last_seen = Carbon::now();
+
+        // Fill with site info
+        $site->fill($healthResponse->toArray());
+
+        $site->save();
+
+        CheckSiteHealth::dispatch($site);
+
+        return $this->ok();
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return JsonResponse
+     */
+    public function check(Request $request): JsonResponse
+    {
+        return response()->json(['check']);
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return JsonResponse
+     */
+    public function delete(Request $request): JsonResponse
+    {
+        return response()->json(['delete']);
+    }
+}

app/Traits/ApiResponse.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\Traits;
+
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Api Response
+ */
+trait ApiResponse
+{
+    /**
+     * @param string $message
+     *
+     * @return JsonResponse
+     */
+    protected function ok(string $message = 'OK'): JsonResponse
+    {
+        return $this->success($message, 200);
+    }
+
+    /**
+     * @param string $message
+     * @param int    $statusCode
+     *
+     * @return JsonResponse
+     */
+    protected function success(string $message, int $statusCode = 200): JsonResponse
+    {
+        return $this->response($message, $statusCode);
+    }
+
+    /**
+     * @param string $message
+     * @param int    $statusCode
+     *
+     * @return JsonResponse
+     */
+    protected function error(string $message, int $statusCode = 400): JsonResponse
+    {
+        return $this->response($message, $statusCode);
+    }
+
+    /**
+     * @param string $message
+     * @param int    $statusCode
+     *
+     * @return JsonResponse
+     */
+    protected function response(string $message, int $statusCode = 200): JsonResponse
+    {
+        return response()->json([
+            'message' => $message,
+            'status' => $statusCode
+        ], $statusCode);
+    }
+}

bootstrap/app.php

@@ -7,6 +7,7 @@
 return Application::configure(basePath: dirname(__DIR__))
     ->withRouting(
         web: __DIR__.'/../routes/web.php',
+        api: __DIR__.'/../routes/api.php',
         commands: __DIR__.'/../routes/console.php',
         health: '/up',
     )

routes/api.php

@@ -0,0 +1,12 @@
+<?php
+
+use App\Http\Controllers\Api\V1\SiteController;
+use Illuminate\Support\Facades\Route;
+
+Route::prefix('v1')->group(function () {
+    Route::controller(SiteController::class)->group(function () {
+        Route::get('register', 'register');
+        Route::get('check/{hase}', 'check');
+        Route::delete('delete/{hash}', 'delete');
+    });
+});