Commit | Line | Data |
256c894f |
1 | # |
2 | # REST.pm |
be3c588a |
3 | # Created by: Adam Jacob, Marchex, <adam@hjksolutions.com> |
256c894f |
4 | # Created on: 10/12/2006 03:00:32 PM PDT |
5 | # |
6 | # $Id$ |
7 | |
8 | package Catalyst::Action::REST; |
9 | |
10 | use strict; |
11 | use warnings; |
12 | |
13 | use base 'Catalyst::Action'; |
7ad87df9 |
14 | use Class::Inspector; |
d4611771 |
15 | use Catalyst; |
9a76221e |
16 | use Catalyst::Request::REST; |
ebba5325 |
17 | use Catalyst::Controller::REST; |
18 | |
9c5c9bd1 |
19 | BEGIN { require 5.008001; } |
256c894f |
20 | |
e74d969d |
21 | our $VERSION = '0.73'; |
9a76221e |
22 | |
5132f5e4 |
23 | sub new { |
24 | my $class = shift; |
25 | my $config = shift; |
37694e6c |
26 | Catalyst::Request::REST->_insert_self_into( $config->{class} ); |
5132f5e4 |
27 | return $class->SUPER::new($config, @_); |
28 | } |
7328f0ab |
29 | |
30 | =head1 NAME |
31 | |
32 | Catalyst::Action::REST - Automated REST Method Dispatching |
33 | |
34 | =head1 SYNOPSIS |
35 | |
5e87ec47 |
36 | sub foo :Local :ActionClass('REST') { |
37 | ... do setup for HTTP method specific handlers ... |
38 | } |
7328f0ab |
39 | |
afa581cf |
40 | sub foo_GET { |
7328f0ab |
41 | ... do something for GET requests ... |
42 | } |
43 | |
afa581cf |
44 | sub foo_PUT { |
7328f0ab |
45 | ... do somethign for PUT requests ... |
46 | } |
47 | |
48 | =head1 DESCRIPTION |
49 | |
50 | This Action handles doing automatic method dispatching for REST requests. It |
51 | takes a normal Catalyst action, and changes the dispatch to append an |
afa581cf |
52 | underscore and method name. |
7328f0ab |
53 | |
54 | For example, in the synopsis above, calling GET on "/foo" would result in |
55 | the foo_GET method being dispatched. |
56 | |
afa581cf |
57 | If a method is requested that is not implemented, this action will |
58 | return a status 405 (Method Not Found). It will populate the "Allow" header |
5e87ec47 |
59 | with the list of implemented request methods. You can override this behavior |
60 | by implementing a custom 405 handler like so: |
61 | |
62 | sub foo_not_implemented { |
63 | ... handle not implemented methods ... |
64 | } |
65 | |
66 | If you do not provide an _OPTIONS subroutine, we will automatically respond |
67 | with a 200 OK. The "Allow" header will be populated with the list of |
68 | implemented request methods. |
7328f0ab |
69 | |
5e87ec47 |
70 | It is likely that you really want to look at L<Catalyst::Controller::REST>, |
71 | which brings this class together with automatic Serialization of requests |
72 | and responses. |
398c5a1b |
73 | |
9a76221e |
74 | When you use this module, the request class will be changed to |
75 | L<Catalyst::Request::REST>. |
76 | |
7328f0ab |
77 | =head1 METHODS |
78 | |
79 | =over 4 |
80 | |
81 | =item dispatch |
82 | |
83 | This method overrides the default dispatch mechanism to the re-dispatching |
84 | mechanism described above. |
85 | |
86 | =cut |
d34c067a |
87 | |
256c894f |
88 | sub dispatch { |
bb4130f6 |
89 | my $self = shift; |
d34c067a |
90 | my $c = shift; |
256c894f |
91 | |
2f91bf68 |
92 | my $controller = $c->component( $self->class ); |
eccb2137 |
93 | my $method = $self->name . "_" . uc( $c->request->method ); |
679978b1 |
94 | |
95 | if (my $code = $controller->can($method)) { |
96 | $c->execute( $self->class, $self, @{ $c->req->args } ) if $code; |
97 | local $self->{reverse} = $self->{reverse} . "_" . uc( $c->request->method ); |
98 | local $self->{code} = $code; |
99 | |
100 | return $c->execute( $self->class, $self, @{ $c->req->args } ); |
256c894f |
101 | } |
679978b1 |
102 | if ($c->request->method eq "OPTIONS") { |
103 | local $self->{reverse} = $self->{reverse} . "_" . uc( $c->request->method ); |
104 | local $self->{code} = sub { $self->can('_return_options')->($self->name, @_) }; |
105 | return $c->execute( $self->class, $self, @{ $c->req->args } ); |
106 | } |
107 | my $not_implemented_method = $self->name . "_not_implemented"; |
108 | local $self->{code} = $controller->can($not_implemented_method) |
109 | || sub { $self->can('_return_not_implemented')->($self->name, @_); }; |
256c894f |
110 | |
679978b1 |
111 | local $self->{reverse} = $not_implemented_method; |
d34c067a |
112 | |
679978b1 |
113 | $c->execute( $self->class, $self, @{ $c->req->args } ); |
d34c067a |
114 | } |
115 | |
679978b1 |
116 | my $_get_allowed_methods = sub { |
117 | my ( $controller, $c, $name ) = @_; |
118 | my $class = ref($controller) ? ref($controller) : $controller; |
119 | my $methods = Class::Inspector->methods($class); |
7ad87df9 |
120 | my @allowed; |
eccb2137 |
121 | foreach my $method ( @{$methods} ) { |
eccb2137 |
122 | if ( $method =~ /^$name\_(.+)$/ ) { |
123 | push( @allowed, $1 ); |
7ad87df9 |
124 | } |
125 | } |
d34c067a |
126 | return @allowed; |
679978b1 |
127 | }; |
128 | |
129 | sub _return_options { |
130 | my ( $method_name, $controller, $c) = @_; |
131 | my @allowed = $controller->$_get_allowed_methods($c, $method_name); |
132 | $c->response->content_type('text/plain'); |
133 | $c->response->status(200); |
134 | $c->response->header( 'Allow' => \@allowed ); |
d34c067a |
135 | } |
136 | |
137 | sub _return_not_implemented { |
679978b1 |
138 | my ( $method_name, $controller, $c ) = @_; |
d34c067a |
139 | |
679978b1 |
140 | my @allowed = $controller->$_get_allowed_methods($c, $method_name); |
7ad87df9 |
141 | $c->response->content_type('text/plain'); |
142 | $c->response->status(405); |
eccb2137 |
143 | $c->response->header( 'Allow' => \@allowed ); |
144 | $c->response->body( "Method " |
145 | . $c->request->method |
146 | . " not implemented for " |
679978b1 |
147 | . $c->uri_for( $method_name ) ); |
7ad87df9 |
148 | } |
149 | |
256c894f |
150 | 1; |
7328f0ab |
151 | |
152 | =back |
153 | |
154 | =head1 SEE ALSO |
155 | |
156 | You likely want to look at L<Catalyst::Controller::REST>, which implements |
157 | a sensible set of defaults for a controller doing REST. |
158 | |
159 | L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize> |
160 | |
5d7480da |
161 | =head1 TROUBLESHOOTING |
162 | |
163 | =over 4 |
164 | |
165 | =item Q: I'm getting a "415 Unsupported Media Type" error. What gives?! |
166 | |
167 | A: Most likely, you haven't set Content-type equal to "application/json", or one of the |
168 | accepted return formats. You can do this by setting it in your query string thusly: |
6df7d0ae |
169 | ?content-type=application%2Fjson (where %2F == / uri escaped). |
170 | |
171 | **NOTE** Apache will refuse %2F unless configured otherise. |
172 | Make sure AllowEncodedSlashes On is in your httpd.conf file in order for this to run smoothly. |
5d7480da |
173 | |
174 | =cut |
175 | |
176 | =cut |
177 | |
178 | |
179 | |
180 | |
2f7533ed |
181 | =head1 MAINTAINER |
7328f0ab |
182 | |
2f7533ed |
183 | J. Shirley <jshirley@gmail.com> |
7328f0ab |
184 | |
2f7533ed |
185 | =head1 CONTRIBUTORS |
398c5a1b |
186 | |
2f7533ed |
187 | Christopher Laco |
188 | |
189 | Luke Saunders |
190 | |
191 | John Goulah |
33e5de96 |
192 | |
193 | Daisuke Maki <daisuke@endeworks.jp> |
194 | |
2f7533ed |
195 | =head1 AUTHOR |
196 | |
197 | Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway |
198 | |
199 | Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) |
200 | |
7328f0ab |
201 | =head1 LICENSE |
202 | |
203 | You may distribute this code under the same terms as Perl itself. |
204 | |
205 | =cut |
d34c067a |
206 | |