1 package Catalyst::TraitFor::Request::REST;
3 use HTTP::Headers::Util qw(split_header_words);
4 use namespace::autoclean;
6 has [qw/ data accept_only /] => ( is => 'rw' );
8 has accepted_content_types => (
12 builder => '_build_accepted_content_types',
16 has preferred_content_type => (
20 builder => '_build_preferred_content_type',
24 sub _build_accepted_content_types {
29 # First, we use the content type in the HTTP Request. It wins all.
30 $types{ $self->content_type } = 3
31 if $self->content_type;
33 if ($self->method eq "GET" && $self->param('content-type')) {
34 $types{ $self->param('content-type') } = 2;
37 # Third, we parse the Accept header, and see if the client
38 # takes a format we understand.
40 # This is taken from chansen's Apache2::UploadProgress.
41 if ( $self->header('Accept') ) {
42 $self->accept_only(1) unless keys %types;
44 my $accept_header = $self->header('Accept');
47 foreach my $pair ( split_header_words($accept_header) ) {
48 my ( $type, $qvalue ) = @{$pair}[ 0, 3 ];
49 next if $types{$type};
51 # cope with invalid (missing required q parameter) header like:
52 # application/json; charset="utf-8"
53 # http://tools.ietf.org/html/rfc2616#section-14.1
54 unless ( defined $pair->[2] && lc $pair->[2] eq 'q' ) {
58 unless ( defined $qvalue ) {
59 $qvalue = 1 - ( ++$counter / 1000 );
62 $types{$type} = sprintf( '%.3f', $qvalue );
66 [ sort { $types{$b} <=> $types{$a} } keys %types ];
69 sub _build_preferred_content_type { $_[0]->accepted_content_types->[0] }
75 return grep { $_ eq $type } @{ $self->accepted_content_types };
83 Catalyst::TraitFor::Request::REST - A role to apply to Catalyst::Request giving it REST methods and attributes.
87 if ( $c->request->accepts('application/json') ) {
91 my $types = $c->request->accepted_content_types();
95 This is a L<Moose::Role> applied to L<Catalyst::Request> that adds a few
96 methods to the request object to faciliate writing REST-y code.
97 Currently, these methods are all related to the content types accepted by
106 If the request went through the Deserializer action, this method will
107 return the deserialized data structure.
109 =item accepted_content_types
111 Returns an array reference of content types accepted by the
114 The list of types is created by looking at the following sources:
118 =item * Content-type header
120 If this exists, this will always be the first type in the list.
122 =item * content-type parameter
124 If the request is a GET request and there is a "content-type"
125 parameter in the query string, this will come before any types in the
128 =item * Accept header
130 This will be parsed and the types found will be ordered by the
131 relative quality specified for each type.
135 If a type appears in more than one of these places, it is ordered based on
136 where it is first found.
138 =item preferred_content_type
140 This returns the first content type found. It is shorthand for:
142 $request->accepted_content_types->[0]
146 Given a content type, this returns true if the type is accepted.
148 Note that this does not do any wildcard expansion of types.
154 See L<Catalyst::Action::REST> for authors.
158 You may distribute this code under the same terms as Perl itself.