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

diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm
index f071d8f..cbd2095 100644
--- a/lib/Catalyst/Action/REST.pm
+++ b/lib/Catalyst/Action/REST.pm
@@ -1,47 +1,221 @@
-#
-# REST.pm
-# Created by: Adam Jacob, Marchex, <adam@marchex.com>
-# Created on: 10/12/2006 03:00:32 PM PDT
-#
-# $Id$
-
 package Catalyst::Action::REST;
 
-use strict;
-use warnings;
+use Moose;
+use namespace::autoclean;
 
-use base 'Catalyst::Action';
+extends 'Catalyst::Action';
 use Class::Inspector;
+use Catalyst::Request::REST;
+use Catalyst::Controller::REST;
+
+BEGIN { require 5.008001; }
+
+our $VERSION = '0.82';
+$VERSION = eval $VERSION;
+
+sub new {
+  my $class  = shift;
+  my $config = shift;
+  Catalyst::Request::REST->_insert_self_into( $config->{class} );
+  return $class->next::method($config, @_);
+}
+
+=head1 NAME
+
+Catalyst::Action::REST - Automated REST Method Dispatching
+
+=head1 SYNOPSIS
+
+    sub foo :Local :ActionClass('REST') {
+      ... do setup for HTTP method specific handlers ...
+    }
+
+    sub foo_GET {
+      ... do something for GET requests ...
+    }
+
+    # alternatively use an Action
+    sub foo_PUT : Action {
+      ... do something for PUT requests ...
+    }
+
+=head1 DESCRIPTION
+
+This Action handles doing automatic method dispatching for REST requests.  It
+takes a normal Catalyst action, and changes the dispatch to append an
+underscore and method name.  First it will try dispatching to an action with
+the generated name, and failing that it will try to dispatch to a regular
+method.
+
+For example, in the synopsis above, calling GET on "/foo" would result in
+the foo_GET method being dispatched.
+
+If a method is requested that is not implemented, this action will
+return a status 405 (Method Not Found).  It will populate the "Allow" header
+with the list of implemented request methods.  You can override this behavior
+by implementing a custom 405 handler like so:
+
+   sub foo_not_implemented {
+      ... handle not implemented methods ...
+   }
+
+If you do not provide an _OPTIONS subroutine, we will automatically respond
+with a 200 OK.  The "Allow" header will be populated with the list of
+implemented request methods.
+
+It is likely that you really want to look at L<Catalyst::Controller::REST>,
+which brings this class together with automatic Serialization of requests
+and responses.
+
+When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
+role to your request class.
+
+=head1 METHODS
+
+=over 4
+
+=item dispatch
+
+This method overrides the default dispatch mechanism to the re-dispatching
+mechanism described above.
+
+=cut
 
 sub dispatch {
-    my ( $self, $c ) = @_;
-
-    my $controller = $self->class;
-    my $method = $self->name . "_" . uc($c->request->method);
-    if ($controller->can($method)) {
-        return $controller->$method($c);
-    } else {
-        $self->_return_405($c);
-        return $c->execute( $self->class, $self );
+    my $self = shift;
+    my $c    = shift;
+
+    my $controller = $c->component( $self->class );
+    my $rest_method = $self->name . "_" . uc( $c->request->method );
+
+    my ($code, $name);
+
+    # Common case, for foo_GET etc
+    if ( $code = $controller->action_for($rest_method) ) {
+        $c->execute( $self->class, $self, @{ $c->req->args } );
+        return $c->forward( $code,  $c->req->args );
+     } elsif ($code = $controller->can($rest_method)) {
+        # Exceute normal action
+        $c->execute( $self->class, $self, @{ $c->req->args } );
+        $name = $rest_method;
     }
-}
 
-sub _return_405 {
-    my ( $self, $c ) = @_;
-
-    my $controller = $self->class;
-    my $methods = Class::Inspector->methods($controller);
-    my @allowed;
-    foreach my $method (@{$methods}) {
-        my $name = $self->name;
-        if ($method =~ /^$name\_(.+)$/) {
-            push(@allowed, $1);
-        }
+    # Generic handling for foo_OPTIONS
+    if (!$code && $c->request->method eq "OPTIONS") {
+        $name = $rest_method;
+        $code = sub { $self->_return_options($self->name, @_) };
     }
+
+    # Otherwise, not implemented.
+    if (!$code) {
+        $name = $self->name . "_not_implemented";
+        $code = $controller->can($name) # User method
+            # Generic not implemented
+            || sub { $self->_return_not_implemented($self->name, @_) };
+    }
+
+    # localise stuff so we can dispatch the action 'as normal, but get
+    # different stats shown, and different code run.
+    local $self->{code} = $code;
+    local $self->{reverse} = $name;
+
+    $c->execute( $self->class, $self, @{ $c->req->args } );
+}
+
+sub _get_allowed_methods {
+    my ( $self, $controller, $c, $name ) = @_;
+    my $class = ref($controller) ? ref($controller) : $controller;
+    my $methods = Class::Inspector->methods($class);
+    return map { /^$name\_(.+)$/ } @$methods;
+};
+
+sub _return_options {
+    my ( $self, $method_name, $controller, $c) = @_;
+    my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
+    $c->response->content_type('text/plain');
+    $c->response->status(200);
+    $c->response->header( 'Allow' => \@allowed );
+}
+
+sub _return_not_implemented {
+    my ( $self, $method_name, $controller, $c ) = @_;
+
+    my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
     $c->response->content_type('text/plain');
     $c->response->status(405);
-    $c->response->header('Allow' => \@allowed);
-    $c->response->body("Method " . $c->request->method . " not implemented for " . $c->uri_for($self->reverse));
+    $c->response->header( 'Allow' => \@allowed );
+    $c->response->body( "Method "
+          . $c->request->method
+          . " not implemented for "
+          . $c->uri_for( $method_name ) );
 }
 
 1;
+
+=back
+
+=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.
+
+This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
+your request class.  If you're writing a webapp which provides RESTful
+responses and still needs to accommodate web browsers, you may prefer to use
+L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
+
+L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
+
+=head1 TROUBLESHOOTING
+
+=over 4
+
+=item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
+
+A:  Most likely, you haven't set Content-type equal to "application/json", or
+one of the accepted return formats.  You can do this by setting it in your query
+accepted return formats.  You can do this by setting it in your query string
+thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
+
+B<NOTE> Apache will refuse %2F unless configured otherwise.
+Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
+for this to run smoothly.
+
+=back
+
+=head1 AUTHOR
+
+Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
+
+Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
+
+=head1 CONTRIBUTORS
+
+Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
+
+John Goulah
+
+Christopher Laco
+
+Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
+
+Hans Dieter Pearcey
+
+Dave Rolsky E<lt>autarch@urth.orgE<gt>
+
+Luke Saunders
+
+Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
+
+J. Shirley E<lt>jshirley@gmail.comE<gt>
+
+=head1 COPYRIGHT
+
+Copyright the above named AUTHOR and CONTRIBUTORS
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+