X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Action-REST.git;a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=cbd2095e2091486cbaf00c81bde68fdd5c8cf741;hp=9411ac279dfc9b9bcda60d2bf99d50b8a2bbd4f6;hb=3bb36dcaabf34fef5c15b1bb74c5eb198a7f5168;hpb=5e87ec47cf8d08513f3f59195941786d89f2ab10 diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index 9411ac2..cbd2095 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -1,21 +1,24 @@ -# -# REST.pm -# Created by: Adam Jacob, Marchex, -# Created on: 10/12/2006 03:00:32 PM PDT -# -# $Id$ - package Catalyst::Action::REST; -use strict; -use warnings; +use Moose; +use namespace::autoclean; -use base 'Catalyst::Action'; +extends 'Catalyst::Action'; use Class::Inspector; -use 5.8.1; +use Catalyst::Request::REST; +use Catalyst::Controller::REST; + +BEGIN { require 5.008001; } -our -$VERSION = '0.2'; +our $VERSION = '0.82'; +$VERSION = eval $VERSION; + +sub new { + my $class = shift; + my $config = shift; + Catalyst::Request::REST->_insert_self_into( $config->{class} ); + return $class->next::method($config, @_); +} =head1 NAME @@ -27,25 +30,28 @@ Catalyst::Action::REST - Automated REST Method Dispatching ... do setup for HTTP method specific handlers ... } - sub foo_GET { + sub foo_GET { ... 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. -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 +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: @@ -61,6 +67,9 @@ 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, it adds the L +role to your request class. + =head1 METHODS =over 4 @@ -76,60 +85,69 @@ sub dispatch { my $self = shift; my $c = shift; - my $controller = $self->class; - my $method = $self->name . "_" . uc( $c->request->method ); - if ( $controller->can($method) ) { + my $controller = $c->component( $self->class ); + my $rest_method = $self->name . "_" . uc( $c->request->method ); + + my ($code, $name); + + # Common case, for foo_GET etc + 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 } ); - return $controller->$method( $c, @{ $c->req->args } ); - } else { - 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); - } - } + $name = $rest_method; + } + + # Generic handling for foo_OPTIONS + if (!$code && $c->request->method eq "OPTIONS") { + $name = $rest_method; + $code = sub { $self->_return_options($self->name, @_) }; } + + # Otherwise, not implemented. + if (!$code) { + $name = $self->name . "_not_implemented"; + $code = $controller->can($name) # User method + # Generic not implemented + || sub { $self->_return_not_implemented($self->name, @_) }; + } + + # localise stuff so we can dispatch the action 'as normal, but get + # different stats shown, and different code run. + local $self->{code} = $code; + local $self->{reverse} = $name; + + $c->execute( $self->class, $self, @{ $c->req->args } ); } -sub _return_options { - my ( $self, $c ) = @_; +sub _get_allowed_methods { + my ( $self, $controller, $c, $name ) = @_; + my $class = ref($controller) ? ref($controller) : $controller; + my $methods = Class::Inspector->methods($class); + return map { /^$name\_(.+)$/ } @$methods; +}; - my @allowed = $self->_get_allowed_methods($c); +sub _return_options { + my ( $self, $method_name, $controller, $c) = @_; + 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 ); } -sub _get_allowed_methods { - my ( $self, $c ) = @_; - - my $controller = $self->class; - my $methods = Class::Inspector->methods($controller); - my @allowed; - foreach my $method ( @{$methods} ) { - my $name = $self->name; - if ( $method =~ /^$name\_(.+)$/ ) { - push( @allowed, $1 ); - } - } - return @allowed; -} - sub _return_not_implemented { - my ( $self, $c ) = @_; + my ( $self, $method_name, $controller, $c ) = @_; - my @allowed = $self->_get_allowed_methods($c); + 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 ); $c->response->body( "Method " . $c->request->method . " not implemented for " - . $c->uri_for( $self->reverse ) ); + . $c->uri_for( $method_name ) ); } 1; @@ -138,20 +156,62 @@ sub _return_not_implemented { =head1 SEE ALSO -You likely want to look at L, which implements -a sensible set of defaults for a controller doing REST. +You likely want to look at L, which implements a +sensible set of defaults for a controller doing REST. + +This class automatically adds the L role to +your request class. If you're writing a webapp which provides RESTful +responses and still needs to accommodate web browsers, you may prefer to use +L instead. 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 +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 Apache will refuse %2F unless configured otherwise. +Make sure C is in your httpd.conf file in order +for this to run smoothly. + +=back + =head1 AUTHOR -Adam Jacob , with lots of help from mst and jrockway +Adam Jacob Eadam@stalecoffee.orgE, with lots of help from mst and jrockway + +Marchex, Inc. paid me while I developed this module. (L) + +=head1 CONTRIBUTORS + +Tomas Doran (t0m) Ebobtfish@bobtfish.netE + +John Goulah + +Christopher Laco + +Daisuke Maki Edaisuke@endeworks.jpE + +Hans Dieter Pearcey + +Dave Rolsky Eautarch@urth.orgE + +Luke Saunders + +Arthur Axel "fREW" Schmidt Efrioux@gmail.comE -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +J. Shirley Ejshirley@gmail.comE -=head1 CONTRIBUTERS +=head1 COPYRIGHT -Daisuke Maki +Copyright the above named AUTHOR and CONTRIBUTORS =head1 LICENSE