Attachment 144752 Details for Bug 31796 – Bug 31796: Add REST endpoint to modify an authority

[patch] Bug 31796: Add REST endpoint to modify an authority

Bug-31796-Add-REST-endpoint-to-modify-an-authority.patch (text/plain), 11.13 KB, created by David Nind on 2022-12-20 22:53:41 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: David Nind

Created: 2022-12-20 22:53:41 UTC

Size: 11.13 KB

patch

obsolete

>From 70f18a724fadaf64c7fee6ad39fcdc6a3284925c Mon Sep 17 00:00:00 2001
>From: Agustin Moyano <agustinmoyano@theke.io>
>Date: Tue, 20 Dec 2022 15:28:04 -0300
>Subject: [PATCH] Bug 31796: Add REST endpoint to modify an authority
>
>To test:
>1. Apply patch
>2. Set RESTBasicAuth preference to true
>3. Pick an authority to modify, and modify it's marc record
>4. Make a PUT request to /api/v1/authorities/:authid with one of the following content type header
>  - application/json
>  - application/marcxml+xml
>  - application/marc-in-json
>  - application/marc
>5. If content type is other than 'application/json' place the following header in the request 'x-authority-type: <auth type>'
>5. Check that the authority was modified
>6. Sign off
>
>Signed-off-by: David Nind <david@davidnind.com>
>---
> Koha/REST/V1/Authorities.pm           |  68 ++++++++++++++-
> api/v1/swagger/paths/authorities.yaml |  64 +++++++++++++-
> t/db_dependent/api/v1/authorities.t   | 118 +++++++++++++++++++++++++-
> 3 files changed, 246 insertions(+), 4 deletions(-)
>
>diff --git a/Koha/REST/V1/Authorities.pm b/Koha/REST/V1/Authorities.pm
>index 15a70070dd..d4236861b1 100644
>--- a/Koha/REST/V1/Authorities.pm
>+++ b/Koha/REST/V1/Authorities.pm
>@@ -21,7 +21,7 @@ use Mojo::Base 'Mojolicious::Controller';
> 
> use Koha::Authorities;
> use Koha::Authority;
>-use C4::AuthoritiesMarc qw( DelAuthority AddAuthority FindDuplicateAuthority);
>+use C4::AuthoritiesMarc qw( DelAuthority AddAuthority FindDuplicateAuthority ModAuthority);
> 
> use List::MoreUtils qw( any );
> use MARC::Record::MiJ;
>@@ -205,4 +205,70 @@ sub add {
>     };
> }
> 
>+
>+=head3 update
>+
>+Controller function that handles modifying an authority object
>+
>+=cut
>+
>+sub update {
>+    my $c = shift->openapi->valid_input or return;
>+
>+    my $authid = $c->validation->param('authority_id');
>+    my $authority = Koha::Authorities->find( { authid => $authid } );
>+
>+    if ( not defined $authority ) {
>+        return $c->render(
>+            status  => 404,
>+            openapi => { error => "Object not found" }
>+        );
>+    }
>+
>+    try {
>+        my $body = $c->validation->param('Body');
>+
>+        my $flavour =
>+            C4::Context->preference('marcflavour') eq 'UNIMARC'
>+            ? 'UNIMARCAUTH'
>+            : 'MARC21';
>+
>+        my $record;
>+        my $authtypecode;
>+
>+        if ( $c->req->headers->content_type =~ m/application\/json/ ) {
>+            $record = MARC::Record->new_from_xml( $body->{marcxml}, 'UTF-8', $flavour );
>+            $authtypecode = $body->{authtypecode} || $authority->authtypecode;
>+        } else {
>+            $authtypecode = $c->validation->param('x-authority-type') || $authority->authtypecode;
>+            if ( $c->req->headers->content_type =~ m/application\/marcxml\+xml/ ) {
>+                $record = MARC::Record->new_from_xml( $body, 'UTF-8', $flavour );
>+            } elsif ( $c->req->headers->content_type =~ m/application\/marc-in-json/ ) {
>+                $record = MARC::Record->new_from_mij_structure( $body );
>+            } elsif ( $c->req->headers->content_type =~ m/application\/marc/ ) {
>+                $record = MARC::Record->new_from_usmarc( $body );
>+            } else {
>+                return $c->render(
>+                    status  => 406,
>+                    openapi => [
>+                        "application/json",
>+                        "application/marcxml+xml",
>+                        "application/marc-in-json",
>+                        "application/marc"
>+                    ]
>+                );
>+            }
>+        }
>+
>+        my $authid = ModAuthority( $authid, $record, $authtypecode );
>+
>+        $c->render(
>+            status  => 200,
>+            openapi => { id => $authid }
>+        );
>+    }
>+    catch {
>+        $c->unhandled_exception($_);
>+    };
>+}
> 1;
>diff --git a/api/v1/swagger/paths/authorities.yaml b/api/v1/swagger/paths/authorities.yaml
>index 92f58d2b57..d754e49b3b 100644
>--- a/api/v1/swagger/paths/authorities.yaml
>+++ b/api/v1/swagger/paths/authorities.yaml
>@@ -130,11 +130,11 @@
>         schema:
>           $ref: "../swagger.yaml#/definitions/error"
>       "404":
>-        description: Biblio not found
>+        description: Authority not found
>         schema:
>           $ref: "../swagger.yaml#/definitions/error"
>       "409":
>-        description: Unable to perform action on biblio
>+        description: Unable to perform action on Authority
>         schema:
>           $ref: "../swagger.yaml#/definitions/error"
>       "500":
>@@ -148,3 +148,63 @@
>     x-koha-authorization:
>       permissions:
>         editcatalogue: edit_catalogue
>+  put:
>+    x-mojo-to: Authorities#update
>+    operationId: updateAuthority
>+    tags:
>+      - authorities
>+    summary: Update authority
>+    parameters:
>+      - $ref: "../swagger.yaml#/parameters/authority_id_pp"
>+      - name: Body
>+        in: body
>+        description: A JSON object or the Marc string describing an authority
>+        required: true
>+        schema:
>+          type:
>+            - string
>+            - object
>+      - $ref: "../swagger.yaml#/parameters/authority_type_header"
>+      - $ref: "../swagger.yaml#/parameters/confirm_not_duplicate_header"
>+    produces:
>+      - application/json
>+    responses:
>+      "200":
>+        description: An authority
>+      "400":
>+        description: Bad request
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+      "401":
>+        description: Authentication required
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+      "403":
>+        description: Access forbidden
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+      "404":
>+        description: Authority not found
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+      "406":
>+        description: Not acceptable
>+        schema:
>+          type: array
>+          description: Accepted content-types
>+          items:
>+            type: string
>+      "500":
>+        description: |
>+          Internal server error. Possible `error_code` attribute values:
>+
>+          * `internal_server_error`
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+      "503":
>+        description: Under maintenance
>+        schema:
>+          $ref: "../swagger.yaml#/definitions/error"
>+    x-koha-authorization:
>+      permissions:
>+        editcatalogue: edit_catalogue
>diff --git a/t/db_dependent/api/v1/authorities.t b/t/db_dependent/api/v1/authorities.t
>index 03cd52e58a..13ec22df63 100755
>--- a/t/db_dependent/api/v1/authorities.t
>+++ b/t/db_dependent/api/v1/authorities.t
>@@ -20,7 +20,7 @@ use Modern::Perl;
> use utf8;
> use Encode;
> 
>-use Test::More tests => 3;
>+use Test::More tests => 4;
> use Test::MockModule;
> use Test::Mojo;
> use Test::Warn;
>@@ -228,5 +228,121 @@ subtest 'post() tests' => sub {
>       ->status_is(200)
>       ->json_has('/id');
> 
>+    $schema->storage->txn_rollback;
>+};
>+
>+subtest 'put() tests' => sub {
>+
>+    plan tests => 18;
>+
>+    $schema->storage->txn_begin;
>+
>+    Koha::Authorities->delete;
>+
>+    my $record;
>+    my $subfield_a;
>+
>+    my $patron = $builder->build_object(
>+        {
>+            class => 'Koha::Patrons',
>+            value => { flags => 0 } # no permissions
>+        }
>+    );
>+    my $password = 'thePassword123';
>+    $patron->set_password( { password => $password, skip_validation => 1 } );
>+    my $userid = $patron->userid;
>+
>+    my $authority = $builder->build_object({ 'class' => 'Koha::Authorities', value => {
>+      marcxml => q|<?xml version="1.0" encoding="UTF-8"?>
>+<record xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loc.gov/MARC21/slim" xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
>+    <controlfield tag="001">1001</controlfield>
>+    <datafield tag="110" ind1=" " ind2=" ">
>+        <subfield code="9">102</subfield>
>+        <subfield code="a">My Corporation</subfield>
>+    </datafield>
>+</record>|
>+    } });
>+
>+    my $authid       = $authority->authid;
>+    my $authtypecode = $authority->authtypecode;
>+
>+    my $marcxml = q|<?xml version="1.0" encoding="UTF-8"?>
>+<record xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loc.gov/MARC21/slim" xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
>+    <controlfield tag="001">1001</controlfield>
>+    <datafield tag="110" ind1=" " ind2=" ">
>+        <subfield code="9">102</subfield>
>+        <subfield code="a">MARCXML</subfield>
>+    </datafield>
>+</record>|;
>+
>+    my $mij = '{"fields":[{"001":"1001"},{"110":{"subfields":[{"9":"102"},{"a":"MIJ"}],"ind1":" ","ind2":" "}}],"leader":"                        "}';
>+    my $marc = '00079     2200049   45000010005000001100024000051001  9102aUSMARCFormated';
>+    my $json = {
>+      authtypecode => $authtypecode,
>+      marcxml      => q|<?xml version="1.0" encoding="UTF-8"?>
>+<record xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.loc.gov/MARC21/slim" xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd">
>+    <controlfield tag="001">1001</controlfield>
>+    <datafield tag="110" ind1=" " ind2=" ">
>+        <subfield code="9">102</subfield>
>+        <subfield code="a">JSON</subfield>
>+    </datafield>
>+</record>|
>+    };
>+
>+    $t->put_ok("//$userid:$password@/api/v1/authorities/$authid")
>+      ->status_is(403, 'Not enough permissions makes it return the right code');
>+
>+    # Add permissions
>+    $builder->build(
>+        {
>+            source => 'UserPermission',
>+            value  => {
>+                borrowernumber => $patron->borrowernumber,
>+                module_bit     => 9,
>+                code           => 'edit_catalogue'
>+            }
>+        }
>+    );
>+
>+    $t->put_ok("//$userid:$password@/api/v1/authorities/$authid" => json => $json)
>+      ->status_is(200)
>+      ->json_has('/id');
>+
>+    $authority = Koha::Authorities->find($authid);
>+    $record = $authority->record;
>+    $subfield_a = $record->subfield('110', 'a');
>+
>+    is($subfield_a, 'JSON');
>+
>+    $t->put_ok("//$userid:$password@/api/v1/authorities/$authid" => {'Content-Type' => 'application/marcxml+xml', 'x-authority-type' => $authtypecode} => $marcxml)
>+      ->status_is(200)
>+      ->json_has('/id');
>+
>+    $authority = Koha::Authorities->find($authid);
>+    $record = $authority->record;
>+    $subfield_a = $record->subfield('110', 'a');
>+
>+    is($subfield_a, 'MARCXML');
>+
>+    $t->put_ok("//$userid:$password@/api/v1/authorities/$authid" => {'Content-Type' => 'application/marc-in-json', 'x-authority-type' => $authtypecode} => $mij)
>+      ->status_is(200)
>+      ->json_has('/id');
>+
>+    $authority = Koha::Authorities->find($authid);
>+    $record = $authority->record;
>+    $subfield_a = $record->subfield('110', 'a');
>+
>+    is($subfield_a, 'MIJ');
>+
>+    $t->put_ok("//$userid:$password@/api/v1/authorities/$authid" => {'Content-Type' => 'application/marc', 'x-authority-type' => $authtypecode} => $marc)
>+      ->status_is(200)
>+      ->json_has('/id');
>+
>+    $authority = Koha::Authorities->find($authid);
>+    $record = $authority->record;
>+    $subfield_a = $record->subfield('110', 'a');
>+
>+    is($subfield_a, 'USMARCFormated');
>+
>     $schema->storage->txn_rollback;
> };
>\ No newline at end of file
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 31796: 144745 | 144752 | 149702 | 150374