-#
-# 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 Moose;
+
+use Catalyst::Utils;
+use namespace::autoclean;
+
+extends 'Catalyst::Request';
+with 'Catalyst::TraitFor::Request::REST';
+
+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
+ # 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);
+ 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);
+}
-use strict;
-use warnings;
-
-use base 'Catalyst::Request';
-use HTTP::Headers::Util qw(split_header_words);
-
+__PACKAGE__->meta->make_immutable;
+__END__
=head1 NAME
=head1 SYNOPSIS
- if ( $c->request->accepts('text/x-json') ) {
+ if ( $c->request->accepts('application/json') ) {
...
}
=head1 DESCRIPTION
-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.
-
-
-=head1 METHODS
-
-=over 4 data
-
-If the request went through the Deserializer action, this method will
-returned the deserialized data structure.
-
-=cut
-
-__PACKAGE__->mk_accessors(qw(data accept_only));
-
-=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;
-
- 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
+This is a subclass of C<Catalyst::Request> that applies the
+L<Catalyst::TraitFor::Request::REST> role to your request class. That trait
+adds a few methods to the request object to facilitate writing REST-y code.
-sub preferred_content_type { $_[0]->accepted_content_types->[0] }
+This class is only here for backwards compatibility with applications already
+subclassing this class. New code should use
+L<Catalyst::TraitFor::Request::REST> directly.
-=item accepts($type)
+L<Catalyst::Action::REST> and L<Catalyst::Controller::REST> will arrange
+for the request trait to be applied if needed.
-Given a content type, this returns true if the type is accepted.
+=head1 SEE ALSO
-Note that this does not do any wildcard expansion of types.
+L<Catalyst::TraitFor::Request::REST>.
-=cut
-
-sub accepts {
- my $self = shift;
- my $type = shift;
-
- return grep { $_ eq $type } @{ $self->accepted_content_types };
-}
-
-=head1 AUTHOR
+=head1 AUTHORS
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+See L<Catalyst::Action::REST> for authors.
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
-
-1;
projects / catagits/Catalyst-Action-REST.git / blobdiff