1 package Catalyst::Action::REST;
5 use namespace::autoclean;
7 extends 'Catalyst::Action';
9 use Catalyst::Request::REST;
10 use Catalyst::Controller::REST;
12 BEGIN { require 5.008001; }
17 Catalyst::Request::REST->_insert_self_into( $config->{class} );
18 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. If you do not provide an _HEAD either, we will
65 auto dispatch to the _GET one in case it exists.
67 It is likely that you really want to look at L<Catalyst::Controller::REST>,
68 which brings this class together with automatic Serialization of requests
71 When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
72 role to your request class.
80 This method overrides the default dispatch mechanism to the re-dispatching
81 mechanism described above.
89 my $rest_method = $self->name . "_" . uc( $c->request->method );
91 return $self->_dispatch_rest_method( $c, $rest_method );
94 sub _dispatch_rest_method {
97 my $rest_method = shift;
98 my $req = $c->request;
100 my $controller = $c->component( $self->class );
104 # Execute normal 'foo' action.
105 $c->execute( $self->class, $self, @{ $req->args } );
107 # Common case, for foo_GET etc
108 if ( $code = $controller->action_for($rest_method) ) {
109 return $c->forward( $code, $req->args ); # Forward to foo_GET if it's an action
111 elsif ($code = $controller->can($rest_method)) {
112 $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below.
115 # Generic handling for foo_*
119 $name = $rest_method;
120 $code = sub { $self->_return_options($self->name, @_) };
123 $rest_method =~ s{_HEAD$}{_GET}i;
124 $self->_dispatch_rest_method($c, $rest_method);
127 # Otherwise, not implemented.
128 $name = $self->name . "_not_implemented";
129 $code = $controller->can($name) # User method
130 # Generic not implemented
131 || sub { $self->_return_not_implemented($self->name, @_) };
134 my ( $http_method, $action_name ) = ( $rest_method, $self->name );
135 $http_method =~ s{\Q$action_name\E\_}{};
136 my $respond = ($code_action->{$http_method}
137 || $code_action->{'default'})->();
138 return $respond unless $name;
141 # localise stuff so we can dispatch the action 'as normal, but get
142 # different stats shown, and different code run.
143 # Also get the full path for the action, and make it look like a forward
144 local $self->{code} = $code;
145 my @name = split m{/}, $self->reverse;
147 local $self->{reverse} = "-> " . join('/', @name);
149 $c->execute( $self->class, $self, @{ $req->args } );
152 sub get_allowed_methods {
153 my ( $self, $controller, $c, $name ) = @_;
154 my $class = ref($controller) ? ref($controller) : $controller;
156 map { /^$name\_(.+)$/ ? ( $1 => 1 ) : () }
157 @{ Class::Inspector->methods($class) }
159 $methods->{'HEAD'} = 1 if $methods->{'GET'};
160 delete $methods->{'not_implemented'};
161 return sort keys %$methods;
164 sub _return_options {
165 my ( $self, $method_name, $controller, $c) = @_;
166 my @allowed = $self->get_allowed_methods($controller, $c, $method_name);
167 $c->response->content_type('text/plain');
168 $c->response->status(200);
169 $c->response->header( 'Allow' => \@allowed );
170 $c->response->body(q{});
173 sub _return_not_implemented {
174 my ( $self, $method_name, $controller, $c ) = @_;
176 my @allowed = $self->get_allowed_methods($controller, $c, $method_name);
177 $c->response->content_type('text/plain');
178 $c->response->status(405);
179 $c->response->header( 'Allow' => \@allowed );
180 $c->response->body( "Method "
181 . $c->request->method
182 . " not implemented for "
183 . $c->uri_for( $method_name ) );
186 __PACKAGE__->meta->make_immutable;
194 You likely want to look at L<Catalyst::Controller::REST>, which implements a
195 sensible set of defaults for a controller doing REST.
197 This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
198 your request class. If you're writing a web application which provides RESTful
199 responses and still needs to accommodate web browsers, you may prefer to use
200 L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
202 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
204 =head1 TROUBLESHOOTING
208 =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
210 A: Most likely, you haven't set Content-type equal to "application/json", or
211 one of the accepted return formats. You can do this by setting it in your query
212 accepted return formats. You can do this by setting it in your query string
213 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
215 B<NOTE> Apache will refuse %2F unless configured otherwise.
216 Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
217 for this to run smoothly.
223 Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
225 Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
229 Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
235 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
239 Brian Phillips E<lt>bphillips@cpan.orgE<gt>
241 Dave Rolsky E<lt>autarch@urth.orgE<gt>
245 Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
247 J. Shirley E<lt>jshirley@gmail.comE<gt>
249 Gavin Henry E<lt>ghenry@surevoip.co.ukE<gt>
251 Gerv http://www.gerv.net/
253 Colin Newell <colin@opusvl.com>
255 Wallace Reis E<lt>wreis@cpan.orgE<gt>
257 André Walker (andrewalker) <andre@cpan.org>
261 Copyright (c) 2006-2015 the above named AUTHOR and CONTRIBUTORS
265 You may distribute this code under the same terms as Perl itself.