X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=f8621da07cdde3a6ef84f9ffcdcb2936b114a418;hb=fec6d454787f6a7c23d1b6a7151a009a3ba0907b;hp=54ade4905ba211f2a273d4f249de5ed9811d21f4;hpb=bb4130f6a50a3fee070d2ce81311fb019166d3a5;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index 54ade49..f8621da 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -1,6 +1,6 @@ # # REST.pm -# Created by: Adam Jacob, Marchex, +# Created by: Adam Jacob, Marchex, # Created on: 10/12/2006 03:00:32 PM PDT # # $Id$ @@ -12,10 +12,19 @@ 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.67'; + +# This is wrong in several ways. First, there's no guarantee that +# Catalyst.pm has not been subclassed. Two, there's no guarantee that +# the user isn't already using their request subclass. +Catalyst->request_class('Catalyst::Request::REST') + unless Catalyst->request_class->isa('Catalyst::Request::REST'); =head1 NAME @@ -23,7 +32,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 +55,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, +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. =head1 METHODS @@ -56,21 +83,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 +128,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 +155,29 @@ a sensible set of defaults for a controller doing REST. L, L +=head1 MAINTAINER + +J. Shirley + +=head1 CONTRIBUTORS + +Christopher Laco + +Luke Saunders + +John Goulah + +Daisuke Maki + =head1 AUTHOR Adam Jacob , 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 +