Skip to content

A self-hosted media server and file management system

feat: Backend Support for changing Passwords and Emails with Testing

aminnausin2c6f94033353
diff --git a/app/Http/Controllers/Api/V1/EmailController.php b/app/Http/Controllers/Api/V1/EmailController.php
new file mode 100644
index 00000000..fb0be457
--- /dev/null
+++ b/app/Http/Controllers/Api/V1/EmailController.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\Request;
+use Illuminate\Validation\Rule;
+
+class EmailController extends Controller {
+ public function update(Request $request) {
+ $request->merge(['current_email' => $request->user()->email]);
+
+ $validated = $request->validate([
+ 'password' => ['required', 'current_password'],
+ 'email' => ['required', 'email', 'different:current_email'],
+ Rule::unique('users', 'email')->ignore($request->user()->id),
+ ], [
+ 'email.different' => 'You already use this email.',
+ ]);
+
+ $request->user()->update([
+ 'email' => $validated['email'],
+ ]);
+
+ return response(null, 204);
+ }
+}
diff --git a/app/Http/Controllers/Api/V1/PasswordController.php b/app/Http/Controllers/Api/V1/PasswordController.php
new file mode 100644
index 00000000..a716bcde
--- /dev/null
+++ b/app/Http/Controllers/Api/V1/PasswordController.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Validation\Rules\Password;
+
+class PasswordController extends Controller {
+ public function update(Request $request) {
+ $validated = $request->validate([
+ 'current_password' => ['required', 'current_password'],
+ 'password' => ['required', Password::defaults(), 'confirmed'],
+ ]);
+
+ $request->user()->update([
+ 'password' => Hash::make($validated['password']),
+ ]);
+
+ return response(null, 204);
+ }
+
+ /**
+ * Handle an incoming new password request. (Starter Pack Demo Code)
+ *
+ * @throws \Illuminate\Validation\ValidationException
+ */
+ public function store(Request $request) {
+ $request->validate([
+ 'token' => 'required',
+ 'email' => 'required|email',
+ // 'password' => ['required', 'confirmed', Rules\Password::defaults()],
+ ]);
+
+ // Here we will attempt to reset the user's password. If it is successful we
+ // will update the password on an actual user model and persist it to the
+ // database. Otherwise we will parse the error and return the response.
+ // $status = Password::reset(
+ // $request->only('email', 'password', 'password_confirmation', 'token'),
+ // function ($user) use ($request) {
+ // $user->forceFill([
+ // 'password' => Hash::make($request->password),
+ // 'remember_token' => Str::random(60),
+ // ])->save();
+
+ // event(new PasswordReset($user));
+ // }
+ // );
+
+ // If the password was successfully reset, we will redirect the user back to
+ // the application's home authenticated view. If there is an error we can
+ // redirect them back to where they came from with their error message.
+ // if ($status == Password::PasswordReset) {
+ // return to_route('login')->with('status', __($status));
+ // }
+
+ // throw ValidationException::withMessages([
+ // 'email' => [__($status)],
+ // ]);
+ }
+}
diff --git a/resources/js/types/requests.ts b/resources/js/types/requests.ts
index 56258d73..5807e5f9 100644
--- a/resources/js/types/requests.ts
+++ b/resources/js/types/requests.ts
@@ -39,3 +39,14 @@ export interface SeriesUpdateRequest {
tags: { name: string; id: number; folder_tag_id?: number }[];
deleted_tags: number[];
}
+
+export interface ChangePasswordRequest {
+ current_password: string;
+ password: string;
+ password_confirmation: string;
+}
+
+export interface ChangeEmailRequest {
+ email: string;
+ password: string;
+}
diff --git a/routes/api.php b/routes/api.php
index 011f8f4e..4981d088 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -3,14 +3,17 @@
use App\Http\Controllers\Api\V1\AnalyticsController;
use App\Http\Controllers\Api\V1\AuthController;
use App\Http\Controllers\Api\V1\CategoryController;
+use App\Http\Controllers\Api\V1\EmailController;
use App\Http\Controllers\Api\V1\ExternalMetadataController;
use App\Http\Controllers\Api\V1\FolderController;
use App\Http\Controllers\Api\V1\JobController;
use App\Http\Controllers\Api\V1\MetadataController;
+use App\Http\Controllers\Api\V1\PasswordController;
use App\Http\Controllers\Api\V1\PlaybackController;
use App\Http\Controllers\Api\V1\ProfileController;
use App\Http\Controllers\Api\V1\RecordController;
use App\Http\Controllers\Api\V1\SeriesController;
+use App\Http\Controllers\API\V1\SessionController;
use App\Http\Controllers\Api\V1\SubTaskController;
use App\Http\Controllers\Api\V1\TagController;
use App\Http\Controllers\Api\V1\TaskController;
@@ -32,6 +35,13 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::get('/auth', [AuthController::class, 'authenticate']); // New
Route::delete('/logout', [AuthController::class, 'destroy']); // New
+ Route::prefix('settings')->group(function () {
+ Route::put('/password', [PasswordController::class, 'update'])->name('password.update');
+ Route::get('/sessions', [SessionController::class, 'index'])->name('sessions.list');
+ Route::put('/email', [EmailController::class, 'update'])->name('email.update');
+ });
+
+
Route::get('/active-sessions', [UserController::class, 'sessionCount']);
Route::get('/user-view-count/{metadata}', [RecordController::class, 'userViewCount']);
Route::get('/profiles/search/{username?}', [ProfileController::class, 'findUser']);
@@ -88,7 +98,7 @@ Route::prefix('pulse')->group(function () {
// public
Route::post('/login', [AuthController::class, 'login']);
-Route::post('/register', [AuthController::class, 'register']);
+Route::post('/register', [AuthController::class, 'register'])->middleware('throttle:6,1')->name('register');
Route::get('/manifest', function () {
return response()->json(AppManifest::info());
diff --git a/tests/Feature/Settings/EmailControllerTest.php b/tests/Feature/Settings/EmailControllerTest.php
new file mode 100644
index 00000000..5984f2b3
--- /dev/null
+++ b/tests/Feature/Settings/EmailControllerTest.php
@@ -0,0 +1,96 @@
+<?php
+
+namespace Tests\Feature\Settings;
+
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Hash;
+use Tests\TestCase;
+
+class EmailControllerTest extends TestCase {
+ use RefreshDatabase;
+
+ private const CHANGE_EMAIL_ENDPOINT = '/api/settings/email';
+
+ public function user_can_update_email_with_correct_password() {
+ $user = User::factory()->create([
+ 'email' => '[email protected]',
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_EMAIL_ENDPOINT, [
+ 'email' => '[email protected]',
+ 'password' => 'old-password',
+ ]);
+
+ $response->assertNoContent();
+ $this->assertTrue($user->fresh()->email === '[email protected]');
+ }
+
+ public function update_fails_with_incorrect_password() {
+ $user = User::factory()->create([
+ 'email' => '[email protected]',
+ 'password' => Hash::make('current-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_EMAIL_ENDPOINT, [
+ 'email' => fake()->unique()->safeEmail,
+ 'password' => 'wrong-password',
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('password');
+ }
+
+ public function update_fails_if_email_exists() {
+ $testUser = $this->getFakeUser();
+ $otherUser = $this->getFakeUser();
+
+ $user = User::factory()->create([
+ 'email' => $testUser['email'],
+ 'password' => Hash::make($testUser['password']),
+ ]);
+
+ User::factory()->create([
+ 'email' => $otherUser['email'],
+ 'password' => Hash::make($otherUser['password']),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_EMAIL_ENDPOINT, [
+ 'email' => $otherUser['email'],
+ 'password' => $testUser['password'],
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('email');
+ }
+
+ public function update_fails_if_email_is_the_same() {
+ $testUser = $this->getFakeUser();
+
+ $user = User::factory()->create([
+ 'email' => $testUser['email'],
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_EMAIL_ENDPOINT, [
+ 'email' => $testUser['email'],
+ 'password' => 'old-password',
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('email');
+ }
+
+ private function getFakeUser(): array {
+ return ["email" => fake()->unique()->safeEmail, "password" => fake()->password(8)];
+ }
+}
diff --git a/tests/Feature/Settings/PasswordControllerTest.php b/tests/Feature/Settings/PasswordControllerTest.php
new file mode 100644
index 00000000..17edab94
--- /dev/null
+++ b/tests/Feature/Settings/PasswordControllerTest.php
@@ -0,0 +1,82 @@
+<?php
+
+namespace Tests\Feature\Settings;
+
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Hash;
+use Tests\TestCase;
+
+class PasswordControllerTest extends TestCase {
+ use RefreshDatabase;
+
+ private const CHANGE_PASSWORD_ENDPOINT = '/api/settings/password';
+
+ public function user_can_update_password_with_correct_current_password() {
+ $user = User::factory()->create([
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_PASSWORD_ENDPOINT, [
+ 'current_password' => 'old-password',
+ 'password' => 'new-secure-password',
+ 'password_confirmation' => 'new-secure-password',
+ ]);
+
+ $response->assertNoContent();
+ $this->assertTrue(Hash::check('new-secure-password', $user->fresh()->password));
+ }
+
+ public function update_fails_with_incorrect_current_password() {
+ $user = User::factory()->create([
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_PASSWORD_ENDPOINT, [
+ 'current_password' => 'wrong-password',
+ 'password' => 'new-password',
+ 'password_confirmation' => 'new-password',
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('current_password');
+ }
+
+ public function update_fails_if_passwords_do_not_match() {
+ $user = User::factory()->create([
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_PASSWORD_ENDPOINT, [
+ 'current_password' => 'old-password',
+ 'password' => 'new-password',
+ 'password_confirmation' => 'wrong-confirmation',
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('password');
+ }
+
+ public function update_fails_if_password_does_not_meet_requirements() {
+ $user = User::factory()->create([
+ 'password' => Hash::make('old-password'),
+ ]);
+
+ $this->actingAs($user);
+
+ $response = $this->putJson(self::CHANGE_PASSWORD_ENDPOINT, [
+ 'current_password' => 'old-password',
+ 'password' => 'short', // invalid with Password::defaults() (not long enough)
+ 'password_confirmation' => 'short',
+ ]);
+
+ $response->assertStatus(422);
+ $response->assertJsonValidationErrors('password');
+ }
+}