use base 'Catalyst::Action';
use Class::Inspector;
-use Catalyst;
use Catalyst::Request::REST;
use Catalyst::Controller::REST;
BEGIN { require 5.008001; }
-our $VERSION = '0.73';
+our $VERSION = '0.78';
+$VERSION = eval $VERSION;
sub new {
my $class = shift;
my $config = shift;
Catalyst::Request::REST->_insert_self_into( $config->{class} );
- return $class->SUPER::new($config, @_);
+ return $class->next::method($config, @_);
}
=head1 NAME
... do something for GET requests ...
}
- sub foo_PUT {
- ... do somethign for PUT requests ...
+ # alternatively use an Action
+ sub foo_PUT : Action {
+ ... do something for PUT requests ...
}
=head1 DESCRIPTION
This Action handles doing automatic method dispatching for REST requests. It
takes a normal Catalyst action, and changes the dispatch to append an
-underscore and method name.
+underscore and method name. First it will try dispatching to an action with
+the generated name, and failing that it will try to dispatch to a regular
+method.
For example, in the synopsis above, calling GET on "/foo" would result in
the foo_GET method being dispatched.
my $c = shift;
my $controller = $c->component( $self->class );
- my $method = $self->name . "_" . uc( $c->request->method );
-
- if (my $code = $controller->can($method)) {
- $c->execute( $self->class, $self, @{ $c->req->args } ) if $code;
- local $self->{reverse} = $self->{reverse} . "_" . uc( $c->request->method );
- local $self->{code} = $code;
+ my $rest_method = $self->name . "_" . uc( $c->request->method );
+
+ my ($code, $name);
+
+ # Common case, for foo_GET etc
+ if ( $code = $controller->action_for($rest_method) ) {
+ $c->execute( $self->class, $self, @{ $c->req->args } );
+ return $c->forward( $code, $c->req->args );
+ } elsif ($code = $controller->can($rest_method)) {
+ # Exceute normal action
+ $c->execute( $self->class, $self, @{ $c->req->args } );
+ $name = $rest_method;
+ }
- return $c->execute( $self->class, $self, @{ $c->req->args } );
+ # Generic handling for foo_OPTIONS
+ if (!$code && $c->request->method eq "OPTIONS") {
+ $name = $rest_method;
+ $code = sub { $self->_return_options($self->name, @_) };
}
- if ($c->request->method eq "OPTIONS") {
- local $self->{reverse} = $self->{reverse} . "_" . uc( $c->request->method );
- local $self->{code} = sub { $self->can('_return_options')->($self->name, @_) };
- return $c->execute( $self->class, $self, @{ $c->req->args } );
+
+ # Otherwise, not implemented.
+ if (!$code) {
+ $name = $self->name . "_not_implemented";
+ $code = $controller->can($name) # User method
+ # Generic not implemented
+ || sub { $self->_return_not_implemented($self->name, @_) };
}
- my $not_implemented_method = $self->name . "_not_implemented";
- local $self->{code} = $controller->can($not_implemented_method)
- || sub { $self->can('_return_not_implemented')->($self->name, @_); };
- local $self->{reverse} = $not_implemented_method;
+ # localise stuff so we can dispatch the action 'as normal, but get
+ # different stats shown, and different code run.
+ local $self->{code} = $code;
+ local $self->{reverse} = $name;
$c->execute( $self->class, $self, @{ $c->req->args } );
}
-my $_get_allowed_methods = sub {
- my ( $controller, $c, $name ) = @_;
+sub _get_allowed_methods {
+ my ( $self, $controller, $c, $name ) = @_;
my $class = ref($controller) ? ref($controller) : $controller;
my $methods = Class::Inspector->methods($class);
my @allowed;
};
sub _return_options {
- my ( $method_name, $controller, $c) = @_;
- my @allowed = $controller->$_get_allowed_methods($c, $method_name);
+ my ( $self, $method_name, $controller, $c) = @_;
+ my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
$c->response->content_type('text/plain');
$c->response->status(200);
$c->response->header( 'Allow' => \@allowed );
}
sub _return_not_implemented {
- my ( $method_name, $controller, $c ) = @_;
+ my ( $self, $method_name, $controller, $c ) = @_;
- my @allowed = $controller->$_get_allowed_methods($c, $method_name);
+ my @allowed = $self->_get_allowed_methods($controller, $c, $method_name);
$c->response->content_type('text/plain');
$c->response->status(405);
$c->response->header( 'Allow' => \@allowed );
=item Q: I'm getting a "415 Unsupported Media Type" error. What gives?!
-A: Most likely, you haven't set Content-type equal to "application/json", or one of the
-accepted return formats. You can do this by setting it in your query string thusly:
-?content-type=application%2Fjson (where %2F == / uri escaped).
-
-**NOTE** Apache will refuse %2F unless configured otherise.
-Make sure AllowEncodedSlashes On is in your httpd.conf file in order for this to run smoothly.
-
-=cut
-
-=cut
+A: Most likely, you haven't set Content-type equal to "application/json", or
+one of the accepted return formats. You can do this by setting it in your query
+accepted return formats. You can do this by setting it in your query string
+thusly: C<< ?content-type=application%2Fjson (where %2F == / uri escaped). >>
+B<NOTE> Apache will refuse %2F unless configured otherise.
+Make sure C<< AllowEncodedSlashes On >> is in your httpd.conf file in orde
+for this to run smoothly.
+=back
+=head1 AUTHOR
-=head1 MAINTAINER
+Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
-J. Shirley <jshirley@gmail.com>
+Marchex, Inc. paid me while I developed this module. (L<http://www.marchex.com>)
=head1 CONTRIBUTORS
+Arthur Axel "fREW" Schmidt <frioux@gmail.com>
+
Christopher Laco
Luke Saunders
Daisuke Maki <daisuke@endeworks.jp>
-=head1 AUTHOR
+J. Shirley <jshirley@gmail.com>
-Adam Jacob <adam@stalecoffee.org>, with lots of help from mst and jrockway
+Hans Dieter Pearcey
+
+Tomas Doran (t0m) <bobtfish@bobtfish.net>
+
+=head1 COPYRIGHT
-Marchex, Inc. paid me while I developed this module. (http://www.marchex.com)
+Copyright the above named AUTHOR and CONTRIBUTORS
=head1 LICENSE
projects / catagits/Catalyst-Action-REST.git / blobdiff