package Catalyst::Controller::REST;
+use strict;
+use warnings;
-our $VERSION = '0.74';
+our $VERSION = '0.78';
+$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 ..
+ ... some action ...
}
=head1 DESCRIPTION
To make your Controller RESTful, simply have it
- use base 'Catalyst::Controller::REST';
+ BEGIN { extends '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>
modules installed. For example, you can't use XML::Simple if it's not already
installed.
-In addition, each serializer has it's quirks in terms of what sorts of data
+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>
+=item * C<text/x-yaml> => C<YAML::Syck>
Returns YAML generated by L<YAML::Syck>.
-=item C<text/html> => C<YAML::HTML>
+=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>
+=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>
+=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>
+=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>
+=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>
+=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>
+=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>
+=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>
+=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>
+=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
{ data => $yourdata }
-=item L<View>
+=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' ],
+ }
+ );
-Will do the trick nicely.
+Your views should have a C<process> method like this:
-=back
+ sub process {
+ my ( $self, $c, $stash_key ) = @_;
-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:
+ my $output;
+ eval {
+ $output = $self->serialize( $c->stash->{$stash_key} );
+ };
+ return $@ if $@;
- __PACKAGE__->config->{'default'} = 'text/x-yaml';
+ $c->response->body( $output );
+ return 1; # important
+ }
+
+ sub serialize {
+ my ( $self, $data ) = @_;
-Would make it always fall back to the serializer plugin defined for text/x-yaml.
+ my $serialized = ... process $data here ...
-Implementing new Serialization formats is easy! Contributions
-are most welcome! See L<Catalyst::Action::Serialize> and
-L<Catalyst::Action::Deserialize> for more information.
+ 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
-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.
+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
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 strict;
-use warnings;
use base 'Catalyst::Controller';
use Params::Validate qw(SCALAR OBJECT);
'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' ],
+ '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' ],
},
);
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
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;
This class provides a default configuration for Serialization. It is currently:
__PACKAGE__->config(
- serialize => {
- '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' ],
- },
- }
+ '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
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