X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=b9e84cfdf28642e6ed0c21087d4fda77820a9b68;hb=888f25e36f418362daee8528b6af555dbee134b3;hp=f071d8f1c641e856e36033d86f27fd4f91393758;hpb=7ad87df957f65463dba321ebe616e2581b7ff58f;p=catagits%2FCatalyst-Action-Serialize-Data-Serializer.git diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index f071d8f..b9e84cf 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,36 +12,193 @@ 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.71'; + +sub new { + my $class = shift; + my $config = shift; + Catalyst::Request::REST->_insert_self_into( $config->{class} ); + return $class->SUPER::new($config, @_); +} + +=head1 NAME + +Catalyst::Action::REST - Automated REST Method Dispatching + +=head1 SYNOPSIS + + sub foo :Local :ActionClass('REST') { + ... do setup for HTTP method specific handlers ... + } + + 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. 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 + +=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 $controller = $c->component( $self->class ); + my $method = $self->name . "_" . uc( $c->request->method ); + if ( $controller->can($method) ) { + $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; - 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 ); } } + 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); - $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, which implements +a sensible set of defaults for a controller doing REST. + +L, L + +=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 + +=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 +