4 add inertia usage to readme (#5)

Author: benbjurstrom

README.md

@@ -157,9 +157,15 @@ return [
 After installing Laravel Breeze or your preferred UI scaffolding, you'll need to replace the login form's login step. Instead of authenticating directly, send the OTP email and redirect the user to the OTP entry page.
 
 ### Laravel Breeze Livewire Example
-1. Replace the [LoginForm authenticate method](https://github.com/laravel/breeze/blob/2.x/stubs/livewire-common/app/Livewire/Forms/LoginForm.php#L29C6-L29C41) with a sendEmail method that runs the SendOtp action. For example:
+1. Replace the [LoginForm authenticate method](https://github.com/laravel/breeze/blob/2.x/stubs/livewire-common/app/Livewire/Forms/LoginForm.php#L29C6-L29C41) with a sendEmail method that runs the SendOtp action and returns the newly created Otp.
+
 ```php
-    public function sendEmail(): void
+    use BenBjurstrom\Otpz\Actions\SendOtp;
+    use BenBjurstrom\Otpz\Exceptions\OtpThrottleException;
+    use BenBjurstrom\Otpz\Models\Otp;
+    //...
+    
+    public function sendEmail(): Otp
     {
         $this->validate();
 
@@ -178,8 +184,7 @@ After installing Laravel Breeze or your preferred UI scaffolding, you'll need to
     }
 ````
 
-2. Next replace [Login component's login method](https://github.com/laravel/breeze/blob/e05ae1a21954c8d83bb0fcc78db87f157c16ac6c/stubs/livewire/resources/views/livewire/pages/auth/login.blade.php#L19-L23) with a method that calls the sendEmail method and redirects to the OTP entry page. For example:
-
+2. Update the [Login component's login method](https://github.com/laravel/breeze/blob/e05ae1a21954c8d83bb0fcc78db87f157c16ac6c/stubs/livewire/resources/views/livewire/pages/auth/login.blade.php#L19-L23) to call the sendEmail method and redirect to the OTP entry page.
 ```php
     public function login(): void
     {
@@ -189,6 +194,53 @@ After installing Laravel Breeze or your preferred UI scaffolding, you'll need to
     }
 ``` 
 
+### Laravel Breeze Inertia Example
+
+1. Remove password from the rules array and replace the [LoginRequest authenticate method](https://github.com/laravel/breeze/blob/e05ae1a21954c8d83bb0fcc78db87f157c16ac6c/stubs/default/app/Http/Requests/Auth/LoginRequest.php#L40) with a sendEmail method that runs the SendOtp action and returns the newly created Otp.
+```php
+    use BenBjurstrom\Otpz\Actions\SendOtp;
+    use BenBjurstrom\Otpz\Exceptions\OtpThrottleException;
+    use BenBjurstrom\Otpz\Models\Otp;
+    //...
+    
+    public function rules(): array
+    {
+        return [
+            'email' => ['required', 'string', 'email']
+        ];
+    }
+    //...
+    
+    public function sendEmail(): Otp
+    {
+        $this->ensureIsNotRateLimited();
+        RateLimiter::hit($this->throttleKey(), 300);
+
+        try {
+            $otp = (new SendOtp)->handle($this->email);
+        } catch (OtpThrottleException $e) {
+            throw ValidationException::withMessages([
+                'email' => $e->getMessage(),
+            ]);
+        }
+
+        RateLimiter::clear($this->throttleKey());
+
+        return $otp;
+    }
+```
+
+2. Update the [AuthenticatedSessionController store method](https://github.com/laravel/breeze/blob/e05ae1a21954c8d83bb0fcc78db87f157c16ac6c/stubs/inertia-common/app/Http/Controllers/Auth/AuthenticatedSessionController.php#L30) to call the sendEmail method and redirect to the OTP entry page.
+
+```php
+    public function store(LoginRequest $request): \Symfony\Component\HttpFoundation\Response
+    {
+        $otp = $request->sendEmail();
+
+        return Inertia::location($otp->url);
+    }
+```
+
 Everything else is handled by the package components.
 
 ## Testing

resources/views/otp.blade.php

@@ -59,11 +59,16 @@ class="block w-72 rounded-xl border-zinc-300 p-4 text-center text-2xl uppercase
                             />
                             <input type="hidden" name="email" value="{{$email}}">
                         </div>
-                        <x-input-error
-                            :messages="$errors->get('code')"
-                            class="mt-2"
-                            id="otp-error"
-                        />
+                        @if ($errors->get('code'))
+                            <ul
+                                id="otp-error"
+                                class="mt-2 text-sm text-red-600 dark:text-red-400 space-y-1"
+                            >
+                                @foreach ((array) $errors->get('code') as $message)
+                                    <li>{{ $message }}</li>
+                                @endforeach
+                            </ul>
+                        @endif
                     </div>
 
                     <div>

src/Http/Controllers/PostOtpController.php

@@ -4,22 +4,20 @@
 
 use BenBjurstrom\Otpz\Actions\AttemptOtp;
 use BenBjurstrom\Otpz\Exceptions\OtpAttemptException;
+use BenBjurstrom\Otpz\Http\Requests\OtpRequest;
 use Illuminate\Http\RedirectResponse;
-use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Session;
 use Illuminate\Validation\ValidationException;
 use Illuminate\View\View;
 
 class PostOtpController
 {
-    public function __invoke(Request $request, int $id): RedirectResponse|View
+    public function __invoke(OtpRequest $request, int $id): RedirectResponse|View
     {
-        $data = $request->validate([
-            'code' => ['required', 'string', 'size:9'],
-        ]);
-
         try {
+            $data = $request->safe()->only(['code']);
+
             $otp = (new AttemptOtp)->handle($id, $data['code']);
 
             Auth::loginUsingId($otp->user_id); // fires Illuminate\Auth\Events\Login;

src/Http/Requests/OtpRequest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace BenBjurstrom\Otpz\Http\Requests;
+
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class OtpRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, ValidationRule|array|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'code' => ['required', 'string', 'size:9'],
+        ];
+    }
+
+    protected function prepareForValidation(): void
+    {
+        $code = preg_replace('/[^0-9A-Z]/', '', strtoupper($this->code));
+        $this->merge([
+            'code' => $code,
+        ]);
+    }
+}

src/Models/Otp.php

@@ -58,9 +58,9 @@ public function user(): BelongsTo
         return $this->belongsTo($authenticatableModel);
     }
 
-    public function getUrlAttribute()
+    public function getUrlAttribute(): string
     {
-        URL::temporarySignedRoute('otp.show', now()->addMinutes(5), [
+        return URL::temporarySignedRoute('otp.show', now()->addMinutes(5), [
             'id' => $this->id,
             'session' => request()->session()->getId(),
         ]);