package Catalyst::Controller::REST;
-use strict;
-use warnings;
+use Moose;
+use namespace::autoclean;
-our $VERSION = '0.78';
+our $VERSION = '0.87';
$VERSION = eval $VERSION;
=head1 NAME
=head1 SYNOPSIS
package Foo::Controller::Bar;
-
- use base 'Catalyst::Controller::REST';
+ use Moose;
+ use namespace::autoclean;
+
+ BEGIN { extends 'Catalyst::Controller::REST' }
sub thing : Local : ActionClass('REST') { }
# Answer PUT requests to "thing"
sub thing_PUT {
- ... some action ...
- }
+ $radiohead = $req->data->{radiohead};
+
+ $self->status_created(
+ $c,
+ location => $c->req->uri->as_string,
+ entity => {
+ radiohead => $radiohead,
+ }
+ );
+ }
=head1 DESCRIPTION
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.
+"The HTTP POST, PUT, and OPTIONS methods will all automatically
+L<deserialize|Catalyst::Action::Deserialize> the contents of
+C<< $c->request->body >> into the C<< $c->request->data >> hashref", based on
+the request's C<Content-type> header. A list of understood serialization
+formats is L<below|/AVAILABLE SERIALIZERS>.
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'; }
+ BEGIN { extends 'Catalyst::Controller::REST' }
-Or if you use pre-Moose Catalyst versions,
-
- use parent 'Catalyst::Controller::REST';
+=head1 CONFIGURATION
+See L<Catalyst::Action::Serialize/CONFIGURATION>. Note that the C<serialize>
+key has been deprecated.
=head1 SERIALIZATION
which serializer to use by mapping a content-type to a Serialization module.
We select the content-type based on:
-=over 2
+=over
=item B<The Content-Type Header>
=back
-
=head1 AVAILABLE SERIALIZERS
A given serialization mechanism is only available if you have the underlying
=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.
+to hyperlinks. Only usable for Serialization.
=item * C<application/json> => C<JSON>
L<JSON::XS> installed. The C<text/x-json> content type is supported but is
deprecated and you will receive warnings in your log.
+You can also add a hash in your controller config to pass options to the json object.
+For instance, to relax permissions when deserializing input, add:
+ __PACKAGE__->config(
+ json_options => { relaxed => 1 }
+ )
+
+=item * C<text/javascript> => C<JSONP>
+
+If a callback=? parameter is passed, this returns javascript in the form of: $callback($serializedJSON);
+
+Note - this is disabled by default as it can be a security risk if you are unaware.
+
+The usual MIME types for this serialization format are: 'text/javascript', 'application/x-javascript',
+'application/javascript'.
+
=item * C<text/x-data-dumper> => C<Data::Serializer>
Uses the L<Data::Serializer> module to generate L<Data::Dumper> output.
=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:
+C<text/html> and C<text/xml> views rendered by TT, set:
- 'text/html' => [ 'View', 'TT' ],
- 'text/xml' => [ 'View', 'XML' ],
+ __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 ) = @_;
-Will do the trick nicely.
+ my $serialized = ... process $data here ...
+
+ return $serialized;
+ }
=back
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';
+ __PACKAGE__->config(default => 'text/x-yaml');
would make it always fall back to the serializer plugin defined for
C<text/x-yaml>.
These routines are all implemented as regular subroutines, and as
such require you pass the current context ($c) as the first argument.
-=over 4
+=over
=cut
-use base 'Catalyst::Controller';
+BEGIN { extends 'Catalyst::Controller' }
use Params::Validate qw(SCALAR OBJECT);
__PACKAGE__->mk_accessors(qw(serialize));
return 1.;
}
+=item status_multiple_choices
+
+Returns a "300 MULTIPLE CHOICES" response. Takes an "entity" to serialize, which should
+provide list of possible locations. Also takes optional "location" for preferred choice.
+
+=cut
+
+sub status_multiple_choices {
+ my $self = shift;
+ my $c = shift;
+ my %p = Params::Validate::validate(
+ @_,
+ {
+ entity => 1,
+ location => { type => SCALAR | OBJECT, optional => 1 },
+ },
+ );
+
+ my $location;
+ if ( ref( $p{'location'} ) ) {
+ $location = $p{'location'}->as_string;
+ } else {
+ $location = $p{'location'};
+ }
+ $c->response->status(300);
+ $c->response->header( 'Location' => $location ) if exists $p{'location'};
+ $self->_set_entity( $c, $p{'entity'} );
+ return 1;
+}
+
=item status_bad_request
Returns a "400 BAD REQUEST" response. Takes a "message" argument
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:
+and forward to another action with the Serialize and/or Deserialize
+action classes:
- my Foo::Controller::Monkey;
- use base qw(Catalyst::Controller::REST);
+ package Foo::Controller::Monkey;
+ use Moose;
+ use namespace::autoclean;
- sub begin :Private {
+ BEGIN { extends 'Catalyst::Controller::REST' }
+
+ sub begin : Private {
my ($self, $c) = @_;
... do things before Deserializing ...
- $self->maybe::next::method($c);
+ $c->forward('deserialize');
... do things after Deserializing ...
}
+ sub deserialize : ActionClass('Deserialize') {}
+
sub end :Private {
my ($self, $c) = @_;
... do things before Serializing ...
- $self->maybe::next::method($c);
+ $c->forward('serialize');
... do things after Serializing ...
}
+ sub serialize : ActionClass('Serialize') {}
+
=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. :)
+between releases. I promise to not break things unnecessarily. :)
=head1 SEE ALSO
The REST Wiki: http://rest.blueoxen.net/cgi-bin/wiki.pl?FrontPage
-=head1 AUTHOR
-
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
-
-Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
-
-=head1 MAINTAINER
+=head1 AUTHORS
-J. Shirley <jshirley@cpan.org>
+See L<Catalyst::Action::REST> for authors.
=head1 LICENSE
projects / catagits/Catalyst-Action-REST.git / blobdiff