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;
98 my $controller = $c->component( $self->class );
102 # Execute normal 'foo' action.
103 $c->execute( $self->class, $self, @{ $c->req->args } );
105 # Common case, for foo_GET etc
106 if ( $code = $controller->action_for($rest_method) ) {
107 return $c->forward( $code, $c->req->args ); # Forward to foo_GET if it's an action
109 elsif ($code = $controller->can($rest_method)) {
110 $name = $rest_method; # Stash name and code to run 'foo_GET' like an action below.
113 # Generic handling for foo_OPTIONS
115 if ( $c->request->method eq "OPTIONS") {
116 $name = $rest_method;
117 $code = sub { $self->_return_options($self->name, @_) };
120 # Otherwise, not implemented.
121 $name = $self->name . "_not_implemented";
122 $code = $controller->can($name) # User method
123 # Generic not implemented
124 || sub { $self->_return_not_implemented($self->name, @_) };
128 # localise stuff so we can dispatch the action 'as normal, but get
129 # different stats shown, and different code run.
130 # Also get the full path for the action, and make it look like a forward
131 local $self->{code} = $code;
132 my @name = split m{/}, $self->reverse;
134 local $self->{reverse} = "-> " . join('/', @name);
136 $c->execute( $self->class, $self, @{ $c->req->args } );
139 sub _get_allowed_methods {
140 my ( $self, $controller, $c, $name ) = @_;
141 my $class = ref($controller) ? ref($controller) : $controller;
142 my $methods = Class::Inspector->methods($class);
143 return map { /^$name\_(.+)$/ } @$methods;
146 sub _return_options {
147 my ( $self, $method_name, $controller, $c) = @_;
148 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
149 $c->response->content_type('text/plain');
150 $c->response->status(200);
151 $c->response->header( 'Allow' => \@allowed );
154 sub _return_not_implemented {
155 my ( $self, $method_name, $controller, $c ) = @_;
157 my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
158 $c->response->content_type('text/plain');
159 $c->response->status(405);
160 $c->response->header( 'Allow' => \@allowed );
161 $c->response->body( "Method "
162 . $c->request->method
163 . " not implemented for "
164 . $c->uri_for( $method_name ) );
167 __PACKAGE__->meta->make_immutable;
175 You likely want to look at L<Catalyst::Controller::REST>, which implements a
176 sensible set of defaults for a controller doing REST.
178 This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
179 your request class. If you're writing a web application which provides RESTful
180 responses and still needs to accommodate web browsers, you may prefer to use
181 L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
183 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
185 =head1 TROUBLESHOOTING
189 =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
191 A: Most likely, you haven't set Content-type equal to "application/json", or
192 one of the accepted return formats. You can do this by setting it in your query
193 accepted return formats. You can do this by setting it in your query string
194 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
196 B<NOTE> Apache will refuse %2F unless configured otherwise.
197 Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
198 for this to run smoothly.
204 Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
206 Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
210 Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
216 Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
220 Brian Phillips E<lt>bphillips@cpan.orgE<gt>
222 Dave Rolsky E<lt>autarch@urth.orgE<gt>
226 Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
228 J. Shirley E<lt>jshirley@gmail.comE<gt>
230 Gavin Henry E<lt>ghenry@surevoip.co.ukE<gt>
232 Gerv http://www.gerv.net/
234 Colin Newell <colin@opusvl.com>
238 Copyright (c) 2006-2012 the above named AUTHOR and CONTRIBUTORS
242 You may distribute this code under the same terms as Perl itself.