wip

composer.json

@@ -21,8 +21,11 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0"
+        "illuminate/contracts": "^10.0",
+        "laravel-notification-channels/discord": "^1.5",
+        "laravel-notification-channels/telegram": "^4.0",
+        "mtdowling/cron-expression": "^1.2",
+        "spatie/laravel-package-tools": "^1.14.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",

src/Checks/Base/Check.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Vormkracht10\LaravelOK\Checks;
+
+use Cron\CronExpression;
+use Illuminate\Console\Scheduling\ManagesFrequencies;
+use Illuminate\Support\Facades\Date;
+use Illuminate\Support\Str;
+use Vormkracht10\LaravelOK\Enums\Status;
+
+abstract class Check
+{
+    use ManagesFrequencies;
+
+    protected string $expression = '* * * * *';
+
+    protected ?string $name = null;
+
+    protected ?string $label = null;
+
+    protected bool $shouldRun = true;
+
+    public function __construct()
+    {
+    }
+
+    public static function config(): static
+    {
+        $instance = app(static::class);
+
+        $instance->everyMinute();
+
+        return $instance;
+    }
+
+    public function name(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    public function getName(): string
+    {
+        if ($this->name) {
+            return $this->name;
+        }
+
+        $baseName = class_basename(static::class);
+
+        return Str::of($baseName)->beforeLast('Check');
+    }
+
+    public function shouldRun(): bool
+    {
+        if (! $this->shouldRun) {
+            return false;
+        }
+
+        $date = Date::now();
+
+        return (new CronExpression($this->expression))->isDue($date->toDateTimeString());
+    }
+
+    public function if(bool $condition)
+    {
+        $this->shouldRun = $condition;
+
+        return $this;
+    }
+
+    public function unless(bool $condition)
+    {
+        $this->shouldRun = ! $condition;
+
+        return $this;
+    }
+
+    abstract public function run(): Result;
+
+    public function markAsCrashed(): Result
+    {
+        return new Result(Status::CRASHED);
+    }
+}

src/Checks/Base/CheckUrl.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Spatie\Health\Checks\Checks;
+
+use Exception;
+use Illuminate\Support\Facades\Http;
+use Spatie\Health\Checks\Check;
+use Spatie\Health\Checks\Result;
+use Spatie\Health\Exceptions\InvalidCheck;
+
+class CheckUrl extends Check
+{
+    protected ?string $url = null;
+
+    protected ?string $failureMessage = null;
+
+    protected int $timeout = 1;
+
+    protected int $retryTimes = 1;
+
+    protected string $method = 'GET';
+
+    /** @var array<string, string> */
+    protected array $headers = [];
+
+    public function url(string $url): self
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    public function timeout(int $seconds): self
+    {
+        $this->timeout = $seconds;
+
+        return $this;
+    }
+
+    public function method(string $method): self
+    {
+        $this->method = $method;
+
+        return $this;
+    }
+
+    public function retryTimes(int $times): self
+    {
+        $this->retryTimes = $times;
+
+        return $this;
+    }
+
+    /**
+     * @param  array<string, string>  $headers
+     * @return $this
+     */
+    public function headers(array $headers = []): self
+    {
+        $this->headers = $headers;
+
+        return $this;
+    }
+
+    public function failureMessage(string $failureMessage): self
+    {
+        $this->failureMessage = $failureMessage;
+
+        return $this;
+    }
+
+    public function run(): Result
+    {
+        if (is_null($this->url)) {
+            throw InvalidCheck::urlNotSet();
+        }
+
+        try {
+            $request = Http::timeout($this->timeout)
+                ->withHeaders($this->headers)
+                ->retry($this->retryTimes)
+                ->send($this->method, $this->url);
+
+            if (! $request->successful()) {
+                return $this->failedResult();
+            }
+        } catch (Exception) {
+            return $this->failedResult();
+        }
+
+        return Result::make()
+            ->ok()
+            ->shortSummary('Reachable');
+    }
+
+    protected function failedResult(): Result
+    {
+        return Result::make()
+            ->failed()
+            ->shortSummary('Unreachable')
+            ->notificationMessage($this->failureMessage ?? "Pinging {$this->getName()} failed.");
+    }
+}

src/Checks/Base/Result.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Vormkracht10\LaravelOK\Checks;
+
+use Carbon\CarbonInterface;
+use Vormkracht10\LaravelOK\Enums\Status;
+
+class Result
+{
+    public Check $check;
+
+    public ?CarbonInterface $ended_at;
+
+    public static function make(string $message = ''): self
+    {
+        return new self(Status::OK, $message);
+    }
+
+    public function __construct(
+        public Status $status,
+        public string $notificationMessage = '',
+    ) {
+    }
+
+    public function check(Check $check): self
+    {
+        $this->check = $check;
+
+        return $this;
+    }
+
+    public function notificationMessage(string $notificationMessage): self
+    {
+        $this->notificationMessage = $notificationMessage;
+
+        return $this;
+    }
+
+    public function ok(string $message = ''): self
+    {
+        $this->notificationMessage = $message;
+
+        $this->status = Status::ok();
+
+        return $this;
+    }
+
+    public function warning(string $message = ''): self
+    {
+        $this->notificationMessage = $message;
+
+        $this->status = Status::warning();
+
+        return $this;
+    }
+
+    public function failed(string $message = ''): self
+    {
+        $this->notificationMessage = $message;
+
+        $this->status = Status::failed();
+
+        return $this;
+    }
+
+    /** @param  array<string, mixed>  $meta */
+    public function meta(array $meta): self
+    {
+        $this->meta = $meta;
+
+        return $this;
+    }
+
+    public function endedAt(CarbonInterface $carbon): self
+    {
+        $this->ended_at = $carbon;
+
+        return $this;
+    }
+}

src/Checks/DebugModeCheck.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Vormkracht10\LaravelOK\Checks\Checks;
+
+use function config;
+use Vormkracht10\LaravelOK\Checks\Result;
+
+class DebugModeCheck extends Check
+{
+    protected bool $expected = false;
+
+    public function expectedToBe(bool $bool): self
+    {
+        $this->expected = $bool;
+
+        return $this;
+    }
+
+    public function run(): Result
+    {
+        $actual = config('app.debug');
+
+        $result = Result::make();
+
+        return $this->expected === $actual
+            ? $result->ok()
+            : $result->failed("The debug mode was expected to be `{$this->convertToWord((bool) $this->expected)}`, but actually was `{$this->convertToWord((bool) $actual)}`");
+    }
+
+    protected function convertToWord(bool $boolean): string
+    {
+        return $boolean ? 'true' : 'false';
+    }
+}

src/Enums/Status.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Vormkracht10\LaravelOK\Enums;
+
+enum Status: string
+{
+    case OK = 'ok';
+    case FAILED = 'failed';
+    case SKIPPED = 'skipped';
+    case CRASHED = 'crashed';
+}

src/Facades/OK.php

@@ -5,9 +5,9 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Vormkracht10\LaravelOK\LaravelOK
+ * @see \Vormkracht10\LaravelOK\OK
  */
-class LaravelOK extends Facade
+class OK extends Facade
 {
     protected static function getFacadeAccessor()
     {

src/LaravelOKServiceProvider.php

@@ -13,7 +13,7 @@ public function configurePackage(Package $package): void
         $package
             ->name('laravel-ok')
             ->hasConfigFile()
-            ->hasMigration('create_laravel_ok_table')
+            // ->hasMigration('create_laravel_ok_table')
             ->hasCommands(
                 RunChecksCommand::class,
             );