Commit | Line | Data |
256c894f |
1 | package Catalyst::Controller::REST; |
930013e6 |
2 | use Moose; |
3 | use namespace::autoclean; |
256c894f |
4 | |
05b98ffc |
5 | our $VERSION = '1.06'; |
a66af307 |
6 | $VERSION = eval $VERSION; |
832e768d |
7 | |
398c5a1b |
8 | =head1 NAME |
9 | |
db8bb647 |
10 | Catalyst::Controller::REST - A RESTful controller |
398c5a1b |
11 | |
12 | =head1 SYNOPSIS |
13 | |
14 | package Foo::Controller::Bar; |
5cb5f6bb |
15 | use Moose; |
16 | use namespace::autoclean; |
259c53c7 |
17 | |
5cb5f6bb |
18 | BEGIN { extends 'Catalyst::Controller::REST' } |
398c5a1b |
19 | |
20 | sub thing : Local : ActionClass('REST') { } |
21 | |
22 | # Answer GET requests to "thing" |
23 | sub thing_GET { |
24 | my ( $self, $c ) = @_; |
db8bb647 |
25 | |
398c5a1b |
26 | # Return a 200 OK, with the data in entity |
db8bb647 |
27 | # serialized in the body |
398c5a1b |
28 | $self->status_ok( |
db8bb647 |
29 | $c, |
398c5a1b |
30 | entity => { |
31 | some => 'data', |
32 | foo => 'is real bar-y', |
33 | }, |
34 | ); |
35 | } |
36 | |
37 | # Answer PUT requests to "thing" |
db8bb647 |
38 | sub thing_PUT { |
ace04991 |
39 | my ( $self, $c ) = @_; |
40 | |
fcf45ed9 |
41 | $radiohead = $c->req->data->{radiohead}; |
259c53c7 |
42 | |
10bcd217 |
43 | $self->status_created( |
44 | $c, |
259c53c7 |
45 | location => $c->req->uri, |
10bcd217 |
46 | entity => { |
47 | radiohead => $radiohead, |
48 | } |
49 | ); |
259c53c7 |
50 | } |
398c5a1b |
51 | |
52 | =head1 DESCRIPTION |
53 | |
54 | Catalyst::Controller::REST implements a mechanism for building |
55 | RESTful services in Catalyst. It does this by extending the |
db8bb647 |
56 | normal Catalyst dispatch mechanism to allow for different |
57 | subroutines to be called based on the HTTP Method requested, |
398c5a1b |
58 | while also transparently handling all the serialization/deserialization for |
59 | you. |
60 | |
61 | This is probably best served by an example. In the above |
62 | controller, we have declared a Local Catalyst action on |
db8bb647 |
63 | "sub thing", and have used the ActionClass('REST'). |
398c5a1b |
64 | |
65 | Below, we have declared "thing_GET" and "thing_PUT". Any |
db8bb647 |
66 | GET requests to thing will be dispatched to "thing_GET", |
67 | while any PUT requests will be dispatched to "thing_PUT". |
398c5a1b |
68 | |
e601adda |
69 | Any unimplemented HTTP methods will be met with a "405 Method Not Allowed" |
70 | response, automatically containing the proper list of available methods. You |
71 | can override this behavior through implementing a custom |
db8bb647 |
72 | C<thing_not_implemented> method. |
e601adda |
73 | |
74 | If you do not provide an OPTIONS handler, we will respond to any OPTIONS |
75 | requests with a "200 OK", populating the Allowed header automatically. |
76 | |
77 | Any data included in C<< $c->stash->{'rest'} >> will be serialized for you. |
78 | The serialization format will be selected based on the content-type |
79 | of the incoming request. It is probably easier to use the L<STATUS HELPERS>, |
80 | which are described below. |
398c5a1b |
81 | |
10bcd217 |
82 | "The HTTP POST, PUT, and OPTIONS methods will all automatically |
83 | L<deserialize|Catalyst::Action::Deserialize> the contents of |
259c53c7 |
84 | C<< $c->request->body >> into the C<< $c->request->data >> hashref", based on |
10bcd217 |
85 | the request's C<Content-type> header. A list of understood serialization |
86 | formats is L<below|/AVAILABLE SERIALIZERS>. |
398c5a1b |
87 | |
e601adda |
88 | If we do not have (or cannot run) a serializer for a given content-type, a 415 |
db8bb647 |
89 | "Unsupported Media Type" error is generated. |
398c5a1b |
90 | |
91 | To make your Controller RESTful, simply have it |
92 | |
5cb5f6bb |
93 | BEGIN { extends 'Catalyst::Controller::REST' } |
398c5a1b |
94 | |
9cd203c9 |
95 | =head1 CONFIGURATION |
96 | |
97 | See L<Catalyst::Action::Serialize/CONFIGURATION>. Note that the C<serialize> |
98 | key has been deprecated. |
99 | |
398c5a1b |
100 | =head1 SERIALIZATION |
101 | |
102 | Catalyst::Controller::REST will automatically serialize your |
e601adda |
103 | responses, and deserialize any POST, PUT or OPTIONS requests. It evaluates |
104 | which serializer to use by mapping a content-type to a Serialization module. |
db8bb647 |
105 | We select the content-type based on: |
e601adda |
106 | |
5cb5f6bb |
107 | =over |
e601adda |
108 | |
109 | =item B<The Content-Type Header> |
110 | |
111 | If the incoming HTTP Request had a Content-Type header set, we will use it. |
112 | |
113 | =item B<The content-type Query Parameter> |
114 | |
115 | If this is a GET request, you can supply a content-type query parameter. |
116 | |
117 | =item B<Evaluating the Accept Header> |
118 | |
119 | Finally, if the client provided an Accept header, we will evaluate |
db8bb647 |
120 | it and use the best-ranked choice. |
e601adda |
121 | |
122 | =back |
123 | |
124 | =head1 AVAILABLE SERIALIZERS |
125 | |
126 | A given serialization mechanism is only available if you have the underlying |
127 | modules installed. For example, you can't use XML::Simple if it's not already |
db8bb647 |
128 | installed. |
e601adda |
129 | |
95318468 |
130 | In addition, each serializer has its quirks in terms of what sorts of data |
e601adda |
131 | structures it will properly handle. L<Catalyst::Controller::REST> makes |
db8bb647 |
132 | no attempt to save you from yourself in this regard. :) |
e601adda |
133 | |
134 | =over 2 |
135 | |
95318468 |
136 | =item * C<text/x-yaml> => C<YAML::Syck> |
e601adda |
137 | |
138 | Returns YAML generated by L<YAML::Syck>. |
139 | |
95318468 |
140 | =item * C<text/html> => C<YAML::HTML> |
e601adda |
141 | |
142 | This uses L<YAML::Syck> and L<URI::Find> to generate YAML with all URLs turned |
26b59bcb |
143 | to hyperlinks. Only usable for Serialization. |
e601adda |
144 | |
95318468 |
145 | =item * C<application/json> => C<JSON> |
e601adda |
146 | |
db8bb647 |
147 | Uses L<JSON> to generate JSON output. It is strongly advised to also have |
e540a1fa |
148 | L<JSON::XS> installed. The C<text/x-json> content type is supported but is |
149 | deprecated and you will receive warnings in your log. |
e601adda |
150 | |
838f49dc |
151 | You can also add a hash in your controller config to pass options to the json object. |
152 | For instance, to relax permissions when deserializing input, add: |
153 | __PACKAGE__->config( |
154 | json_options => { relaxed => 1 } |
155 | ) |
156 | |
d0d292d4 |
157 | =item * C<text/javascript> => C<JSONP> |
158 | |
159 | If a callback=? parameter is passed, this returns javascript in the form of: $callback($serializedJSON); |
160 | |
92d78e8f |
161 | Note - this is disabled by default as it can be a security risk if you are unaware. |
162 | |
163 | The usual MIME types for this serialization format are: 'text/javascript', 'application/x-javascript', |
164 | 'application/javascript'. |
165 | |
95318468 |
166 | =item * C<text/x-data-dumper> => C<Data::Serializer> |
e601adda |
167 | |
168 | Uses the L<Data::Serializer> module to generate L<Data::Dumper> output. |
169 | |
95318468 |
170 | =item * C<text/x-data-denter> => C<Data::Serializer> |
e601adda |
171 | |
172 | Uses the L<Data::Serializer> module to generate L<Data::Denter> output. |
173 | |
95318468 |
174 | =item * C<text/x-data-taxi> => C<Data::Serializer> |
e601adda |
175 | |
176 | Uses the L<Data::Serializer> module to generate L<Data::Taxi> output. |
177 | |
95318468 |
178 | =item * C<text/x-config-general> => C<Data::Serializer> |
e601adda |
179 | |
180 | Uses the L<Data::Serializer> module to generate L<Config::General> output. |
181 | |
95318468 |
182 | =item * C<text/x-php-serialization> => C<Data::Serializer> |
e601adda |
183 | |
184 | Uses the L<Data::Serializer> module to generate L<PHP::Serialization> output. |
185 | |
95318468 |
186 | =item * C<text/xml> => C<XML::Simple> |
e601adda |
187 | |
188 | Uses L<XML::Simple> to generate XML output. This is probably not suitable |
189 | for any real heavy XML work. Due to L<XML::Simple>s requirement that the data |
190 | you serialize be a HASHREF, we transform outgoing data to be in the form of: |
191 | |
192 | { data => $yourdata } |
193 | |
95318468 |
194 | =item * L<View> |
9a76221e |
195 | |
db8bb647 |
196 | Uses a regular Catalyst view. For example, if you wanted to have your |
3d8a0645 |
197 | C<text/html> and C<text/xml> views rendered by TT, set: |
198 | |
199 | __PACKAGE__->config( |
200 | map => { |
201 | 'text/html' => [ 'View', 'TT' ], |
202 | 'text/xml' => [ 'View', 'XML' ], |
203 | } |
5cb5f6bb |
204 | ); |
3d8a0645 |
205 | |
206 | Your views should have a C<process> method like this: |
207 | |
208 | sub process { |
209 | my ( $self, $c, $stash_key ) = @_; |
5cb5f6bb |
210 | |
3d8a0645 |
211 | my $output; |
212 | eval { |
213 | $output = $self->serialize( $c->stash->{$stash_key} ); |
214 | }; |
215 | return $@ if $@; |
5cb5f6bb |
216 | |
3d8a0645 |
217 | $c->response->body( $output ); |
218 | return 1; # important |
219 | } |
259c53c7 |
220 | |
3d8a0645 |
221 | sub serialize { |
222 | my ( $self, $data ) = @_; |
5cb5f6bb |
223 | |
3d8a0645 |
224 | my $serialized = ... process $data here ... |
5cb5f6bb |
225 | |
3d8a0645 |
226 | return $serialized; |
227 | } |
9a76221e |
228 | |
178f8470 |
229 | =item * Callback |
230 | |
231 | For infinite flexibility, you can provide a callback for the |
232 | deserialization/serialization steps. |
233 | |
234 | __PACKAGE__->config( |
235 | map => { |
236 | 'text/xml' => [ 'Callback', { deserialize => \&parse_xml, serialize => \&render_xml } ], |
237 | } |
238 | ); |
239 | |
240 | The C<deserialize> callback is passed a string that is the body of the |
241 | request and is expected to return a scalar value that results from |
242 | the deserialization. The C<serialize> callback is passed the data |
243 | structure that needs to be serialized and must return a string suitable |
244 | for returning in the HTTP response. In addition to receiving the scalar |
245 | to act on, both callbacks are passed the controller object and the context |
246 | (i.e. C<$c>) as the second and third arguments. |
247 | |
e601adda |
248 | =back |
249 | |
259c53c7 |
250 | By default, L<Catalyst::Controller::REST> will return a |
95318468 |
251 | C<415 Unsupported Media Type> response if an attempt to use an unsupported |
252 | content-type is made. You can ensure that something is always returned by |
253 | setting the C<default> config option: |
398c5a1b |
254 | |
5cb5f6bb |
255 | __PACKAGE__->config(default => 'text/x-yaml'); |
398c5a1b |
256 | |
95318468 |
257 | would make it always fall back to the serializer plugin defined for |
258 | C<text/x-yaml>. |
398c5a1b |
259 | |
e601adda |
260 | =head1 CUSTOM SERIALIZERS |
261 | |
95318468 |
262 | Implementing new Serialization formats is easy! Contributions |
259c53c7 |
263 | are most welcome! If you would like to implement a custom serializer, |
95318468 |
264 | you should create two new modules in the L<Catalyst::Action::Serialize> |
265 | and L<Catalyst::Action::Deserialize> namespace. Then assign your new |
266 | class to the content-type's you want, and you're done. |
267 | |
259c53c7 |
268 | See L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize> |
95318468 |
269 | for more information. |
e601adda |
270 | |
398c5a1b |
271 | =head1 STATUS HELPERS |
272 | |
e601adda |
273 | Since so much of REST is in using HTTP, we provide these Status Helpers. |
274 | Using them will ensure that you are responding with the proper codes, |
275 | headers, and entities. |
276 | |
398c5a1b |
277 | These helpers try and conform to the HTTP 1.1 Specification. You can |
db8bb647 |
278 | refer to it at: L<http://www.w3.org/Protocols/rfc2616/rfc2616.txt>. |
398c5a1b |
279 | These routines are all implemented as regular subroutines, and as |
280 | such require you pass the current context ($c) as the first argument. |
281 | |
5cb5f6bb |
282 | =over |
398c5a1b |
283 | |
284 | =cut |
285 | |
930013e6 |
286 | BEGIN { extends 'Catalyst::Controller' } |
d4611771 |
287 | use Params::Validate qw(SCALAR OBJECT); |
256c894f |
288 | |
289 | __PACKAGE__->mk_accessors(qw(serialize)); |
290 | |
291 | __PACKAGE__->config( |
e540a1fa |
292 | 'stash_key' => 'rest', |
293 | 'map' => { |
294 | 'text/html' => 'YAML::HTML', |
295 | 'text/xml' => 'XML::Simple', |
296 | 'text/x-yaml' => 'YAML', |
297 | 'application/json' => 'JSON', |
298 | 'text/x-json' => 'JSON', |
299 | 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ], |
300 | 'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ], |
301 | 'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ], |
95318468 |
302 | 'text/x-config-general' => [ 'Data::Serializer', 'Config::General' ], |
e540a1fa |
303 | 'text/x-php-serialization' => [ 'Data::Serializer', 'PHP::Serialization' ], |
304 | }, |
256c894f |
305 | ); |
306 | |
e540a1fa |
307 | sub begin : ActionClass('Deserialize') { } |
5511d1ff |
308 | |
0ba73721 |
309 | sub end : ActionClass('Serialize') { } |
310 | |
398c5a1b |
311 | =item status_ok |
312 | |
313 | Returns a "200 OK" response. Takes an "entity" to serialize. |
314 | |
315 | Example: |
316 | |
317 | $self->status_ok( |
db8bb647 |
318 | $c, |
398c5a1b |
319 | entity => { |
320 | radiohead => "Is a good band!", |
321 | } |
322 | ); |
323 | |
324 | =cut |
325 | |
326 | sub status_ok { |
327 | my $self = shift; |
e601adda |
328 | my $c = shift; |
d4611771 |
329 | my %p = Params::Validate::validate( @_, { entity => 1, }, ); |
398c5a1b |
330 | |
331 | $c->response->status(200); |
e601adda |
332 | $self->_set_entity( $c, $p{'entity'} ); |
398c5a1b |
333 | return 1; |
334 | } |
335 | |
336 | =item status_created |
337 | |
338 | Returns a "201 CREATED" response. Takes an "entity" to serialize, |
339 | and a "location" where the created object can be found. |
340 | |
341 | Example: |
342 | |
343 | $self->status_created( |
db8bb647 |
344 | $c, |
259c53c7 |
345 | location => $c->req->uri, |
398c5a1b |
346 | entity => { |
347 | radiohead => "Is a good band!", |
348 | } |
349 | ); |
350 | |
351 | In the above example, we use the requested URI as our location. |
352 | This is probably what you want for most PUT requests. |
353 | |
354 | =cut |
bb4130f6 |
355 | |
5511d1ff |
356 | sub status_created { |
357 | my $self = shift; |
e601adda |
358 | my $c = shift; |
d4611771 |
359 | my %p = Params::Validate::validate( |
e601adda |
360 | @_, |
5511d1ff |
361 | { |
e601adda |
362 | location => { type => SCALAR | OBJECT }, |
363 | entity => { optional => 1 }, |
5511d1ff |
364 | }, |
365 | ); |
256c894f |
366 | |
5511d1ff |
367 | $c->response->status(201); |
259c53c7 |
368 | $c->response->header( 'Location' => $p{location} ); |
e601adda |
369 | $self->_set_entity( $c, $p{'entity'} ); |
bb4130f6 |
370 | return 1; |
371 | } |
372 | |
398c5a1b |
373 | =item status_accepted |
374 | |
375 | Returns a "202 ACCEPTED" response. Takes an "entity" to serialize. |
259c53c7 |
376 | Also takes optional "location" for queue type scenarios. |
398c5a1b |
377 | |
378 | Example: |
379 | |
380 | $self->status_accepted( |
db8bb647 |
381 | $c, |
259c53c7 |
382 | location => $c->req->uri, |
398c5a1b |
383 | entity => { |
384 | status => "queued", |
385 | } |
386 | ); |
387 | |
388 | =cut |
e601adda |
389 | |
398c5a1b |
390 | sub status_accepted { |
bb4130f6 |
391 | my $self = shift; |
e601adda |
392 | my $c = shift; |
259c53c7 |
393 | my %p = Params::Validate::validate( |
394 | @_, |
395 | { |
396 | location => { type => SCALAR | OBJECT, optional => 1 }, |
397 | entity => 1, |
398 | }, |
399 | ); |
bb4130f6 |
400 | |
398c5a1b |
401 | $c->response->status(202); |
259c53c7 |
402 | $c->response->header( 'Location' => $p{location} ) if exists $p{location}; |
e601adda |
403 | $self->_set_entity( $c, $p{'entity'} ); |
bb4130f6 |
404 | return 1; |
405 | } |
406 | |
bbf0feae |
407 | =item status_no_content |
408 | |
409 | Returns a "204 NO CONTENT" response. |
410 | |
411 | =cut |
412 | |
413 | sub status_no_content { |
414 | my $self = shift; |
415 | my $c = shift; |
416 | $c->response->status(204); |
417 | $self->_set_entity( $c, undef ); |
042656b6 |
418 | return 1; |
bbf0feae |
419 | } |
420 | |
bdff70a9 |
421 | =item status_multiple_choices |
422 | |
423 | Returns a "300 MULTIPLE CHOICES" response. Takes an "entity" to serialize, which should |
424 | provide list of possible locations. Also takes optional "location" for preferred choice. |
425 | |
426 | =cut |
427 | |
428 | sub status_multiple_choices { |
429 | my $self = shift; |
430 | my $c = shift; |
431 | my %p = Params::Validate::validate( |
432 | @_, |
433 | { |
434 | entity => 1, |
435 | location => { type => SCALAR | OBJECT, optional => 1 }, |
436 | }, |
437 | ); |
438 | |
bdff70a9 |
439 | $c->response->status(300); |
259c53c7 |
440 | $c->response->header( 'Location' => $p{location} ) if exists $p{'location'}; |
bdff70a9 |
441 | $self->_set_entity( $c, $p{'entity'} ); |
442 | return 1; |
443 | } |
444 | |
e52456a4 |
445 | =item status_found |
446 | |
447 | Returns a "302 FOUND" response. Takes an "entity" to serialize. |
259c53c7 |
448 | Also takes optional "location". |
e52456a4 |
449 | |
450 | =cut |
451 | |
452 | sub status_found { |
453 | my $self = shift; |
454 | my $c = shift; |
455 | my %p = Params::Validate::validate( |
456 | @_, |
457 | { |
458 | entity => 1, |
459 | location => { type => SCALAR | OBJECT, optional => 1 }, |
460 | }, |
461 | ); |
462 | |
e52456a4 |
463 | $c->response->status(302); |
259c53c7 |
464 | $c->response->header( 'Location' => $p{location} ) if exists $p{'location'}; |
e52456a4 |
465 | $self->_set_entity( $c, $p{'entity'} ); |
466 | return 1; |
467 | } |
468 | |
398c5a1b |
469 | =item status_bad_request |
470 | |
471 | Returns a "400 BAD REQUEST" response. Takes a "message" argument |
472 | as a scalar, which will become the value of "error" in the serialized |
473 | response. |
474 | |
475 | Example: |
476 | |
477 | $self->status_bad_request( |
db8bb647 |
478 | $c, |
33e5de96 |
479 | message => "Cannot do what you have asked!", |
398c5a1b |
480 | ); |
481 | |
482 | =cut |
e601adda |
483 | |
cc186a5b |
484 | sub status_bad_request { |
485 | my $self = shift; |
e601adda |
486 | my $c = shift; |
d4611771 |
487 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
cc186a5b |
488 | |
489 | $c->response->status(400); |
faf5c20b |
490 | $c->log->debug( "Status Bad Request: " . $p{'message'} ) if $c->debug; |
e601adda |
491 | $self->_set_entity( $c, { error => $p{'message'} } ); |
cc186a5b |
492 | return 1; |
493 | } |
494 | |
550807bc |
495 | =item status_forbidden |
496 | |
497 | Returns a "403 FORBIDDEN" response. Takes a "message" argument |
498 | as a scalar, which will become the value of "error" in the serialized |
499 | response. |
500 | |
501 | Example: |
502 | |
503 | $self->status_forbidden( |
504 | $c, |
505 | message => "access denied", |
506 | ); |
507 | |
508 | =cut |
509 | |
510 | sub status_forbidden { |
511 | my $self = shift; |
512 | my $c = shift; |
513 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
514 | |
515 | $c->response->status(403); |
516 | $c->log->debug( "Status Forbidden: " . $p{'message'} ) if $c->debug; |
517 | $self->_set_entity( $c, { error => $p{'message'} } ); |
518 | return 1; |
519 | } |
520 | |
398c5a1b |
521 | =item status_not_found |
522 | |
523 | Returns a "404 NOT FOUND" response. Takes a "message" argument |
524 | as a scalar, which will become the value of "error" in the serialized |
525 | response. |
526 | |
527 | Example: |
528 | |
529 | $self->status_not_found( |
db8bb647 |
530 | $c, |
33e5de96 |
531 | message => "Cannot find what you were looking for!", |
398c5a1b |
532 | ); |
533 | |
534 | =cut |
e601adda |
535 | |
bb4130f6 |
536 | sub status_not_found { |
537 | my $self = shift; |
e601adda |
538 | my $c = shift; |
d4611771 |
539 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
bb4130f6 |
540 | |
541 | $c->response->status(404); |
faf5c20b |
542 | $c->log->debug( "Status Not Found: " . $p{'message'} ) if $c->debug; |
e601adda |
543 | $self->_set_entity( $c, { error => $p{'message'} } ); |
bb4130f6 |
544 | return 1; |
545 | } |
546 | |
bbf0feae |
547 | =item gone |
548 | |
549 | Returns a "41O GONE" response. Takes a "message" argument as a scalar, |
550 | which will become the value of "error" in the serialized response. |
551 | |
552 | Example: |
553 | |
554 | $self->status_gone( |
555 | $c, |
556 | message => "The document have been deleted by foo", |
557 | ); |
558 | |
559 | =cut |
560 | |
561 | sub status_gone { |
562 | my $self = shift; |
563 | my $c = shift; |
564 | my %p = Params::Validate::validate( @_, { message => { type => SCALAR }, }, ); |
565 | |
566 | $c->response->status(410); |
567 | $c->log->debug( "Status Gone " . $p{'message'} ) if $c->debug; |
568 | $self->_set_entity( $c, { error => $p{'message'} } ); |
569 | return 1; |
570 | } |
571 | |
bb4130f6 |
572 | sub _set_entity { |
e601adda |
573 | my $self = shift; |
574 | my $c = shift; |
bb4130f6 |
575 | my $entity = shift; |
e601adda |
576 | if ( defined($entity) ) { |
faf5c20b |
577 | $c->stash->{ $self->{'stash_key'} } = $entity; |
5511d1ff |
578 | } |
579 | return 1; |
eccb2137 |
580 | } |
256c894f |
581 | |
398c5a1b |
582 | =back |
583 | |
584 | =head1 MANUAL RESPONSES |
585 | |
586 | If you want to construct your responses yourself, all you need to |
587 | do is put the object you want serialized in $c->stash->{'rest'}. |
588 | |
e601adda |
589 | =head1 IMPLEMENTATION DETAILS |
590 | |
591 | This Controller ties together L<Catalyst::Action::REST>, |
592 | L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize>. It should be suitable for most applications. You should be aware that it: |
593 | |
594 | =over 4 |
595 | |
596 | =item Configures the Serialization Actions |
597 | |
598 | This class provides a default configuration for Serialization. It is currently: |
599 | |
600 | __PACKAGE__->config( |
95318468 |
601 | 'stash_key' => 'rest', |
602 | 'map' => { |
603 | 'text/html' => 'YAML::HTML', |
604 | 'text/xml' => 'XML::Simple', |
605 | 'text/x-yaml' => 'YAML', |
606 | 'application/json' => 'JSON', |
607 | 'text/x-json' => 'JSON', |
608 | 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ], |
609 | 'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ], |
610 | 'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ], |
611 | 'application/x-storable' => [ 'Data::Serializer', 'Storable' ], |
612 | 'application/x-freezethaw' => [ 'Data::Serializer', 'FreezeThaw' ], |
613 | 'text/x-config-general' => [ 'Data::Serializer', 'Config::General' ], |
614 | 'text/x-php-serialization' => [ 'Data::Serializer', 'PHP::Serialization' ], |
615 | }, |
e601adda |
616 | ); |
617 | |
618 | You can read the full set of options for this configuration block in |
619 | L<Catalyst::Action::Serialize>. |
620 | |
621 | =item Sets a C<begin> and C<end> method for you |
622 | |
623 | The C<begin> method uses L<Catalyst::Action::Deserialize>. The C<end> |
624 | method uses L<Catalyst::Action::Serialize>. If you want to override |
625 | either behavior, simply implement your own C<begin> and C<end> actions |
355d4385 |
626 | and forward to another action with the Serialize and/or Deserialize |
627 | action classes: |
e601adda |
628 | |
10bcd217 |
629 | package Foo::Controller::Monkey; |
630 | use Moose; |
631 | use namespace::autoclean; |
355d4385 |
632 | |
10bcd217 |
633 | BEGIN { extends 'Catalyst::Controller::REST' } |
e601adda |
634 | |
355d4385 |
635 | sub begin : Private { |
e601adda |
636 | my ($self, $c) = @_; |
db8bb647 |
637 | ... do things before Deserializing ... |
355d4385 |
638 | $c->forward('deserialize'); |
e601adda |
639 | ... do things after Deserializing ... |
db8bb647 |
640 | } |
e601adda |
641 | |
355d4385 |
642 | sub deserialize : ActionClass('Deserialize') {} |
643 | |
e601adda |
644 | sub end :Private { |
645 | my ($self, $c) = @_; |
db8bb647 |
646 | ... do things before Serializing ... |
355d4385 |
647 | $c->forward('serialize'); |
e601adda |
648 | ... do things after Serializing ... |
649 | } |
650 | |
355d4385 |
651 | sub serialize : ActionClass('Serialize') {} |
652 | |
8bf1f20e |
653 | If you need to deserialize multipart requests (i.e. REST data in |
654 | one part and file uploads in others) you can do so by using the |
655 | L<Catalyst::Action::DeserializeMultiPart> action class. |
656 | |
e540a1fa |
657 | =back |
658 | |
e601adda |
659 | =head1 A MILD WARNING |
660 | |
661 | I have code in production using L<Catalyst::Controller::REST>. That said, |
662 | it is still under development, and it's possible that things may change |
d6ece98c |
663 | between releases. I promise to not break things unnecessarily. :) |
e601adda |
664 | |
398c5a1b |
665 | =head1 SEE ALSO |
666 | |
667 | L<Catalyst::Action::REST>, L<Catalyst::Action::Serialize>, |
668 | L<Catalyst::Action::Deserialize> |
669 | |
670 | For help with REST in general: |
671 | |
672 | The HTTP 1.1 Spec is required reading. http://www.w3.org/Protocols/rfc2616/rfc2616.txt |
673 | |
674 | Wikipedia! http://en.wikipedia.org/wiki/Representational_State_Transfer |
675 | |
676 | The REST Wiki: http://rest.blueoxen.net/cgi-bin/wiki.pl?FrontPage |
677 | |
5cb5f6bb |
678 | =head1 AUTHORS |
e540a1fa |
679 | |
5cb5f6bb |
680 | See L<Catalyst::Action::REST> for authors. |
e540a1fa |
681 | |
398c5a1b |
682 | =head1 LICENSE |
683 | |
684 | You may distribute this code under the same terms as Perl itself. |
685 | |
686 | =cut |
687 | |
24748286 |
688 | __PACKAGE__->meta->make_immutable; |
689 | |
256c894f |
690 | 1; |