lib/Catalyst/Request/REST.pm

   1 package Catalyst::Request::REST;
   2 use Moose;
   3
   4 use Catalyst::Utils;
   5 use namespace::autoclean;
   6
   7 extends 'Catalyst::Request';
   8 with 'Catalyst::TraitFor::Request::REST';
   9
  10 our $VERSION = '1.01';
  11 $VERSION = eval $VERSION;
  12
  13 # Please don't take this as a recommended way to do things.
  14 # The code below is grotty, badly factored and mostly here for back
  15 # compat..
  16 sub _insert_self_into {
  17   my ($class, $app_class ) = @_;
  18   # the fallback to $app_class is for the (rare and deprecated) case when
  19   # people are defining actions in MyApp.pm instead of in a controller.
  20   my $app = (blessed($app_class) && $app_class->can('_application'))
  21         ? $app_class->_application : Catalyst::Utils::class2appclass( $app_class ) || $app_class;
  22
  23   my $req_class = $app->request_class;
  24   return if $req_class->isa($class);
  25   my $req_class_meta = Moose->init_meta( for_class => $req_class );
  26   my $role = $class->_related_role;
  27   return if $req_class_meta->does_role($role);
  28   if ($req_class eq 'Catalyst::Request') {
  29     $app->request_class($class);
  30   }
  31   else {
  32       my $meta = Moose::Meta::Class->create_anon_class(
  33           superclasses => [$req_class],
  34           roles => [$role],
  35           cache => 1
  36       );
  37       $meta->_add_meta_method('meta');
  38       $app->request_class($meta->name);
  39   }
  40 }
  41
  42 sub _related_role { 'Catalyst::TraitFor::Request::REST' }
  43
  44 __PACKAGE__->meta->make_immutable;
  45
  46 1;
  47
  48 __END__
  49
  50 =head1 NAME
  51
  52 Catalyst::Request::REST - A REST-y subclass of Catalyst::Request
  53
  54 =head1 SYNOPSIS
  55
  56      if ( $c->request->accepts('application/json') ) {
  57          ...
  58      }
  59
  60      my $types = $c->request->accepted_content_types();
  61
  62 =head1 DESCRIPTION
  63
  64 This is a subclass of C<Catalyst::Request> that applies the
  65 L<Catalyst::TraitFor::Request::REST> role to your request class. That trait
  66 adds a few methods to the request object to facilitate writing REST-y code.
  67
  68 This class is only here for backwards compatibility with applications already
  69 subclassing this class. New code should use
  70 L<Catalyst::TraitFor::Request::REST> directly.
  71
  72 L<Catalyst::Action::REST> and L<Catalyst::Controller::REST> will arrange
  73 for the request trait to be applied if needed.
  74
  75 =head1 SEE ALSO
  76
  77 L<Catalyst::TraitFor::Request::REST>.
  78
  79 =head1 AUTHORS
  80
  81 See L<Catalyst::Action::REST> for authors.
  82
  83 =head1 LICENSE
  84
  85 You may distribute this code under the same terms as Perl itself.
  86
  87 =cut