1 package Catalyst::Controller::DBIC::API;
3 #ABSTRACT: Provides a DBIx::Class web service automagically
5 BEGIN { extends 'Catalyst::Controller'; }
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
59 =method_protected setup
61 :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config')
63 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
65 package MyApp::Controller::API::RPC::Track;
66 use base qw/Catalyst::Controller::DBIC::API::RPC/;
69 ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
75 sub setup :Chained('/api/rpc_base') :CaptureArgs(0) :PathPart('track') {
78 $self->next::method($c);
81 This action will populate $c->req->current_result_set with $self->stored_result_source->resultset for other actions in the chain to use.
85 sub setup :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config')
89 Catalyst::Controller::DBIC::API::Request->meta->apply($c->req)
90 unless Moose::Util::does_role($c->req, 'Catalyst::Controller::DBIC::API::Request');
93 =method_protected deserialize
95 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:
104 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.
108 sub deserialize :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
113 if ($c->req->data && scalar(keys %{$c->req->data}))
115 $req_params = $c->req->data;
119 $req_params = CGI::Expand->expand_hash($c->req->params);
121 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]})
123 # these params can also be composed of JSON
124 # but skip if the parameter is not provided
125 next if not exists $req_params->{$param};
126 # find out if CGI::Expand was involved
127 if (ref $req_params->{$param} eq 'HASH')
129 for my $key ( keys %{$req_params->{$param}} )
133 my $deserialized = JSON::Any->from_json($req_params->{$param}->{$key});
134 $req_params->{$param}->{$key} = $deserialized;
138 $c->log->debug("Param '$param.$key' did not deserialize appropriately: $_")
147 my $deserialized = JSON::Any->from_json($req_params->{$param});
148 $req_params->{$param} = $deserialized;
152 $c->log->debug("Param '$param' did not deserialize appropriately: $_")
159 $self->inflate_request($c, $req_params);
162 =method_protected inflate_request
164 inflate_request is called at the end of deserialize to populate key portions of the request with the useful bits
170 my ($self, $c, $params) = @_;
174 # set static arguments
175 $c->req->_set_controller($self);
177 # set request arguments
178 $c->req->_set_request_data($params);
180 # set the current resultset
181 $c->req->_set_current_result_set($self->stored_result_source->resultset);
187 $self->push_error($c, { message => $_ });
192 =method_protected object_with_id
194 :Chained('deserialize') :CaptureArgs(1) :PathPart('')
196 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.
200 sub object_with_id :Chained('deserialize') :CaptureArgs(1) :PathPart('')
202 my ($self, $c, $id) = @_;
204 my $vals = $c->req->request_data->{$self->data_root};
205 unless(defined($vals))
207 # no data root, assume the request_data itself is the payload
208 $vals = $c->req->request_data;
213 # there can be only one set of data
214 $c->req->add_object([$self->object_lookup($c, $id), $vals]);
219 $self->push_error($c, { message => $_ });
224 =method_protected objects_no_id
226 :Chained('deserialize') :CaptureArgs(0) :PathPart('')
228 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.
232 sub objects_no_id :Chained('deserialize') :CaptureArgs(0) :PathPart('')
236 my $vals = $c->req->request_data->{$self->data_root};
237 unless(defined($vals))
239 # no data root, assume the request_data itself is the payload
240 $vals = [$c->req->request_data];
242 unless(reftype($vals) eq 'ARRAY')
244 $c->log->error('Invalid request data');
245 $self->push_error($c, { message => 'Invalid request data' });
249 foreach my $val (@$vals)
251 unless(exists($val->{id}))
253 $c->req->add_object([$c->req->current_result_set->new_result({}), $val]);
259 $c->req->add_object([$self->object_lookup($c, $val->{id}), $val]);
264 $self->push_error($c, { message => $_ });
270 =method_protected object_lookup
272 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.
278 my ($self, $c, $id) = @_;
280 die 'No valid ID provided for look up' unless defined $id and length $id;
281 my $object = $c->req->current_result_set->find($id);
282 die "No object found for id '$id'" unless defined $object;
286 =method_protected list
290 List level action chained from L</setup>. List's steps are broken up into three distinct methods: L</list_munge_parameters>, L</list_perform_search>, and L</list_format_output>.
292 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.
294 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.
296 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.
298 For example, these request parameters:
300 ?search.name=fred&search.cd.artist=luke
302 ?search={"name":"fred","cd": {"artist":"luke"}}
304 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):
306 $rs->search({ name => 'fred', 'cd.artist' => 'luke' }, { join => ['cd'] })
308 It is also possible to use a JSON string for expandeded parameters:
310 ?search.datetime={"-between":["2010-01-06 19:28:00","2010-01-07 19:28:00"]}
312 Note that if pagination is needed, this can be achieved using a combination of the L</count> and L</page> parameters. For example:
316 Would result in this search:
318 $rs->search({}, { page => 2, rows => 20 })
326 $self->list_munge_parameters($c);
327 $self->list_perform_search($c);
328 $self->list_format_output($c);
331 =method_protected list_munge_parameters
333 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.
337 sub list_munge_parameters { } # noop by default
339 =method_protected list_perform_search
341 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.
345 sub list_perform_search
353 my $rs = $req->current_result_set->search
355 $req->search_parameters,
356 $req->search_attributes
359 $req->_set_current_result_set($rs);
361 $req->_set_search_total_entries($req->current_result_set->pager->total_entries)
362 if $req->has_search_attributes && (exists($req->search_attributes->{page}) && defined($req->search_attributes->{page}) && length($req->search_attributes->{page}));
367 $self->push_error($c, { message => 'a database error has occured.' });
372 =method_protected list_format_output
374 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.
378 sub list_format_output
382 my $rs = $c->req->current_result_set->search;
383 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
390 foreach my $row ($rs->all)
392 push(@$formatted, $self->row_format_output($c, $row));
395 $output->{$self->data_root} = $formatted;
397 if ($c->req->has_search_total_entries)
399 $output->{$self->total_entries_arg} = $c->req->search_total_entries + 0;
402 $c->stash->{response} = $output;
407 $self->push_error($c, { message => 'a database error has occured.' });
412 =method_protected row_format_output
414 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.
418 sub row_format_output
420 my ($self, $c, $row) = @_;
421 return $row; # passthrough by default
424 =method_protected update_or_create
428 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>.
432 sub update_or_create :Private
436 if($c->req->has_objects)
438 $self->validate_objects($c);
439 $self->transact_objects($c, sub { $self->save_objects($c, @_) } );
444 $self->push_error($c, { message => 'No objects on which to operate' });
449 =method_protected transact_objects
451 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.
457 my ($self, $c, $coderef) = @_;
461 $self->stored_result_source->schema->txn_do
470 $self->push_error($c, { message => 'a database error has occured.' });
475 =method_protected validate_objects
477 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.
487 foreach my $obj ($c->req->all_objects)
489 $obj->[1] = $self->validate_object($c, $obj);
495 $c->log->error($err);
496 $err =~ s/\s+at\s+\/.+\n$//g;
497 $self->push_error($c, { message => $err });
502 =method_protected validate_object
504 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.
510 my ($self, $c, $obj) = @_;
511 my ($object, $params) = @$obj;
514 my %requires_map = map
519 ($object->in_storage)
521 : $c->stash->{create_requires} || $self->create_requires
526 (ref $_) ? %{$_} : ($_ => 1)
531 ($object->in_storage)
532 ? ($c->stash->{update_allows} || $self->update_allows)
533 : ($c->stash->{create_allows} || $self->create_allows)
537 foreach my $key (keys %allows_map)
539 # check value defined if key required
540 my $allowed_fields = $allows_map{$key};
542 if (ref $allowed_fields)
544 my $related_source = $object->result_source->related_source($key);
545 my $related_params = $params->{$key};
546 my %allowed_related_map = map { $_ => 1 } @$allowed_fields;
547 my $allowed_related_cols = ($allowed_related_map{'*'}) ? [$related_source->columns] : $allowed_fields;
549 foreach my $related_col (@{$allowed_related_cols})
551 if (my $related_col_value = $related_params->{$related_col}) {
552 $values{$key}{$related_col} = $related_col_value;
558 my $value = $params->{$key};
560 if ($requires_map{$key})
562 unless (defined($value))
564 # if not defined look for default
565 $value = $object->result_source->column_info($key)->{default_value};
566 unless (defined $value)
568 die "No value supplied for ${key} and no default";
573 # check for multiple values
574 if (ref($value) && !($value == JSON::Any::true || $value == JSON::Any::false))
576 require Data::Dumper;
577 die "Multiple values for '${key}': ${\Data::Dumper::Dumper($value)}";
580 # check exists so we don't just end up with hash of undefs
581 # check defined to account for default values being used
582 $values{$key} = $value if exists $params->{$key} || defined $value;
586 unless (keys %values || !$object->in_storage)
588 die 'No valid keys passed';
594 =method_protected delete
598 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.
606 if($c->req->has_objects)
608 $self->transact_objects($c, sub { $self->delete_objects($c, @_) });
609 $c->req->clear_objects;
614 $self->push_error($c, { message => 'No objects on which to operate' });
619 =method_protected save_objects
621 This method is used by update_or_create to perform the actual database manipulations. It iterates each object calling L</save_object>.
627 my ($self, $c, $objects) = @_;
629 foreach my $obj (@$objects)
631 $self->save_object($c, $obj);
635 =method_protected save_object
637 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>
643 my ($self, $c, $obj) = @_;
645 my ($object, $params) = @$obj;
647 if ($object->in_storage)
649 $self->update_object_from_params($c, $object, $params);
653 $self->insert_object_from_params($c, $object, $params);
658 =method_protected update_object_from_params
660 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 ->upbdate on the object.
664 sub update_object_from_params
666 my ($self, $c, $object, $params) = @_;
668 foreach my $key (keys %$params)
670 my $value = $params->{$key};
671 if (ref($value) && !($value == JSON::Any::true || $value == JSON::Any::false))
673 $self->update_object_relation($c, $object, delete $params->{$key}, $key);
677 $object->update($params);
680 =method_protected update_object_relation
682 update_object_relation finds the relation to the object, then calls ->update with the specified parameters
686 sub update_object_relation
688 my ($self, $c, $object, $related_params, $relation) = @_;
689 my $row = $object->find_related($relation, {} , {});
690 $row->update($related_params);
693 =method_protected insert_object_from_params
695 insert_object_from_params sets the columns for the object, then calls ->insert
699 sub insert_object_from_params
701 my ($self, $c, $object, $params) = @_;
702 $object->set_columns($params);
706 =method_protected delete_objects
708 delete_objects iterates through each object calling L</delete_object>
714 my ($self, $c, $objects) = @_;
716 map { $self->delete_object($c, $_->[0]) } @$objects;
719 =method_protected delete_object
721 Performs the actual ->delete on the object
727 my ($self, $c, $object) = @_;
732 =method_protected end
736 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
747 # Check for errors caught elsewhere
748 if ( $c->res->status and $c->res->status != 200 ) {
749 $default_status = $c->res->status;
750 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
751 } elsif ($self->get_errors($c)) {
752 $c->stash->{response}->{messages} = $self->get_errors($c);
753 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
754 $default_status = 400;
756 $c->stash->{response}->{success} = $self->use_json_boolean ? JSON::Any::true : 'true';
757 $default_status = 200;
760 unless ($default_status == 200)
762 delete $c->stash->{response}->{$self->data_root};
764 elsif($self->return_object && $c->req->has_objects)
766 my $returned_objects = [];
767 push(@$returned_objects, $self->each_object_inflate($c, $_)) for map { $_->[0] } $c->req->all_objects;
768 $c->stash->{response}->{$self->data_root} = scalar(@$returned_objects) > 1 ? $returned_objects : $returned_objects->[0];
771 $c->res->status( $default_status || 200 );
772 $c->forward('serialize');
775 =method_protected each_object_inflate
777 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.
779 This only executes if L</return_object> if set and if there are any objects to actually return.
783 sub each_object_inflate
785 my ($self, $c, $object) = @_;
787 return { $object->get_inflated_columns };
790 # from Catalyst::Action::Serialize
791 sub serialize :ActionClass('Serialize') { }
793 =method_protected push_error
795 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.
801 my ( $self, $c, $params ) = @_;
802 push( @{$c->stash->{_dbic_crud_errors}}, $params->{message} || 'unknown error' );
805 =method_protected get_errors
807 get_errors returns all of the errors stored in the stash
813 my ( $self, $c ) = @_;
814 return $c->stash->{_dbic_crud_errors};
819 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.
823 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.
825 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>.
827 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.
831 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>.
833 The class, create_requires, create_allows and update_requires parameters can also be set in the stash like so:
835 sub setup :Chained('/api/rpc/rpc_base') :CaptureArgs(1) :PathPart('any') {
836 my ($self, $c, $object_type) = @_;
838 if ($object_type eq 'artist') {
839 $c->stash->{class} = 'MyAppDB::Artist';
840 $c->stash->{create_requires} = [qw/name/];
841 $c->stash->{update_allows} = [qw/name/];
843 $self->push_error($c, { message => "invalid object_type" });
847 $self->next::method($c);
850 Generally it's better to have one controller for each DBIC source with the config hardcoded, but in some cases this isn't possible.
852 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.
854 Below are explanations for various configuration parameters. Please see L<Catalyst::Controller::DBIC::API::StaticArguments> for more details.
858 Whatever you would pass to $c->model to get a resultset for this class. MyAppDB::Track for example.
862 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.
864 =head3 use_json_boolean
866 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.
868 =head3 count_arg, page_arg, select_arg, search_arg, grouped_by_arg, ordered_by_arg, prefetch_arg, as_arg, total_entries_arg
870 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.
872 =head3 create_requires
874 Arrayref listing columns required to be passed to create in order for the request to be valid.
878 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.
882 Arrayref listing columns that update will allow. Columns passed to update that are not listed here will be ignored.
886 Arguments to pass to L<DBIx::Class::ResultSet/select> when performing search for L</list>.
890 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.
892 =head3 select_exposes
894 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.
898 Arguments to pass to L<DBIx::Class::ResultSet/prefetch> when performing search for L</list>.
900 =head3 prefetch_allows
902 Arrayref listing relationships that are allowed to be prefetched.
903 This is necessary to avoid denial of service attacks in form of
904 queries which would return a large number of data
905 and unwanted disclosure of data.
909 Arguments to pass to L<DBIx::Class::ResultSet/group_by> when performing search for L</list>.
913 Arguments to pass to L<DBIx::Class::ResultSet/order_by> when performing search for L</list>.
915 =head3 search_exposes
917 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
919 search_exposes => [qw/position/, { cd => ['*'] }]
921 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:
923 package RestTest::Controller::API::RPC::TrackExposed;
929 search_exposes => [qw/position title custom_column/],
932 and then in your custom resultset:
934 package RestTest::Schema::ResultSet::Track;
936 use base 'RestTest::Schema::ResultSet';
940 my ($clause, $params) = @_;
943 if (my $pretend = delete $clause->{custom_column}) {
944 $clause->{'cd.year'} = $pretend;
946 my $rs = $self->SUPER::search(@_);
951 Arguments to pass to L<DBIx::Class::ResultSet/rows> when performing search for L</list>.
955 Arguments to pass to L<DBIx::Class::ResultSet/rows> when performing search for L</list>.
959 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.
961 For example if you wanted create to return the JSON for the newly created object you might have something like:
963 package MyApp::ControllerBase::DBIC::API::RPC;
966 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' };
968 sub create :Chained('setup') :Args(0) :PathPart('create') {
971 # $c->req->all_objects will contain all of the created
972 $self->next::method($c);
974 if ($c->req->has_objects) {
975 # $c->stash->{response} will be serialized in the end action
976 $c->stash->{response}->{$self->data_root} = [ map { { $_->get_inflated_columns } } ($c->req->all_objects) ] ;
981 package MyApp::Controller::API::RPC::Track;
984 BEGIN { extends 'MyApp::ControllerBase::DBIC::API::RPC' };
987 It should be noted that the return_object attribute will produce the above result for you, free of charge.
989 For REST the only difference besides the class names would be that create should be :Private rather than an endpoint.
991 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.
993 If more extensive customization is required, it is recommened to peer into the roles that comprise the system and make use
997 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.
999 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.
1001 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>.
1004 Transactions are used. The stash is put aside in favor of roles applied to the request object with additional accessors.
1005 Error handling is now much more consistent with most errors immediately detaching.
1006 The internals are much easier to read and understand with lots more documentation.