X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FDeserialize.pm;h=5be60f3513ff0e35dde87584ee12a4e8df81f252;hb=9819a955ab18ead8943cc8a912dcddcacbade74b;hp=24aac2a72a1418fa44a76f693d64856cf57267e4;hpb=be3c588afb1dd6d6c8e6171c01c3d38afa75d6d5;p=catagits%2FCatalyst-Action-REST.git

diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm
index 24aac2a..5be60f3 100644
--- a/lib/Catalyst/Action/Deserialize.pm
+++ b/lib/Catalyst/Action/Deserialize.pm
@@ -1,26 +1,38 @@
-#
-# Catlyst::Action::Deserialize
-# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
-#
-# $Id$
-
 package Catalyst::Action::Deserialize;
 
-use strict;
-use warnings;
+use Moose;
+use namespace::autoclean;
 
-use base 'Catalyst::Action::SerializeBase';
+extends 'Catalyst::Action::SerializeBase';
 use Module::Pluggable::Object;
-
-__PACKAGE__->mk_accessors(qw(plugins));
+use MRO::Compat;
+use Moose::Util::TypeConstraints;
+
+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 );
@@ -32,17 +44,19 @@ 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 );
         }
     }
 
-    $self->NEXT::execute(@_);
+    $self->maybe::next::method(@_);
 
     return 1;
 }
 
+__PACKAGE__->meta->make_immutable;
+
 =head1 NAME
 
 Catalyst::Action::Deserialize - Deserialize Data in a Request
@@ -64,11 +78,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<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>.
@@ -87,6 +117,43 @@ Will work just fine.
 When you use this module, the request class will be changed to
 L<Catalyst::Request::REST>.
 
+=head1 RFC 7231 Compliance Mode
+
+To maintain backwards compatibility with the module's original functionality,
+where it was assumed the deserialize and serialize content types are the same,
+an optional compliance mode can be enabled to break this assumption.
+
+    __PACKAGE__->config(
+        'compliance_mode'    => 1,
+        'default'            => 'text/x-yaml',
+        'stash_key'          => 'rest',
+        'map'                => {
+            'text/x-yaml'        => 'YAML',
+            'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
+        },
+        'deserialize_default => 'application/json',
+        'deserialize_map'    => {
+            'application/json'   => 'JSON',
+        },
+    );
+
+Three extra keys are added to the controller configuration. compliance_mode, a
+boolean to enable the mode. And a parallel set of content type mappings
+'deserialize_default' and 'deserialize_map' to mirror the default/map
+configuration keys.
+
+The module will use the default/map keys when negotiating the serializing
+content type specified by the client in the Accept header. And will use the
+deserialize_default/deserialize_map in conjunction with the Content-Type
+header where the client is giving the content type being sent in the request.
+
+=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
@@ -94,16 +161,12 @@ a sensible set of defaults for a controller doing REST.
 
 L<Catalyst::Action::Serialize>, L<Catalyst::Action::REST>
 
-=head1 AUTHOR
-
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+=head1 AUTHORS
 
-Marchex, Inc. paid me while I developed this module.  (http://www.marchex.com)
+See L<Catalyst::Action::REST> for authors.
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =cut
-
-1;