Add POD escapes for < and >
[catagits/Catalyst-Action-REST.git] / lib / Catalyst / Action / REST.pm
index c06ad8d..eaa2c31 100644 (file)
@@ -1,23 +1,16 @@
-#
-# REST.pm
-# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
-# Created on: 10/12/2006 03:00:32 PM PDT
-#
-# $Id$
-
 package Catalyst::Action::REST;
 
-use strict;
-use warnings;
+use Moose;
+use namespace::autoclean;
 
-use base 'Catalyst::Action';
+extends 'Catalyst::Action';
 use Class::Inspector;
 use Catalyst::Request::REST;
 use Catalyst::Controller::REST;
 
 BEGIN { require 5.008001; }
 
-our $VERSION = '0.76';
+our $VERSION = '0.81';
 $VERSION = eval $VERSION;
 
 sub new {
@@ -74,8 +67,8 @@ It is likely that you really want to look at L<Catalyst::Controller::REST>,
 which brings this class together with automatic Serialization of requests
 and responses.
 
-When you use this module, the request class will be changed to
-L<Catalyst::Request::REST>.
+When you use this module, it adds the L<Catalyst::TraitFor::Request::REST>
+role to your request class.
 
 =head1 METHODS
 
@@ -132,14 +125,8 @@ sub dispatch {
 sub _get_allowed_methods {
     my ( $self, $controller, $c, $name ) = @_;
     my $class = ref($controller) ? ref($controller) : $controller;
-    my $methods    = Class::Inspector->methods($class);
-    my @allowed;
-    foreach my $method ( @{$methods} ) {
-        if ( $method =~ /^$name\_(.+)$/ ) {
-            push( @allowed, $1 );
-        }
-    }
-    return @allowed;
+    my $methods = Class::Inspector->methods($class);
+    return map { /^$name\_(.+)$/ } @$methods;
 };
 
 sub _return_options {
@@ -169,8 +156,13 @@ sub _return_not_implemented {
 
 =head1 SEE ALSO
 
-You likely want to look at L<Catalyst::Controller::REST>, which implements
-a sensible set of defaults for a controller doing REST.
+You likely want to look at L<Catalyst::Controller::REST>, which implements a
+sensible set of defaults for a controller doing REST.
+
+This class automatically adds the L<Catalyst::TraitFor::Request::REST> role to
+your request class.  If you're writing a webapp which provides RESTful
+responses and still needs to accommodate web browsers, you may prefer to use
+L<Catalyst::TraitFor::Request::REST::ForBrowsers> instead.
 
 L<Catalyst::Action::Serialize>, L<Catalyst::Action::Deserialize>
 
@@ -185,15 +177,21 @@ one of the accepted return formats.  You can do this by setting it in your query
 accepted return formats.  You can do this by setting it in your query string
 thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
 
-B<NOTE> Apache will refuse %2F unless configured otherise.
-Make sure C<< AllowEncodedSlashes On >> is in your httpd.conf file in orde
+B<NOTE> Apache will refuse %2F unless configured otherwise.
+Make sure C<AllowEncodedSlashes On> is in your httpd.conf file in order
 for this to run smoothly.
 
 =back
 
+=head1 AUTHOR
+
+Adam Jacob E<lt>adam@stalecoffee.orgE<gt>, with lots of help from mst and jrockway
+
+Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
+
 =head1 CONTRIBUTORS
 
-Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+Arthur Axel "fREW" Schmidt E<lt>frioux@gmail.comE<gt>
 
 Christopher Laco
 
@@ -201,19 +199,19 @@ Luke Saunders
 
 John Goulah
 
-Daisuke Maki <daisuke@endeworks.jp>
+Daisuke Maki E<lt>daisuke@endeworks.jpE<gt>
 
-J. Shirley <jshirley@gmail.com>
+J. Shirley E<lt>jshirley@gmail.comE<gt>
 
 Hans Dieter Pearcey
 
-Tomas Doran (t0m) <bobtfish@bobtfish.net>
+Tomas Doran (t0m) E<lt>bobtfish@bobtfish.netE<gt>
 
-=head1 AUTHOR
+Dave Rolsky E<lt>autarch@urth.orgE<gt>
 
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+=head1 COPYRIGHT
 
-Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
+Copyright the above named AUTHOR and CONTRIBUTORS
 
 =head1 LICENSE