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