Additional pod cleanups

[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 e9ca9b0..7adc6b2 100644 (file)
--- a/lib/Catalyst/Action/REST.pm
+++ b/lib/Catalyst/Action/REST.pm
@@ -12,19 +12,19 @@ use warnings;
 
 use base 'Catalyst::Action';
 use Class::Inspector;
-use Catalyst;
 use Catalyst::Request::REST;
 use Catalyst::Controller::REST;
 
 BEGIN { require 5.008001; }
 
-our $VERSION = '0.73';
+our $VERSION = '0.78';
+$VERSION = eval $VERSION;
 
 sub new {
   my $class  = shift;
   my $config = shift;
   Catalyst::Request::REST->_insert_self_into( $config->{class} );
-  return $class->SUPER::new($config, @_);
+  return $class->next::method($config, @_);
 }
 
 =head1 NAME
@@ -41,15 +41,18 @@ Catalyst::Action::REST - Automated REST Method Dispatching
       ... do something for GET requests ...
     }
 
-    sub foo_PUT {
-      ... do somethign for PUT 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.
+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.
@@ -95,7 +98,10 @@ sub dispatch {
     my ($code, $name);
 
     # Common case, for foo_GET etc
-    if ($code = $controller->can($rest_method)) {
+    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;
@@ -123,8 +129,8 @@ sub dispatch {
     $c->execute( $self->class, $self, @{ $c->req->args } );
 }
 
-my $_get_allowed_methods = sub {
-    my ( $controller, $c, $name ) = @_;
+sub _get_allowed_methods {
+    my ( $self, $controller, $c, $name ) = @_;
     my $class = ref($controller) ? ref($controller) : $controller;
     my $methods    = Class::Inspector->methods($class);
     my @allowed;
@@ -138,7 +144,7 @@ my $_get_allowed_methods = sub {
 
 sub _return_options {
     my ( $self, $method_name, $controller, $c) = @_;
-    my @allowed = $controller->$_get_allowed_methods($c, $method_name);
+    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 );
@@ -147,7 +153,7 @@ sub _return_options {
 sub _return_not_implemented {
     my ( $self, $method_name, $controller, $c ) = @_;
 
-    my @allowed = $controller->$_get_allowed_methods($c, $method_name);
+    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 );
@@ -174,26 +180,27 @@ L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
 
 =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 string thusly:
-?content-type=application%2Fjson (where %2F == / uri escaped). 
-
-**NOTE** Apache will refuse %2F unless configured otherise.
-Make sure AllowEncodedSlashes On is in your httpd.conf file in order for this to run smoothly.
-
-=cut
-
-=cut
+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 otherise.
+Make sure C<< AllowEncodedSlashes On >> is in your httpd.conf file in orde
+for this to run smoothly.
 
+=back
 
+=head1 AUTHOR
 
-=head1 MAINTAINER
+Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
 
-J. Shirley <jshirley@gmail.com>
+Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
 
 =head1 CONTRIBUTORS
 
+Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+
 Christopher Laco
 
 Luke Saunders
@@ -202,11 +209,15 @@ John Goulah
 
 Daisuke Maki <daisuke@endeworks.jp>
 
-=head1 AUTHOR
+J. Shirley <jshirley@gmail.com>
 
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+Hans Dieter Pearcey
+
+Tomas Doran (t0m) <bobtfish@bobtfish.net>
+
+=head1 COPYRIGHT
 
-Marchex, Inc. paid me while I developed this module.  (http://www.marchex.com)
+Copyright the above named AUTHOR and CONTRIBUTORS
 
 =head1 LICENSE