X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FDeserialize.pm;h=a632e19198b88754bf5e170f94aff1705088514f;hb=7566d72f425ab3a870f1d6c8945c43f4edeedf2a;hp=3c90466ffd3a9499cd321fb2c503e5a1886fd8ac;hpb=930013e6f19b25a090c3f8839495ad8d9b15ff6d;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm index 3c90466..a632e19 100644 --- a/lib/Catalyst/Action/Deserialize.pm +++ b/lib/Catalyst/Action/Deserialize.pm @@ -6,16 +6,36 @@ use namespace::autoclean; extends 'Catalyst::Action::SerializeBase'; use Module::Pluggable::Object; use MRO::Compat; - -__PACKAGE__->mk_accessors(qw(plugins)); +use Moose::Util::TypeConstraints; + +our $VERSION = '1.13'; +$VERSION = eval $VERSION; + +has plugins => ( is => 'rw' ); + +has deserialize_http_methods => ( + traits => ['Hash'], + isa => do { + my $tc = subtype as 'HashRef[Str]'; + coerce $tc, from 'ArrayRef[Str]', + via { +{ map { ($_ => 1) } @$_ } }; + $tc; + }, + coerce => 1, + builder => '_build_deserialize_http_methods', + handles => { + deserialize_http_methods => 'keys', + _deserialize_handles_http_method => 'exists', + }, +); + +sub _build_deserialize_http_methods { [qw(POST PUT OPTIONS DELETE)] } sub execute { my $self = shift; my ( $controller, $c ) = @_; - my @demethods = qw(POST PUT OPTIONS); - my $method = $c->request->method; - if ( grep /^$method$/, @demethods ) { + if ( !defined($c->req->data) && $self->_deserialize_handles_http_method($c->request->method) ) { my ( $sclass, $sarg, $content_type ) = $self->_load_content_plugins( 'Catalyst::Action::Deserialize', $controller, $c ); @@ -27,9 +47,9 @@ sub execute { $rc = $sclass->execute( $controller, $c ); } if ( $rc eq "0" ) { - return $self->_unsupported_media_type( $c, $content_type ); + return $self->unsupported_media_type( $c, $content_type ); } elsif ( $rc ne "1" ) { - return $self->_serialize_bad_request( $c, $content_type, $rc ); + return $self->serialize_bad_request( $c, $content_type, $rc ); } } @@ -38,6 +58,8 @@ sub execute { return 1; } +__PACKAGE__->meta->make_immutable; + =head1 NAME Catalyst::Action::Deserialize - Deserialize Data in a Request @@ -59,11 +81,27 @@ Catalyst::Action::Deserialize - Deserialize Data in a Request =head1 DESCRIPTION -This action will deserialize HTTP POST, PUT, and OPTIONS requests. +This action will deserialize HTTP POST, PUT, OPTIONS and DELETE 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. +If you want deserialize any other HTTP method besides POST, PUT, +OPTIONS and DELETE you can do this by setting the +C<< deserialize_http_methods >> list via C<< action_args >>. +Just modify the config in your controller and define a list of HTTP +methods the deserialization should happen for: + + __PACKAGE__->config( + action_args => { + '*' => { + deserialize_http_methods => [qw(POST PUT OPTIONS DELETE GET)] + } + } + ); + +See also L. + 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. @@ -82,6 +120,13 @@ Will work just fine. When you use this module, the request class will be changed to L. +=head1 CUSTOM ERRORS + +For building custom error responses when de-serialization fails, you can create +an ActionRole (and use L to apply it to the +C action) which overrides C and/or C<_serialize_bad_request> +methods. + =head1 SEE ALSO You likely want to look at L, which implements @@ -98,5 +143,3 @@ See L for authors. You may distribute this code under the same terms as Perl itself. =cut - -1;