1 package Catalyst::Controller::DBIC::API;
3 #ABSTRACT: Provides a DBIx::Class web service automagically
5 BEGIN { extends 'Catalyst::Controller::ActionRole'; }
8 use DBIx::Class::ResultClass::HashRefInflator;
10 use Test::Deep::NoTest('eq_deeply');
11 use MooseX::Types::Moose(':all');
13 use Scalar::Util('blessed', 'reftype');
15 use Catalyst::Controller::DBIC::API::Request;
16 use namespace::autoclean;
18 with 'Catalyst::Controller::DBIC::API::StoredResultSource';
19 with 'Catalyst::Controller::DBIC::API::StaticArguments';
20 with 'Catalyst::Controller::DBIC::API::RequestArguments' => { static => 1 };
22 __PACKAGE__->config();
26 package MyApp::Controller::API::RPC::Artist;
28 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' }
31 ( action => { setup => { PathPart => 'artist', Chained => '/api/rpc/rpc_base' } }, # define parent chain action and partpath
32 class => 'MyAppDB::Artist', # DBIC schema class
33 create_requires => ['name', 'age'], # columns required to create
34 create_allows => ['nickname'], # additional non-required columns that create allows
35 update_allows => ['name', 'age', 'nickname'], # columns that update allows
36 update_allows => ['name', 'age', 'nickname'], # columns that update allows
37 select => [qw/name age/], # columns that data returns
38 prefetch => ['cds'], # relationships that are prefetched when no prefetch param is passed
39 prefetch_allows => [ # every possible prefetch param allowed
43 { cds => [qw/ tracks /] }
45 ordered_by => [qw/age/], # order of generated list
46 search_exposes => [qw/age nickname/, { cds => [qw/title year/] }], # columns that can be searched on via list
47 data_root => 'data' # defaults to "list" for backwards compatibility
48 use_json_boolean => 1, # use JSON::Any::true|false in the response instead of strings
49 return_object => 1, # makes create and update actions return the object
52 # Provides the following functional endpoints:
53 # /api/rpc/artist/create
54 # /api/rpc/artist/list
55 # /api/rpc/artist/id/[id]/delete
56 # /api/rpc/artist/id/[id]/update
63 begin is provided in the base class to setup the Catalyst Request object, by applying the DBIC::API::Request role.
71 Catalyst::Controller::DBIC::API::Request->meta->apply($c->req)
72 unless Moose::Util::does_role($c->req, 'Catalyst::Controller::DBIC::API::Request');
75 =method_protected setup
77 :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config')
79 This action is the chain root of the controller. It must either be overridden or configured to provide a base pathpart to the action and also a parent action. For example, for class MyAppDB::Track you might have
81 package MyApp::Controller::API::RPC::Track;
83 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC'; }
86 ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
92 sub setup :Chained('/api/rpc_base') :CaptureArgs(0) :PathPart('track') {
95 $self->next::method($c);
98 This action does nothing by default.
102 sub setup :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config') {}
104 =method_protected deserialize
106 :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
108 deserialize absorbs the request data and transforms it into useful bits by using CGI::Expand->expand_hash and a smattering of JSON::Any->from_json for a handful of arguments. Current only the following arguments are capable of being expressed as JSON:
117 It should be noted that arguments can used mixed modes in with some caveats. Each top level arg can be expressed as CGI::Expand with their immediate child keys expressed as JSON when sending the data application/x-www-form-urlencoded. Otherwise, you can send content as raw json and it will be deserialized as is with no CGI::Expand expasion.
121 sub deserialize :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
126 if ($c->req->data && scalar(keys %{$c->req->data}))
128 $req_params = $c->req->data;
132 $req_params = CGI::Expand->expand_hash($c->req->params);
134 foreach my $param (@{[$self->search_arg, $self->count_arg, $self->page_arg, $self->offset_arg, $self->ordered_by_arg, $self->grouped_by_arg, $self->prefetch_arg]})
136 # these params can also be composed of JSON
137 # but skip if the parameter is not provided
138 next if not exists $req_params->{$param};
139 # find out if CGI::Expand was involved
140 if (ref $req_params->{$param} eq 'HASH')
142 for my $key ( keys %{$req_params->{$param}} )
146 my $deserialized = JSON::Any->from_json($req_params->{$param}->{$key});
147 $req_params->{$param}->{$key} = $deserialized;
151 $c->log->debug("Param '$param.$key' did not deserialize appropriately: $_")
160 my $deserialized = JSON::Any->from_json($req_params->{$param});
161 $req_params->{$param} = $deserialized;
165 $c->log->debug("Param '$param' did not deserialize appropriately: $_")
172 $self->inflate_request($c, $req_params);
175 =method_protected generate_rs
177 generate_rs is used by inflate_request to generate the resultset stored in the current request. It receives $c as its only argument. And by default it merely returns the resultset from the stored_result_source on the controller. Override this method if you need to manipulate the default implementation of getting the resultset from the controller.
184 return $self->stored_result_source->resultset;
187 =method_protected inflate_request
189 inflate_request is called at the end of deserialize to populate key portions of the request with the useful bits
195 my ($self, $c, $params) = @_;
199 # set static arguments
200 $c->req->_set_controller($self);
202 # set request arguments
203 $c->req->_set_request_data($params);
205 # set the current resultset
206 $c->req->_set_current_result_set($self->generate_rs($c));
212 $self->push_error($c, { message => $_ });
217 =method_protected object_with_id
219 :Chained('deserialize') :CaptureArgs(1) :PathPart('')
221 This action is the chain root for all object level actions (such as delete and update) that operate on a single identifer. The provided identifier will be used to find that particular object and add it to the request's store of objects. Please see L<Catalyst::Controller::DBIC::API::Context> for more details on the stored objects.
225 sub object_with_id :Chained('deserialize') :CaptureArgs(1) :PathPart('')
227 my ($self, $c, $id) = @_;
229 my $vals = $c->req->request_data->{$self->data_root};
230 unless(defined($vals))
232 # no data root, assume the request_data itself is the payload
233 $vals = $c->req->request_data;
238 # there can be only one set of data
239 $c->req->add_object([$self->object_lookup($c, $id), $vals]);
244 $self->push_error($c, { message => $_ });
249 =method_protected objects_no_id
251 :Chained('deserialize') :CaptureArgs(0) :PathPart('')
253 This action is the chain root for object level actions (such as create, update, or delete) that can involve more than one object. The data stored at the data_root of the request_data will be interpreted as an array of hashes on which to operate. If the hashes are missing an 'id' key, they will be considered a new object to be created. Otherwise, the values in the hash will be used to perform an update. As a special case, a single hash sent will be coerced into an array. Please see L<Catalyst::Controller::DBIC::API::Context> for more details on the stored objects.
257 sub objects_no_id :Chained('deserialize') :CaptureArgs(0) :PathPart('')
261 if($c->req->has_request_data)
263 my $data = $c->req->request_data;
266 if(exists($data->{$self->data_root}) && defined($data->{$self->data_root}))
268 my $root = $data->{$self->data_root};
269 if(reftype($root) eq 'ARRAY')
273 elsif(reftype($root) eq 'HASH')
279 $c->log->error('Invalid request data');
280 $self->push_error($c, { message => 'Invalid request data' });
286 # no data root, assume the request_data itself is the payload
287 $vals = [$c->req->request_data];
290 foreach my $val (@$vals)
292 unless(exists($val->{id}))
294 $c->req->add_object([$c->req->current_result_set->new_result({}), $val]);
300 $c->req->add_object([$self->object_lookup($c, $val->{id}), $val]);
305 $self->push_error($c, { message => $_ });
312 =method_protected object_lookup
314 This method provides the look up functionality for an object based on 'id'. It is passed the current $c and the $id to be used to perform the lookup. Dies if there is no provided $id or if no object was found.
320 my ($self, $c, $id) = @_;
322 die 'No valid ID provided for look up' unless defined $id and length $id;
323 my $object = $c->req->current_result_set->find($id);
324 die "No object found for id '$id'" unless defined $object;
328 =method_protected list
330 list's steps are broken up into three distinct methods: L</list_munge_parameters>, L</list_perform_search>, and L</list_format_output>.
332 The goal of this method is to call ->search() on the current_result_set, HashRefInflator the result, and return it in $c->stash->{response}->{$self->data_root}. Please see the individual methods for more details on what actual processing takes place.
334 If the L</select> config param is defined then the hashes will contain only those columns, otherwise all columns in the object will be returned. L</select> of course supports the function/procedure calling semantics that L<DBIx::Class::ResultSet/select>. In order to have proper column names in the result, provide arguments in L</as> (which also follows L<DBIx::Class::ResultSet/as> semantics. Similarly L</count>, L</page>, L</grouped_by> and L</ordered_by> affect the maximum number of rows returned as well as the ordering and grouping. Note that if select, count, ordered_by or grouped_by request parameters are present then these will override the values set on the class with select becoming bound by the select_exposes attribute.
336 If not all objects in the resultset are required then it's possible to pass conditions to the method as request parameters. You can use a JSON string as the 'search' parameter for maximum flexibility or use L<CGI::Expand> syntax. In the second case the request parameters are expanded into a structure and then used as the search condition.
338 For example, these request parameters:
340 ?search.name=fred&search.cd.artist=luke
342 ?search={"name":"fred","cd": {"artist":"luke"}}
344 Would result in this search (where 'name' is a column of the schema class, 'cd' is a relation of the schema class and 'artist' is a column of the related class):
346 $rs->search({ name => 'fred', 'cd.artist' => 'luke' }, { join => ['cd'] })
348 It is also possible to use a JSON string for expandeded parameters:
350 ?search.datetime={"-between":["2010-01-06 19:28:00","2010-01-07 19:28:00"]}
352 Note that if pagination is needed, this can be achieved using a combination of the L</count> and L</page> parameters. For example:
356 Would result in this search:
358 $rs->search({}, { page => 2, rows => 20 })
366 $self->list_munge_parameters($c);
367 $self->list_perform_search($c);
368 $self->list_format_output($c);
370 # make sure there are no objects lingering
371 $c->req->clear_objects();
374 =method_protected list_munge_parameters
376 list_munge_parameters is a noop by default. All arguments will be passed through without any manipulation. In order to successfully manipulate the parameters before the search is performed, simply access $c->req->search_parameters|search_attributes (ArrayRef and HashRef respectively), which correspond directly to ->search($parameters, $attributes). Parameter keys will be in already-aliased form.
377 To store the munged parameters call $c->req->_set_search_parameters($newparams) and $c->req->_set_search_attributes($newattrs).
381 sub list_munge_parameters { } # noop by default
383 =method_protected list_perform_search
385 list_perform_search executes the actual search. current_result_set is updated to contain the result returned from ->search. If paging was requested, search_total_entries will be set as well.
389 sub list_perform_search
397 my $rs = $req->current_result_set->search
399 $req->search_parameters,
400 $req->search_attributes
403 $req->_set_current_result_set($rs);
405 $req->_set_search_total_entries($req->current_result_set->pager->total_entries)
406 if $req->has_search_attributes && (exists($req->search_attributes->{page}) && defined($req->search_attributes->{page}) && length($req->search_attributes->{page}));
411 $self->push_error($c, { message => 'a database error has occured.' });
416 =method_protected list_format_output
418 list_format_output prepares the response for transmission across the wire. A copy of the current_result_set is taken and its result_class is set to L<DBIx::Class::ResultClass::HashRefInflator>. Each row in the resultset is then iterated and passed to L</row_format_output> with the result of that call added to the output.
422 sub list_format_output
426 my $rs = $c->req->current_result_set->search;
427 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
434 foreach my $row ($rs->all)
436 push(@$formatted, $self->row_format_output($c, $row));
439 $output->{$self->data_root} = $formatted;
441 if ($c->req->has_search_total_entries)
443 $output->{$self->total_entries_arg} = $c->req->search_total_entries + 0;
446 $c->stash->{response} = $output;
451 $self->push_error($c, { message => 'a database error has occured.' });
456 =method_protected row_format_output
458 row_format_output is called each row of the inflated output generated from the search. It receives two arguments, the catalyst context and the hashref that represents the row. By default, this method is merely a passthrough.
462 sub row_format_output
464 my ($self, $c, $row) = @_;
465 return $row; # passthrough by default
468 =method_protected item
470 item will return a single object called by identifier in the uri. It will be inflated via each_object_inflate.
478 if($c->req->count_objects != 1)
481 $self->push_error($c, { message => 'No objects on which to operate' });
486 $c->stash->{response}->{$self->item_root} = $self->each_object_inflate($c, $c->req->get_object(0)->[0]);
490 =method_protected update_or_create
492 update_or_create is responsible for iterating any stored objects and performing updates or creates. Each object is first validated to ensure it meets the criteria specified in the L</create_requires> and L</create_allows> (or L</update_allows>) parameters of the controller config. The objects are then committed within a transaction via L</transact_objects> using a closure around L</save_objects>.
500 if($c->req->has_objects)
502 $self->validate_objects($c);
503 $self->transact_objects($c, sub { $self->save_objects($c, @_) } );
508 $self->push_error($c, { message => 'No objects on which to operate' });
513 =method_protected transact_objects
515 transact_objects performs the actual commit to the database via $schema->txn_do. This method accepts two arguments, the context and a coderef to be used within the transaction. All of the stored objects are passed as an arrayref for the only argument to the coderef.
521 my ($self, $c, $coderef) = @_;
525 $self->stored_result_source->schema->txn_do
534 $self->push_error($c, { message => 'a database error has occured.' });
539 =method_protected validate_objects
541 This is a shortcut method for performing validation on all of the stored objects in the request. Each object's provided values (for create or update) are updated to the allowed values permitted by the various config parameters.
551 foreach my $obj ($c->req->all_objects)
553 $obj->[1] = $self->validate_object($c, $obj);
559 $c->log->error($err);
560 $err =~ s/\s+at\s+.+\n$//g;
561 $self->push_error($c, { message => $err });
566 =method_protected validate_object
568 validate_object takes the context and the object as an argument. It then filters the passed values in slot two of the tuple through the create|update_allows configured. It then returns those filtered values. Values that are not allowed are silently ignored. If there are no values for a particular key, no valid values at all, or multiple of the same key, this method will die.
574 my ($self, $c, $obj) = @_;
575 my ($object, $params) = @$obj;
578 my %requires_map = map
583 ($object->in_storage)
585 : $c->stash->{create_requires} || $self->create_requires
590 (ref $_) ? %{$_} : ($_ => 1)
595 ($object->in_storage)
596 ? ($c->stash->{update_allows} || $self->update_allows)
597 : ($c->stash->{create_allows} || $self->create_allows)
601 foreach my $key (keys %allows_map)
603 # check value defined if key required
604 my $allowed_fields = $allows_map{$key};
606 if (ref $allowed_fields)
608 my $related_source = $object->result_source->related_source($key);
609 my $related_params = $params->{$key};
610 my %allowed_related_map = map { $_ => 1 } @$allowed_fields;
611 my $allowed_related_cols = ($allowed_related_map{'*'}) ? [$related_source->columns] : $allowed_fields;
613 foreach my $related_col (@{$allowed_related_cols})
615 if (defined(my $related_col_value = $related_params->{$related_col})) {
616 $values{$key}{$related_col} = $related_col_value;
622 my $value = $params->{$key};
624 if ($requires_map{$key})
626 unless (defined($value))
628 # if not defined look for default
629 $value = $object->result_source->column_info($key)->{default_value};
630 unless (defined $value)
632 die "No value supplied for ${key} and no default";
637 # check for multiple values
638 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
640 require Data::Dumper;
641 die "Multiple values for '${key}': ${\Data::Dumper::Dumper($value)}";
644 # check exists so we don't just end up with hash of undefs
645 # check defined to account for default values being used
646 $values{$key} = $value if exists $params->{$key} || defined $value;
650 unless (keys %values || !$object->in_storage)
652 die 'No valid keys passed';
658 =method_protected delete
660 delete operates on the stored objects in the request. It first transacts the objects, deleting them in the database using L</transact_objects> and a closure around L</delete_objects>, and then clears the request store of objects.
668 if($c->req->has_objects)
670 $self->transact_objects($c, sub { $self->delete_objects($c, @_) });
671 $c->req->clear_objects;
676 $self->push_error($c, { message => 'No objects on which to operate' });
681 =method_protected save_objects
683 This method is used by update_or_create to perform the actual database manipulations. It iterates each object calling L</save_object>.
689 my ($self, $c, $objects) = @_;
691 foreach my $obj (@$objects)
693 $self->save_object($c, $obj);
697 =method_protected save_object
699 save_object first checks to see if the object is already in storage. If so, it calls L</update_object_from_params> otherwise it calls L</insert_object_from_params>
705 my ($self, $c, $obj) = @_;
707 my ($object, $params) = @$obj;
709 if ($object->in_storage)
711 $self->update_object_from_params($c, $object, $params);
715 $self->insert_object_from_params($c, $object, $params);
720 =method_protected update_object_from_params
722 update_object_from_params iterates through the params to see if any of them are pertinent to relations. If so it calls L</update_object_relation> with the object, and the relation parameters. Then it calls ->update on the object.
726 sub update_object_from_params
728 my ($self, $c, $object, $params) = @_;
730 foreach my $key (keys %$params)
732 my $value = $params->{$key};
733 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
735 $self->update_object_relation($c, $object, delete $params->{$key}, $key);
738 elsif ($object->can($key)) {
739 $object->$key($value);
741 # accessor != colname
743 my $accessor = $object->result_source->column_info($key)->{accessor};
744 $object->$accessor($value);
751 =method_protected update_object_relation
753 update_object_relation finds the relation to the object, then calls ->update with the specified parameters
757 sub update_object_relation
759 my ($self, $c, $object, $related_params, $relation) = @_;
760 my $row = $object->find_related($relation, {} , {});
763 foreach my $key (keys %$related_params) {
764 my $value = $related_params->{$key};
765 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
767 $self->update_object_relation($c, $row, delete $related_params->{$key}, $key);
770 elsif ($row->can($key)) {
773 # accessor != colname
775 my $accessor = $row->result_source->column_info($key)->{accessor};
776 $row->$accessor($value);
782 $object->create_related($relation, $related_params);
786 =method_protected insert_object_from_params
788 insert_object_from_params sets the columns for the object, then calls ->insert
792 sub insert_object_from_params
794 my ($self, $c, $object, $params) = @_;
797 while (my ($k, $v) = each %{ $params }) {
798 if (ref($v) && !(reftype($v) eq reftype(JSON::Any::true))) {
802 $object->set_column($k => $v);
808 while (my ($k, $v) = each %rels) {
809 $object->create_related($k, $v);
813 =method_protected delete_objects
815 delete_objects iterates through each object calling L</delete_object>
821 my ($self, $c, $objects) = @_;
823 map { $self->delete_object($c, $_->[0]) } @$objects;
826 =method_protected delete_object
828 Performs the actual ->delete on the object
834 my ($self, $c, $object) = @_;
839 =method_protected end
841 end performs the final manipulation of the response before it is serialized. This includes setting the success of the request both at the HTTP layer and JSON layer. If configured with return_object true, and there are stored objects as the result of create or update, those will be inflated according to the schema and get_inflated_columns
852 # Check for errors caught elsewhere
853 if ( $c->res->status and $c->res->status != 200 ) {
854 $default_status = $c->res->status;
855 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
856 } elsif ($self->get_errors($c)) {
857 $c->stash->{response}->{messages} = $self->get_errors($c);
858 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
859 $default_status = 400;
861 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::true : 'true';
862 $default_status = 200;
865 unless ($default_status == 200)
867 delete $c->stash->{response}->{$self->data_root};
869 elsif($self->return_object && $c->req->has_objects)
871 my $returned_objects = [];
872 push(@$returned_objects, $self->each_object_inflate($c, $_)) for map { $_->[0] } $c->req->all_objects;
873 $c->stash->{response}->{$self->data_root} = scalar(@$returned_objects) > 1 ? $returned_objects : $returned_objects->[0];
876 $c->res->status( $default_status || 200 );
877 $c->forward('serialize');
880 =method_protected each_object_inflate
882 each_object_inflate executes during L</end> and allows hooking into the process of inflating the objects to return in the response. Receives, the context, and the object as arguments.
884 This only executes if L</return_object> if set and if there are any objects to actually return.
888 sub each_object_inflate
890 my ($self, $c, $object) = @_;
892 return { $object->get_columns };
895 =method_protected serialize
897 multiple actions forward to serialize which uses Catalyst::Action::Serialize.
901 # from Catalyst::Action::Serialize
902 sub serialize :ActionClass('Serialize') { }
904 =method_protected push_error
906 push_error stores an error message into the stash to be later retrieved by L</end>. Accepts a Dict[message => Str] parameter that defines the error message.
912 my ( $self, $c, $params ) = @_;
913 push( @{$c->stash->{_dbic_crud_errors}}, $params->{message} || 'unknown error' );
916 =method_protected get_errors
918 get_errors returns all of the errors stored in the stash
924 my ( $self, $c ) = @_;
925 return $c->stash->{_dbic_crud_errors};
930 Easily provide common API endpoints based on your L<DBIx::Class> schema classes. Module provides both RPC and REST interfaces to base functionality. Uses L<Catalyst::Action::Serialize> and L<Catalyst::Action::Deserialize> to serialise response and/or deserialise request.
934 This document describes base functionlity such as list, create, delete, update and the setting of config attributes. L<Catalyst::Controller::DBIC::API::RPC> and L<Catalyst::Controller::DBIC::API::REST> describe details of provided endpoints to those base methods.
936 You will need to create a controller for each schema class you require API endpoints for. For example if your schema has Artist and Track, and you want to provide a RESTful interface to these, you should create MyApp::Controller::API::REST::Artist and MyApp::Controller::API::REST::Track which both subclass L<Catalyst::Controller::DBIC::API::REST>. Similarly if you wanted to provide an RPC style interface then subclass L<Catalyst::Controller::DBIC::API::RPC>. You then configure these individually as specified in L</CONFIGURATION>.
938 Also note that the test suite of this module has an example application used to run tests against. It maybe helpful to look at that until a better tutorial is written.
942 Each of your controller classes needs to be configured to point at the relevant schema class, specify what can be updated and so on, as shown in the L</SYNOPSIS>.
944 The class, create_requires, create_allows and update_requires parameters can also be set in the stash like so:
946 sub setup :Chained('/api/rpc/rpc_base') :CaptureArgs(1) :PathPart('any') {
947 my ($self, $c, $object_type) = @_;
949 if ($object_type eq 'artist') {
950 $c->stash->{class} = 'MyAppDB::Artist';
951 $c->stash->{create_requires} = [qw/name/];
952 $c->stash->{update_allows} = [qw/name/];
954 $self->push_error($c, { message => "invalid object_type" });
958 $self->next::method($c);
961 Generally it's better to have one controller for each DBIC source with the config hardcoded, but in some cases this isn't possible.
963 Note that the Chained, CaptureArgs and PathPart are just standard Catalyst configuration parameters and that then endpoint specified in Chained - in this case '/api/rpc/rpc_base' - must actually exist elsewhere in your application. See L<Catalyst::DispatchType::Chained> for more details.
965 Below are explanations for various configuration parameters. Please see L<Catalyst::Controller::DBIC::API::StaticArguments> for more details.
969 Whatever you would pass to $c->model to get a resultset for this class. MyAppDB::Track for example.
973 By default, the response data is serialized into $c->stash->{response}->{$self->data_root} and data_root defaults to 'list' to preserve backwards compatibility. This is now configuable to meet the needs of the consuming client.
975 =head3 use_json_boolean
977 By default, the response success status is set to a string value of "true" or "false". If this attribute is true, JSON::Any's true() and false() will be used instead. Note, this does not effect other internal processing of boolean values.
979 =head3 count_arg, page_arg, select_arg, search_arg, grouped_by_arg, ordered_by_arg, prefetch_arg, as_arg, total_entries_arg
981 These attributes allow customization of the component to understand requests made by clients where these argument names are not flexible and cannot conform to this components defaults.
983 =head3 create_requires
985 Arrayref listing columns required to be passed to create in order for the request to be valid.
989 Arrayref listing columns additional to those specified in create_requires that are not required to create but which create does allow. Columns passed to create that are not listed in create_allows or create_requires will be ignored.
993 Arrayref listing columns that update will allow. Columns passed to update that are not listed here will be ignored.
997 Arguments to pass to L<DBIx::Class::ResultSet/select> when performing search for L</list>.
1001 Complements arguments passed to L<DBIx::Class::ResultSet/select> when performing a search. This allows you to specify column names in the result for RDBMS functions, etc.
1003 =head3 select_exposes
1005 Columns and related columns that are okay to return in the resultset since clients can request more or less information specified than the above select argument.
1009 Arguments to pass to L<DBIx::Class::ResultSet/prefetch> when performing search for L</list>.
1011 =head3 prefetch_allows
1013 Arrayref listing relationships that are allowed to be prefetched.
1014 This is necessary to avoid denial of service attacks in form of
1015 queries which would return a large number of data
1016 and unwanted disclosure of data.
1020 Arguments to pass to L<DBIx::Class::ResultSet/group_by> when performing search for L</list>.
1024 Arguments to pass to L<DBIx::Class::ResultSet/order_by> when performing search for L</list>.
1026 =head3 search_exposes
1028 Columns and related columns that are okay to search on. For example if only the position column and all cd columns were to be allowed
1030 search_exposes => [qw/position/, { cd => ['*'] }]
1032 You can also use this to allow custom columns should you wish to allow them through in order to be caught by a custom resultset. For example:
1034 package RestTest::Controller::API::RPC::TrackExposed;
1040 search_exposes => [qw/position title custom_column/],
1043 and then in your custom resultset:
1045 package RestTest::Schema::ResultSet::Track;
1047 use base 'RestTest::Schema::ResultSet';
1051 my ($clause, $params) = @_;
1054 if (my $pretend = delete $clause->{custom_column}) {
1055 $clause->{'cd.year'} = $pretend;
1057 my $rs = $self->SUPER::search(@_);
1062 Arguments to pass to L<DBIx::Class::ResultSet/rows> when performing search for L</list>.
1066 Arguments to pass to L<DBIx::Class::ResultSet/page> when performing search for L</list>.
1070 By default the create, delete and update actions will not return anything apart from the success parameter set in L</end>, often this is not ideal but the required behaviour varies from application to application. So normally it's sensible to write an intermediate class which your main controller classes subclass from.
1072 For example if you wanted create to return the JSON for the newly created object you might have something like:
1074 package MyApp::ControllerBase::DBIC::API::RPC;
1077 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' };
1079 sub create :Chained('setup') :Args(0) :PathPart('create') {
1080 my ($self, $c) = @_;
1082 # $c->req->all_objects will contain all of the created
1083 $self->next::method($c);
1085 if ($c->req->has_objects) {
1086 # $c->stash->{response} will be serialized in the end action
1087 $c->stash->{response}->{$self->data_root} = [ map { { $_->get_inflated_columns } } ($c->req->all_objects) ] ;
1091 package MyApp::Controller::API::RPC::Track;
1094 BEGIN { extends 'MyApp::ControllerBase::DBIC::API::RPC' };
1097 It should be noted that the return_object attribute will produce the above result for you, free of charge.
1099 Similarly you might want create, update and delete to all forward to the list action once they are done so you can refresh your view. This should also be simple enough.
1101 If more extensive customization is required, it is recommened to peer into the roles that comprise the system and make use
1105 It should be noted that version 1.004 and above makes a rapid depature from the status quo. The internals were revamped to use more modern tools such as Moose and its role system to refactor functionality out into self-contained roles.
1107 To this end, internally, this module now understands JSON boolean values (as represented by JSON::Any) and will Do The Right Thing in handling those values. This means you can have ColumnInflators installed that can covert between JSON::Any booleans and whatever your database wants for boolean values.
1109 Validation for various *_allows or *_exposes is now accomplished via Data::DPath::Validator with a lightly simplified, via subclass, Data::DPath::Validator::Visitor. The rough jist of the process goes as follows: Arguments provided to those attributes are fed into the Validator and Data::DPaths are generated. Then, incoming requests are validated against these paths generated. The validator is set in "loose" mode meaning only one path is required to match. For more information, please see L<Data::DPath::Validator> and more specifically L<Catalyst::Controller::DBIC::API::Validator>.
1112 Transactions are used. The stash is put aside in favor of roles applied to the request object with additional accessors.
1113 Error handling is now much more consistent with most errors immediately detaching.
1114 The internals are much easier to read and understand with lots more documentation.