1 package Catalyst::Action::REST;
4 use namespace::autoclean;
6 extends 'Catalyst::Action';
8 use Catalyst::Request::REST;
9 use Catalyst::Controller::REST;
11 BEGIN { require 5.008001; }
13 our $VERSION = '1.02';
14 $VERSION = eval $VERSION;
19 Catalyst::Request::REST->_insert_self_into( $config->{class} );
20 return $class->SUPER::BUILDARGS($config, @_);
25 Catalyst::Action::REST - Automated REST Method Dispatching
29 sub foo :Local :ActionClass('REST') {
30 ... do setup for HTTP method specific handlers ...
34 ... do something for GET requests ...
37 # alternatively use an Action
38 sub foo_PUT : Action {
39 ... do something for PUT requests ...
44 This Action handles doing automatic method dispatching for REST requests. It
45 takes a normal Catalyst action, and changes the dispatch to append an
46 underscore and method name. First it will try dispatching to an action with
47 the generated name, and failing that it will try to dispatch to a regular
50 For example, in the synopsis above, calling GET on "/foo" would result in
51 the foo_GET method being dispatched.
53 If a method is requested that is not implemented, this action will
54 return a status 405 (Method Not Found). It will populate the "Allow" header
55 with the list of implemented request methods. You can override this behavior
56 by implementing a custom 405 handler like so:
58 sub foo_not_implemented {
59 ... handle not implemented methods ...
62 If you do not provide an _OPTIONS subroutine, we will automatically respond
63 with a 200 OK. The "Allow" header will be populated with the list of
64 implemented request methods.
66 It is likely that you really want to look at L<Catalyst::Controller::REST>,
67 which brings this class together with automatic Serialization of requests
70 When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
71 role to your request class.
79 This method overrides the default dispatch mechanism to the re-dispatching
80 mechanism described above.
88 my $rest_method = $self->name . "_" . uc( $c->request->method );
90 return $self->_dispatch_rest_method( $c, $rest_method );
93 sub _dispatch_rest_method {
96 my $rest_method = shift;
97 my $req = $c->request;
99 my $controller = $c->component( $self->class );
103 # Execute normal 'foo' action.
104 $c->execute( $self->class, $self, @{ $req->args } );
106 # Common case, for foo_GET etc
107 if ( $code = $controller->action_for($rest_method) ) {
108 return $c->forward( $code, $req->args ); # Forward to foo_GET if it's an action
110 elsif ($code = $controller->can($rest_method)) {
111 $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below.
114 # Generic handling for foo_*
118 $name = $rest_method;
119 $code = sub { $self->_return_options($self->name, @_) };
122 $rest_method =~ s{_HEAD$}{_GET}i;
123 $self->_dispatch_rest_method($c, $rest_method);
126 # Otherwise, not implemented.
127 $name = $self->name . "_not_implemented";
128 $code = $controller->can($name) # User method
129 # Generic not implemented
130 || sub { $self->_return_not_implemented($self->name, @_) };
133 my $respond = ($code_action->{$req->method}
134 || $code_action->{'default'})->();
135 return $respond unless $name;
138 # localise stuff so we can dispatch the action 'as normal, but get
139 # different stats shown, and different code run.
140 # Also get the full path for the action, and make it look like a forward
141 local $self->{code} = $code;
142 my @name = split m{/}, $self->reverse;
144 local $self->{reverse} = "-> " . join('/', @name);
146 $c->execute( $self->class, $self, @{ $req->args } );
149 sub _get_allowed_methods {
150 my ( $self, $controller, $c, $name ) = @_;
151 my $class = ref($controller) ? ref($controller) : $controller;
152 my $methods = Class::Inspector->methods($class);
153 return map { /^$name\_(.+)$/ } @$methods;
156 sub _return_options {
157 my ( $self, $method_name, $controller, $c) = @_;
158 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
159 $c->response->content_type('text/plain');
160 $c->response->status(200);
161 $c->response->header( 'Allow' => \@allowed );
164 sub _return_not_implemented {
165 my ( $self, $method_name, $controller, $c ) = @_;
167 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
168 $c->response->content_type('text/plain');
169 $c->response->status(405);
170 $c->response->header( 'Allow' => \@allowed );
171 $c->response->body( "Method "
172 . $c->request->method
173 . " not implemented for "
174 . $c->uri_for( $method_name ) );
177 __PACKAGE__->meta->make_immutable;
185 You likely want to look at L<Catalyst::Controller::REST>, which implements a
186 sensible set of defaults for a controller doing REST.
188 This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
189 your request class. If you're writing a web application which provides RESTful
190 responses and still needs to accommodate web browsers, you may prefer to use
191 L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
193 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
195 =head1 TROUBLESHOOTING
199 =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
201 A: Most likely, you haven't set Content-type equal to "application/json", or
202 one of the accepted return formats. You can do this by setting it in your query
203 accepted return formats. You can do this by setting it in your query string
204 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
206 B<NOTE> Apache will refuse %2F unless configured otherwise.
207 Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
208 for this to run smoothly.
214 Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
216 Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
220 Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
226 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
230 Brian Phillips E<lt>bphillips@cpan.orgE<gt>
232 Dave Rolsky E<lt>autarch@urth.orgE<gt>
236 Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
238 J. Shirley E<lt>jshirley@gmail.comE<gt>
240 Gavin Henry E<lt>ghenry@surevoip.co.ukE<gt>
242 Gerv http://www.gerv.net/
244 Colin Newell <colin@opusvl.com>
248 Copyright (c) 2006-2012 the above named AUTHOR and CONTRIBUTORS
252 You may distribute this code under the same terms as Perl itself.