X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FREST.pm;h=0fcd31cd09a250eb21724b77ce823ca63386097d;hb=f789417d081b4d519ded07eec046c0b01661e25d;hp=16c1e6a5e1cfe94b8b39bfe751d32eeb4cccb0e6;hpb=5bbe8fb2380d1d5bc86eb0e595f30c76aa29d6b2;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Request/REST.pm b/lib/Catalyst/Request/REST.pm index 16c1e6a..0fcd31c 100644 --- a/lib/Catalyst/Request/REST.pm +++ b/lib/Catalyst/Request/REST.pm @@ -1,21 +1,16 @@ -# -# REST.pm -# 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 qw/Catalyst::Request Class::Accessor::Fast/; +use Moose; use Catalyst::Utils; -use HTTP::Headers::Util qw(split_header_words); +use namespace::autoclean; +extends 'Catalyst::Request'; +with 'Catalyst::TraitFor::Request::REST'; + +# Please don't take this as a recommended way to do things. +# The code below is grotty, badly factored and mostly here for back +# compat.. sub _insert_self_into { my ($class, $app_class ) = @_; # the fallback to $app_class is for the (rare and deprecated) case when @@ -25,14 +20,31 @@ sub _insert_self_into { my $req_class = $app->request_class; return if $req_class->isa($class); + my $req_class_meta = Moose->init_meta( for_class => $req_class ); + my $role = $class->_related_role; + return if $req_class_meta->does_role($role); 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"; + } + else { + my $meta = Moose::Meta::Class->create_anon_class( + superclasses => [$req_class], + roles => [$role], + cache => 1 + ); + $meta->_add_meta_method('meta'); + $app->request_class($meta->name); } } +sub _related_role { 'Catalyst::TraitFor::Request::REST' } + +__PACKAGE__->meta->make_immutable; + +1; + +__END__ + =head1 NAME Catalyst::Request::REST - A REST-y subclass of Catalyst::Request @@ -47,145 +59,27 @@ Catalyst::Request::REST - A REST-y subclass of Catalyst::Request =head1 DESCRIPTION -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 - -If the request went through the Deserializer action, this method will -returned the deserialized data structure. - -=cut - -__PACKAGE__->mk_accessors(qw(data accept_only)); - -=over 4 - -=item accepted_content_types - -Returns an array reference of content types accepted by the -client. - -The list of types is created by looking at the following sources: - -=over 8 - -=item * Content-type header - -If this exists, this will always be the first type in the list. - -=item * content-type parameter - -If the request is a GET request and there is a "content-type" -parameter in the query string, this will come before any types in the -Accept header. - -=item * Accept header - -This will be parsed and the types found will be ordered by the -relative quality specified for each type. - -=back - -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; +This is a subclass of C that applies the +L role to your request class. That trait +adds a few methods to the request object to facilitate writing REST-y code. - foreach my $pair ( split_header_words($accept_header) ) { - my ( $type, $qvalue ) = @{$pair}[ 0, 3 ]; - next if $types{$type}; +This class is only here for backwards compatibility with applications already +subclassing this class. New code should use +L directly. - # 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; - } +L and L will arrange +for the request trait to be applied if needed. - unless ( defined $qvalue ) { - $qvalue = 1 - ( ++$counter / 1000 ); - } +=head1 SEE ALSO - $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 +L. -sub preferred_content_type { $_[0]->accepted_content_types->[0] } +=head1 AUTHORS -=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 +See L for authors. =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut - -1;