From: Tomas Doran Date: Fri, 11 Dec 2009 01:07:13 +0000 (+0000) Subject: Additional pod cleanups X-Git-Tag: 0.79~1 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Action-REST.git;a=commitdiff_plain;h=5cb5f6bb8bd7e95865e8e3eb238b482aa161aa0d Additional pod cleanups --- diff --git a/lib/Catalyst/Action/Deserialize.pm b/lib/Catalyst/Action/Deserialize.pm index 9daf029..d6568ae 100644 --- a/lib/Catalyst/Action/Deserialize.pm +++ b/lib/Catalyst/Action/Deserialize.pm @@ -95,11 +95,9 @@ a sensible set of defaults for a controller doing REST. L, L -=head1 AUTHOR +=head1 AUTHORS -Adam Jacob , with lots of help from mst and jrockway - -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +See L for authors. =head1 LICENSE diff --git a/lib/Catalyst/Action/REST.pm b/lib/Catalyst/Action/REST.pm index 7ddf629..7adc6b2 100644 --- a/lib/Catalyst/Action/REST.pm +++ b/lib/Catalyst/Action/REST.pm @@ -191,6 +191,12 @@ for this to run smoothly. =back +=head1 AUTHOR + +Adam Jacob , with lots of help from mst and jrockway + +Marchex, Inc. paid me while I developed this module. (L) + =head1 CONTRIBUTORS Arthur Axel "fREW" Schmidt @@ -209,11 +215,9 @@ Hans Dieter Pearcey Tomas Doran (t0m) -=head1 AUTHOR +=head1 COPYRIGHT -Adam Jacob , with lots of help from mst and jrockway - -Marchex, Inc. paid me while I developed this module. (L) +Copyright the above named AUTHOR and CONTRIBUTORS =head1 LICENSE diff --git a/lib/Catalyst/Action/Serialize.pm b/lib/Catalyst/Action/Serialize.pm index 38dbc43..47c150a 100644 --- a/lib/Catalyst/Action/Serialize.pm +++ b/lib/Catalyst/Action/Serialize.pm @@ -137,11 +137,9 @@ a sensible set of defaults for doing a REST controller. L, L -=head1 AUTHOR +=head1 AUTHORS -Adam Jacob , with lots of help from mst and jrockway - -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +See L for authors. =head1 LICENSE diff --git a/lib/Catalyst/Action/SerializeBase.pm b/lib/Catalyst/Action/SerializeBase.pm index e616f8a..984457b 100644 --- a/lib/Catalyst/Action/SerializeBase.pm +++ b/lib/Catalyst/Action/SerializeBase.pm @@ -177,11 +177,9 @@ code for L and L. L, L, L, -=head1 AUTHOR +=head1 AUTHORS -Adam Jacob , with lots of help from mst and jrockway. - -Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) +See L for authors. =head1 LICENSE diff --git a/lib/Catalyst/Controller/REST.pm b/lib/Catalyst/Controller/REST.pm index 33eb25b..b77eb61 100644 --- a/lib/Catalyst/Controller/REST.pm +++ b/lib/Catalyst/Controller/REST.pm @@ -12,8 +12,10 @@ Catalyst::Controller::REST - A RESTful controller =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') { } @@ -76,19 +78,13 @@ If we do not have (or cannot run) a serializer for a given content-type, a 415 To make your Controller RESTful, simply have it - BEGIN {extends 'Catalyst::Controller::REST'; } - -Or if you use pre-Moose Catalyst versions, - - use parent 'Catalyst::Controller::REST'; - + BEGIN { extends 'Catalyst::Controller::REST' } =head1 CONFIGURATION See L. Note that the C key has been deprecated. - =head1 SERIALIZATION Catalyst::Controller::REST will automatically serialize your @@ -96,7 +92,7 @@ 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 2 +=over =item B @@ -113,7 +109,6 @@ it and use the best-ranked choice. =back - =head1 AVAILABLE SERIALIZERS A given serialization mechanism is only available if you have the underlying @@ -187,31 +182,30 @@ C and C views rendered by TT, set: 'text/html' => [ 'View', 'TT' ], 'text/xml' => [ 'View', 'XML' ], } - ); + ); Your views should have a C 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 @@ -220,7 +214,7 @@ 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 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. @@ -247,7 +241,7 @@ refer to it at: L. 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 @@ -556,15 +550,9 @@ Wikipedia! http://en.wikipedia.org/wiki/Representational_State_Transfer The REST Wiki: http://rest.blueoxen.net/cgi-bin/wiki.pl?FrontPage -=head1 AUTHOR - -Adam Jacob , 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 +See L for authors. =head1 LICENSE