Attachment 67786 Details for Bug 19234 – Bug 19234: Add query parameters handling helpers

[patch] Bug 19234: Add query parameters handling helpers

Bug-19234-Add-query-parameters-handling-helpers.patch (text/plain), 3.74 KB, created by Lari Taskula on 2017-10-07 12:46:41 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Lari Taskula

Created: 2017-10-07 12:46:41 UTC

Size: 3.74 KB

patch

obsolete

>From f590b4d0b7c157b16b5588eb46337862b07f4611 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Fri, 1 Sep 2017 11:53:35 -0300
>Subject: [PATCH] Bug 19234: Add query parameters handling helpers
>
>This patch introduces a Mojolicious plugin to be used on the REST api.
>It adds a helper method:
>
>generate_dbic_query
>===================
>
>When used, it generates what's needed to perform a search on
>DBIC/Koha::Objects like this:
>
>    my $params  = $c->validation->output;
>    my ($filtered_params, $reserved_params) = $c->extract_reserved_params($params);
>
>    my $filter = do_smth($filtered_params, $reserved_params);
>    my $attributes = do_smth_reserved($reserved_params);
>
>    my $patrons = Koha::Patrons->search( $filter, $attributes );
>
>It introduces reserved param names:
>- _match
>- _order_by
>- _page
>- _per_page
>
>They are reserved for later usage (pagination, matching algorithm on building DB queries)
>
>All the plugin's behaviour is tested.
>
>To test:
>- Run:
>  $ sudo koha-shell kohadev
> k$ cd kohaclone
> k$ prove t/Koha/REST/Plugin/Query.t
>=> SUCCESS: Tests pass!
>- Sign off :-D
>
>Sponsored-by: ByWater solutions
>Sponsored-by: Camden County
>
>Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
>Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
>
>Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
>
>Signed-off-by: Lari Taskula <lari.taskula@jns.fi>
>---
> Koha/REST/Plugin/Query.pm | 84 +++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 84 insertions(+)
> create mode 100644 Koha/REST/Plugin/Query.pm
>
>diff --git a/Koha/REST/Plugin/Query.pm b/Koha/REST/Plugin/Query.pm
>new file mode 100644
>index 0000000..1b7176c
>--- /dev/null
>+++ b/Koha/REST/Plugin/Query.pm
>@@ -0,0 +1,84 @@
>+package Koha::REST::Plugin::Query;
>+
>+# This file is part of Koha.
>+#
>+# Koha is free software; you can redistribute it and/or modify it under the
>+# terms of the GNU General Public License as published by the Free Software
>+# Foundation; either version 3 of the License, or (at your option) any later
>+# version.
>+#
>+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
>+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
>+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
>+#
>+# You should have received a copy of the GNU General Public License along
>+# with Koha; if not, write to the Free Software Foundation, Inc.,
>+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
>+
>+use Modern::Perl;
>+
>+use Mojo::Base 'Mojolicious::Plugin';
>+
>+=head1 NAME
>+
>+Koha::REST::Plugin::Query
>+
>+=head1 API
>+
>+=head2 Mojolicious::Plugin methods
>+
>+=head3 register
>+
>+=cut
>+
>+sub register {
>+    my ( $self, $app ) = @_;
>+
>+=head2 Helper methods
>+
>+=head3 extract_reserved_params
>+
>+    my ( $filtered_params, $reserved_params ) = $c->extract_reserved_params($params);
>+
>+Generates the DBIC query from the query parameters.
>+
>+=cut
>+
>+    $app->helper(
>+        'extract_reserved_params' => sub {
>+            my ( $c, $params ) = @_;
>+
>+            my $reserved_params;
>+            my $filtered_params;
>+
>+            my $reserved_words = _reserved_words();
>+
>+            foreach my $param ( keys %{$params} ) {
>+                if ( grep { $param eq $_ } @{$reserved_words} ) {
>+                    $reserved_params->{$param} = $params->{$param};
>+                }
>+                else {
>+                    $filtered_params->{$param} = $params->{$param};
>+                }
>+            }
>+
>+            return ( $filtered_params, $reserved_params );
>+        }
>+    );
>+}
>+
>+=head2 Internal methods
>+
>+=head3 _reserved_words
>+
>+    my $reserved_words = _reserved_words();
>+
>+=cut
>+
>+sub _reserved_words {
>+
>+    my @reserved_words = qw( _match _order_by _page _per_page );
>+    return \@reserved_words;
>+}
>+
>+1;
>-- 
>2.7.4

Actions: View | Diff | Splinter Review

Attachments on bug 19234: 66752 | 66753 | 66754 | 66991 | 66992 | 66993 | 67358 | 67359 | 67360 | 67363 | 67364 | 67365 | 67374 | 67375 | 67377 | 67785 | 67786 | 67787 | 69360 | 69361 | 69362