1 package Catalyst::Action::Deserialize;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::SerializeBase';
7 use Module::Pluggable::Object;
9 use Moose::Util::TypeConstraints;
13 has plugins => ( is => 'rw' );
15 has deserialize_http_methods => (
18 my $tc = subtype as 'HashRef[Str]';
19 coerce $tc, from 'ArrayRef[Str]',
20 via { +{ map { ($_ => 1) } @$_ } };
24 builder => '_build_deserialize_http_methods',
26 deserialize_http_methods => 'keys',
27 _deserialize_handles_http_method => 'exists',
31 sub _build_deserialize_http_methods { [qw(POST PUT OPTIONS DELETE)] }
35 my ( $controller, $c ) = @_;
37 if ( !defined($c->req->data) && $self->_deserialize_handles_http_method($c->request->method) ) {
38 my ( $sclass, $sarg, $content_type ) =
39 $self->_load_content_plugins( 'Catalyst::Action::Deserialize',
41 return 1 unless defined($sclass);
43 if ( defined($sarg) ) {
44 $rc = $sclass->execute( $controller, $c, $sarg );
46 $rc = $sclass->execute( $controller, $c );
49 return $self->unsupported_media_type( $c, $content_type );
50 } elsif ( $rc ne "1" ) {
51 return $self->serialize_bad_request( $c, $content_type, $rc );
55 $self->maybe::next::method(@_);
60 __PACKAGE__->meta->make_immutable;
64 Catalyst::Action::Deserialize - Deserialize Data in a Request
68 package Foo::Controller::Bar;
71 'default' => 'text/x-yaml',
72 'stash_key' => 'rest',
74 'text/x-yaml' => 'YAML',
75 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
79 sub begin :ActionClass('Deserialize') {}
83 This action will deserialize HTTP POST, PUT, OPTIONS and DELETE requests.
84 It assumes that the body of the HTTP Request is a serialized object.
85 The serializer is selected by introspecting the requests content-type
88 If you want deserialize any other HTTP method besides POST, PUT,
89 OPTIONS and DELETE you can do this by setting the
90 C<< deserialize_http_methods >> list via C<< action_args >>.
91 Just modify the config in your controller and define a list of HTTP
92 methods the deserialization should happen for:
97 deserialize_http_methods => [qw(POST PUT OPTIONS DELETE GET)]
102 See also L<Catalyst::Controller/action_args>.
104 The specifics of deserializing each content-type is implemented as
105 a plugin to L<Catalyst::Action::Deserialize>. You can see a list
106 of currently implemented plugins in L<Catalyst::Controller::REST>.
108 The results of your Deserializing will wind up in $c->req->data.
109 This is done through the magic of L<Catalyst::Request::REST>.
111 While it is common for this Action to be called globally as a
112 C<begin> method, there is nothing stopping you from using it on a
115 sub foo :Local :Action('Deserialize') {}
119 When you use this module, the request class will be changed to
120 L<Catalyst::Request::REST>.
124 For building custom error responses when de-serialization fails, you can create
125 an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
126 C<begin> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
131 You likely want to look at L<Catalyst::Controller::REST>, which implements
132 a sensible set of defaults for a controller doing REST.
134 L<Catalyst::Action::Serialize>, L<Catalyst::Action::REST>
138 See L<Catalyst::Action::REST> for authors.
142 You may distribute this code under the same terms as Perl itself.