X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Action-REST.git;a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FDeserialize.pm;h=ead726dd645c7e3a6c7bd0656bc86f3886e922af;hp=2d778b4e836821db15ac258f6bc155c91ffe93c4;hb=3bb36dcaabf34fef5c15b1bb74c5eb198a7f5168;hpb=7ad87df957f65463dba321ebe616e2581b7ff58f diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm index 2d778b4..ead726d 100644 --- a/lib/Catalyst/Action/Deserialize.pm +++ b/lib/Catalyst/Action/Deserialize.pm @@ -1,71 +1,105 @@ -# -# Catlyst::Action::Deserialize -# Created by: Adam Jacob, Marchex, -# -# $Id$ - package Catalyst::Action::Deserialize; -use strict; -use warnings; +use Moose; +use namespace::autoclean; -use base 'Catalyst::Action'; +extends 'Catalyst::Action::SerializeBase'; use Module::Pluggable::Object; -use Catalyst::Request::REST; +use MRO::Compat; + +our $VERSION = '0.82'; +$VERSION = eval $VERSION; -__PACKAGE__->mk_accessors(qw(plugins)); +has plugins => ( is => 'rw' ); sub execute { my $self = shift; - my ( $controller, $c, $test ) = @_; - - my $nreq = bless($c->request, 'Catalyst::Request::REST'); - $c->request($nreq); - - unless(defined($self->plugins)) { - my $mpo = Module::Pluggable::Object->new( - 'require' => 1, - 'search_path' => [ 'Catalyst::Action::Deserialize' ], - ); - my @plugins = $mpo->plugins; - $self->plugins(\@plugins); - } - my $content_type = $c->request->content_type; - my $sclass = 'Catalyst::Action::Deserialize::'; - my $sarg; - my $map = $controller->serialize->{'map'}; - if (exists($map->{$content_type})) { - my $mc; - if (ref($map->{$content_type}) eq "ARRAY") { - $mc = $map->{$content_type}->[0]; - $sarg = $map->{$content_type}->[1]; - } else { - $mc = $map->{$content_type}; - } - $sclass .= $mc; - if (! grep(/^$sclass$/, @{$self->plugins})) { - die "Cannot find plugin $sclass for $content_type!"; - } - } else { - if (exists($controller->serialize->{'default'})) { - $sclass .= $controller->serialize->{'default'}; - } else { - die "I cannot find a default serializer!"; - } - } + my ( $controller, $c ) = @_; my @demethods = qw(POST PUT OPTIONS); - my $method = $c->request->method; - if (grep /^$method$/, @demethods) { - if (defined($sarg)) { - $sclass->execute($controller, $c, $sarg); + my $method = $c->request->method; + if ( grep /^$method$/, @demethods ) { + my ( $sclass, $sarg, $content_type ) = + $self->_load_content_plugins( 'Catalyst::Action::Deserialize', + $controller, $c ); + return 1 unless defined($sclass); + my $rc; + if ( defined($sarg) ) { + $rc = $sclass->execute( $controller, $c, $sarg ); } else { - $sclass->execute($controller, $c); + $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 ); } - $self->NEXT::execute( @_, ); - } else { - $self->NEXT::execute( @_ ); } -}; -1; + $self->maybe::next::method(@_); + + return 1; +} + +__PACKAGE__->meta->make_immutable; + +=head1 NAME + +Catalyst::Action::Deserialize - Deserialize Data in a Request + +=head1 SYNOPSIS + + package Foo::Controller::Bar; + + __PACKAGE__->config( + 'default' => 'text/x-yaml', + 'stash_key' => 'rest', + 'map' => { + 'text/x-yaml' => 'YAML', + 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ], + }, + ); + + sub begin :ActionClass('Deserialize') {} + +=head1 DESCRIPTION + +This action will deserialize HTTP POST, PUT, and OPTIONS requests. +It assumes that the body of the HTTP Request is a serialized object. +The serializer is selected by introspecting the requests content-type +header. + +The specifics of deserializing each content-type is implemented as +a plugin to L. You can see a list +of currently implemented plugins in L. + +The results of your Deserializing will wind up in $c->req->data. +This is done through the magic of L. + +While it is common for this Action to be called globally as a +C method, there is nothing stopping you from using it on a +single routine: + + sub foo :Local :Action('Deserialize') {} + +Will work just fine. + +When you use this module, the request class will be changed to +L. + +=head1 SEE ALSO + +You likely want to look at L, which implements +a sensible set of defaults for a controller doing REST. + +L, L + +=head1 AUTHORS + +See L for authors. + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut