use Moose;
use namespace::autoclean;
-our $VERSION = '0.80';
+our $VERSION = '0.91';
$VERSION = eval $VERSION;
=head1 NAME
# Answer PUT requests to "thing"
sub thing_PUT {
- $radiohead = $req->data->{radiohead};
+ my ( $self, $c ) = @_;
+
+ $radiohead = $c->req->data->{radiohead};
$self->status_created(
$c,
=item * C<text/html> => C<YAML::HTML>
This uses L<YAML::Syck> and L<URI::Find> to generate YAML with all URLs turned
-to hyperlinks. Only useable for Serialization.
+to hyperlinks. Only usable for Serialization.
=item * C<application/json> => C<JSON>
L<JSON::XS> installed. The C<text/x-json> content type is supported but is
deprecated and you will receive warnings in your log.
+You can also add a hash in your controller config to pass options to the json object.
+For instance, to relax permissions when deserializing input, add:
+ __PACKAGE__->config(
+ json_options => { relaxed => 1 }
+ )
+
=item * C<text/javascript> => C<JSONP>
If a callback=? parameter is passed, this returns javascript in the form of: $callback($serializedJSON);
+Note - this is disabled by default as it can be a security risk if you are unaware.
+
+The usual MIME types for this serialization format are: 'text/javascript', 'application/x-javascript',
+'application/javascript'.
+
=item * C<text/x-data-dumper> => C<Data::Serializer>
Uses the L<Data::Serializer> module to generate L<Data::Dumper> output.
'text/x-yaml' => 'YAML',
'application/json' => 'JSON',
'text/x-json' => 'JSON',
- 'application/x-javascript' => 'JSONP',
- 'application/javascript' => 'JSONP',
- 'text/javascript' => 'JSONP',
'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ],
'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ],
my $c = shift;
$c->response->status(204);
$self->_set_entity( $c, undef );
- return 1.;
+ return 1;
+}
+
+=item status_multiple_choices
+
+Returns a "300 MULTIPLE CHOICES" response. Takes an "entity" to serialize, which should
+provide list of possible locations. Also takes optional "location" for preferred choice.
+
+=cut
+
+sub status_multiple_choices {
+ my $self = shift;
+ my $c = shift;
+ my %p = Params::Validate::validate(
+ @_,
+ {
+ entity => 1,
+ location => { type => SCALAR | OBJECT, optional => 1 },
+ },
+ );
+
+ my $location;
+ if ( ref( $p{'location'} ) ) {
+ $location = $p{'location'}->as_string;
+ } else {
+ $location = $p{'location'};
+ }
+ $c->response->status(300);
+ $c->response->header( 'Location' => $location ) if exists $p{'location'};
+ $self->_set_entity( $c, $p{'entity'} );
+ return 1;
}
=item status_bad_request
'text/x-yaml' => 'YAML',
'application/json' => 'JSON',
'text/x-json' => 'JSON',
- 'application/x-javascript' => 'JSONP',
- 'application/javascript' => 'JSONP',
- 'text/javascript' => 'JSONP',
'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
'text/x-data-denter' => [ 'Data::Serializer', 'Data::Denter' ],
'text/x-data-taxi' => [ 'Data::Serializer', 'Data::Taxi' ],
The C<begin> method uses L<Catalyst::Action::Deserialize>. The C<end>
method uses L<Catalyst::Action::Serialize>. If you want to override
either behavior, simply implement your own C<begin> and C<end> actions
-and use MRO::Compat:
+and forward to another action with the Serialize and/or Deserialize
+action classes:
package Foo::Controller::Monkey;
use Moose;
use namespace::autoclean;
-
+
BEGIN { extends 'Catalyst::Controller::REST' }
- sub begin :Private {
+ sub begin : Private {
my ($self, $c) = @_;
... do things before Deserializing ...
- $self->maybe::next::method($c);
+ $c->forward('deserialize');
... do things after Deserializing ...
}
+ sub deserialize : ActionClass('Deserialize') {}
+
sub end :Private {
my ($self, $c) = @_;
... do things before Serializing ...
- $self->maybe::next::method($c);
+ $c->forward('serialize');
... do things after Serializing ...
}
+ sub serialize : ActionClass('Serialize') {}
+
+If you need to deserialize multipart requests (i.e. REST data in
+one part and file uploads in others) you can do so by using the
+L<Catalyst::Action::DeserializeMultiPart> action class.
+
=back
=head1 A MILD WARNING
I have code in production using L<Catalyst::Controller::REST>. That said,
it is still under development, and it's possible that things may change
-between releases. I promise to not break things unneccesarily. :)
+between releases. I promise to not break things unnecessarily. :)
=head1 SEE ALSO
=cut
+__PACKAGE__->meta->make_immutable;
+
1;