feat: add user preferences and saved stations API endpoints
Adds authenticated endpoints for reading/updating fuel type preferences and managing saved stations, backed by new migrations and a SavedStation model. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
62
app/Http/Controllers/Api/UserController.php
Normal file
62
app/Http/Controllers/Api/UserController.php
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Http\Controllers\Api;
|
||||||
|
|
||||||
|
use App\Http\Controllers\Controller;
|
||||||
|
use Illuminate\Http\JsonResponse;
|
||||||
|
use Illuminate\Http\Request;
|
||||||
|
use Illuminate\Http\Response;
|
||||||
|
use Illuminate\Validation\Rule;
|
||||||
|
|
||||||
|
final class UserController extends Controller
|
||||||
|
{
|
||||||
|
public function preferences(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
return response()->json([
|
||||||
|
'preferred_fuel_type' => $request->user()->preferred_fuel_type,
|
||||||
|
'postcode' => $request->user()->postcode,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function updatePreferences(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
$validated = $request->validate([
|
||||||
|
'preferred_fuel_type' => ['sometimes', Rule::in(['petrol', 'diesel', 'e5', 'b7_premium', 'b10', 'hvo'])],
|
||||||
|
'postcode' => ['sometimes', 'string', 'max:8'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
$request->user()->update($validated);
|
||||||
|
|
||||||
|
return response()->json([
|
||||||
|
'preferred_fuel_type' => $request->user()->fresh()->preferred_fuel_type,
|
||||||
|
'postcode' => $request->user()->fresh()->postcode,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function savedStations(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
$stations = $request->user()->savedStations()->get();
|
||||||
|
|
||||||
|
return response()->json(['data' => $stations]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function saveStation(Request $request): JsonResponse
|
||||||
|
{
|
||||||
|
$validated = $request->validate([
|
||||||
|
'station_id' => ['required', 'string', 'max:64'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
$request->user()->savedStations()->firstOrCreate([
|
||||||
|
'station_id' => $validated['station_id'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
return response()->json(null, 201);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function removeStation(Request $request, string $stationId): Response
|
||||||
|
{
|
||||||
|
$request->user()->savedStations()->where('station_id', $stationId)->delete();
|
||||||
|
|
||||||
|
return response()->noContent();
|
||||||
|
}
|
||||||
|
}
|
||||||
10
app/Models/SavedStation.php
Normal file
10
app/Models/SavedStation.php
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
final class SavedStation extends Model
|
||||||
|
{
|
||||||
|
protected $fillable = ['user_id', 'station_id'];
|
||||||
|
}
|
||||||
@@ -9,13 +9,14 @@ use Filament\Panel;
|
|||||||
use Illuminate\Database\Eloquent\Attributes\Fillable;
|
use Illuminate\Database\Eloquent\Attributes\Fillable;
|
||||||
use Illuminate\Database\Eloquent\Attributes\Hidden;
|
use Illuminate\Database\Eloquent\Attributes\Hidden;
|
||||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
use Illuminate\Foundation\Auth\User as Authenticatable;
|
use Illuminate\Foundation\Auth\User as Authenticatable;
|
||||||
use Illuminate\Notifications\Notifiable;
|
use Illuminate\Notifications\Notifiable;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Laravel\Fortify\TwoFactorAuthenticatable;
|
use Laravel\Fortify\TwoFactorAuthenticatable;
|
||||||
use Laravel\Sanctum\HasApiTokens;
|
use Laravel\Sanctum\HasApiTokens;
|
||||||
|
|
||||||
#[Fillable(['name', 'email', 'password', 'is_admin', 'postcode'])]
|
#[Fillable(['name', 'email', 'password', 'is_admin', 'postcode', 'preferred_fuel_type'])]
|
||||||
#[Hidden(['password', 'two_factor_secret', 'two_factor_recovery_codes', 'remember_token'])]
|
#[Hidden(['password', 'two_factor_secret', 'two_factor_recovery_codes', 'remember_token'])]
|
||||||
class User extends Authenticatable implements FilamentUser
|
class User extends Authenticatable implements FilamentUser
|
||||||
{
|
{
|
||||||
@@ -52,4 +53,9 @@ class User extends Authenticatable implements FilamentUser
|
|||||||
->map(fn ($word) => Str::substr($word, 0, 1))
|
->map(fn ($word) => Str::substr($word, 0, 1))
|
||||||
->implode('');
|
->implode('');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function savedStations(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(SavedStation::class);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Run the migrations.
|
||||||
|
*/
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
Schema::table('users', function (Blueprint $table): void {
|
||||||
|
$table->string('preferred_fuel_type', 20)->default('petrol')->after('postcode')
|
||||||
|
->comment('User\'s default fuel type for homepage search');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reverse the migrations.
|
||||||
|
*/
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::table('users', function (Blueprint $table): void {
|
||||||
|
$table->dropColumn('preferred_fuel_type');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Run the migrations.
|
||||||
|
*/
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
Schema::create('saved_stations', function (Blueprint $table): void {
|
||||||
|
$table->id();
|
||||||
|
$table->foreignId('user_id')->constrained()->cascadeOnDelete();
|
||||||
|
$table->string('station_id', 64);
|
||||||
|
$table->timestamps();
|
||||||
|
|
||||||
|
$table->unique(['user_id', 'station_id']);
|
||||||
|
$table->index(['user_id']);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reverse the migrations.
|
||||||
|
*/
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::dropIfExists('saved_stations');
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -4,6 +4,7 @@ use App\Http\Controllers\Api\AuthController;
|
|||||||
use App\Http\Controllers\Api\PredictionController;
|
use App\Http\Controllers\Api\PredictionController;
|
||||||
use App\Http\Controllers\Api\StationController;
|
use App\Http\Controllers\Api\StationController;
|
||||||
use App\Http\Controllers\Api\StatsController;
|
use App\Http\Controllers\Api\StatsController;
|
||||||
|
use App\Http\Controllers\Api\UserController;
|
||||||
use App\Http\Middleware\VerifyApiKey;
|
use App\Http\Middleware\VerifyApiKey;
|
||||||
use Illuminate\Support\Facades\Route;
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
@@ -22,4 +23,11 @@ Route::middleware(['throttle:60,1', VerifyApiKey::class])->group(function (): vo
|
|||||||
Route::middleware('auth:sanctum')->group(function (): void {
|
Route::middleware('auth:sanctum')->group(function (): void {
|
||||||
Route::get('/auth/me', [AuthController::class, 'me']);
|
Route::get('/auth/me', [AuthController::class, 'me']);
|
||||||
Route::post('/auth/logout', [AuthController::class, 'logout']);
|
Route::post('/auth/logout', [AuthController::class, 'logout']);
|
||||||
|
|
||||||
|
// User dashboard endpoints
|
||||||
|
Route::get('/user/preferences', [UserController::class, 'preferences']);
|
||||||
|
Route::put('/user/preferences', [UserController::class, 'updatePreferences']);
|
||||||
|
Route::get('/user/saved-stations', [UserController::class, 'savedStations']);
|
||||||
|
Route::post('/user/saved-stations', [UserController::class, 'saveStation']);
|
||||||
|
Route::delete('/user/saved-stations/{stationId}', [UserController::class, 'removeStation']);
|
||||||
});
|
});
|
||||||
|
|||||||
67
tests/Feature/Api/UserControllerTest.php
Normal file
67
tests/Feature/Api/UserControllerTest.php
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use App\Models\User;
|
||||||
|
use Laravel\Sanctum\Sanctum;
|
||||||
|
|
||||||
|
it('returns user preferences for authenticated user', function (): void {
|
||||||
|
$user = User::factory()->create(['preferred_fuel_type' => 'diesel']);
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->getJson('/api/user/preferences')
|
||||||
|
->assertOk()
|
||||||
|
->assertJsonFragment(['preferred_fuel_type' => 'diesel']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('updates user preferences', function (): void {
|
||||||
|
$user = User::factory()->create(['preferred_fuel_type' => 'petrol']);
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->putJson('/api/user/preferences', ['preferred_fuel_type' => 'diesel'])
|
||||||
|
->assertOk()
|
||||||
|
->assertJsonFragment(['preferred_fuel_type' => 'diesel']);
|
||||||
|
|
||||||
|
expect($user->fresh()->preferred_fuel_type)->toBe('diesel');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects invalid fuel type in preferences update', function (): void {
|
||||||
|
$user = User::factory()->create();
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->putJson('/api/user/preferences', ['preferred_fuel_type' => 'aviation_fuel'])
|
||||||
|
->assertUnprocessable();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('returns saved stations for authenticated user', function (): void {
|
||||||
|
$user = User::factory()->create();
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->getJson('/api/user/saved-stations')
|
||||||
|
->assertOk()
|
||||||
|
->assertJsonStructure(['data']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('saves a station', function (): void {
|
||||||
|
$user = User::factory()->create();
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->postJson('/api/user/saved-stations', ['station_id' => 'abc123'])
|
||||||
|
->assertCreated();
|
||||||
|
|
||||||
|
expect($user->savedStations()->where('station_id', 'abc123')->exists())->toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes a saved station', function (): void {
|
||||||
|
$user = User::factory()->create();
|
||||||
|
$user->savedStations()->create(['station_id' => 'abc123']);
|
||||||
|
Sanctum::actingAs($user);
|
||||||
|
|
||||||
|
$this->deleteJson('/api/user/saved-stations/abc123')
|
||||||
|
->assertNoContent();
|
||||||
|
|
||||||
|
expect($user->savedStations()->where('station_id', 'abc123')->exists())->toBeFalse();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects unauthenticated requests to user endpoints', function (): void {
|
||||||
|
$this->getJson('/api/user/preferences')->assertUnauthorized();
|
||||||
|
$this->getJson('/api/user/saved-stations')->assertUnauthorized();
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user