r42@latte: adam | 2006-11-30 23:59:03 -0800

[catagits/Catalyst-Action-REST.git] / lib / Catalyst / Action / REST.pm

diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm
index d04fa0d..fe63ee9 100644 (file)
--- a/lib/Catalyst/Action/REST.pm
+++ b/lib/Catalyst/Action/REST.pm
@@ -12,21 +12,86 @@ use warnings;
 
 use base 'Catalyst::Action';
 use Class::Inspector;
+use 5.8.1;
+
+our
+$VERSION = '0.2';
+
+=head1 NAME
+
+Catalyst::Action::REST - Automated REST Method Dispatching
+
+=head1 SYNOPSIS
+
+    sub foo :Local :ActionClass('REST') {}
+
+    sub foo_GET { 
+      ... do something for GET requests ...
+    }
+
+    sub foo_PUT { 
+      ... do somethign 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. 
+
+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.
+
+It is likely that you really want to look at L<Catalyst::Controller::REST>.
+
+=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 $self = shift;
+    my $c    = shift;
 
     my $controller = $self->class;
     my $method     = $self->name . "_" . uc( $c->request->method );
     if ( $controller->can($method) ) {
-        return $controller->$method($c);
+        $c->execute( $self->class, $self, @{ $c->req->args } );
+        return $controller->$method( $c, @{ $c->req->args } );
     } else {
-        $self->_return_405($c);
-        return $c->execute( $self->class, $self );
+        if ( $c->request->method eq "OPTIONS" ) {
+            return $self->_return_options($c);
+        } else {
+            my $handle_ni = $self->name . "_not_implemented";
+            if ( $controller->can($handle_ni) ) {
+                return $controller->$handle_ni( $c, @{ $c->req->args } );
+            } else {
+                return $self->_return_not_implemented($c);
+            }
+        }
     }
 }
 
-sub _return_405 {
+sub _return_options {
+    my ( $self, $c ) = @_;
+
+    my @allowed = $self->_get_allowed_methods($c);
+    $c->response->content_type('text/plain');
+    $c->response->status(200);
+    $c->response->header( 'Allow' => \@allowed );
+}
+
+sub _get_allowed_methods {
     my ( $self, $c ) = @_;
 
     my $controller = $self->class;
@@ -38,6 +103,13 @@ sub _return_405 {
             push( @allowed, $1 );
         }
     }
+    return @allowed;
+}
+
+sub _return_not_implemented {
+    my ( $self, $c ) = @_;
+
+    my @allowed = $self->_get_allowed_methods($c);
     $c->response->content_type('text/plain');
     $c->response->status(405);
     $c->response->header( 'Allow' => \@allowed );
@@ -48,3 +120,29 @@ sub _return_405 {
 }
 
 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.
+
+L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
+
+=head1 AUTHOR
+
+Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+
+Marchex, Inc. paid me while I developed this module.  (http://www.marchex.com)
+
+=head1 CONTRIBUTERS
+
+Daisuke Maki <daisuke@endeworks.jp>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+