-#
-# 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 = '1.02';
+$VERSION = eval $VERSION;
-sub new {
- my $class = shift;
- my $config = shift;
- Catalyst::Request::REST->_insert_self_into( $config->{class} );
- return $class->SUPER::new($config, @_);
+sub BUILDARGS {
+ my $class = shift;
+ my $config = shift;
+ Catalyst::Request::REST->_insert_self_into( $config->{class} );
+ return $class->SUPER::BUILDARGS($config, @_);
}
=head1 NAME
... 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.
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 $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->can($rest_method)) {
- # Exceute normal action
- $c->execute( $self->class, $self, @{ $c->req->args } );
- $name = $rest_method;
+ if ( $code = $controller->action_for($rest_method) ) {
+ 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 $respond = ($code_action->{$req->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 {
my ( $self, $controller, $c, $name ) = @_;
my $class = ref($controller) ? ref($controller) : $controller;
- my $methods = Class::Inspector->methods($class);
- my @allowed;
- foreach my $method ( @{$methods} ) {
- if ( $method =~ /^$name\_(.+)$/ ) {
- push( @allowed, $1 );
- }
- }
- return @allowed;
+ my $methods = Class::Inspector->methods($class);
+ return map { /^$name\_(.+)$/ } @$methods;
};
sub _return_options {
$c->response->content_type('text/plain');
$c->response->status(200);
$c->response->header( 'Allow' => \@allowed );
+ $c->response->body(q{});
}
sub _return_not_implemented {
. $c->uri_for( $method_name ) );
}
+__PACKAGE__->meta->make_immutable;
+
1;
=back
=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 web application 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>
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<NOTE> Apache will refuse %2F unless configured otherise.
-Make sure C<< AllowEncodedSlashes On >> is in your httpd.conf file in orde
+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.
=back
-=head1 MAINTAINER
+=head1 AUTHOR
-Hans Dieter Pearcey
+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 CONTRIBUTORS
+Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
+
+John Goulah
+
Christopher Laco
+Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
+
+Hans Dieter Pearcey
+
+Brian Phillips E<lt>bphillips@cpan.orgE<gt>
+
+Dave Rolsky E<lt>autarch@urth.orgE<gt>
+
Luke Saunders
-John Goulah
+Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
-Daisuke Maki <daisuke@endeworks.jp>
+J. Shirley E<lt>jshirley@gmail.comE<gt>
-J. Shirley <jshirley@gmail.com>
+Gavin Henry E<lt>ghenry@surevoip.co.ukE<gt>
-Tomas Doran (t0m) <bobtfish@bobtfish.net>
+Gerv http://www.gerv.net/
-=head1 AUTHOR
+Colin Newell <colin@opusvl.com>
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+=head1 COPYRIGHT
-Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
+Copyright (c) 2006-2012 the above named AUTHOR and CONTRIBUTORS
=head1 LICENSE
projects / catagits/Catalyst-Action-REST.git / blobdiff