-#
-# Catlyst::Action::Serialize.pm
-# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
-#
-# $Id$
-
package Catalyst::Action::Serialize;
-use strict;
-use warnings;
+use Moose;
+use namespace::autoclean;
-use base 'Catalyst::Action::SerializeBase';
+extends 'Catalyst::Action::SerializeBase';
use Module::Pluggable::Object;
-use Data::Dump qw(dump);
+use MRO::Compat;
+
+our $VERSION = '1.04';
+$VERSION = eval $VERSION;
+
+has _encoders => (
+ is => 'ro',
+ isa => 'HashRef',
+ default => sub { {} },
+);
sub execute {
my $self = shift;
my ( $controller, $c ) = @_;
- $self->NEXT::execute(@_);
+ $self->maybe::next::method(@_);
return 1 if $c->req->method eq 'HEAD';
- return 1 if length( $c->response->body );
+ return 1 if $c->response->has_body;
return 1 if scalar @{ $c->error };
- return 1 if $c->response->status =~ /^(?:204|3\d\d)$/;
+ return 1 if $c->response->status =~ /^(?:204)$/;
my ( $sclass, $sarg, $content_type ) =
$self->_load_content_plugins( "Catalyst::Action::Serialize",
$c->log->info("Could not find a serializer for $content_type");
} else {
$c->log->info(
- "Could not find a serializer for an empty content type");
+ "Could not find a serializer for an empty content-type");
}
return 1;
}
$c->log->debug(
"Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
+ $self->_encoders->{$sclass} ||= $sclass->new;
+ my $sobj = $self->_encoders->{$sclass};
+
my $rc;
- if ( defined($sarg) ) {
- $rc = $sclass->execute( $controller, $c, $sarg );
- } else {
- $rc = $sclass->execute( $controller, $c );
- }
- if ( $rc eq 0 ) {
- return $self->_unsupported_media_type( $c, $content_type );
- } elsif ( $rc ne 1 ) {
- return $self->_serialize_bad_request( $c, $content_type, $rc );
+ eval {
+ if ( defined($sarg) ) {
+ $rc = $sobj->execute( $controller, $c, $sarg );
+ } else {
+ $rc = $sobj->execute( $controller, $c );
+ }
+ };
+ if ($@) {
+ return $self->serialize_bad_request( $c, $content_type, $@ );
+ } elsif (!$rc) {
+ return $self->unsupported_media_type( $c, $content_type );
}
return 1;
}
+__PACKAGE__->meta->make_immutable;
+
1;
=head1 NAME
=head1 CONFIGURATION
-=over 4
+=head2 map
-=item default
+Takes a hashref, mapping Content-Types to a given serializer plugin.
-The Content-Type of the default Serialization format. This must be a
-Content-Type associated with a plugin in the "map" section below.
+=head2 default
-This is used if a requested content-type is not recognized.
+This is the 'fall-back' Content-Type if none of the requested or acceptable
+types is found in the L</map>. It must be an entry in the L</map>.
-=item stash_key
+=head2 stash_key
-We will serialize the data that lives in this location in the stash. So
-if the value is "rest", we will serialize the data under:
+Specifies the key of the stash entry holding the data that is to be serialized.
+So if the value is "rest", we will serialize the data under:
$c->stash->{'rest'}
-=item map
+=head2 content_type_stash_key
-Takes a hashref, mapping Content-Types to a given plugin.
+Specifies the key of the stash entry that optionally holds an overriding
+Content-Type. If set, and if the specified stash entry has a valid value,
+then it takes priority over the requested content types.
-=back
+This can be useful if you want to dynamically force a particular content type,
+perhaps for debugging.
=head1 HELPFUL PEOPLE
Daisuke Maki pointed out that early versions of this Action did not play
well with others, or generally behave in a way that was very consistent
-with the rest of Catalyst.
+with the rest of Catalyst.
+
+=head1 CUSTOM ERRORS
+
+For building custom error responses when serialization fails, you can create
+an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
+C<end> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
+methods.
=head1 SEE ALSO
L<Catalyst::Action::Deserialize>, L<Catalyst::Action::REST>
-=head1 AUTHOR
-
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+=head1 AUTHORS
-Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
+See L<Catalyst::Action::REST> for authors.
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
-