Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/froggs/p5-mojolicious-plugin-inputvalidation

Validate incoming request payloads
https://github.com/froggs/p5-mojolicious-plugin-inputvalidation

mojolicious perl plugin post request validation

Last synced: 19 days ago
JSON representation

Validate incoming request payloads

Awesome Lists containing this project

README 

        
# Mojolicious::Plugin::InputValidation - Validate incoming requests



# SYNOPSIS



```perl

  use Mojolicious::Lite;

  plugin 'InputValidation';



  # This needs to be done where one wants to use the iv_* routines.

  use Mojolicious::Plugin::InputValidation;



  post '/books' => sub {

      my $c = shift;



      # Validate incoming requests against our data model.

      if (my $error = $c->validate_json_request({

          title    => iv_any,

          abstract => iv_any(optional => 1, empty => 1),

          author   => {

              firstname => iv_word,

              lastname  => iv_word,

          },

          published => iv_datetime,

          price     => iv_float,

          revision  => iv_int,

          isbn      => iv_any(pattern => qr/^[0-9\-]{10,13}$/),

          advertise => iv_bool,

      })) {

          return $c->render(status => 400, text => $error);

      }



      # Now the payload is safe to use.

      my $payload = $c->req->json;

      ...

  };

```



# INSTALLATION



To install this module, run the following commands:



```sh

	perl Makefile.PL

	make

	make test

	make install

```



# SUPPORT AND DOCUMENTATION



After installing, you can find documentation for this module with the

perldoc command.



```sh

    perldoc Mojolicious::Plugin::InputValidation

```



You can also look for information at:



    RT, CPAN's request tracker (report bugs here)

        https://rt.cpan.org/NoAuth/Bugs.html?Dist=Mojolicious-Plugin-InputValidation



    AnnoCPAN, Annotated CPAN documentation

        http://annocpan.org/dist/Mojolicious-Plugin-InputValidation



    CPAN Ratings

        https://cpanratings.perl.org/d/Mojolicious-Plugin-InputValidation



    Search CPAN

        https://metacpan.org/release/Mojolicious-Plugin-InputValidation



# LICENSE AND COPYRIGHT



Copyright (C) 2018 Tobias Leich



This program is free software; you can redistribute it and/or modify it

under the terms of the the Artistic License (2.0). You may obtain a

copy of the full license at:



http://www.perlfoundation.org/artistic_license_2_0



Any use, modification, and distribution of the Standard or Modified

Versions is governed by this Artistic License. By using, modifying or

distributing the Package, you accept this license. Do not use, modify,

or distribute the Package, if you do not accept this license.



If your Modified Version has been derived from a Modified Version made

by someone other than you, you are nevertheless required to ensure that

your Modified Version complies with the requirements of this license.



This license does not grant you the right to use any trademark, service

mark, tradename, or logo of the Copyright Holder.



This license includes the non-exclusive, worldwide, free-of-charge

patent license to make, have made, use, offer to sell, sell, import and

otherwise transfer the Package with respect to any patent claims

licensable by the Copyright Holder that are necessarily infringed by the

Package. If you institute patent litigation (including a cross-claim or

counterclaim) against any party alleging that the Package constitutes

direct or contributory patent infringement, then this Artistic License

to you shall terminate on the date that such litigation is filed.



Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER

AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.

THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY

YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR

CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR

CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,

EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.