Bug 19661: REST API - Funds Endpoint
[koha.git] / Koha / REST / V1 / Acquisitions / Funds.pm
1 package Koha::REST::V1::Acquisitions::Funds;
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 3 of the License, or (at your option) any later
8 # version.
9 #
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17
18 use Modern::Perl;
19
20 use Mojo::Base 'Mojolicious::Controller';
21
22 use C4::Budgets;
23 use JSON qw(to_json);
24
25 use Try::Tiny;
26
27 =head1 NAME
28
29 Koha::REST::V1::Acquisitions::Funds
30
31 =head1 API
32
33 =head2 Methods
34
35 =head3 list_funds
36
37 Controller function that handles listing Funds
38
39 =cut
40
41 sub list_funds {
42     my $c = shift->openapi->valid_input or return;
43
44     my $args = _to_model($c->req->params->to_hash);
45     my $filter;
46
47     for my $filter_param ( keys %$args ) {
48         $filter->{$filter_param} = { LIKE => $args->{$filter_param} . "%" }
49             if $args->{$filter_param};
50     }
51
52     return try {
53         my $funds = GetBudgets($filter);
54         my @fundsArray = map { _to_api($_) } @$funds;
55         return $c->render( status  => 200,
56                            openapi =>  \@fundsArray);
57     }
58     catch {
59         if ( $_->isa('DBIx::Class::Exception') ) {
60             return $c->render( status  => 500,
61                                openapi => { error => $_->{msg} } );
62         }
63         else {
64             return $c->render( status  => 500,
65                                openapi => { error => "Something went wrong, check the logs. $_ $filter" } );
66         }
67     };
68 }
69
70 =head3 _to_api
71
72 Helper function that maps a Fund  into
73 the attribute names the exposed REST api spec.
74
75 =cut
76
77 sub _to_api {
78     my $fund = shift;
79     my $returnfund;
80     $returnfund->{id} = delete $fund->{budget_id};
81     $returnfund->{code} = delete $fund->{budget_code};
82     $returnfund->{name} = delete $fund->{budget_name};
83
84     return $returnfund;
85 }
86
87 =head3 _to_model
88
89 Helper function that maps REST api objects into Fund
90 attribute names.
91
92 =cut
93
94 sub _to_model {
95     my $fund = shift;
96
97     # Rename back
98     $fund->{budget_id}     = delete $fund->{id};
99     $fund->{budget_code}   = delete $fund->{code};
100     $fund->{budget_name}   = delete $fund->{name};
101
102     return $fund;
103 }
104
105 1;