X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FDeserialize.pm;h=f978aac9160e5ac227cee300a5b196cfd205b409;hb=b3996af85ac6bea294c4d4b82167429f5694a694;hp=2d778b4e836821db15ac258f6bc155c91ffe93c4;hpb=7ad87df957f65463dba321ebe616e2581b7ff58f;p=catagits%2FCatalyst-Action-REST.git

diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm
index 2d778b4..f978aac 100644
--- a/lib/Catalyst/Action/Deserialize.pm
+++ b/lib/Catalyst/Action/Deserialize.pm
@@ -1,71 +1,145 @@
-#
-# Catlyst::Action::Deserialize
-# Created by: Adam Jacob, Marchex, <adam@marchex.com>
-#
-# $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;
+use Moose::Util::TypeConstraints;
+
+our $VERSION = '1.01';
+$VERSION = eval $VERSION;
+
+has plugins => ( is => 'rw' );
 
-__PACKAGE__->mk_accessors(qw(plugins));
+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, $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];
+    my ( $controller, $c ) = @_;
+
+    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 );
+        return 1 unless defined($sclass);
+        my $rc;
+        if ( defined($sarg) ) {
+            $rc = $sclass->execute( $controller, $c, $sarg );
         } else {
-            $mc = $map->{$content_type};
-        }
-        $sclass .= $mc;
-        if (! grep(/^$sclass$/, @{$self->plugins})) {
-            die "Cannot find plugin $sclass for $content_type!";
+            $rc = $sclass->execute( $controller, $c );
         }
-    } else {
-        if (exists($controller->serialize->{'default'})) {
-            $sclass .= $controller->serialize->{'default'};
-        } else {
-            die "I cannot find a default serializer!";
+        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 );
         }
     }
 
-    my @demethods = qw(POST PUT OPTIONS);
-    my $method = $c->request->method;
-    if (grep /^$method$/, @demethods) {
-        if (defined($sarg)) {
-            $sclass->execute($controller, $c, $sarg);
-        } else {
-            $sclass->execute($controller, $c);
+    $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, 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)]
+            }
         }
-        $self->NEXT::execute( @_, );
-    } else {
-        $self->NEXT::execute( @_ );
-    }
-};
+    );
+
+See also L<Catalyst::Controller/action_args>.
+
+The specifics of deserializing each content-type is implemented as
+a plugin to L<Catalyst::Action::Deserialize>.  You can see a list
+of currently implemented plugins in L<Catalyst::Controller::REST>.
+
+The results of your Deserializing will wind up in $c->req->data.
+This is done through the magic of L<Catalyst::Request::REST>.
+
+While it is common for this Action to be called globally as a
+C<begin> 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<Catalyst::Request::REST>.
+
+=head1 CUSTOM ERRORS
+
+For building custom error responses when de-serialization fails, you can create
+an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
+C<begin> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
+methods.
+
+=head1 SEE ALSO
+
+You likely want to look at L<Catalyst::Controller::REST>, which implements
+a sensible set of defaults for a controller doing REST.
+
+L<Catalyst::Action::Serialize>, L<Catalyst::Action::REST>
+
+=head1 AUTHORS
+
+See L<Catalyst::Action::REST> for authors.
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
 
-1;
+=cut