Shuffle all the Pod to the bottom of the file
Tomas Doran [Fri, 11 Dec 2009 02:18:21 +0000 (02:18 +0000)]
lib/Catalyst/Request/REST.pm

index 16c1e6a..2bc59e6 100644 (file)
@@ -2,9 +2,6 @@
 # REST.pm
 # Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
 # Created on: 10/13/2006 03:54:33 PM PDT
-#
-# $Id: $
-
 package Catalyst::Request::REST;
 
 use strict;
@@ -33,6 +30,65 @@ sub _insert_self_into {
   }
 }
 
+__PACKAGE__->mk_accessors(qw(data accept_only));
+
+sub accepted_content_types {
+    my $self = shift;
+
+    return $self->{content_types} if $self->{content_types};
+
+    my %types;
+
+    # First, we use the content type in the HTTP Request.  It wins all.
+    $types{ $self->content_type } = 3
+        if $self->content_type;
+
+    if ($self->method eq "GET" && $self->param('content-type')) {
+        $types{ $self->param('content-type') } = 2;
+    }
+
+    # Third, we parse the Accept header, and see if the client
+    # takes a format we understand.
+    #
+    # This is taken from chansen's Apache2::UploadProgress.
+    if ( $self->header('Accept') ) {
+        $self->accept_only(1) unless keys %types;
+
+        my $accept_header = $self->header('Accept');
+        my $counter       = 0;
+
+        foreach my $pair ( split_header_words($accept_header) ) {
+            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 );
+            }
+
+            $types{$type} = sprintf( '%.3f', $qvalue );
+        }
+    }
+
+    return $self->{content_types} =
+        [ sort { $types{$b} <=> $types{$a} } keys %types ];
+}
+
+sub preferred_content_type { $_[0]->accepted_content_types->[0] }
+
+sub accepts {
+    my $self = shift;
+    my $type = shift;
+
+    return grep { $_ eq $type } @{ $self->accepted_content_types };
+}
+
 =head1 NAME
 
 Catalyst::Request::REST - A REST-y subclass of Catalyst::Request
@@ -59,14 +115,12 @@ custom request class inherits from C<Catalyst::Request::REST>.
 
 =head1 METHODS
 
-If the request went through the Deserializer action, this method will
-returned the deserialized data structure.
-
-=cut
+=over
 
-__PACKAGE__->mk_accessors(qw(data accept_only));
+=item data
 
-=over 4
+If the request went through the Deserializer action, this method will
+return the deserialized data structure.
 
 =item accepted_content_types
 
@@ -97,81 +151,18 @@ relative quality specified for each type.
 If a type appears in more than one of these places, it is ordered based on
 where it is first found.
 
-=cut
-
-sub accepted_content_types {
-    my $self = shift;
-
-    return $self->{content_types} if $self->{content_types};
-
-    my %types;
-
-    # First, we use the content type in the HTTP Request.  It wins all.
-    $types{ $self->content_type } = 3
-        if $self->content_type;
-
-    if ($self->method eq "GET" && $self->param('content-type')) {
-        $types{ $self->param('content-type') } = 2;
-    }
-
-    # Third, we parse the Accept header, and see if the client
-    # takes a format we understand.
-    #
-    # This is taken from chansen's Apache2::UploadProgress.
-    if ( $self->header('Accept') ) {
-        $self->accept_only(1) unless keys %types;
-
-        my $accept_header = $self->header('Accept');
-        my $counter       = 0;
-
-        foreach my $pair ( split_header_words($accept_header) ) {
-            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 );
-            }
-
-            $types{$type} = sprintf( '%.3f', $qvalue );
-        }
-    }
-
-    return $self->{content_types} =
-        [ sort { $types{$b} <=> $types{$a} } keys %types ];
-}
-
 =item preferred_content_type
 
 This returns the first content type found. It is shorthand for:
 
   $request->accepted_content_types->[0]
 
-=cut
-
-sub preferred_content_type { $_[0]->accepted_content_types->[0] }
-
 =item accepts($type)
 
 Given a content type, this returns true if the type is accepted.
 
 Note that this does not do any wildcard expansion of types.
 
-=cut
-
-sub accepts {
-    my $self = shift;
-    my $type = shift;
-
-    return grep { $_ eq $type } @{ $self->accepted_content_types };
-}
-
 =back
 
 =head1 AUTHOR