X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FREST.pm;h=2bc59e6f11aca187ba72189cfce20929385c243a;hb=bd8fc54ea9f1948e79ba01e8e57e27183723dc0d;hp=cd1b10399e93039d80850ba9f4634294111b4fbb;hpb=9a76221ea1453d244e65429d3e10b5bde42d7733;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Request/REST.pm b/lib/Catalyst/Request/REST.pm index cd1b103..2bc59e6 100644 --- a/lib/Catalyst/Request/REST.pm +++ b/lib/Catalyst/Request/REST.pm @@ -1,18 +1,93 @@ # # REST.pm -# Created by: Adam Jacob, Marchex, +# Created by: Adam Jacob, Marchex, # Created on: 10/13/2006 03:54:33 PM PDT -# -# $Id: $ - 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"; + } +} + +__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 @@ -20,7 +95,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,17 +107,20 @@ This is a subclass of C 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, your application will fail with an +error indicating a conflict the first time it tries to use +C's functionality. To fix this error, make sure your +custom request class inherits from C. =head1 METHODS -=over 4 data +=over -If the request went through the Deserializer action, this method will -returned the deserialized data structure. - -=cut +=item data -__PACKAGE__->mk_accessors(qw(data accept_only)); +If the request went through the Deserializer action, this method will +return the deserialized data structure. =item accepted_content_types @@ -73,79 +151,28 @@ 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}; - - 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 Adam Jacob , with lots of help from mst and jrockway +=head1 MAINTAINER + +J. Shirley + =head1 LICENSE You may distribute this code under the same terms as Perl itself.