/usr/share/perl5/Perinci/Object/EnvResultMulti.pm is in libperinci-object-perl 0.24-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 | package Perinci::Object::EnvResultMulti;
our $DATE = '2015-09-03'; # DATE
our $VERSION = '0.24'; # VERSION
use 5.010;
use strict;
use warnings;
use parent qw(Perinci::Object::EnvResult);
sub new {
my ($class, $res) = @_;
$res //= [200, "Success/no items"];
my $obj = \$res;
bless $obj, $class;
}
sub add_result {
my ($self, $status, $message, $extra) = @_;
my $num_ok = 0;
my $num_nok = 0;
push @{ ${$self}->[3]{results} },
{%{ $extra // {} }, status=>$status, message=>$message};
for (@{ ${$self}->[3]{results} // [] }) {
if ($_->{status} =~ /\A(2|304)/) {
$num_ok++;
} else {
$num_nok++;
}
}
if ($num_ok) {
if ($num_nok) {
${$self}->[0] = 207;
${$self}->[1] = "Partial success";
} else {
${$self}->[0] = 200;
${$self}->[1] = "All success";
}
} else {
${$self}->[0] = $status;
${$self}->[1] = $message;
}
}
1;
# ABSTRACT: Represent enveloped result (multistatus)
__END__
=pod
=encoding UTF-8
=head1 NAME
Perinci::Object::EnvResultMulti - Represent enveloped result (multistatus)
=head1 VERSION
This document describes version 0.24 of Perinci::Object::EnvResultMulti (from Perl distribution Perinci-Object), released on 2015-09-03.
=head1 SYNOPSIS
use Perinci::Object::EnvResultMulti;
use Data::Dump; # for dd()
sub myfunc {
...
# if unspecified, the default status will be [200, "Success/no items"]
my $envres = Perinci::Object::EnvResultMulti->new;
# then you can add result for each item
$envres->add_result(200, "OK", {item_id=>1});
$envres->add_result(202, "OK", {item_id=>2, note=>"blah"});
$envres->add_result(404, "Not found", {item_id=>3});
...
# if you add a success status, the overall status will still be 200
# if you add a non-success staus, the overall status will be 207, or
# the non-success status (if no success has been added)
# finally, return the result
return $envres->as_struct;
# the result from the above will be: [207, "Partial success", undef,
# {results => [
# {success=>200, message=>"OK", item_id=>1},
# {success=>201, message=>"OK", item_id=>2, note=>"blah"},
# {success=>404, message=>"Not found", item_id=>3},
# ]}]
} # myfunc
=head1 DESCRIPTION
This class is a subclass of L<Perinci::Object::EnvResult> and provide a
convenience method when you want to use multistatus/detailed per-item results
(specified in L<Rinci> 1.1.63: C<results> result metadata property). In this
case, response status can be 200, 207, or non-success. As you add more per-item
results, this class will set/update the overall response status for you.
=head1 METHODS
=head2 new($res) => OBJECT
Create a new object from C<$res> enveloped result array. If C<$res> is not
specified, the default is C<< [200, "Success/no items"] >>.
=head2 $envres->add_result($status, $message, \%extra)
Add an item result.
=head1 SEE ALSO
L<Perinci::Object>
L<Perinci::Object::EnvResult>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Perinci-Object>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Perinci-Object>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Object>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|