3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use Test::More tests => 7;
29 use t::lib::TestBuilder;
32 use C4::Circulation qw( AddIssue AddReturn );
37 use Koha::Old::Checkouts;
39 my $schema = Koha::Database->new->schema;
40 my $builder = t::lib::TestBuilder->new;
42 t::lib::Mocks::mock_preference( 'RESTBasicAuth', 1 );
44 my $t = Test::Mojo->new('Koha::REST::V1');
46 subtest 'get() tests' => sub {
50 $schema->storage->txn_begin;
52 my $patron = $builder->build_object(
54 class => 'Koha::Patrons',
55 value => { flags => 0 }
58 my $password = 'thePassword123';
59 $patron->set_password( { password => $password, skip_validation => 1 } );
60 $patron->discard_changes;
61 my $userid = $patron->userid;
63 my $biblio = $builder->build_sample_biblio({
64 title => 'The unbearable lightness of being',
65 author => 'Milan Kundera'
67 $t->get_ok("//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber)
70 $patron->flags(4)->store;
72 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
73 => { Accept => 'application/weird+format' } )
75 ->json_is( [ "application/json",
76 "application/marcxml+xml",
77 "application/marc-in-json",
81 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
82 => { Accept => 'application/json' } )
84 ->json_is( '/title', 'The unbearable lightness of being' )
85 ->json_is( '/author', 'Milan Kundera' );
87 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
88 => { Accept => 'application/marcxml+xml' } )
91 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
92 => { Accept => 'application/marc-in-json' } )
95 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
96 => { Accept => 'application/marc' } )
99 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
100 => { Accept => 'text/plain' } )
102 ->content_is($biblio->metadata->record->as_formatted);
105 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
106 => { Accept => 'application/marc' } )
108 ->json_is( '/error', 'Object not found.' );
110 subtest 'marc-in-json encoding tests' => sub {
114 my $title_with_diacritics = "L'insoutenable légèreté de l'être";
116 my $biblio = $builder->build_sample_biblio(
118 title => $title_with_diacritics,
119 author => "Milan Kundera"
123 my $result = $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber
124 => { Accept => 'application/marc-in-json' } )
125 ->status_is(200)->tx->res->body;
127 my $encoded_title = Encode::encode( "UTF-8", $title_with_diacritics );
129 like( $result, qr/\Q$encoded_title/, "The title is not double encoded" );
132 $schema->storage->txn_rollback;
135 subtest 'get_items() tests' => sub {
139 $schema->storage->txn_begin;
141 my $patron = $builder->build_object(
143 class => 'Koha::Patrons',
144 value => { flags => 0 }
147 my $password = 'thePassword123';
148 $patron->set_password( { password => $password, skip_validation => 1 } );
149 $patron->discard_changes;
150 my $userid = $patron->userid;
152 my $biblio = $builder->build_sample_biblio();
153 $t->get_ok("//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/items")
156 $patron->flags(4)->store;
158 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/items")
160 ->json_is( '' => [], 'No items on the biblio' );
162 my $item_1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
163 my $item_2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
165 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/items")
167 ->json_is( '' => [ $item_1->to_api, $item_2->to_api ], 'The items are returned' );
169 $schema->storage->txn_rollback;
172 subtest 'delete() tests' => sub {
176 $schema->storage->txn_begin;
178 my $patron = $builder->build_object(
180 class => 'Koha::Patrons',
181 value => { flags => 0 } # no permissions
184 my $password = 'thePassword123';
185 $patron->set_password( { password => $password, skip_validation => 1 } );
186 my $userid = $patron->userid;
188 my $item = $builder->build_sample_item();
189 my $biblio_id = $item->biblionumber;
191 $t->delete_ok("//$userid:$password@/api/v1/biblios/$biblio_id")
192 ->status_is(403, 'Not enough permissions makes it return the right code');
197 source => 'UserPermission',
199 borrowernumber => $patron->borrowernumber,
201 code => 'edit_catalogue'
207 # Bibs with items cannot be deleted
208 $t->delete_ok("//$userid:$password@/api/v1/biblios/$biblio_id")
213 # Bibs with no items can be deleted
214 $t->delete_ok("//$userid:$password@/api/v1/biblios/$biblio_id")
215 ->status_is(204, 'SWAGGER3.2.4')
216 ->content_is('', 'SWAGGER3.3.4');
218 $t->delete_ok("//$userid:$password@/api/v1/biblios/$biblio_id")
221 $schema->storage->txn_rollback;
224 subtest 'get_public() tests' => sub {
228 $schema->storage->txn_begin;
230 my $category = $builder->build_object({ class => 'Koha::Patron::Categories' });
231 my $patron = $builder->build_object(
233 class => 'Koha::Patrons',
235 flags => undef, # opac user
236 categorycode => $category->categorycode
240 my $password = 'thePassword123';
241 $patron->set_password( { password => $password, skip_validation => 1 } );
242 $patron->discard_changes;
243 my $userid = $patron->userid;
245 my $biblio = $builder->build_sample_biblio({
246 title => 'The unbearable lightness of being',
247 author => 'Milan Kundera'
250 # Make sure author in shown in the OPAC
251 my $subfields = Koha::MarcSubfieldStructures->search({ tagfield => '100' });
252 while ( my $subfield = $subfields->next ) {
253 $subfield->set({ hidden => -1 })->store;
255 Koha::Caches->get_instance()->flush_all;
257 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
258 => { Accept => 'application/weird+format' } )
260 ->json_is( [ "application/marcxml+xml",
261 "application/marc-in-json",
265 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
266 => { Accept => 'text/plain' } )
268 ->content_like( qr{100\s+_aMilan Kundera} )
269 ->content_like( qr{245\s+_aThe unbearable lightness of being} );
271 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
272 => { Accept => 'application/marcxml+xml' } )
275 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
276 => { Accept => 'application/marc-in-json' } )
279 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
280 => { Accept => 'application/marc' } )
283 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
284 => { Accept => 'text/plain' } )
286 ->content_is($biblio->metadata->record->as_formatted);
288 subtest 'anonymous access' => sub {
291 $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
292 => { Accept => 'application/marcxml+xml' } )
295 $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
296 => { Accept => 'application/marc-in-json' } )
299 $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
300 => { Accept => 'application/marc' } )
303 $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
304 => { Accept => 'text/plain' } )
306 ->content_is($biblio->metadata->record->as_formatted);
309 subtest 'marc-in-json encoding tests' => sub {
313 my $title_with_diacritics = "L'insoutenable légèreté de l'être";
315 my $biblio = $builder->build_sample_biblio(
317 title => $title_with_diacritics,
318 author => "Milan Kundera"
322 my $result = $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
323 => { Accept => 'application/marc-in-json' } )
324 ->status_is(200)->tx->res->body;
326 my $encoded_title = Encode::encode( "UTF-8", $title_with_diacritics );
328 like( $result, qr/\Q$encoded_title/, "The title is not double encoded" );
331 # Hide author in OPAC
332 $subfields = Koha::MarcSubfieldStructures->search({ tagfield => '100' });
333 while ( my $subfield = $subfields->next ) {
334 $subfield->set({ hidden => 1 })->store;
337 Koha::Caches->get_instance()->flush_all;
339 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
340 => { Accept => 'text/plain' } )
342 ->content_unlike( qr{100\s+_aMilan Kundera} )
343 ->content_like( qr{245\s+_aThe unbearable lightness of being} );
345 subtest 'hidden_in_opac tests' => sub {
349 my $biblio_hidden_in_opac = 1;
351 my $biblio_class = Test::MockModule->new('Koha::Biblio');
352 # force biblio hidden in OPAC
353 $biblio_class->mock( 'hidden_in_opac', sub { return $biblio_hidden_in_opac; } );
355 $t->get_ok( "/api/v1/public/biblios/" . $biblio->biblionumber
356 => { Accept => 'text/plain' } )
357 ->status_is(404, 'hidden_in_opac + anonymous => hidden');
359 my $category_override_hidden_items = 0;
360 my $category_class = Test::MockModule->new('Koha::Patron::Category');
361 $category_class->mock( 'override_hidden_items', sub { return $category_override_hidden_items; } );
362 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
363 => { Accept => 'text/plain' } )
364 ->status_is(404, "hidden_in_opac + patron whose category doesn't override => hidden");
366 # Make the category override
367 $category_override_hidden_items = 1;
368 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
369 => { Accept => 'text/plain' } )
370 ->status_is(200, "hidden_in_opac + patron whose category that overrides => displayed");
372 t::lib::Mocks::mock_preference('OpacHiddenItems');
376 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/" . $biblio->biblionumber
377 => { Accept => 'application/marc' } )
379 ->json_is( '/error', 'Object not found.' );
381 $schema->storage->txn_rollback;
384 subtest 'pickup_locations() tests' => sub {
388 $schema->storage->txn_begin;
390 t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 0 );
392 # Small trick to ease testing
393 Koha::Libraries->search->update({ pickup_location => 0 });
395 my $library_1 = $builder->build_object({ class => 'Koha::Libraries', value => { marcorgcode => 'A', pickup_location => 1 } });
396 my $library_2 = $builder->build_object({ class => 'Koha::Libraries', value => { marcorgcode => 'B', pickup_location => 1 } });
397 my $library_3 = $builder->build_object({ class => 'Koha::Libraries', value => { marcorgcode => 'C', pickup_location => 1 } });
399 my $library_1_api = $library_1->to_api();
400 my $library_2_api = $library_2->to_api();
401 my $library_3_api = $library_3->to_api();
403 $library_1_api->{needs_override} = Mojo::JSON->false;
404 $library_2_api->{needs_override} = Mojo::JSON->false;
405 $library_3_api->{needs_override} = Mojo::JSON->true;
407 my $patron = $builder->build_object(
409 class => 'Koha::Patrons',
410 value => { userid => 'tomasito', flags => 0 }
413 my $password = 'thePassword123';
414 $patron->set_password( { password => $password, skip_validation => 1 } );
415 my $userid = $patron->userid;
418 source => 'UserPermission',
420 borrowernumber => $patron->borrowernumber,
422 code => 'place_holds',
427 my $biblio_class = Test::MockModule->new('Koha::Biblio');
431 my ( $self, $params ) = @_;
432 my $mock_patron = $params->{patron};
433 is( $mock_patron->borrowernumber,
434 $patron->borrowernumber, 'Patron passed correctly' );
435 return Koha::Libraries->search(
439 $library_1->branchcode,
440 $library_2->branchcode
444 { # we make sure no surprises in the order of the result
445 order_by => { '-asc' => 'marcorgcode' }
451 my $biblio = $builder->build_sample_biblio;
453 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
455 . "/pickup_locations?patron_id=" . $patron->id )
456 ->json_is( [ $library_1_api, $library_2_api ] );
459 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
461 . '/pickup_locations?'
462 . 'patron_id=' . $patron->id . '&q={"marc_org_code": { "-like": "A%" }}' )
463 ->json_is( [ $library_1_api ] );
465 t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 1 );
467 my $library_4 = $builder->build_object({ class => 'Koha::Libraries', value => { pickup_location => 0, marcorgcode => 'X' } });
468 my $library_5 = $builder->build_object({ class => 'Koha::Libraries', value => { pickup_location => 1, marcorgcode => 'Y' } });
470 my $library_5_api = $library_5->to_api();
471 $library_5_api->{needs_override} = Mojo::JSON->true;
473 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
475 . "/pickup_locations?"
476 . "patron_id=" . $patron->id . "&_order_by=marc_org_code" )
477 ->json_is( [ $library_1_api, $library_2_api, $library_3_api, $library_5_api ] );
479 subtest 'Pagination and AllowHoldPolicyOverride tests' => sub {
483 t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 1 );
485 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->id . "/pickup_locations?" . "patron_id=" . $patron->id . "&_order_by=marc_org_code" . "&_per_page=1" )
486 ->json_is( [$library_1_api] )
487 ->header_is( 'X-Total-Count', '4', '4 is the count for libraries with pickup_location=1' )
488 ->header_is( 'X-Base-Total-Count', '4', '4 is the count for libraries with pickup_location=1' )
489 ->header_unlike( 'Link', qr|rel="prev"| )
490 ->header_like( 'Link', qr#(_per_page=1.*\&_page=2.*|_page=2.*\&_per_page=1.*)>\; rel="next"# )
491 ->header_like( 'Link', qr#(_per_page=1.*\&_page=1.*|_page=1.*\&_per_page=1).*>\; rel="first"# )
492 ->header_like( 'Link', qr#(_per_page=1.*\&_page=4.*|_page=4.*\&_per_page=1).*>\; rel="last"# );
494 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
496 . "/pickup_locations?"
499 . "&_order_by=marc_org_code"
500 . "&_per_page=1&_page=3" ) # force the needs_override=1 check
501 ->json_is( [$library_3_api] )
502 ->header_is( 'X-Total-Count', '4', '4 is the count for libraries with pickup_location=1' )
503 ->header_is( 'X-Base-Total-Count', '4', '4 is the count for libraries with pickup_location=1' )
504 ->header_like( 'Link', qr#(_per_page=1.*\&_page=2.*|_page=2.*\&_per_page=1.*)>\; rel="prev"# )
505 ->header_like( 'Link', qr#(_per_page=1.*\&_page=4.*|_page=4.*\&_per_page=1.*)>\; rel="next"# )
506 ->header_like( 'Link', qr#(_per_page=1.*\&_page=1.*|_page=1.*\&_per_page=1).*>\; rel="first"# )
507 ->header_like( 'Link', qr#(_per_page=1.*\&_page=4.*|_page=4.*\&_per_page=1).*>\; rel="last"# );
509 t::lib::Mocks::mock_preference( 'AllowHoldPolicyOverride', 0 );
511 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->id . "/pickup_locations?" . "patron_id=" . $patron->id . "&_order_by=marc_org_code" . "&_per_page=1" )
512 ->json_is( [$library_1_api] )
513 ->header_is( 'X-Total-Count', '2' )
514 ->header_is( 'X-Base-Total-Count', '2' )
515 ->header_unlike( 'Link', qr|rel="prev"| )
516 ->header_like( 'Link', qr#(_per_page=1.*\&_page=2.*|_page=2.*\&_per_page=1.*)>\; rel="next"# )
517 ->header_like( 'Link', qr#(_per_page=1.*\&_page=1.*|_page=1.*\&_per_page=1).*>\; rel="first"# )
518 ->header_like( 'Link', qr#(_per_page=1.*\&_page=2.*|_page=2.*\&_per_page=1).*>\; rel="last"# );
521 my $deleted_patron = $builder->build_object({ class => 'Koha::Patrons' });
522 my $deleted_patron_id = $deleted_patron->id;
523 $deleted_patron->delete;
525 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
527 . "/pickup_locations?"
528 . "patron_id=" . $deleted_patron_id )
530 ->json_is( '/error' => 'Patron not found' );
534 $t->get_ok( "//$userid:$password@/api/v1/biblios/"
536 . "/pickup_locations?"
537 . "patron_id=" . $patron->id )
539 ->json_is( '/error' => 'Biblio not found' );
541 $schema->storage->txn_rollback;
544 subtest 'get_items_public() tests' => sub {
548 $schema->storage->txn_begin;
550 my $override_hidden_items = 0;
552 my $mocked_category = Test::MockModule->new('Koha::Patron::Category');
553 $mocked_category->mock(
554 'override_hidden_items',
556 return $override_hidden_items;
562 my $mocked_context = Test::MockModule->new('C4::Context');
563 $mocked_context->mock(
570 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
571 my $password = 'thePassword123';
572 $patron->set_password( { password => $password, skip_validation => 1 } );
573 $patron->discard_changes;
574 my $userid = $patron->userid;
576 my $biblio = $builder->build_sample_biblio();
579 "//$userid:$password@/api/v1/public/biblios/" . $biblio->id . "/items" )
580 ->status_is(200)->json_is( '' => [], 'No items on the biblio' );
582 my $item_1 = $builder->build_sample_item( { biblionumber => $biblio->id } );
583 my $item_2 = $builder->build_sample_item(
584 { biblionumber => $biblio->id, withdrawn => 1 } );
586 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/"
587 . $biblio->biblionumber
588 . "/items" )->status_is(200)->json_is(
590 $item_1->to_api( { public => 1 } ),
591 $item_2->to_api( { public => 1 } )
593 'The items are returned'
596 $rules = { withdrawn => ['1'] };
598 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/"
599 . $biblio->biblionumber
600 . "/items" )->status_is(200)->json_is(
601 '' => [ $item_1->to_api( { public => 1 } ) ],
602 'The items are returned, hidden one is not returned'
605 $t->get_ok( "/api/v1/public/biblios/"
606 . $biblio->biblionumber
607 . "/items" )->status_is(200)->json_is(
608 '' => [ $item_1->to_api( { public => 1 } ) ],
609 'Anonymous user, items are returned, hidden one is not returned'
613 $override_hidden_items = 1;
615 $t->get_ok( "//$userid:$password@/api/v1/public/biblios/"
616 . $biblio->biblionumber
617 . "/items" )->status_is(200)->json_is(
619 $item_1->to_api( { public => 1 } ),
620 $item_2->to_api( { public => 1 } )
622 'The items are returned, the patron category has an override'
625 $schema->storage->txn_rollback;
628 subtest 'get_checkouts() tests' => sub {
632 $schema->storage->txn_begin;
634 my $patron = $builder->build_object(
636 class => 'Koha::Patrons',
637 value => { flags => 0 }
640 my $password = 'thePassword123';
641 $patron->set_password( { password => $password, skip_validation => 1 } );
642 $patron->discard_changes;
643 my $userid = $patron->userid;
645 my $biblio = $builder->build_sample_biblio();
646 $t->get_ok("//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/checkouts")
649 $patron->flags(1)->store; # circulate permissions
651 $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/checkouts")
653 ->json_is( '' => [], 'No checkouts on the biblio' );
655 my $item_1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
656 my $item_2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
658 AddIssue( $patron->unblessed, $item_1->barcode );
659 AddIssue( $patron->unblessed, $item_2->barcode );
661 my $ret = $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/checkouts")
665 my $checkout_1 = Koha::Checkouts->find({ itemnumber => $item_1->id });
666 my $checkout_2 = Koha::Checkouts->find({ itemnumber => $item_2->id });
668 is_deeply( $ret, [ $checkout_1->to_api, $checkout_2->to_api ] );
670 AddReturn( $item_1->barcode );
672 $ret = $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/checkouts")
676 is_deeply( $ret, [ $checkout_2->to_api ] );
678 $ret = $t->get_ok( "//$userid:$password@/api/v1/biblios/" . $biblio->biblionumber . "/checkouts?checked_in=1")
682 my $old_checkout_1 = Koha::Old::Checkouts->find( $checkout_1->id );
684 is_deeply( $ret, [ $old_checkout_1->to_api ] );
686 $schema->storage->txn_rollback;