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>.
20 use Koha::Acquisition::Orders;
25 # Dummy app for testing the plugin
26 use Mojolicious::Lite;
28 app->log->level('error');
30 plugin 'Koha::REST::Plugin::Objects';
31 plugin 'Koha::REST::Plugin::Query';
32 plugin 'Koha::REST::Plugin::Pagination';
34 get '/cities' => sub {
36 $c->validation->output($c->req->params->to_hash);
37 my $cities = $c->objects->search(Koha::Cities->new);
38 $c->render( status => 200, json => $cities );
41 get '/orders' => sub {
43 $c->stash('koha.embed', ( { fund => {} } ) );
44 $c->validation->output($c->req->params->to_hash);
45 my $orders = $c->objects->search(Koha::Acquisition::Orders->new);
46 $c->render( status => 200, json => $orders );
49 get '/patrons/:patron_id/holds' => sub {
51 my $params = $c->req->params->to_hash;
52 $params->{patron_id} = $c->stash("patron_id");
53 $c->validation->output($params);
54 my $holds_set = Koha::Holds->new;
55 my $holds = $c->objects->search( $holds_set );
56 $c->render( status => 200, json => {count => scalar(@$holds)} );
59 get '/biblios' => sub {
61 my $output = $c->req->params->to_hash;
62 $output->{query} = $c->req->json if defined $c->req->json;
63 my $headers = $c->req->headers->to_hash;
64 $output->{'x-koha-query'} = $headers->{'x-koha-query'} if defined $headers->{'x-koha-query'};
65 $c->validation->output($output);
66 my $biblios_set = Koha::Biblios->new;
67 $c->stash("koha.embed", {
74 my $biblios = $c->objects->search($biblios_set);
75 $c->render( status => 200, json => {count => scalar(@$biblios), biblios => $biblios} );
80 use Test::More tests => 10;
84 use t::lib::TestBuilder;
87 my $schema = Koha::Database->new()->schema();
88 my $builder = t::lib::TestBuilder->new;
90 subtest 'objects.search helper' => sub {
94 $schema->storage->txn_begin;
96 # Remove existing cities to have more control on the search results
99 # Create three sample cities that match the query. This makes sure we
100 # always have a "next" link regardless of Mojolicious::Plugin::OpenAPI version.
101 $builder->build_object({
102 class => 'Koha::Cities',
104 city_name => 'Manuel'
107 $builder->build_object({
108 class => 'Koha::Cities',
110 city_name => 'Manuela'
113 $builder->build_object({
114 class => 'Koha::Cities',
116 city_name => 'Manuelab'
120 my $t = Test::Mojo->new;
121 $t->get_ok('/cities?name=manuel&_per_page=1&_page=1')
123 ->header_like( 'Link' => qr/<http:\/\/.*[\?&]_page=2.*>; rel="next",/ )
126 ->json_is('/0/name' => 'Manuel');
128 $builder->build_object({
129 class => 'Koha::Cities',
131 city_name => 'Emanuel'
136 $t->get_ok('/cities?name=manuel&_per_page=4&_page=1&_match=starts_with')
142 ->json_is('/0/name' => 'Manuel')
143 ->json_is('/1/name' => 'Manuela')
144 ->json_is('/2/name' => 'Manuelab');
147 $t->get_ok('/cities?name=manuel&_per_page=4&_page=1&_match=ends_with')
152 ->json_is('/0/name' => 'Manuel')
153 ->json_is('/1/name' => 'Emanuel');
156 $t->get_ok('/cities?name=manuel&_per_page=4&_page=1&_match=exact')
160 ->json_is('/0/name' => 'Manuel');
163 $t->get_ok('/cities?name=manuel&_per_page=4&_page=1&_match=contains')
170 ->json_is('/0/name' => 'Manuel')
171 ->json_is('/1/name' => 'Manuela')
172 ->json_is('/2/name' => 'Manuelab')
173 ->json_is('/3/name' => 'Emanuel');
177 $builder->build_object({ class => 'Koha::Cities' });
180 t::lib::Mocks::mock_preference('RESTdefaultPageSize', 20 );
181 $t->get_ok('/cities')
184 my $response_count = scalar @{ $t->tx->res->json };
185 is( $response_count, 20, 'RESTdefaultPageSize is honoured by default (20)' );
187 t::lib::Mocks::mock_preference('RESTdefaultPageSize', 5 );
188 $t->get_ok('/cities')
191 $response_count = scalar @{ $t->tx->res->json };
192 is( $response_count, 5, 'RESTdefaultPageSize is honoured by default (5)' );
194 $t->get_ok('/cities?_page=1&_per_page=-1')
197 $response_count = scalar @{ $t->tx->res->json };
198 is( $response_count, 24, '_per_page=-1 means all resources' );
200 $t->get_ok('/cities?_page=100&_per_page=-1')
203 $response_count = scalar @{ $t->tx->res->json };
204 is( $response_count, 24, 'When _per_page=-1 the page param is not considered' );
206 $schema->storage->txn_rollback;
209 subtest 'objects.search helper, sorting on mapped column' => sub {
213 $schema->storage->txn_begin;
215 # Have complete control over the existing cities to ease testing
216 Koha::Cities->delete;
218 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'A', city_country => 'Argentina' } });
219 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'B', city_country => 'Argentina' } });
220 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'C', city_country => 'Argentina' } });
221 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'C', city_country => 'Belarus' } });
223 my $t = Test::Mojo->new;
225 $t->get_ok('/cities?_order_by=%2Bname,-country')
229 ->json_is('/0/name' => 'A')
230 ->json_is('/1/name' => 'B')
231 ->json_is('/2/name' => 'C')
232 ->json_is('/2/country' => 'Belarus')
233 ->json_is('/3/name' => 'C')
234 ->json_is('/3/country' => 'Argentina')
237 # Multi-param: traditional
238 $t->get_ok('/cities?_order_by=%2Bname&_order_by=-country')
242 ->json_is('/0/name' => 'A')
243 ->json_is('/1/name' => 'B')
244 ->json_is('/2/name' => 'C')
245 ->json_is('/2/country' => 'Belarus')
246 ->json_is('/3/name' => 'C')
247 ->json_is('/3/country' => 'Argentina')
250 # Multi-param: PHP Style, Passes validation as above, subsequntly explodes
251 $t->get_ok('/cities?_order_by[]=%2Bname&_order_by[]=-country')
255 ->json_is('/0/name' => 'A')
256 ->json_is('/1/name' => 'B')
257 ->json_is('/2/name' => 'C')
258 ->json_is('/2/country' => 'Belarus')
259 ->json_is('/3/name' => 'C')
260 ->json_is('/3/country' => 'Argentina')
264 $t->get_ok('/cities?_order_by=-name')
268 ->json_is('/0/name' => 'C')
269 ->json_is('/1/name' => 'C')
270 ->json_is('/2/name' => 'B')
271 ->json_is('/3/name' => 'A')
274 $schema->storage->txn_rollback;
277 subtest 'objects.search helper, encoding' => sub {
281 $schema->storage->txn_begin;
283 Koha::Cities->delete;
285 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'A', city_country => 'Argentina' } });
286 $builder->build_object({ class => 'Koha::Cities', value => { city_name => 'B', city_country => '❤Argentina❤' } });
288 my $t = Test::Mojo->new;
289 $t->get_ok('/cities?q={"country": "❤Argentina❤"}')
293 ->json_is('/0/name' => 'B');
295 $schema->storage->txn_rollback;
298 subtest 'objects.search helper, embed' => sub {
302 $schema->storage->txn_begin;
304 my $order = $builder->build_object({ class => 'Koha::Acquisition::Orders' });
306 my $t = Test::Mojo->new;
307 $t->get_ok('/orders?order_id=' . $order->ordernumber)
308 ->json_is('/0',$order->to_api({ embed => ( { fund => {} } ) }));
310 $schema->storage->txn_rollback;
313 subtest 'objects.search helper, with path parameters and _match' => sub {
316 $schema->storage->txn_begin;
318 Koha::Holds->search()->delete;
320 my $patron = Koha::Patrons->find(10);
321 $patron->delete if $patron;
322 $patron = $builder->build_object( { class => "Koha::Patrons" } );
323 $patron->borrowernumber(10)->store;
324 $builder->build_object(
326 class => "Koha::Holds",
327 value => { borrowernumber => $patron->borrowernumber }
331 my $t = Test::Mojo->new;
332 $t->get_ok('/patrons/1/holds?_match=exact')
333 ->json_is('/count' => 0, 'there should be no holds for borrower 1 with _match=exact');
335 $t->get_ok('/patrons/1/holds?_match=contains')
336 ->json_is('/count' => 0, 'there should be no holds for borrower 1 with _match=contains');
338 $t->get_ok('/patrons/10/holds?_match=exact')
339 ->json_is('/count' => 1, 'there should be 1 hold for borrower 10 with _match=exact');
341 $t->get_ok('/patrons/10/holds?_match=contains')
342 ->json_is('/count' => 1, 'there should be 1 hold for borrower 10 with _match=contains');
344 $schema->storage->txn_rollback;
347 subtest 'object.search helper with query parameter' => sub {
350 $schema->storage->txn_begin;
352 my $patron1 = $builder->build_object( { class => "Koha::Patrons" } );
353 my $patron2 = $builder->build_object( { class => "Koha::Patrons" } );
354 my $biblio1 = $builder->build_sample_biblio;
355 my $biblio2 = $builder->build_sample_biblio;
356 my $biblio3 = $builder->build_sample_biblio;
357 my $suggestion1 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron1->borrowernumber, biblionumber => $biblio1->biblionumber} } );
358 my $suggestion2 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio2->biblionumber} } );
359 my $suggestion3 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio3->biblionumber} } );
361 my $t = Test::Mojo->new;
362 $t->get_ok('/biblios' => json => {"suggestions.suggester.patron_id" => $patron1->borrowernumber })
363 ->json_is('/count' => 1, 'there should be 1 biblio with suggestions of patron 1');
365 $t->get_ok('/biblios' => json => {"suggestions.suggester.patron_id" => $patron2->borrowernumber })
366 ->json_is('/count' => 2, 'there should be 2 biblios with suggestions of patron 2');
368 $schema->storage->txn_rollback;
371 subtest 'object.search helper with q parameter' => sub {
374 $schema->storage->txn_begin;
376 my $patron1 = $builder->build_object( { class => "Koha::Patrons" } );
377 my $patron2 = $builder->build_object( { class => "Koha::Patrons" } );
378 my $biblio1 = $builder->build_sample_biblio;
379 my $biblio2 = $builder->build_sample_biblio;
380 my $biblio3 = $builder->build_sample_biblio;
381 my $suggestion1 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron1->borrowernumber, biblionumber => $biblio1->biblionumber} } );
382 my $suggestion2 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio2->biblionumber} } );
383 my $suggestion3 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio3->biblionumber} } );
385 my $t = Test::Mojo->new;
386 $t->get_ok('/biblios?q={"suggestions.suggester.patron_id": "'.$patron1->borrowernumber.'"}')
387 ->json_is('/count' => 1, 'there should be 1 biblio with suggestions of patron 1');
389 $t->get_ok('/biblios?q={"suggestions.suggester.patron_id": "'.$patron2->borrowernumber.'"}')
390 ->json_is('/count' => 2, 'there should be 2 biblios with suggestions of patron 2');
392 $schema->storage->txn_rollback;
395 subtest 'object.search helper with x-koha-query header' => sub {
398 $schema->storage->txn_begin;
400 my $patron1 = $builder->build_object( { class => "Koha::Patrons" } );
401 my $patron2 = $builder->build_object( { class => "Koha::Patrons" } );
402 my $biblio1 = $builder->build_sample_biblio;
403 my $biblio2 = $builder->build_sample_biblio;
404 my $biblio3 = $builder->build_sample_biblio;
405 my $suggestion1 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron1->borrowernumber, biblionumber => $biblio1->biblionumber} } );
406 my $suggestion2 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio2->biblionumber} } );
407 my $suggestion3 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio3->biblionumber} } );
409 my $t = Test::Mojo->new;
410 $t->get_ok('/biblios' => {'x-koha-query' => '{"suggestions.suggester.patron_id": "'.$patron1->borrowernumber.'"}'})
411 ->json_is('/count' => 1, 'there should be 1 biblio with suggestions of patron 1');
413 $t->get_ok('/biblios' => {'x-koha-query' => '{"suggestions.suggester.patron_id": "'.$patron2->borrowernumber.'"}'})
414 ->json_is('/count' => 2, 'there should be 2 biblios with suggestions of patron 2');
416 $schema->storage->txn_rollback;
419 subtest 'object.search helper with all query methods' => sub {
422 $schema->storage->txn_begin;
424 my $patron1 = $builder->build_object( { class => "Koha::Patrons" , value => {firstname=>'patron1'} } );
425 my $patron2 = $builder->build_object( { class => "Koha::Patrons" , value => {firstname=>'patron2'} } );
426 my $biblio1 = $builder->build_sample_biblio;
427 my $biblio2 = $builder->build_sample_biblio;
428 my $biblio3 = $builder->build_sample_biblio;
429 my $suggestion1 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron1->borrowernumber, biblionumber => $biblio1->biblionumber} } );
430 my $suggestion2 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio2->biblionumber} } );
431 my $suggestion3 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio3->biblionumber} } );
433 my $t = Test::Mojo->new;
434 $t->get_ok('/biblios?q={"suggestions.suggester.firstname": "'.$patron1->firstname.'"}' => {'x-koha-query' => '{"suggestions.suggester.patron_id": "'.$patron1->borrowernumber.'"}'} => json => {"suggestions.suggester.cardnumber" => $patron1->cardnumber})
435 ->json_is('/count' => 1, 'there should be 1 biblio with suggestions of patron 1');
437 $t->get_ok('/biblios?q={"suggestions.suggester.firstname": "'.$patron2->firstname.'"}' => {'x-koha-query' => '{"suggestions.suggester.patron_id": "'.$patron2->borrowernumber.'"}'} => json => {"suggestions.suggester.cardnumber" => $patron2->cardnumber})
438 ->json_is('/count' => 2, 'there should be 2 biblios with suggestions of patron 2');
440 $t->get_ok('/biblios?q={"suggestions.suggester.firstname": "'.$patron1->firstname.'"}' => {'x-koha-query' => '{"suggestions.suggester.patron_id": "'.$patron2->borrowernumber.'"}'} => json => {"suggestions.suggester.cardnumber" => $patron2->cardnumber})
441 ->json_is('/count' => 0, 'there shouldn\'t be biblios where suggester has patron1 fistname and patron2 id');
443 $schema->storage->txn_rollback;
446 subtest 'object.search helper order by embedded columns' => sub {
449 my $patron1 = $builder->build_object( { class => "Koha::Patrons" , value => {firstname=>'patron1'} } );
450 my $patron2 = $builder->build_object( { class => "Koha::Patrons" , value => {firstname=>'patron2'} } );
451 my $biblio1 = $builder->build_sample_biblio;
452 my $biblio2 = $builder->build_sample_biblio;
453 my $suggestion1 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron1->borrowernumber, biblionumber => $biblio1->biblionumber} } );
454 my $suggestion2 = $builder->build_object( { class => "Koha::Suggestions", value => { suggestedby => $patron2->borrowernumber, biblionumber => $biblio2->biblionumber} } );
456 my $t = Test::Mojo->new;
457 $t->get_ok('/biblios?_order_by=-suggestions.suggester.firstname' => json => [{"me.biblio_id" => $biblio1->biblionumber}, {"me.biblio_id" => $biblio2->biblionumber}])
458 ->json_is('/biblios/0/biblio_id' => $biblio2->biblionumber, 'Biblio 2 should be first')
459 ->json_is('/biblios/1/biblio_id' => $biblio1->biblionumber, 'Biblio 1 should be second');
461 $schema->storage->txn_begin;