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 'Catalyst::Controller::DBIC::API::StaticArguments',
20 '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',
33 result_class => 'MyAppDB::ResultSet::Artist',
34 create_requires => ['name', 'age'],
35 create_allows => ['nickname'],
36 update_allows => ['name', 'age', 'nickname'],
37 update_allows => ['name', 'age', 'nickname'],
38 select => [qw/name age/],
44 { cds => [qw/ tracks /] },
46 ordered_by => [qw/age/],
47 search_exposes => [qw/age nickname/, { cds => [qw/title year/] }],
49 use_json_boolean => 1,
53 # Provides the following functional endpoints:
54 # /api/rpc/artist/create
55 # /api/rpc/artist/list
56 # /api/rpc/artist/id/[id]/delete
57 # /api/rpc/artist/id/[id]/update
64 begin is provided in the base class to setup the Catalyst Request object, by applying the DBIC::API::Request role.
72 Catalyst::Controller::DBIC::API::Request->meta->apply($c->req)
73 unless Moose::Util::does_role($c->req, 'Catalyst::Controller::DBIC::API::Request');
76 =method_protected setup
78 :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config')
80 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
82 package MyApp::Controller::API::RPC::Track;
84 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC'; }
87 ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
93 sub setup :Chained('/api/rpc_base') :CaptureArgs(0) :PathPart('track') {
96 $self->next::method($c);
99 This action does nothing by default.
103 sub setup :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config') {}
105 =method_protected deserialize
107 :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
109 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:
118 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.
122 sub deserialize :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
127 if ($c->req->data && scalar(keys %{$c->req->data}))
129 $req_params = $c->req->data;
133 $req_params = CGI::Expand->expand_hash($c->req->params);
135 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]})
137 # these params can also be composed of JSON
138 # but skip if the parameter is not provided
139 next if not exists $req_params->{$param};
140 # find out if CGI::Expand was involved
141 if (ref $req_params->{$param} eq 'HASH')
143 for my $key ( keys %{$req_params->{$param}} )
147 my $deserialized = JSON::Any->from_json($req_params->{$param}->{$key});
148 $req_params->{$param}->{$key} = $deserialized;
152 $c->log->debug("Param '$param.$key' did not deserialize appropriately: $_")
161 my $deserialized = JSON::Any->from_json($req_params->{$param});
162 $req_params->{$param} = $deserialized;
166 $c->log->debug("Param '$param' did not deserialize appropriately: $_")
173 $self->inflate_request($c, $req_params);
176 =method_protected generate_rs
178 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 #my ($self, $c) = @_;
187 return $self->stored_result_source->resultset;
190 =method_protected inflate_request
192 inflate_request is called at the end of deserialize to populate key portions of the request with the useful bits
198 my ($self, $c, $params) = @_;
202 # set static arguments
203 $c->req->_set_controller($self);
205 # set request arguments
206 $c->req->_set_request_data($params);
208 # set the current resultset
209 $c->req->_set_current_result_set($self->generate_rs($c));
215 $self->push_error($c, { message => $_ });
220 =method_protected object_with_id
222 :Chained('deserialize') :CaptureArgs(1) :PathPart('')
224 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.
228 sub object_with_id :Chained('deserialize') :CaptureArgs(1) :PathPart('')
230 my ($self, $c, $id) = @_;
232 my $vals = $c->req->request_data->{$self->data_root};
233 unless(defined($vals))
235 # no data root, assume the request_data itself is the payload
236 $vals = $c->req->request_data;
241 # there can be only one set of data
242 $c->req->add_object([$self->object_lookup($c, $id), $vals]);
247 $self->push_error($c, { message => $_ });
252 =method_protected objects_no_id
254 :Chained('deserialize') :CaptureArgs(0) :PathPart('')
256 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.
260 sub objects_no_id :Chained('deserialize') :CaptureArgs(0) :PathPart('')
264 if($c->req->has_request_data)
266 my $data = $c->req->request_data;
269 if(exists($data->{$self->data_root}) && defined($data->{$self->data_root}))
271 my $root = $data->{$self->data_root};
272 if(reftype($root) eq 'ARRAY')
276 elsif(reftype($root) eq 'HASH')
282 $c->log->error('Invalid request data');
283 $self->push_error($c, { message => 'Invalid request data' });
289 # no data root, assume the request_data itself is the payload
290 $vals = [$c->req->request_data];
293 foreach my $val (@$vals)
295 unless(exists($val->{id}))
297 $c->req->add_object([$c->req->current_result_set->new_result({}), $val]);
303 $c->req->add_object([$self->object_lookup($c, $val->{id}), $val]);
308 $self->push_error($c, { message => $_ });
315 =method_protected object_lookup
317 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.
323 my ($self, $c, $id) = @_;
325 die 'No valid ID provided for look up' unless defined $id and length $id;
326 my $object = $c->req->current_result_set->find($id);
327 die "No object found for id '$id'" unless defined $object;
331 =method_protected list
333 list's steps are broken up into three distinct methods: L</list_munge_parameters>, L</list_perform_search>, and L</list_format_output>.
335 The goal of this method is to call ->search() on the current_result_set, change resultset class of the result (if needed), and return it in $c->stash->{$self->stash_key}->{$self->data_root}. Please see the individual methods for more details on what actual processing takes place.
337 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.
339 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.
341 For example, these request parameters:
343 ?search.name=fred&search.cd.artist=luke
345 ?search={"name":"fred","cd": {"artist":"luke"}}
347 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):
349 $rs->search({ name => 'fred', 'cd.artist' => 'luke' }, { join => ['cd'] })
351 It is also possible to use a JSON string for expandeded parameters:
353 ?search.datetime={"-between":["2010-01-06 19:28:00","2010-01-07 19:28:00"]}
355 Note that if pagination is needed, this can be achieved using a combination of the L</count> and L</page> parameters. For example:
359 Would result in this search:
361 $rs->search({}, { page => 2, rows => 20 })
369 $self->list_munge_parameters($c);
370 $self->list_perform_search($c);
371 $self->list_format_output($c);
373 # make sure there are no objects lingering
374 $c->req->clear_objects();
377 =method_protected list_munge_parameters
379 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.
380 To store the munged parameters call $c->req->_set_search_parameters($newparams) and $c->req->_set_search_attributes($newattrs).
384 sub list_munge_parameters { } # noop by default
386 =method_protected list_perform_search
388 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.
392 sub list_perform_search
400 my $rs = $req->current_result_set->search
402 $req->search_parameters,
403 $req->search_attributes
406 $req->_set_current_result_set($rs);
408 $req->_set_search_total_entries($req->current_result_set->pager->total_entries)
409 if $req->has_search_attributes && (exists($req->search_attributes->{page}) && defined($req->search_attributes->{page}) && length($req->search_attributes->{page}));
414 $self->push_error($c, { message => 'a database error has occured.' });
419 =method_protected list_format_output
421 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.
425 sub list_format_output
429 my $rs = $c->req->current_result_set->search;
430 $rs->result_class($self->result_class) if $self->result_class;
437 foreach my $row ($rs->all)
439 push(@$formatted, $self->row_format_output($c, $row));
442 $output->{$self->data_root} = $formatted;
444 if ($c->req->has_search_total_entries)
446 $output->{$self->total_entries_arg} = $c->req->search_total_entries + 0;
449 $c->stash->{$self->stash_key} = $output;
454 $self->push_error($c, { message => 'a database error has occured.' });
459 =method_protected row_format_output
461 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.
465 sub row_format_output
467 #my ($self, $c, $row) = @_;
468 my ($self, undef, $row) = @_;
469 return $row; # passthrough by default
472 =method_protected item
474 item will return a single object called by identifier in the uri. It will be inflated via each_object_inflate.
482 if($c->req->count_objects != 1)
485 $self->push_error($c, { message => 'No objects on which to operate' });
490 $c->stash->{$self->stash_key}->{$self->item_root} = $self->each_object_inflate($c, $c->req->get_object(0)->[0]);
494 =method_protected update_or_create
496 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>.
504 if($c->req->has_objects)
506 $self->validate_objects($c);
507 $self->transact_objects($c, sub { $self->save_objects($c, @_) } );
512 $self->push_error($c, { message => 'No objects on which to operate' });
517 =method_protected transact_objects
519 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.
525 my ($self, $c, $coderef) = @_;
529 $self->stored_result_source->schema->txn_do
538 $self->push_error($c, { message => 'a database error has occured.' });
543 =method_protected validate_objects
545 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.
555 foreach my $obj ($c->req->all_objects)
557 $obj->[1] = $self->validate_object($c, $obj);
563 $c->log->error($err);
564 $err =~ s/\s+at\s+.+\n$//g;
565 $self->push_error($c, { message => $err });
570 =method_protected validate_object
572 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.
578 my ($self, $c, $obj) = @_;
579 my ($object, $params) = @$obj;
582 my %requires_map = map
587 ($object->in_storage)
589 : $c->stash->{create_requires} || $self->create_requires
594 (ref $_) ? %{$_} : ($_ => 1)
599 ($object->in_storage)
600 ? ($c->stash->{update_allows} || $self->update_allows)
601 : ($c->stash->{create_allows} || $self->create_allows)
605 foreach my $key (keys %allows_map)
607 # check value defined if key required
608 my $allowed_fields = $allows_map{$key};
610 if (ref $allowed_fields)
612 my $related_source = $object->result_source->related_source($key);
613 my $related_params = $params->{$key};
614 my %allowed_related_map = map { $_ => 1 } @$allowed_fields;
615 my $allowed_related_cols = ($allowed_related_map{'*'}) ? [$related_source->columns] : $allowed_fields;
617 foreach my $related_col (@{$allowed_related_cols})
619 if (defined(my $related_col_value = $related_params->{$related_col})) {
620 $values{$key}{$related_col} = $related_col_value;
626 my $value = $params->{$key};
628 if ($requires_map{$key})
630 unless (defined($value))
632 # if not defined look for default
633 $value = $object->result_source->column_info($key)->{default_value};
634 unless (defined $value)
636 die "No value supplied for ${key} and no default";
641 # check for multiple values
642 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
644 require Data::Dumper;
645 die "Multiple values for '${key}': ${\Data::Dumper::Dumper($value)}";
648 # check exists so we don't just end up with hash of undefs
649 # check defined to account for default values being used
650 $values{$key} = $value if exists $params->{$key} || defined $value;
654 unless (keys %values || !$object->in_storage)
656 die 'No valid keys passed';
662 =method_protected delete
664 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.
672 if($c->req->has_objects)
674 $self->transact_objects($c, sub { $self->delete_objects($c, @_) });
675 $c->req->clear_objects;
680 $self->push_error($c, { message => 'No objects on which to operate' });
685 =method_protected save_objects
687 This method is used by update_or_create to perform the actual database manipulations. It iterates each object calling L</save_object>.
693 my ($self, $c, $objects) = @_;
695 foreach my $obj (@$objects)
697 $self->save_object($c, $obj);
701 =method_protected save_object
703 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>
709 my ($self, $c, $obj) = @_;
711 my ($object, $params) = @$obj;
713 if ($object->in_storage)
715 $self->update_object_from_params($c, $object, $params);
719 $self->insert_object_from_params($c, $object, $params);
724 =method_protected update_object_from_params
726 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.
730 sub update_object_from_params
732 my ($self, $c, $object, $params) = @_;
734 foreach my $key (keys %$params)
736 my $value = $params->{$key};
737 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
739 $self->update_object_relation($c, $object, delete $params->{$key}, $key);
742 elsif ($object->can($key)) {
743 $object->$key($value);
745 # accessor != colname
747 my $accessor = $object->result_source->column_info($key)->{accessor};
748 $object->$accessor($value);
755 =method_protected update_object_relation
757 update_object_relation finds the relation to the object, then calls ->update with the specified parameters
761 sub update_object_relation
763 my ($self, $c, $object, $related_params, $relation) = @_;
764 my $row = $object->find_related($relation, {} , {});
767 foreach my $key (keys %$related_params) {
768 my $value = $related_params->{$key};
769 if (ref($value) && !(reftype($value) eq reftype(JSON::Any::true)))
771 $self->update_object_relation($c, $row, delete $related_params->{$key}, $key);
774 elsif ($row->can($key)) {
777 # accessor != colname
779 my $accessor = $row->result_source->column_info($key)->{accessor};
780 $row->$accessor($value);
786 $object->create_related($relation, $related_params);
790 =method_protected insert_object_from_params
792 insert_object_from_params sets the columns for the object, then calls ->insert
796 sub insert_object_from_params
798 #my ($self, $c, $object, $params) = @_;
799 my ($self, undef, $object, $params) = @_;
802 while (my ($k, $v) = each %{ $params }) {
803 if (ref($v) && !(reftype($v) eq reftype(JSON::Any::true))) {
807 $object->set_column($k => $v);
813 while (my ($k, $v) = each %rels) {
814 $object->create_related($k, $v);
818 =method_protected delete_objects
820 delete_objects iterates through each object calling L</delete_object>
826 my ($self, $c, $objects) = @_;
828 map { $self->delete_object($c, $_->[0]) } @$objects;
831 =method_protected delete_object
833 Performs the actual ->delete on the object
839 #my ($self, $c, $object) = @_;
840 my ($self, undef, $object) = @_;
845 =method_protected end
847 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
858 # Check for errors caught elsewhere
859 if ( $c->res->status and $c->res->status != 200 ) {
860 $default_status = $c->res->status;
861 $c->stash->{$self->stash_key}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
862 } elsif ($self->get_errors($c)) {
863 $c->stash->{$self->stash_key}->{messages} = $self->get_errors($c);
864 $c->stash->{$self->stash_key}->{success} = $self->use_json_boolean ? JSON::Any::false : 'false';
865 $default_status = 400;
867 $c->stash->{$self->stash_key}->{success} = $self->use_json_boolean ? JSON::Any::true : 'true';
868 $default_status = 200;
871 unless ($default_status == 200)
873 delete $c->stash->{$self->stash_key}->{$self->data_root};
875 elsif($self->return_object && $c->req->has_objects)
877 my $returned_objects = [];
878 push(@$returned_objects, $self->each_object_inflate($c, $_)) for map { $_->[0] } $c->req->all_objects;
879 $c->stash->{$self->stash_key}->{$self->data_root} = scalar(@$returned_objects) > 1 ? $returned_objects : $returned_objects->[0];
882 $c->res->status( $default_status || 200 );
883 $c->forward('serialize');
886 =method_protected each_object_inflate
888 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.
890 This only executes if L</return_object> if set and if there are any objects to actually return.
894 sub each_object_inflate
896 #my ($self, $c, $object) = @_;
897 my ($self, undef, $object) = @_;
899 return { $object->get_columns };
902 =method_protected serialize
904 multiple actions forward to serialize which uses Catalyst::Action::Serialize.
908 # from Catalyst::Action::Serialize
909 sub serialize :ActionClass('Serialize') { }
911 =method_protected push_error
913 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.
919 my ( $self, $c, $params ) = @_;
920 my $error = 'unknown error';
921 if (exists $params->{message}) {
922 $error = $params->{message};
923 # remove newline from die "error message\n" which is required to not
924 # have the filename and line number in the error text
927 push( @{$c->stash->{_dbic_crud_errors}}, $error);
930 =method_protected get_errors
932 get_errors returns all of the errors stored in the stash
938 my ( $self, $c ) = @_;
939 return $c->stash->{_dbic_crud_errors};
944 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.
948 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.
950 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>.
952 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.
956 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>.
958 The class, create_requires, create_allows and update_requires parameters can also be set in the stash like so:
960 sub setup :Chained('/api/rpc/rpc_base') :CaptureArgs(1) :PathPart('any') {
961 my ($self, $c, $object_type) = @_;
963 if ($object_type eq 'artist') {
964 $c->stash->{class} = 'MyAppDB::Artist';
965 $c->stash->{create_requires} = [qw/name/];
966 $c->stash->{update_allows} = [qw/name/];
968 $self->push_error($c, { message => "invalid object_type" });
972 $self->next::method($c);
975 Generally it's better to have one controller for each DBIC source with the config hardcoded, but in some cases this isn't possible.
977 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.
979 Below are explanations for various configuration parameters. Please see L<Catalyst::Controller::DBIC::API::StaticArguments> for more details.
983 Whatever you would pass to $c->model to get a resultset for this class. MyAppDB::Track for example.
985 =head3 resultset_class
987 Desired resultset class after accessing your model. MyAppDB::ResultSet::Track for example. By default, it's DBIx::Class::ResultClass::HashRefInflator. Set to empty string to leave resultset class without change.
991 Controls where in stash request_data should be stored, and defaults to 'response'.
995 By default, the response data is serialized into $c->stash->{$self->stash_key}->{$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.
997 =head3 use_json_boolean
999 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.
1001 =head3 count_arg, page_arg, select_arg, search_arg, grouped_by_arg, ordered_by_arg, prefetch_arg, as_arg, total_entries_arg
1003 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.
1005 =head3 create_requires
1007 Arrayref listing columns required to be passed to create in order for the request to be valid.
1009 =head3 create_allows
1011 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.
1013 =head3 update_allows
1015 Arrayref listing columns that update will allow. Columns passed to update that are not listed here will be ignored.
1019 Arguments to pass to L<DBIx::Class::ResultSet/select> when performing search for L</list>.
1023 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.
1025 =head3 select_exposes
1027 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.
1031 Arguments to pass to L<DBIx::Class::ResultSet/prefetch> when performing search for L</list>.
1033 =head3 prefetch_allows
1035 Arrayref listing relationships that are allowed to be prefetched.
1036 This is necessary to avoid denial of service attacks in form of
1037 queries which would return a large number of data
1038 and unwanted disclosure of data.
1042 Arguments to pass to L<DBIx::Class::ResultSet/group_by> when performing search for L</list>.
1046 Arguments to pass to L<DBIx::Class::ResultSet/order_by> when performing search for L</list>.
1048 =head3 search_exposes
1050 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
1052 search_exposes => [qw/position/, { cd => ['*'] }]
1054 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:
1056 package RestTest::Controller::API::RPC::TrackExposed;
1062 search_exposes => [qw/position title custom_column/],
1065 and then in your custom resultset:
1067 package RestTest::Schema::ResultSet::Track;
1069 use base 'RestTest::Schema::ResultSet';
1073 my ($clause, $params) = @_;
1076 if (my $pretend = delete $clause->{custom_column}) {
1077 $clause->{'cd.year'} = $pretend;
1079 my $rs = $self->SUPER::search(@_);
1084 Arguments to pass to L<DBIx::Class::ResultSet/rows> when performing search for L</list>.
1088 Arguments to pass to L<DBIx::Class::ResultSet/page> when performing search for L</list>.
1092 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.
1094 For example if you wanted create to return the JSON for the newly created object you might have something like:
1096 package MyApp::ControllerBase::DBIC::API::RPC;
1099 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' };
1101 sub create :Chained('setup') :Args(0) :PathPart('create') {
1102 my ($self, $c) = @_;
1104 # $c->req->all_objects will contain all of the created
1105 $self->next::method($c);
1107 if ($c->req->has_objects) {
1108 # $c->stash->{$self->stash_key} will be serialized in the end action
1109 $c->stash->{$self->stash_key}->{$self->data_root} = [ map { { $_->get_inflated_columns } } ($c->req->all_objects) ] ;
1113 package MyApp::Controller::API::RPC::Track;
1116 BEGIN { extends 'MyApp::ControllerBase::DBIC::API::RPC' };
1119 It should be noted that the return_object attribute will produce the above result for you, free of charge.
1121 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.
1123 If more extensive customization is required, it is recommened to peer into the roles that comprise the system and make use
1127 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.
1129 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.
1131 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>.
1134 Transactions are used. The stash is put aside in favor of roles applied to the request object with additional accessors.
1135 Error handling is now much more consistent with most errors immediately detaching.
1136 The internals are much easier to read and understand with lots more documentation.