Merge pull request #2 from cinderblockgames/homepage-api

Homepage api

Author: cinderblockgames

README.md

@@ -1,31 +1,32 @@
-## Speedtest Tracker
+# Speedtest Tracker
 
-### Introduction
+## Introduction
 
 Speedtest Tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.
 
 ### Why might I use this?
 
 The main use case for Speedtest Tracker is to build a history of your internet's performance so that you can be informed when you're not receiving your ISP's advertised rates.
 
-#### What about that other Speedtest Tracker?
+### What about that other Speedtest Tracker?
 
-As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This version is meant to be an actively maintained replacement with an improved UI and feature set.
+As far as I can tell https://github.com/henrywhitaker3/Speedtest-Tracker was abandoned. This is meant to be an actively maintained replacement with an improved UI and feature set.
 
-### Getting Started
+## Getting Started
 
 Speedtest Tracker is containerized so you can run it anywhere you run your Docker containers. The [install](https://docs.speedtest-tracker.dev/getting-started/installation) documentation will get you up and running with using Docker or Docker Composer along with choosing a database (SQLite, MySQL/MariaDB or Postgresql).
 
-#### FAQs and Features
+### FAQs and Features
 
 [FAQs](https://docs.speedtest-tracker.dev/faqs) and a full list of planned and completed [features](https://docs.speedtest-tracker.dev/getting-started/features) can be found in the [documentation](https://docs.speedtest-tracker.dev).
 
-### Screenshots
-#### Dashboard
+## Screenshots
+
 ![Dashboard](.github/screenshots/dashboard_screenshot.png)
+**Dashboard**
 
-#### Results page
 ![Results page](.github/screenshots/results_screenshot.png)
+**Results page**
 
-#### General Settings page
 ![General Settings page](.github/screenshots/general_settings_screenshot.png)
+** General Settings page**

app/Actions/GetLatestSpeedtestData.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Actions;
+
+use App\Helpers\SpeedtestHelper;
+use App\Models\Speedtest;
+use DB;
+use Henrywhitaker3\LaravelActions\Interfaces\ActionInterface;
+
+class GetLatestSpeedtestData implements ActionInterface
+{
+    /**
+     * Run the action.
+     *
+     * @return mixed
+     */
+    public function run()
+    {
+        $data = SpeedtestHelper::latest();
+        
+        // Homepage expects this to in Mbps.  This calculation matches the results shown in the UI.
+        $data['download'] /= 125000;
+        $data['upload'] /= 125000;
+
+        $response = [
+            'data' => $data,
+        ];
+
+        return $response;
+    }
+}

app/Filament/Pages/Settings/GeneralPage.php

@@ -86,28 +86,61 @@ protected function getFormSchema(): array
                                     ->multiple()
                                     ->maxItems(10)
                                     ->searchable()
-                                    ->getSearchResultsUsing(function (string $search) {
-                                        $url = "https://www.speedtest.net/api/js/servers?engine=js&search={$search}&https_functional=true&limit=10";
-
-                                        $response = Http::get($url);
+                                    ->options(function () {
+                                        $response = Http::get(
+                                            url: 'https://www.speedtest.net/api/js/servers',
+                                            query: [
+                                                'engine' => 'js',
+                                                'https_functional' => true,
+                                                'limit' => 10,
+                                            ]
+                                        );
+
+                                        if ($response->failed()) {
+                                            return [
+                                                '' => 'There was an error retrieving Speedtest servers',
+                                            ];
+                                        }
 
-                                        $options = $response->collect()->map(function ($item) {
+                                        return $response->collect()->map(function ($item) {
                                             return [
                                                 'id' => $item['id'],
                                                 'name' => $item['id'].': '.$item['name'].' ('.$item['sponsor'].')',
                                             ];
-                                        });
+                                        })->pluck('name', 'id');
+                                    })
+                                    ->getSearchResultsUsing(function (string $search) {
+                                        $response = Http::get(
+                                            url: 'https://www.speedtest.net/api/js/servers',
+                                            query: [
+                                                'engine' => 'js',
+                                                'search' => $search,
+                                                'https_functional' => true,
+                                                'limit' => 10,
+                                            ]
+                                        );
+
+                                        if ($response->failed()) {
+                                            return [
+                                                '' => 'There was an error retrieving Speedtest servers',
+                                            ];
+                                        }
 
-                                        if (! $options->count() && is_numeric($search)) {
-                                            $options = collect([
+                                        if (! $response->collect()->count() && is_numeric($search)) {
+                                            return collect([
                                                 [
                                                     'id' => $search,
                                                     'name' => $search.': No server found, manually add this ID.',
                                                 ],
                                             ]);
                                         }
 
-                                        return $options->pluck('name', 'id');
+                                        return $response->collect()->map(function ($item) {
+                                            return [
+                                                'id' => $item['id'],
+                                                'name' => $item['id'].': '.$item['name'].' ('.$item['sponsor'].')',
+                                            ];
+                                        })->pluck('name', 'id');
                                     })
                                     ->columnSpan(2),
                             ])

app/Helpers/SpeedtestHelper.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Helpers;
+
+use App\Models\Result;
+
+class SpeedtestHelper
+{
+
+    /**
+     * Returns the latest speedtest object.
+     *
+     * @return boolean|\App\Speedtest
+     */
+    public static function latest()
+    {
+        $data = Result::latest()->get();
+
+        if ($data->isEmpty()) {
+            return false;
+        }
+
+        return $data->first();
+    }
+
+}

app/Http/Controllers/SpeedtestController.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Actions\GetLatestSpeedtestData;
+use App\Actions\QueueSpeedtest;
+use App\Jobs\SpeedtestJob;
+use App\Models\Speedtest;
+use Carbon\Carbon;
+use Exception;
+use Illuminate\Http\Request;
+use Illuminate\Http\JsonResponse;
+
+class SpeedtestController extends Controller
+{
+  
+    /**
+     * Return latest speedtest
+     *
+     * @return  JsonResponse
+     */
+    public function latest()
+    {
+        $data = run(GetLatestSpeedtestData::class);
+        
+        if ($data['data']) {
+            return response()->json($data, 200);
+        } else {
+            return response()->json([
+                'method' => 'get latest speedtest',
+                'error' => 'no speedtests have been run'
+            ], 404);
+        }
+    }
+
+    /**
+     * Queue a new speedtest
+     *
+     * @return JsonResponse
+     */
+    public function run()
+    {
+        try {
+            run(QueueSpeedtest::class);
+
+            return response()->json([
+                'method' => 'run speedtest',
+                'data' => 'a new speedtest has been added to the queue'
+            ], 200);
+        } catch (Exception $e) {
+            return response()->json([
+                'method' => 'run speedtest',
+                'error' => $e
+            ], 500);
+        }
+    }
+
+}

composer.json

@@ -12,6 +12,7 @@
         "filament/filament": "^2.0",
         "filament/spatie-laravel-settings-plugin": "^2.0",
         "guzzlehttp/guzzle": "^7.2",
+        "henrywhitaker3/laravel-actions": "^1.0",
         "influxdata/influxdb-client-php": "^2.9",
         "laravel-notification-channels/telegram": "^3.0",
         "laravel/framework": "^9.19",

composer.lock

@@ -6,7 +6,7 @@
     /**
      * Build information
      */
-    'build_date' => Carbon::parse('2023-03-07'),
+    'build_date' => Carbon::parse('2023-03-09'),
 
-    'build_version' => '0.11.6',
+    'build_version' => '0.11.7',
 ];

config/speedtest.php

@@ -1,5 +1,6 @@
 <?php
 
+use App\Http\Controllers\SpeedtestController;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Route;
 
@@ -17,3 +18,11 @@
 Route::middleware('auth:sanctum')->get('/user', function (Request $request) {
     return $request->user();
 });
+
+Route::group([
+    'middleware' => ['api'],
+    'prefix' => 'speedtest'
+], function ($router) {
+    Route::get('latest', [SpeedtestController::class, 'latest'])
+        ->name('speedtest.latest');
+});