Deal with nasty q headers (chansen)

[catagits/Catalyst-Action-REST.git] / lib / Catalyst / Request / REST.pm

diff --git a/lib/Catalyst/Request/REST.pm b/lib/Catalyst/Request/REST.pm
index cd1b103..16c1e6a 100644 (file)
--- a/lib/Catalyst/Request/REST.pm
+++ b/lib/Catalyst/Request/REST.pm
@@ -1,6 +1,6 @@
 #
 # REST.pm
-# Created by: Adam Jacob, Marchex, <adam@marchex.com>
+# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
 # Created on: 10/13/2006 03:54:33 PM PDT
 #
 # $Id: $
@@ -9,10 +9,29 @@ package Catalyst::Request::REST;
 
 use strict;
 use warnings;
+use Scalar::Util qw/blessed/;
 
-use base 'Catalyst::Request';
+use base qw/Catalyst::Request Class::Accessor::Fast/;
+
+use Catalyst::Utils;
 use HTTP::Headers::Util qw(split_header_words);
 
+sub _insert_self_into {
+  my ($class, $app_class ) = @_;
+  # the fallback to $app_class is for the (rare and deprecated) case when
+  # people are defining actions in MyApp.pm instead of in a controller.
+  my $app = (blessed($app_class) && $app_class->can('_application'))
+        ? $app_class->_application : Catalyst::Utils::class2appclass( $app_class ) || $app_class;
+
+  my $req_class = $app->request_class;
+  return if $req_class->isa($class);
+  if ($req_class eq 'Catalyst::Request') {
+    $app->request_class($class);
+  } else {
+    die "$app has a custom request class $req_class, "
+      . "which is not a $class; see Catalyst::Request::REST";
+  }
+}
 
 =head1 NAME
 
@@ -20,7 +39,7 @@ Catalyst::Request::REST - A REST-y subclass of Catalyst::Request
 
 =head1 SYNOPSIS
 
-     if ( $c->request->accepts('text/x-json') ) {
+     if ( $c->request->accepts('application/json') ) {
          ...
      }
 
@@ -32,11 +51,14 @@ This is a subclass of C<Catalyst::Request> that adds a few methods to
 the request object to faciliate writing REST-y code. Currently, these
 methods are all related to the content types accepted by the client.
 
+Note that if you have a custom request class in your application, and it does
+not inherit from C<Catalyst::Request::REST>, your application will fail with an
+error indicating a conflict the first time it tries to use
+C<Catalyst::Request::REST>'s functionality.  To fix this error, make sure your
+custom request class inherits from C<Catalyst::Request::REST>.
 
 =head1 METHODS
 
-=over 4 data
-
 If the request went through the Deserializer action, this method will
 returned the deserialized data structure.
 
@@ -44,6 +66,8 @@ returned the deserialized data structure.
 
 __PACKAGE__->mk_accessors(qw(data accept_only));
 
+=over 4
+
 =item accepted_content_types
 
 Returns an array reference of content types accepted by the
@@ -87,7 +111,6 @@ sub accepted_content_types {
         if $self->content_type;
 
     if ($self->method eq "GET" && $self->param('content-type')) {
-
         $types{ $self->param('content-type') } = 2;
     }
 
@@ -105,6 +128,13 @@ sub accepted_content_types {
             my ( $type, $qvalue ) = @{$pair}[ 0, 3 ];
             next if $types{$type};
 
+            # cope with invalid (missing required q parameter) header like:
+            # application/json; charset="utf-8"
+            # http://tools.ietf.org/html/rfc2616#section-14.1
+            unless ( defined $pair->[2] && lc $pair->[2] eq 'q' ) {
+                $qvalue = undef;
+            }
+
             unless ( defined $qvalue ) {
                 $qvalue = 1 - ( ++$counter / 1000 );
             }
@@ -142,10 +172,16 @@ sub accepts {
     return grep { $_ eq $type } @{ $self->accepted_content_types };
 }
 
+=back
+
 =head1 AUTHOR
 
 Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
 
+=head1 MAINTAINER
+
+J. Shirley <jshirley@cpan.org>
+
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.