X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FSerialize.pm;h=057cc39e1d20bcbcee145277669431deecf36163;hb=b74200b31daa4a059b0f1555f2d9e079f35d08ff;hp=1f6db7d1d09e8d06b7791678490693c72793b66c;hpb=def65dcc8983843dd6da4a40e03ee6fbded2b69a;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/Serialize.pm b/lib/Catalyst/Action/Serialize.pm index 1f6db7d..057cc39 100644 --- a/lib/Catalyst/Action/Serialize.pm +++ b/lib/Catalyst/Action/Serialize.pm @@ -1,18 +1,18 @@ -# -# Catlyst::Action::Serialize.pm -# Created by: Adam Jacob, Marchex, -# -# $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 MRO::Compat; +has _encoders => ( + is => 'ro', + isa => 'HashRef', + default => sub { {} }, +); + sub execute { my $self = shift; my ( $controller, $c ) = @_; @@ -20,9 +20,20 @@ sub 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)$/; + return 1 if defined $c->stash->{current_view}; + return 1 if defined $c->stash->{current_view_instance}; + + # on 3xx responses, serialize if there's something to + # serialize, no-op if not + my $stash_key = ( + $controller->{'serialize'} ? + $controller->{'serialize'}->{'stash_key'} : + $controller->{'stash_key'} + ) || 'rest'; + return 1 if $c->response->status =~ /^(?:3\d\d)$/ && ! defined $c->stash->{$stash_key}; my ( $sclass, $sarg, $content_type ) = $self->_load_content_plugins( "Catalyst::Action::Serialize", @@ -32,28 +43,35 @@ sub execute { $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 @@ -108,7 +126,7 @@ Takes a hashref, mapping Content-Types to a given serializer plugin. This is the 'fall-back' Content-Type if none of the requested or acceptable types is found in the L. It must be an entry in the L. -=head2 stash_key +=head2 stash_key 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: @@ -128,7 +146,14 @@ perhaps for debugging. 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 to apply it to the +C action) which overrides C and/or C +methods. =head1 SEE ALSO @@ -137,15 +162,12 @@ a sensible set of defaults for doing a REST controller. L, L -=head1 AUTHOR +=head1 AUTHORS -Adam Jacob , with lots of help from mst and jrockway - -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +See L for authors. =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut -