lib/Catalyst/Action/Deserialize.pm

   1 package Catalyst::Action::Deserialize;
   2
   3 use Moose;
   4 use namespace::autoclean;
   5
   6 extends 'Catalyst::Action::SerializeBase';
   7 use Module::Pluggable::Object;
   8 use MRO::Compat;
   9
  10 our $VERSION = '0.81';
  11 $VERSION = eval $VERSION;
  12
  13 has plugins => ( is => 'rw' );
  14
  15 sub execute {
  16     my $self = shift;
  17     my ( $controller, $c ) = @_;
  18
  19     my @demethods = qw(POST PUT OPTIONS);
  20     my $method    = $c->request->method;
  21     if ( grep /^$method$/, @demethods ) {
  22         my ( $sclass, $sarg, $content_type ) =
  23           $self->_load_content_plugins( 'Catalyst::Action::Deserialize',
  24             $controller, $c );
  25         return 1 unless defined($sclass);
  26         my $rc;
  27         if ( defined($sarg) ) {
  28             $rc = $sclass->execute( $controller, $c, $sarg );
  29         } else {
  30             $rc = $sclass->execute( $controller, $c );
  31         }
  32         if ( $rc eq "0" ) {
  33             return $self->_unsupported_media_type( $c, $content_type );
  34         } elsif ( $rc ne "1" ) {
  35             return $self->_serialize_bad_request( $c, $content_type, $rc );
  36         }
  37     }
  38
  39     $self->maybe::next::method(@_);
  40
  41     return 1;
  42 }
  43
  44 __PACKAGE__->meta->make_immutable;
  45
  46 =head1 NAME
  47
  48 Catalyst::Action::Deserialize - Deserialize Data in a Request
  49
  50 =head1 SYNOPSIS
  51
  52     package Foo::Controller::Bar;
  53
  54     __PACKAGE__->config(
  55         'default'   => 'text/x-yaml',
  56         'stash_key' => 'rest',
  57         'map'       => {
  58             'text/x-yaml'        => 'YAML',
  59             'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
  60         },
  61     );
  62
  63     sub begin :ActionClass('Deserialize') {}
  64
  65 =head1 DESCRIPTION
  66
  67 This action will deserialize HTTP POST, PUT, and OPTIONS requests.
  68 It assumes that the body of the HTTP Request is a serialized object.
  69 The serializer is selected by introspecting the requests content-type
  70 header.
  71
  72 The specifics of deserializing each content-type is implemented as
  73 a plugin to L<Catalyst::Action::Deserialize>.  You can see a list
  74 of currently implemented plugins in L<Catalyst::Controller::REST>.
  75
  76 The results of your Deserializing will wind up in $c->req->data.
  77 This is done through the magic of L<Catalyst::Request::REST>.
  78
  79 While it is common for this Action to be called globally as a
  80 C<begin> method, there is nothing stopping you from using it on a
  81 single routine:
  82
  83    sub foo :Local :Action('Deserialize') {}
  84
  85 Will work just fine.
  86
  87 When you use this module, the request class will be changed to
  88 L<Catalyst::Request::REST>.
  89
  90 =head1 SEE ALSO
  91
  92 You likely want to look at L<Catalyst::Controller::REST>, which implements
  93 a sensible set of defaults for a controller doing REST.
  94
  95 L<Catalyst::Action::Serialize>, L<Catalyst::Action::REST>
  96
  97 =head1 AUTHORS
  98
  99 See L<Catalyst::Action::REST> for authors.
 100
 101 =head1 LICENSE
 102
 103 You may distribute this code under the same terms as Perl itself.
 104
 105 =cut