X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Action-Serialize-Data-Serializer.git;a=blobdiff_plain;f=lib%2FCatalyst%2FTraitFor%2FRequest%2FREST.pm;fp=lib%2FCatalyst%2FTraitFor%2FRequest%2FREST.pm;h=0000000000000000000000000000000000000000;hp=91065203770c5986e3e43640af39b5f05c56dc39;hb=79025f72c27ba313b3c701cee238f84166f32f9e;hpb=f10c7e1c7eb3b4cb10401dbb86ca8db3dc38ced2 diff --git a/lib/Catalyst/TraitFor/Request/REST.pm b/lib/Catalyst/TraitFor/Request/REST.pm deleted file mode 100644 index 9106520..0000000 --- a/lib/Catalyst/TraitFor/Request/REST.pm +++ /dev/null @@ -1,164 +0,0 @@ -package Catalyst::TraitFor::Request::REST; -use Moose::Role; -use HTTP::Headers::Util qw(split_header_words); -use namespace::autoclean; - -our $VERSION = '1.07'; -$VERSION = eval $VERSION; - -has [qw/ data accept_only /] => ( is => 'rw' ); - -has accepted_content_types => ( - is => 'ro', - isa => 'ArrayRef', - lazy => 1, - builder => '_build_accepted_content_types', - init_arg => undef, -); - -has preferred_content_type => ( - is => 'ro', - isa => 'Str', - lazy => 1, - builder => '_build_preferred_content_type', - init_arg => undef, -); - -sub _build_accepted_content_types { - my $self = shift; - - 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 ); - } - } - - [ sort { $types{$b} <=> $types{$a} } keys %types ]; -} - -sub _build_preferred_content_type { $_[0]->accepted_content_types->[0] } - -sub accepts { - my $self = shift; - my $type = shift; - - return grep { $_ eq $type } @{ $self->accepted_content_types }; -} - -1; -__END__ - -=head1 NAME - -Catalyst::TraitFor::Request::REST - A role to apply to Catalyst::Request giving it REST methods and attributes. - -=head1 SYNOPSIS - - if ( $c->request->accepts('application/json') ) { - ... - } - - my $types = $c->request->accepted_content_types(); - -=head1 DESCRIPTION - -This is a L applied to L that adds a few -methods to the request object to facilitate writing REST-y code. -Currently, these methods are all related to the content types accepted by -the client. - -=head1 METHODS - -=over - -=item data - -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 - -=head1 AUTHORS - -See L for authors. - -=head1 LICENSE - -You may distribute this code under the same terms as Perl itself. - -=cut -