X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FDeserialize.pm;h=e856d5c82c39cf527f8b843d9b55eb9616294401;hb=3d1e10e70eb17bd02ed4c3ba440fce3a94696833;hp=e1a134b62f6f382e103866fa92dfbd0340255a77;hpb=ab8ab47a739539677817d6a7493b888c7a7815f6;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm index e1a134b..e856d5c 100644 --- a/lib/Catalyst/Action/Deserialize.pm +++ b/lib/Catalyst/Action/Deserialize.pm @@ -6,19 +6,36 @@ use namespace::autoclean; extends 'Catalyst::Action::SerializeBase'; use Module::Pluggable::Object; use MRO::Compat; +use Moose::Util::TypeConstraints; -our $VERSION = '0.85'; +our $VERSION = '1.10'; $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 DELETE); - 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 ); @@ -30,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 ); } } @@ -64,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. @@ -87,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