Merge

[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 54ade49..b9e84cf 100644 (file)
--- a/lib/Catalyst/Action/REST.pm
+++ b/lib/Catalyst/Action/REST.pm
@@ -1,6 +1,6 @@
 #
 # REST.pm
-# Created by: Adam Jacob, Marchex, <adam@marchex.com>
+# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
 # Created on: 10/12/2006 03:00:32 PM PDT
 #
 # $Id$
@@ -12,10 +12,20 @@ use warnings;
 
 use base 'Catalyst::Action';
 use Class::Inspector;
-use 5.8.1;
+use Catalyst;
+use Catalyst::Request::REST;
+use Catalyst::Controller::REST;
 
-my 
-$VERSION = '0.1';
+BEGIN { require 5.008001; }
+
+our $VERSION = '0.71';
+
+sub new {
+  my $class  = shift;
+  my $config = shift;
+  Catalyst::Request::REST->_insert_self_into( $config->{class} );
+  return $class->SUPER::new($config, @_);
+}
 
 =head1 NAME
 
@@ -23,7 +33,9 @@ Catalyst::Action::REST - Automated REST Method Dispatching
 
 =head1 SYNOPSIS
 
-    sub foo :Local :ActionClass('REST') {}
+    sub foo :Local :ActionClass('REST') {
+      ... do setup for HTTP method specific handlers ...
+    }
 
     sub foo_GET { 
       ... do something for GET requests ...
@@ -44,7 +56,23 @@ 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.
+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, the request class will be changed to
+L<Catalyst::Request::REST>.
 
 =head1 METHODS
 
@@ -56,21 +84,40 @@ This method overrides the default dispatch mechanism to the re-dispatching
 mechanism described above.
 
 =cut
+
 sub dispatch {
     my $self = shift;
-    my $c = shift;
+    my $c    = shift;
 
-    my $controller = $self->class;
+    my $controller = $c->component( $self->class );
     my $method     = $self->name . "_" . uc( $c->request->method );
     if ( $controller->can($method) ) {
-        return $controller->$method($c, @{$c->req->args});
+        $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, @{$c->req->args} );
+        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;
@@ -82,6 +129,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 );
@@ -102,12 +156,49 @@ a sensible set of defaults for a controller doing REST.
 
 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 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
+
+
+
+
+=head1 MAINTAINER
+
+J. Shirley <jshirley@gmail.com>
+
+=head1 CONTRIBUTORS
+
+Christopher Laco
+
+Luke Saunders
+
+John Goulah
+
+Daisuke Maki <daisuke@endeworks.jp>
+
 =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
+