X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Action-REST.git;a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FREST.pm;h=1d7e6af1401bba771091529c0a1d827b9c2eb770;hp=03c38697e1779de0a0563e9ccb1c136463215402;hb=3bb36dcaabf34fef5c15b1bb74c5eb198a7f5168;hpb=10bcd217c37d68aabbb0db8a5a7e233e679cb945 diff --git a/lib/Catalyst/Request/REST.pm b/lib/Catalyst/Request/REST.pm index 03c3869..1d7e6af 100644 --- a/lib/Catalyst/Request/REST.pm +++ b/lib/Catalyst/Request/REST.pm @@ -1,14 +1,18 @@ package Catalyst::Request::REST; +use Moose; -use strict; -use warnings; -use Scalar::Util qw/blessed/; +use Catalyst::Utils; +use namespace::autoclean; -use base qw/Catalyst::Request Class::Accessor::Fast/; +extends 'Catalyst::Request'; +with 'Catalyst::TraitFor::Request::REST'; -use Catalyst::Utils; -use HTTP::Headers::Util qw(split_header_words); +our $VERSION = '0.82'; +$VERSION = eval $VERSION; +# 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 @@ -18,72 +22,19 @@ sub _insert_self_into { 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 ]; + my $req_class_meta = Moose->init_meta( for_class => $req_class ); + return if $req_class_meta->does_role('Catalyst::TraitFor::Request::REST'); + my $meta = Moose::Meta::Class->create_anon_class( + superclasses => [$req_class], + roles => ['Catalyst::TraitFor::Request::REST'], + cache => 1 + ); + $meta->add_method(meta => sub { $meta }); + $app->request_class($meta->name); } -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 }; -} +__PACKAGE__->meta->make_immutable; +__END__ =head1 NAME @@ -99,67 +50,20 @@ 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. +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. -=head1 METHODS +This class is only here for backwards compatibility with applications already +subclassing this class. New code should use +L directly. -=over +L and L will arrange +for the request trait to be applied if needed. -=item data +=head1 SEE ALSO -If the request went through the Deserializer action, this method will -return the deserialized data structure. - -=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. - -=item preferred_content_type - -This returns the first content type found. It is shorthand for: - - $request->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. - -=back +L. =head1 AUTHORS @@ -170,5 +74,3 @@ See L for authors. You may distribute this code under the same terms as Perl itself. =cut - -1;