X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FREST.pm;h=ea6a6c8e4d8d2786c008b03a567587b32478bc56;hb=2fd04833bede1413a73d037414c57dcf01bbae94;hp=fd1278f1a84e7077b8ef1307d91660b4d0529383;hpb=29f9721bfe883351594c7d664e3778a36ceaeb27;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index fd1278f..ea6a6c8 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -1,5 +1,6 @@ package Catalyst::Action::REST; +use utf8; use Moose; use namespace::autoclean; @@ -10,9 +11,6 @@ use Catalyst::Controller::REST; BEGIN { require 5.008001; } -our $VERSION = '0.94'; -$VERSION = eval $VERSION; - sub BUILDARGS { my $class = shift; my $config = shift; @@ -20,6 +18,8 @@ sub BUILDARGS { return $class->SUPER::BUILDARGS($config, @_); } +=encoding utf-8 + =head1 NAME Catalyst::Action::REST - Automated REST Method Dispatching @@ -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 @@ -94,64 +95,85 @@ 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 + return $c->forward( $code, $req->args ); # Forward to foo_GET if it's an action } elsif ($code = $controller->can($rest_method)) { - # Execute 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. } - # Generic handling for foo_OPTIONS + # Generic handling for foo_* if (!$code) { - if ( $c->request->method eq "OPTIONS") { - $name = $rest_method; - $code = sub { $self->_return_options($self->name, @_) }; - } - else { - # 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 $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 ); @@ -224,9 +246,19 @@ 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 + +André Walker (andrewalker) + =head1 COPYRIGHT -Copyright (c) 2006-2011 the above named AUTHOR and CONTRIBUTORS +Copyright (c) 2006-2015 the above named AUTHOR and CONTRIBUTORS =head1 LICENSE