Merge pull request #56 from owenvoke/feature/uptime

feat: add support for Uptime API

Author: freekmurze

src/Concerns/SupportsUptimeEndpoints.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace OhDear\PhpSdk\Concerns;
+
+use OhDear\PhpSdk\Dto\Uptime;
+use OhDear\PhpSdk\Requests\Uptime\GetUptimeRequest;
+
+trait SupportsUptimeEndpoints
+{
+    /** @return list<Uptime> */
+    public function uptime(int $monitorId, string $startedAt, string $endedAt): array
+    {
+        $request = new GetUptimeRequest($monitorId, $startedAt, $endedAt);
+
+        return $this->send($request)->dtoOrFail();
+    }
+}

src/Dto/Uptime.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OhDear\PhpSdk\Dto;
+
+use Saloon\Http\Response;
+
+class Uptime
+{
+    public function __construct(
+        public string $datetime,
+        public int $uptimePercentage,
+    ) {}
+
+    public static function fromResponse(array $data): self
+    {
+        return new self(
+            datetime: $data['datetime'],
+            uptimePercentage: $data['uptime_percentage'],
+        );
+    }
+
+    public static function collect(Response $response): array
+    {
+        return array_map(
+            fn (array $item) => self::fromResponse($item),
+            $response->json()
+        );
+    }
+}

src/OhDear.php

@@ -17,6 +17,7 @@
 use OhDear\PhpSdk\Concerns\SupportsMonitorEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsSitemapEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsStatusPageEndpoints;
+use OhDear\PhpSdk\Concerns\SupportsUptimeEndpoints;
 use OhDear\PhpSdk\Concerns\SupportsUptimeMetricsEndpoints;
 use OhDear\PhpSdk\Exceptions\OhDearException;
 use OhDear\PhpSdk\Exceptions\ValidationException;
@@ -50,6 +51,7 @@ class OhDear extends Connector implements HasPagination
     use SupportsMonitorEndpoints;
     use SupportsSitemapEndpoints;
     use SupportsStatusPageEndpoints;
+    use SupportsUptimeEndpoints;
     use SupportsUptimeMetricsEndpoints;
 
     protected string $apiToken;

src/Requests/Uptime/GetUptimeRequest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace OhDear\PhpSdk\Requests\Uptime;
+
+use OhDear\PhpSdk\Dto\Uptime;
+use OhDear\PhpSdk\Helpers\Helpers;
+use Saloon\Enums\Method;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+
+class GetUptimeRequest extends Request
+{
+    protected Method $method = Method::GET;
+
+    public function __construct(
+        protected int $monitorId,
+        protected string $startedAt,
+        protected string $endedAt,
+    ) {}
+
+    public function resolveEndpoint(): string
+    {
+        return "/monitors/{$this->monitorId}/uptime";
+    }
+
+    protected function defaultQuery(): array
+    {
+        return [
+            'filter' => [
+                'started_at' => Helpers::convertDateFormat($this->startedAt),
+                'ended_at' => Helpers::convertDateFormat($this->endedAt),
+            ],
+        ];
+    }
+
+    public function createDtoFromResponse(Response $response): array
+    {
+        return Uptime::collect($response);
+    }
+}

tests/Fixtures/Saloon/uptime.json

@@ -0,0 +1,9 @@
+{
+    "statusCode": 200,
+    "headers": {
+        "Date": "Tue, 26 Aug 2025 14:40:00 GMT",
+        "Content-Type": "application\/json"
+    },
+    "data": "[{\"datetime\":\"2025-08-01 00:00:00.\", \"uptime_percentage\": 100}]",
+    "context": []
+}

tests/OhDearTests/UptimeTest.php

@@ -0,0 +1,24 @@
+<?php
+
+use OhDear\PhpSdk\Requests\Uptime\GetUptimeRequest;
+use Saloon\Http\Faking\MockClient;
+use Saloon\Http\Faking\MockResponse;
+
+beforeEach(function () {
+    $this->ohDear = ohDearMock();
+});
+
+it('can get uptime periods', function () {
+    MockClient::global([
+        GetUptimeRequest::class => MockResponse::fixture('uptime'),
+    ]);
+
+    $uptimePeriods = $this->ohDear->uptime(82065, '2025-08-25 00:00:00', '2025-08-26 23:59:59');
+
+    expect($uptimePeriods)->toBeArray();
+
+    foreach ($uptimePeriods as $uptime) {
+        expect($uptime->datetime)->toBeString();
+        expect($uptime->uptimePercentage)->toBeInt();
+    }
+});