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;
25 # no ->utf8 here because the request params get decoded by Catalyst
29 with 'Catalyst::Controller::DBIC::API::StoredResultSource',
30 'Catalyst::Controller::DBIC::API::StaticArguments';
32 with 'Catalyst::Controller::DBIC::API::RequestArguments' => { static => 1 };
34 __PACKAGE__->config();
38 package MyApp::Controller::API::RPC::Artist;
40 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' }
43 ( action => { setup => { PathPart => 'artist', Chained => '/api/rpc/rpc_base' } }, # define parent chain action and partpath
44 class => 'MyAppDB::Artist',
45 resultset_class => 'MyAppDB::ResultSet::Artist',
46 create_requires => ['name', 'age'],
47 create_allows => ['nickname'],
48 update_allows => ['name', 'age', 'nickname'],
49 update_allows => ['name', 'age', 'nickname'],
50 select => [qw/name age/],
56 { cds => [qw/ tracks /] },
58 ordered_by => [qw/age/],
59 search_exposes => [qw/age nickname/, { cds => [qw/title year/] }],
61 use_json_boolean => 1,
65 # Provides the following functional endpoints:
66 # /api/rpc/artist/create
67 # /api/rpc/artist/list
68 # /api/rpc/artist/id/[id]/delete
69 # /api/rpc/artist/id/[id]/update
76 begin is provided in the base class to setup the Catalyst Request object, by applying the DBIC::API::Request role.
84 Moose::Util::ensure_all_roles($c->req, 'Catalyst::Controller::DBIC::API::Request');
87 =method_protected setup
89 :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config')
91 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
93 package MyApp::Controller::API::RPC::Track;
95 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC'; }
98 ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
104 sub setup :Chained('/api/rpc_base') :CaptureArgs(0) :PathPart('track') {
107 $self->next::method($c);
110 This action does nothing by default.
114 sub setup :Chained('specify.in.subclass.config') :CaptureArgs(0) :PathPart('specify.in.subclass.config') {}
116 =method_protected deserialize
118 :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
120 deserialize absorbs the request data and transforms it into useful bits by using CGI::Expand->expand_hash and a smattering of JSON->decode for a handful of arguments. Current only the following arguments are capable of being expressed as JSON:
129 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.
133 sub deserialize :Chained('setup') :CaptureArgs(0) :PathPart('') :ActionClass('Deserialize')
138 if ($c->req->data && scalar(keys %{$c->req->data}))
140 $req_params = $c->req->data;
144 $req_params = CGI::Expand->expand_hash($c->req->params);
146 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]})
148 # these params can also be composed of JSON
149 # but skip if the parameter is not provided
150 next if not exists $req_params->{$param};
151 # find out if CGI::Expand was involved
152 if (ref $req_params->{$param} eq 'HASH')
154 for my $key ( keys %{$req_params->{$param}} )
156 # copy the value because JSON::XS will alter it
157 # even if decoding failed
158 my $value = $req_params->{$param}->{$key};
161 my $deserialized = $self->_json->decode($value);
162 $req_params->{$param}->{$key} = $deserialized;
166 $c->log->debug("Param '$param.$key' did not deserialize appropriately: $_")
175 my $value = $req_params->{$param};
176 my $deserialized = $self->_json->decode($value);
177 $req_params->{$param} = $deserialized;
181 $c->log->debug("Param '$param' did not deserialize appropriately: $_")
188 $self->inflate_request($c, $req_params);
191 =method_protected generate_rs
193 generate_rs is used by inflate_request to get a resultset for the current
194 request. It receives $c as its only argument.
195 By default it returns a resultset of the controller's class.
196 Override this method if you need to manipulate the default implementation of
205 return $c->model($self->class);
208 =method_protected inflate_request
210 inflate_request is called at the end of deserialize to populate key portions of the request with the useful bits
216 my ($self, $c, $params) = @_;
220 # set static arguments
221 $c->req->_set_controller($self);
223 # set request arguments
224 $c->req->_set_request_data($params);
226 # set the current resultset
227 $c->req->_set_current_result_set($self->generate_rs($c));
233 $self->push_error($c, { message => $_ });
238 =method_protected object_with_id
240 :Chained('deserialize') :CaptureArgs(1) :PathPart('')
242 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.
246 sub object_with_id :Chained('deserialize') :CaptureArgs(1) :PathPart('')
248 my ($self, $c, $id) = @_;
250 my $vals = $c->req->request_data->{$self->data_root};
251 unless(defined($vals))
253 # no data root, assume the request_data itself is the payload
254 $vals = $c->req->request_data;
259 # there can be only one set of data
260 $c->req->add_object([$self->object_lookup($c, $id), $vals]);
265 $self->push_error($c, { message => $_ });
270 =method_protected objects_no_id
272 :Chained('deserialize') :CaptureArgs(0) :PathPart('')
274 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.
278 sub objects_no_id :Chained('deserialize') :CaptureArgs(0) :PathPart('')
282 if($c->req->has_request_data)
284 my $data = $c->req->request_data;
287 if(exists($data->{$self->data_root}) && defined($data->{$self->data_root}))
289 my $root = $data->{$self->data_root};
290 if(reftype($root) eq 'ARRAY')
294 elsif(reftype($root) eq 'HASH')
300 $c->log->error('Invalid request data');
301 $self->push_error($c, { message => 'Invalid request data' });
307 # no data root, assume the request_data itself is the payload
308 $vals = [$c->req->request_data];
311 foreach my $val (@$vals)
313 unless(exists($val->{id}))
315 $c->req->add_object([$c->req->current_result_set->new_result({}), $val]);
321 $c->req->add_object([$self->object_lookup($c, $val->{id}), $val]);
326 $self->push_error($c, { message => $_ });
333 =method_protected object_lookup
335 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.
341 my ($self, $c, $id) = @_;
343 die 'No valid ID provided for look up' unless defined $id and length $id;
344 my $object = $c->req->current_result_set->find($id);
345 die "No object found for id '$id'" unless defined $object;
349 =method_protected list
351 list's steps are broken up into three distinct methods: L</list_munge_parameters>, L</list_perform_search>, and L</list_format_output>.
353 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.
355 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.
357 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.
359 For example, these request parameters:
361 ?search.name=fred&search.cd.artist=luke
363 ?search={"name":"fred","cd": {"artist":"luke"}}
365 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):
367 $rs->search({ name => 'fred', 'cd.artist' => 'luke' }, { join => ['cd'] })
369 It is also possible to use a JSON string for expandeded parameters:
371 ?search.datetime={"-between":["2010-01-06 19:28:00","2010-01-07 19:28:00"]}
373 Note that if pagination is needed, this can be achieved using a combination of the L</count> and L</page> parameters. For example:
377 Would result in this search:
379 $rs->search({}, { page => 2, rows => 20 })
387 $self->list_munge_parameters($c);
388 $self->list_perform_search($c);
389 $self->list_format_output($c);
391 # make sure there are no objects lingering
392 $c->req->clear_objects();
395 =method_protected list_munge_parameters
397 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.
398 To store the munged parameters call $c->req->_set_search_parameters($newparams) and $c->req->_set_search_attributes($newattrs).
402 sub list_munge_parameters { } # noop by default
404 =method_protected list_perform_search
406 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.
410 sub list_perform_search
418 my $rs = $req->current_result_set->search
420 $req->search_parameters,
421 $req->search_attributes
424 $req->_set_current_result_set($rs);
426 $req->_set_search_total_entries($req->current_result_set->pager->total_entries)
427 if $req->has_search_attributes && (exists($req->search_attributes->{page}) && defined($req->search_attributes->{page}) && length($req->search_attributes->{page}));
432 $self->push_error($c, { message => 'a database error has occured.' });
437 =method_protected list_format_output
439 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.
443 sub list_format_output
447 my $rs = $c->req->current_result_set->search;
448 $rs->result_class($self->result_class) if $self->result_class;
455 foreach my $row ($rs->all)
457 push(@$formatted, $self->row_format_output($c, $row));
460 $output->{$self->data_root} = $formatted;
462 if ($c->req->has_search_total_entries)
464 $output->{$self->total_entries_arg} = $c->req->search_total_entries + 0;
467 $c->stash->{$self->stash_key} = $output;
472 $self->push_error($c, { message => 'a database error has occured.' });
477 =method_protected row_format_output
479 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.
483 sub row_format_output
485 #my ($self, $c, $row) = @_;
486 my ($self, undef, $row) = @_;
487 return $row; # passthrough by default
490 =method_protected item
492 item will return a single object called by identifier in the uri. It will be inflated via each_object_inflate.
500 if($c->req->count_objects != 1)
503 $self->push_error($c, { message => 'No objects on which to operate' });
508 $c->stash->{$self->stash_key}->{$self->item_root} = $self->each_object_inflate($c, $c->req->get_object(0)->[0]);
512 =method_protected update_or_create
514 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>.
522 if($c->req->has_objects)
524 $self->validate_objects($c);
525 $self->transact_objects($c, sub { $self->save_objects($c, @_) } );
530 $self->push_error($c, { message => 'No objects on which to operate' });
535 =method_protected transact_objects
537 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.
543 my ($self, $c, $coderef) = @_;
547 $self->stored_result_source->schema->txn_do
556 $self->push_error($c, { message => 'a database error has occured.' });
561 =method_protected validate_objects
563 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.
573 foreach my $obj ($c->req->all_objects)
575 $obj->[1] = $self->validate_object($c, $obj);
581 $c->log->error($err);
582 $err =~ s/\s+at\s+.+\n$//g;
583 $self->push_error($c, { message => $err });
588 =method_protected validate_object
590 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.
596 my ($self, $c, $obj) = @_;
597 my ($object, $params) = @$obj;
600 my %requires_map = map
605 ($object->in_storage)
607 : $c->stash->{create_requires} || $self->create_requires
612 (ref $_) ? %{$_} : ($_ => 1)
617 ($object->in_storage)
618 ? ($c->stash->{update_allows} || $self->update_allows)
619 : ($c->stash->{create_allows} || $self->create_allows)
623 foreach my $key (keys %allows_map)
625 # check value defined if key required
626 my $allowed_fields = $allows_map{$key};
628 if (ref $allowed_fields)
630 my $related_source = $object->result_source->related_source($key);
631 my $related_params = $params->{$key};
632 my %allowed_related_map = map { $_ => 1 } @$allowed_fields;
633 my $allowed_related_cols = ($allowed_related_map{'*'}) ? [$related_source->columns] : $allowed_fields;
635 foreach my $related_col (@{$allowed_related_cols})
637 if (defined(my $related_col_value = $related_params->{$related_col})) {
638 $values{$key}{$related_col} = $related_col_value;
644 my $value = $params->{$key};
646 if ($requires_map{$key})
648 unless (defined($value))
650 # if not defined look for default
651 $value = $object->result_source->column_info($key)->{default_value};
652 unless (defined $value)
654 die "No value supplied for ${key} and no default";
659 # check for multiple values
660 if (ref($value) && !(reftype($value) eq reftype(JSON::true)))
662 require Data::Dumper;
663 die "Multiple values for '${key}': ${\Data::Dumper::Dumper($value)}";
666 # check exists so we don't just end up with hash of undefs
667 # check defined to account for default values being used
668 $values{$key} = $value if exists $params->{$key} || defined $value;
672 unless (keys %values || !$object->in_storage)
674 die 'No valid keys passed';
680 =method_protected delete
682 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.
690 if($c->req->has_objects)
692 $self->transact_objects($c, sub { $self->delete_objects($c, @_) });
693 $c->req->clear_objects;
698 $self->push_error($c, { message => 'No objects on which to operate' });
703 =method_protected save_objects
705 This method is used by update_or_create to perform the actual database manipulations. It iterates each object calling L</save_object>.
711 my ($self, $c, $objects) = @_;
713 foreach my $obj (@$objects)
715 $self->save_object($c, $obj);
719 =method_protected save_object
721 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>
727 my ($self, $c, $obj) = @_;
729 my ($object, $params) = @$obj;
731 if ($object->in_storage)
733 $self->update_object_from_params($c, $object, $params);
737 $self->insert_object_from_params($c, $object, $params);
742 =method_protected update_object_from_params
744 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.
748 sub update_object_from_params
750 my ($self, $c, $object, $params) = @_;
752 foreach my $key (keys %$params)
754 my $value = $params->{$key};
755 if (ref($value) && !(reftype($value) eq reftype(JSON::true)))
757 $self->update_object_relation($c, $object, delete $params->{$key}, $key);
760 elsif ($object->can($key)) {
761 $object->$key($value);
763 # accessor != colname
765 my $accessor = $object->result_source->column_info($key)->{accessor};
766 $object->$accessor($value);
773 =method_protected update_object_relation
775 update_object_relation finds the relation to the object, then calls ->update with the specified parameters
779 sub update_object_relation
781 my ($self, $c, $object, $related_params, $relation) = @_;
782 my $row = $object->find_related($relation, {} , {});
785 foreach my $key (keys %$related_params) {
786 my $value = $related_params->{$key};
787 if (ref($value) && !(reftype($value) eq reftype(JSON::true)))
789 $self->update_object_relation($c, $row, delete $related_params->{$key}, $key);
792 elsif ($row->can($key)) {
795 # accessor != colname
797 my $accessor = $row->result_source->column_info($key)->{accessor};
798 $row->$accessor($value);
804 $object->create_related($relation, $related_params);
808 =method_protected insert_object_from_params
810 insert_object_from_params sets the columns for the object, then calls ->insert
814 sub insert_object_from_params
816 #my ($self, $c, $object, $params) = @_;
817 my ($self, undef, $object, $params) = @_;
820 while (my ($key, $value) = each %{ $params }) {
821 if (ref($value) && !(reftype($value) eq reftype(JSON::true))) {
822 $rels{$key} = $value;
825 elsif ($object->can($key)) {
826 $object->$key($value);
828 # accessor != colname
830 my $accessor = $object->result_source->column_info($key)->{accessor};
831 $object->$accessor($value);
837 while (my ($k, $v) = each %rels) {
838 $object->create_related($k, $v);
842 =method_protected delete_objects
844 delete_objects iterates through each object calling L</delete_object>
850 my ($self, $c, $objects) = @_;
852 map { $self->delete_object($c, $_->[0]) } @$objects;
855 =method_protected delete_object
857 Performs the actual ->delete on the object
863 #my ($self, $c, $object) = @_;
864 my ($self, undef, $object) = @_;
869 =method_protected end
871 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
879 # don't change the http status code if already set elsewhere
880 unless ($c->res->status && $c->res->status != 200) {
881 if ($self->has_errors($c)) {
882 $c->res->status(400);
885 $c->res->status(200);
889 if ($c->res->status == 200) {
890 $c->stash->{$self->stash_key}->{success} = $self->use_json_boolean ? JSON::true : 'true';
891 if($self->return_object && $c->req->has_objects) {
892 my $returned_objects = [];
893 push(@$returned_objects, $self->each_object_inflate($c, $_)) for map { $_->[0] } $c->req->all_objects;
894 $c->stash->{$self->stash_key}->{$self->data_root} = scalar(@$returned_objects) > 1 ? $returned_objects : $returned_objects->[0];
898 $c->stash->{$self->stash_key}->{success} = $self->use_json_boolean ? JSON::false : 'false';
899 $c->stash->{$self->stash_key}->{messages} = $self->get_errors($c)
900 if $self->has_errors($c);
901 # don't return data for error responses
902 delete $c->stash->{$self->stash_key}->{$self->data_root};
905 $c->forward('serialize');
908 =method_protected each_object_inflate
910 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.
912 This only executes if L</return_object> if set and if there are any objects to actually return.
916 sub each_object_inflate
918 #my ($self, $c, $object) = @_;
919 my ($self, undef, $object) = @_;
921 return { $object->get_columns };
924 =method_protected serialize
926 multiple actions forward to serialize which uses Catalyst::Action::Serialize.
930 # from Catalyst::Action::Serialize
931 sub serialize :ActionClass('Serialize') { }
933 =method_protected push_error
935 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.
941 my ( $self, $c, $params ) = @_;
942 die 'Catalyst app object missing'
944 my $error = 'unknown error';
945 if (exists $params->{message}) {
946 $error = $params->{message};
947 # remove newline from die "error message\n" which is required to not
948 # have the filename and line number in the error text
951 push( @{$c->stash->{_dbic_crud_errors}}, $error);
954 =method_protected get_errors
956 get_errors returns all of the errors stored in the stash
962 my ( $self, $c ) = @_;
963 die 'Catalyst app object missing'
965 return $c->stash->{_dbic_crud_errors};
968 =method_protected has_errors
970 returns returns true if errors are stored in the stash
975 my ( $self, $c ) = @_;
976 die 'Catalyst app object missing'
978 return exists $c->stash->{_dbic_crud_errors};
983 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.
987 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.
989 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>.
991 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.
995 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>.
997 The class, create_requires, create_allows and update_requires parameters can also be set in the stash like so:
999 sub setup :Chained('/api/rpc/rpc_base') :CaptureArgs(1) :PathPart('any') {
1000 my ($self, $c, $object_type) = @_;
1002 if ($object_type eq 'artist') {
1003 $c->stash->{class} = 'MyAppDB::Artist';
1004 $c->stash->{create_requires} = [qw/name/];
1005 $c->stash->{update_allows} = [qw/name/];
1007 $self->push_error($c, { message => "invalid object_type" });
1011 $self->next::method($c);
1014 Generally it's better to have one controller for each DBIC source with the config hardcoded, but in some cases this isn't possible.
1016 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.
1018 Below are explanations for various configuration parameters. Please see L<Catalyst::Controller::DBIC::API::StaticArguments> for more details.
1022 Whatever you would pass to $c->model to get a resultset for this class. MyAppDB::Track for example.
1024 =head3 resultset_class
1026 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.
1030 Controls where in stash request_data should be stored, and defaults to 'response'.
1034 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.
1036 =head3 use_json_boolean
1038 By default, the response success status is set to a string value of "true" or "false". If this attribute is true, JSON's true() and false() will be used instead. Note, this does not effect other internal processing of boolean values.
1040 =head3 count_arg, page_arg, select_arg, search_arg, grouped_by_arg, ordered_by_arg, prefetch_arg, as_arg, total_entries_arg
1042 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.
1044 =head3 create_requires
1046 Arrayref listing columns required to be passed to create in order for the request to be valid.
1048 =head3 create_allows
1050 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.
1052 =head3 update_allows
1054 Arrayref listing columns that update will allow. Columns passed to update that are not listed here will be ignored.
1058 Arguments to pass to L<DBIx::Class::ResultSet/select> when performing search for L</list>.
1062 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.
1064 =head3 select_exposes
1066 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.
1070 Arguments to pass to L<DBIx::Class::ResultSet/prefetch> when performing search for L</list>.
1072 =head3 prefetch_allows
1074 Arrayref listing relationships that are allowed to be prefetched.
1075 This is necessary to avoid denial of service attacks in form of
1076 queries which would return a large number of data
1077 and unwanted disclosure of data.
1081 Arguments to pass to L<DBIx::Class::ResultSet/group_by> when performing search for L</list>.
1085 Arguments to pass to L<DBIx::Class::ResultSet/order_by> when performing search for L</list>.
1087 =head3 search_exposes
1089 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
1091 search_exposes => [qw/position/, { cd => ['*'] }]
1093 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:
1095 package RestTest::Controller::API::RPC::TrackExposed;
1101 search_exposes => [qw/position title custom_column/],
1104 and then in your custom resultset:
1106 package RestTest::Schema::ResultSet::Track;
1108 use base 'RestTest::Schema::ResultSet';
1112 my ($clause, $params) = @_;
1115 if (my $pretend = delete $clause->{custom_column}) {
1116 $clause->{'cd.year'} = $pretend;
1118 my $rs = $self->SUPER::search(@_);
1123 Arguments to pass to L<DBIx::Class::ResultSet/rows> when performing search for L</list>.
1127 Arguments to pass to L<DBIx::Class::ResultSet/page> when performing search for L</list>.
1131 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.
1133 For example if you wanted create to return the JSON for the newly created object you might have something like:
1135 package MyApp::ControllerBase::DBIC::API::RPC;
1138 BEGIN { extends 'Catalyst::Controller::DBIC::API::RPC' };
1140 sub create :Chained('setup') :Args(0) :PathPart('create') {
1141 my ($self, $c) = @_;
1143 # $c->req->all_objects will contain all of the created
1144 $self->next::method($c);
1146 if ($c->req->has_objects) {
1147 # $c->stash->{$self->stash_key} will be serialized in the end action
1148 $c->stash->{$self->stash_key}->{$self->data_root} = [ map { { $_->get_inflated_columns } } ($c->req->all_objects) ] ;
1152 package MyApp::Controller::API::RPC::Track;
1155 BEGIN { extends 'MyApp::ControllerBase::DBIC::API::RPC' };
1158 It should be noted that the return_object attribute will produce the above result for you, free of charge.
1160 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.
1162 If more extensive customization is required, it is recommened to peer into the roles that comprise the system and make use
1166 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.
1168 To this end, internally, this module now understands JSON boolean values (as represented by the JSON module) and will Do The Right Thing in handling those values. This means you can have ColumnInflators installed that can covert between JSON booleans and whatever your database wants for boolean values.
1170 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>.
1173 Transactions are used. The stash is put aside in favor of roles applied to the request object with additional accessors.
1174 Error handling is now much more consistent with most errors immediately detaching.
1175 The internals are much easier to read and understand with lots more documentation.