-#
-# REST.pm
-# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
-# 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 Catalyst;
use Catalyst::Request::REST;
use Catalyst::Controller::REST;
BEGIN { require 5.008001; }
-our $VERSION = '0.73';
+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->SUPER::new($config, @_);
+ return $class->next::method($config, @_);
}
=head1 NAME
... 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:
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<Catalyst::Request::REST>.
+When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
+role to your request class.
=head1 METHODS
my $c = shift;
my $controller = $c->component( $self->class );
- my $method = $self->name . "_" . uc( $c->request->method );
- if ( $controller->can($method) ) {
+ 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;
=head1 SEE ALSO
-You likely want to look at L<Catalyst::Controller::REST>, which implements
-a sensible set of defaults for a controller doing REST.
+You likely want to look at L<Catalyst::Controller::REST>, which implements a
+sensible set of defaults for a controller doing REST.
+
+This class automatically adds the L<Catalyst::TraitFor::Request::REST> 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<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
=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).
+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). >>
-**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
+B<NOTE> Apache will refuse %2F unless configured otherwise.
+Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
+for this to run smoothly.
-=cut
+=back
+=head1 AUTHOR
+Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
+Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
-=head1 MAINTAINER
+=head1 CONTRIBUTORS
-J. Shirley <jshirley@gmail.com>
+Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
-=head1 CONTRIBUTORS
+John Goulah
Christopher Laco
-Luke Saunders
+Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
-John Goulah
+Hans Dieter Pearcey
-Daisuke Maki <daisuke@endeworks.jp>
+Dave Rolsky E<lt>autarch@urth.orgE<gt>
-=head1 AUTHOR
+Luke Saunders
+
+Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
+
+J. Shirley E<lt>jshirley@gmail.comE<gt>
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+=head1 COPYRIGHT
-Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
+Copyright the above named AUTHOR and CONTRIBUTORS
=head1 LICENSE
projects / catagits/Catalyst-Action-REST.git / blobdiff