X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=ccbc657f119f9413dfc3bc8fdc113370eefa0d2f;hb=7566d72f425ab3a870f1d6c8945c43f4edeedf2a;hp=30e4369bee00a36880b267af6b13102fa7ac9929;hpb=ad46030d0708d0bd6a5ae048efa956eed0105874;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index 30e4369..ccbc657 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -10,14 +10,14 @@ use Catalyst::Controller::REST; BEGIN { require 5.008001; } -our $VERSION = '0.86'; +our $VERSION = '1.13'; $VERSION = eval $VERSION; -sub new { - my $class = shift; - my $config = shift; - Catalyst::Request::REST->_insert_self_into( $config->{class} ); - return $class->next::method($config, @_); +sub BUILDARGS { + my $class = shift; + my $config = shift; + Catalyst::Request::REST->_insert_self_into( $config->{class} ); + return $class->SUPER::BUILDARGS($config, @_); } =head1 NAME @@ -61,7 +61,8 @@ by implementing a custom 405 handler like so: 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. +implemented request methods. If you do not provide an _HEAD either, we will +auto dispatch to the _GET one in case it exists. It is likely that you really want to look at L, which brings this class together with automatic Serialization of requests @@ -85,63 +86,94 @@ sub dispatch { my $self = shift; my $c = shift; - my $controller = $c->component( $self->class ); my $rest_method = $self->name . "_" . uc( $c->request->method ); + return $self->_dispatch_rest_method( $c, $rest_method ); +} + +sub _dispatch_rest_method { + my $self = shift; + my $c = shift; + my $rest_method = shift; + my $req = $c->request; + + my $controller = $c->component( $self->class ); + my ($code, $name); + # Execute normal 'foo' action. + $c->execute( $self->class, $self, @{ $req->args } ); + # Common case, for foo_GET etc if ( $code = $controller->action_for($rest_method) ) { - $c->execute( $self->class, $self, @{ $c->req->args } ); # Execute normal 'foo' action. - return $c->forward( $code, $c->req->args ); # Forward to foo_GET if it's an action - } - elsif ($code = $controller->can($rest_method)) { - # Exceute normal action - $c->execute( $self->class, $self, @{ $c->req->args } ); - $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below. + return $c->forward( $code, $req->args ); # Forward to foo_GET if it's an action } - - # Generic handling for foo_OPTIONS - if (!$code && $c->request->method eq "OPTIONS") { - $name = $rest_method; - $code = sub { $self->_return_options($self->name, @_) }; + elsif ($code = $controller->can($rest_method)) { + $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below. } - # Otherwise, not implemented. + # Generic handling for foo_* if (!$code) { - $name = $self->name . "_not_implemented"; - $code = $controller->can($name) # User method - # Generic not implemented - || sub { $self->_return_not_implemented($self->name, @_) }; + my $code_action = { + OPTIONS => sub { + $name = $rest_method; + $code = sub { $self->_return_options($self->name, @_) }; + }, + HEAD => sub { + $rest_method =~ s{_HEAD$}{_GET}i; + $self->_dispatch_rest_method($c, $rest_method); + }, + default => sub { + # Otherwise, not implemented. + $name = $self->name . "_not_implemented"; + $code = $controller->can($name) # User method + # Generic not implemented + || sub { $self->_return_not_implemented($self->name, @_) }; + }, + }; + my ( $http_method, $action_name ) = ( $rest_method, $self->name ); + $http_method =~ s{\Q$action_name\E\_}{}; + my $respond = ($code_action->{$http_method} + || $code_action->{'default'})->(); + return $respond unless $name; } # localise stuff so we can dispatch the action 'as normal, but get # different stats shown, and different code run. + # Also get the full path for the action, and make it look like a forward local $self->{code} = $code; - local $self->{reverse} = $name; + my @name = split m{/}, $self->reverse; + $name[-1] = $name; + local $self->{reverse} = "-> " . join('/', @name); - $c->execute( $self->class, $self, @{ $c->req->args } ); + $c->execute( $self->class, $self, @{ $req->args } ); } -sub _get_allowed_methods { +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 $methods = { + map { /^$name\_(.+)$/ ? ( $1 => 1 ) : () } + @{ Class::Inspector->methods($class) } + }; + $methods->{'HEAD'} = 1 if $methods->{'GET'}; + delete $methods->{'not_implemented'}; + return sort keys %$methods; }; sub _return_options { my ( $self, $method_name, $controller, $c) = @_; - my @allowed = $self->_get_allowed_methods($controller, $c, $method_name); + 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 ); + $c->response->body(q{}); } sub _return_not_implemented { my ( $self, $method_name, $controller, $c ) = @_; - my @allowed = $self->_get_allowed_methods($controller, $c, $method_name); + 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 ); @@ -151,6 +183,8 @@ sub _return_not_implemented { . $c->uri_for( $method_name ) ); } +__PACKAGE__->meta->make_immutable; + 1; =back @@ -161,7 +195,7 @@ 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 +your request class. If you're writing a web application which provides RESTful responses and still needs to accommodate web browsers, you may prefer to use L instead. @@ -202,6 +236,8 @@ Daisuke Maki Edaisuke@endeworks.jpE Hans Dieter Pearcey +Brian Phillips Ebphillips@cpan.orgE + Dave Rolsky Eautarch@urth.orgE Luke Saunders @@ -210,9 +246,17 @@ Arthur Axel "fREW" Schmidt Efrioux@gmail.comE J. Shirley Ejshirley@gmail.comE +Gavin Henry Eghenry@surevoip.co.ukE + +Gerv http://www.gerv.net/ + +Colin Newell + +Wallace Reis Ewreis@cpan.orgE + =head1 COPYRIGHT -Copyright the above named AUTHOR and CONTRIBUTORS +Copyright (c) 2006-2012 the above named AUTHOR and CONTRIBUTORS =head1 LICENSE