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