File Coverage

blib/lib/WebService/Mattermost/Role/Returns.pm

Criterion	Covered	Total	%
statement	7	7	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod	1	1	100.0
total	10	10	100.0

package WebService::Mattermost::Role::Returns;

# ABSTRACT: Standard returns for user-facing subroutines.

use Moo::Role;

################################################################################

sub error_return {
    my $self  = shift;
    my $error = shift;

    $error = sprintf '%s. No API query was made.', $error;

    return { error => 1, message => $error };
}

################################################################################

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

WebService::Mattermost::Role::Returns - Standard returns for user-facing subroutines.

=head1 VERSION

version 0.26

=head1 DESCRIPTION

Common structures for return values.

=head2 METHODS

=over 4

=item C<error_return()>

Return an unsuccessful response with an error message.

    return $self->error_return('Error here');

    # \{
    #     error   => 1,
    #     message => 'Error here. No API query was made.',
    # }

=back

=head1 AUTHOR

Mike Jones <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Mike Jones.

This is free software, licensed under:

  The MIT (X11) License

=cut