Adding a README

[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 f071d8f..9adb921 100644 (file)
--- a/lib/Catalyst/Action/REST.pm
+++ b/lib/Catalyst/Action/REST.pm
@@ -12,17 +12,63 @@ use warnings;
 
 use base 'Catalyst::Action';
 use Class::Inspector;
+use 5.8.1;
 
+my 
+$VERSION = '0.1';
+
+=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);
+    my $method     = $self->name . "_" . uc( $c->request->method );
+    if ( $controller->can($method) ) {
+        return $controller->$method($c, @{$c->req->args});
     } else {
         $self->_return_405($c);
-        return $c->execute( $self->class, $self );
+        return $c->execute( $self->class, $self, @{$c->req->args} );
     }
 }
 
@@ -30,18 +76,42 @@ sub _return_405 {
     my ( $self, $c ) = @_;
 
     my $controller = $self->class;
-    my $methods = Class::Inspector->methods($controller);
+    my $methods    = Class::Inspector->methods($controller);
     my @allowed;
-    foreach my $method (@{$methods}) {
+    foreach my $method ( @{$methods} ) {
         my $name = $self->name;
-        if ($method =~ /^$name\_(.+)$/) {
-            push(@allowed, $1);
+        if ( $method =~ /^$name\_(.+)$/ ) {
+            push( @allowed, $1 );
         }
     }
     $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( $self->reverse ) );
 }
 
 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 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut