Attachment 154463 Details for Bug 34313 – Bug 34313: Add patron information in pass validation response

[patch] Bug 34313: Add patron information in pass validation response

Bug-34313-Add-patron-information-in-pass-validatio.patch (text/plain), 3.00 KB, created by Nick Clemens (kidclamp) on 2023-08-16 11:27:56 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Nick Clemens (kidclamp)

Created: 2023-08-16 11:27:56 UTC

Size: 3.00 KB

patch

obsolete

>From b90f450116f06d080af9c9e1c4a6896a77da1766 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Wed, 19 Jul 2023 16:15:13 -0300
>Subject: [PATCH] Bug 34313: Add patron information in pass validation response
>
>This patch makes the password validation response return the following
>patron attributes to the API consumer:
>
>* cardnumber
>* userid
>
>This will give hints on what was used to validate in the fallback
>bahvior the endpoint has.
>
>To test:
>1. Apply the unit tests patch
>2. Run:
>   $ ktd --shell
>  k$ prove t/db_dependent/api/v1/password_validation.t
>=> FAIL: The endpoint doesn't return this valuable data
>3. Apply this patch
>4. Repeat 2
>=> SUCESS: Tests pass! We got the cardnumber and the userid!
>5. Sign off :-D
>
>Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
>Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
>---
> Koha/REST/V1/Auth/Password.pm  | 16 ++++++++++++----
> api/v1/swagger/paths/auth.yaml | 15 ++++++++++++++-
> 2 files changed, 26 insertions(+), 5 deletions(-)
>
>diff --git a/Koha/REST/V1/Auth/Password.pm b/Koha/REST/V1/Auth/Password.pm
>index d5ea5c726f1..4369ffd187c 100644
>--- a/Koha/REST/V1/Auth/Password.pm
>+++ b/Koha/REST/V1/Auth/Password.pm
>@@ -71,7 +71,7 @@ sub validate {
>     my $password = $body->{password} // "";
> 
>     return try {
>-        my ( $status, $cardnumber, $userid ) = C4::Auth::checkpw( $identifier, $password );
>+        my ( $status, $THE_cardnumber, $THE_userid ) = C4::Auth::checkpw( $identifier, $password );
>         unless ($status) {
>             return $c->render(
>                 status  => 400,
>@@ -79,9 +79,17 @@ sub validate {
>             );
>         }
> 
>-        return $c->render( status => 204, openapi => '' );
>-    }
>-    catch {
>+        my $patron = Koha::Patrons->find( { cardnumber => $THE_cardnumber } );
>+
>+        return $c->render(
>+            status  => 201,
>+            openapi => {
>+                cardnumber => $patron->cardnumber,
>+                patron_id  => $patron->id,
>+                userid     => $patron->userid,
>+            }
>+        );
>+    } catch {
>         if ( blessed $_ and $_->isa('Koha::Exceptions::Password') ) {
>             return $c->render(
>                 status  => 400,
>diff --git a/api/v1/swagger/paths/auth.yaml b/api/v1/swagger/paths/auth.yaml
>index 3b61a220133..b9dee70cdca 100644
>--- a/api/v1/swagger/paths/auth.yaml
>+++ b/api/v1/swagger/paths/auth.yaml
>@@ -1091,8 +1091,21 @@
>     produces:
>       - application/json
>     responses:
>-      "204":
>+      "201":
>         description: Validation successful
>+        schema:
>+          type: object
>+          properties:
>+            cardnumber:
>+              type: string
>+              description: cardnumber for the validated patron
>+            patron_id:
>+              type: integer
>+              description: Internal patron identifier
>+            userid:
>+              type: string
>+              description: userid for the validated patron
>+          additionalProperties: false
>       "400":
>         description: Bad request
>         schema:
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 34313: 153685 | 153686 | 153690 | 153691 | 153787 | 153788 | 154462 | 154463