X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=f3c99dbf4f6413ac95d25ccee611fbfb376bcd5c;hb=28463ece18fecf94d353479a6d2b07fc0388fd42;hp=5c0d1125c5270927c6a507b323e471c2ce632c11;hpb=7328f0ab3294f5e6546109a7aff256b7d2a898c4;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index 5c0d112..f3c99db 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -12,10 +12,17 @@ use warnings; use base 'Catalyst::Action'; use Class::Inspector; +use Catalyst::Request::REST; use 5.8.1; -my -$VERSION = '0.1'; +our + $VERSION = '0.41'; + +# 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 +30,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 +53,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,20 +81,40 @@ 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 $controller = $c->component($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; @@ -81,6 +126,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 ); @@ -105,8 +157,15 @@ L, L Adam Jacob , 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 + =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut +