File Coverage

blib/lib/Yancy/Controller/Yancy/API.pm

Criterion	Covered	Total	%
statement	9	87	10.3
branch	0	48	0.0
condition	0	17	0.0
subroutine	3	10	30.0
pod	4	4	100.0
total	16	166	9.6

package Yancy::Controller::Yancy::API;
our $VERSION = '1.086';
# ABSTRACT: (DEPRECATED) An OpenAPI REST controller for the Yancy editor

#pod =head1 DESCRIPTION
#pod
#pod B: This module has been merged into the
#pod L class and the editor now uses that class by
#pod default.
#pod
#pod This module contains the routes that L uses to work with the
#pod backend data. This API is used by the Yancy editor.
#pod
#pod =head1 SUBCLASSING
#pod
#pod To change how the API provides access to the data in your database, you
#pod can create a custom controller. To do so, you should extend
#pod L and override the desired methods to provide
#pod the desired functionality.
#pod
#pod     package MyApp::Controller::CustomYancyAPI;
#pod     use Mojo::Base 'Yancy::Controller::Yancy';
#pod     sub list {
#pod         my ( $c ) = @_;
#pod         return unless $c->openapi->valid_input;
#pod         my $items = $c->yancy->backend->list( $c->stash( 'schema' ) );
#pod         return $c->render(
#pod             status => 200,
#pod             openapi => $items,
#pod         );
#pod     }
#pod
#pod     package main;
#pod     use Mojolicious::Lite;
#pod     push @{ app->routes->namespaces }, 'MyApp::Controller';
#pod     plugin Yancy => {
#pod         editor => {
#pod             default_controller => 'CustomYancyAPI',
#pod         },
#pod     };
#pod
#pod For an example, you could extend this class to add authorization based
#pod on your own requirements.
#pod
#pod =head1 SEE ALSO
#pod
#pod L, L
#pod
#pod =cut

use Mojo::Base 'Mojolicious::Controller';
use Mojo::JSON qw( to_json );
use Yancy::Util qw( derp );

#pod =method list
#pod
#pod List the items in a schema. The schema name should be in the
#pod stash key C.
#pod
#pod Each returned item will be filtered by filters conforming with
#pod L that are passed in the
#pod array-ref in stash key C.
#pod
#pod C<$limit>, C<$offset>, and C<$order_by> may be provided as query parameters.
#pod
#pod =cut

sub list {
    my ( $c ) = @_;
    return unless $c->openapi->valid_input;
    my $args = $c->validation->output;

    my %opt = (
        limit => delete $args->{'$limit'},
        offset => delete $args->{'$offset'},
    );
    if ( my $order_by = delete $args->{'$order_by'} ) {
        $opt{order_by} = [
            map +{ "-$_->[0]" => $_->[1] },
            map +[ split /:/ ],
            split /,/, $order_by
        ];
    }

    my %filter;
    if ( $c->stash( 'collection' ) ) {
        derp '"collection" stash key is now "schema" in controller configuration';
    }
    my $schema_name = $c->stash( 'schema' ) || $c->stash( 'collection' );
    my $schema = $c->yancy->schema( $schema_name )  ;
    my $props  = $schema->{properties};
    for my $key ( keys %$args ) {
        my $value = $args->{ $key };
        my $type = $props->{$key}{type} || 'string';
        if ( _is_type( $type, 'string' ) ) {
            if ( ( $value =~ tr/*/%/ ) <= 0 ) {
                 $value = "\%$value\%";
            }
            $filter{ $key } = { -like => $value };
        }
        elsif ( grep _is_type( $type, $_ ), qw(number integer) ) {
            $filter{ $key } = $value ;
        }
        elsif ( _is_type( $type, 'boolean' ) ) {
            $filter{ $value ? '-bool' : '-not_bool' } = $key;
        }
        else {
            die "Sorry type '" .
                to_json( $type ) .
                "' is not handled yet, only string|number|integer|boolean is supported."
        }
    }

    my $res = $c->yancy->backend->list( $schema_name, \%filter, \%opt );
    _delete_null_values( @{ $res->{items} } );
    $res->{items} = [
        map _apply_op_filters( $schema_name, $_, $c->stash( 'filters_out' ), $c->yancy->filters ), @{ $res->{items} }
    ] if $c->stash( 'filters_out' );

    return $c->render(
        status => 200,
        openapi => $res,
    );
}

sub _is_type {
    my ( $type, $is_type ) = @_;
    return unless $type;
    return ref $type eq 'ARRAY'
        ? !!grep { $_ eq $is_type } @$type
        : $type eq $is_type;
}

#pod =method get
#pod
#pod Get a single item from a schema. The schema should be in the stash key
#pod C.
#pod
#pod The item's ID field-name is in the stash key C. The ID itself
#pod is extracted from the OpenAPI input, under a parameter of that name.
#pod
#pod The return value is filtered like each result is in L.
#pod
#pod =cut

sub get {
    my ( $c ) = @_;
    return unless $c->openapi->valid_input;
    my $args = $c->validation->output;
    my $id = $args->{ $c->stash( 'id_field' ) };
    if ( $c->stash( 'collection' ) ) {
        derp '"collection" stash key is now "schema" in controller configuration';
    }
    my $schema_name = $c->stash( 'schema' ) || $c->stash( 'collection' );
    my $res = _delete_null_values( $c->yancy->backend->get( $schema_name, $id ) );
    $res = _apply_op_filters( $schema_name, $res, $c->stash( 'filters_out' ), $c->yancy->filters )
        if $c->stash( 'filters_out' );
    return $c->render(
        status => 200,
        openapi => $res,
    );
}

#pod =method set
#pod
#pod Create or update an item in a schema. The schema should be in the stash
#pod key C.
#pod
#pod The item to be updated is determined as with L, if any.
#pod The new item is extracted from the OpenAPI input, under parameter name
#pod C, and must be a hash/JSON "object". It will be filtered by
#pod filters conforming with L
#pod that are passed in the array-ref in stash key C, after the
#pod schema and property filters have been applied.
#pod
#pod The return value is filtered like each result is in L.
#pod
#pod =cut

sub set {
    my ( $c ) = @_;
    return unless $c->openapi->valid_input;
    my $args = $c->validation->output;
    my $id = $args->{ $c->stash( 'id_field' ) };
    if ( $c->stash( 'collection' ) ) {
        derp '"collection" stash key is now "schema" in controller configuration';
    }
    my $schema_name = $c->stash( 'schema' ) || $c->stash( 'collection' );
    my $item = $c->yancy->filter->apply( $schema_name, $args->{ newItem } );
    $item = _apply_op_filters( $schema_name, $item, $c->stash( 'filters' ), $c->yancy->filters )
        if $c->stash( 'filters' );

    if ( $id ) {
        $c->yancy->backend->set( $schema_name, $id, $item );
        # ID field may have changed
        $id = $item->{ $c->stash( 'id_field' ) } || $id;
    }
    else {
        $id = $c->yancy->backend->create( $schema_name, $item );
    }

    my $res = _delete_null_values( $c->yancy->backend->get( $schema_name, $id ) );
    $res = _apply_op_filters( $schema_name, $res, $c->stash( 'filters_out' ), $c->yancy->filters )
        if $c->stash( 'filters_out' );
    return $c->render(
        status => 200,
        openapi => $res,
    );
}

#pod =method delete
#pod
#pod Delete an item from a schema. The schema name should be in the
#pod stash key C.
#pod
#pod The item to be deleted is determined as with L.
#pod
#pod =cut

sub delete {
    my ( $c ) = @_;
    return unless $c->openapi->valid_input;
    my $args = $c->validation->output;
    my $id = $args->{ $c->stash( 'id_field' ) };
    if ( $c->stash( 'collection' ) ) {
        derp '"collection" stash key is now "schema" in controller configuration';
    }
    my $schema_name = $c->stash( 'schema' ) || $c->stash( 'collection' );
    $c->yancy->backend->delete( $schema_name, $id );
    return $c->rendered( 204 );
}

#=sub _delete_null_values
#
#   _delete_null_values( @items );
#
# Remove all the keys with a value of C from the given items.
# This prevents the user from having to explicitly declare fields that
# can be C as C<< [ 'string', 'null' ] >>. Since this validation
# really only happens when a response is generated, it can be very
# confusing to understand what the problem is
sub _delete_null_values {
    for my $item ( @_ ) {
        delete $item->{ $_ } for grep !defined $item->{ $_ }, keys %$item;
    }
    return wantarray ? @_ : $_[0];
}

#=sub _apply_op_filters
#
# Similar to the helper 'yancy.filter.apply' - filters input item,
# returns updated version.
sub _apply_op_filters {
    my ( $schema_name, $item, $filters, $app_filters ) = @_;
    $item = { %$item }; # no mutate input
    for my $filter ( @$filters ) {
        ( $filter, my @params ) = @$filter if ref $filter eq 'ARRAY';
        my $sub = $app_filters->{ $filter };
        die "Unknown filter: $filter" unless $sub;
        $item = $sub->( $schema_name, $item, {}, @params );
    }
    $item;
}

1;

__END__