-#
-# Catlyst::Action::Serialize.pm
-# Created by: Adam Jacob, Marchex, <adam@marchex.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 = '0.82';
+$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 scalar @{ $c->error };
return 1 if $c->response->status =~ /^(?:204|3\d\d)$/;
- my ($sclass, $sarg, $content_type) = $self->_load_content_plugins("Catalyst::Action::Serialize", $controller, $c);
- return 1 unless defined $sclass;
+ my ( $sclass, $sarg, $content_type ) =
+ $self->_load_content_plugins( "Catalyst::Action::Serialize",
+ $controller, $c );
+ unless ( defined($sclass) ) {
+ if ( defined($content_type) ) {
+ $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");
+ }
+ 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 );
+ 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 );
}
- 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);
- }
return 1;
}
-1;
+__PACKAGE__->meta->make_immutable;
=head1 NAME
package Foo::Controller::Bar;
__PACKAGE__->config(
- serialize => {
- 'default' => 'YAML',
- 'stash_key' => 'rest',
- 'map' => {
- 'text/x-yaml' => 'YAML',
- 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
- },
+ 'default' => 'text/x-yaml',
+ 'stash_key' => 'rest',
+ 'map' => {
+ 'text/html' => [ 'View', 'TT', ],
+ 'text/x-yaml' => 'YAML',
+ 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
}
);
This action will serialize the body of an HTTP Response. The serializer is
selected by introspecting the HTTP Requests content-type header.
-It requires that your Catalyst controller have a "serialize" entry
-in it's configuration, which sets up the mapping between Content Type's
-and Serialization classes.
+It requires that your Catalyst controller is properly configured to set up the
+mapping between Content Type's and Serialization classes.
-The specifics of serializing each content-type is implemented as
-a plugin to L<Catalyst::Action::Serialize>.
+The specifics of serializing each content-type is implemented as a plugin to
+L<Catalyst::Action::Serialize>.
Typically, you would use this ActionClass on your C<end> method. However,
nothing is stopping you from choosing specific methods to Serialize:
.. populate stash with data ..
}
+When you use this module, the request class will be changed to
+L<Catalyst::Request::REST>.
+
=head1 CONFIGURATION
-=over 4
+=head2 map
-=item default
+Takes a hashref, mapping Content-Types to a given serializer plugin.
-The default Serialization format. See the next section for
-available options. This is used if a requested content-type
-is not recognized.
+=head2 default
-=item stash_key
+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>.
-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:
+=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:
$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 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
projects / catagits/Catalyst-Action-REST.git / blobdiff