use Catalyst's http method matching for REST

[catagits/Catalyst-Controller-DBIC-API.git] / lib / Catalyst / Controller / DBIC / API / REST.pm

diff --git a/lib/Catalyst/Controller/DBIC/API/REST.pm b/lib/Catalyst/Controller/DBIC/API/REST.pm
index b40b5de..df58115 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API/REST.pm
+++ b/lib/Catalyst/Controller/DBIC/API/REST.pm
@@ -14,7 +14,7 @@ __PACKAGE__->config(
 
 =head1 DESCRIPTION
 
-Provides a REST style API interface to the functionality described in L<Catalyst::Controller::DBIC::API>. 
+Provides a REST style API interface to the functionality described in L<Catalyst::Controller::DBIC::API>.
 
 By default provides the following endpoints:
 
@@ -32,88 +32,110 @@ CaptureArgs: 0
 As described in L<Catalyst::Controller::DBIC::API/setup>, this action is the chain root of the controller but has no pathpart or chain parent defined by default, so these must be defined in order for the controller to function. The neatest way is normally to define these using the controller's config.
 
   __PACKAGE__->config
-    ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } }, 
+    ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } },
        ...
   );
 
-=method_protected no_id
+=method_protected update_or_create_objects
 
-Chained: L</object_no_id>
+Chained: L</objects_no_id>
 PathPart: none
-CaptureArgs: 0
-
-Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
+Args: 0
+Method: POST/PUT
 
-DELETE: L<Catalyst::Controller::DBIC::API/delete>
-POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
-GET: forwards to L<Catalyst::Controller::DBIC::API/list>
+Calls L<Catalyst::Controller::DBIC::API/update_or_create>. 
 
 =cut
 
-sub no_id : Chained('object_no_id') PathPart('') ActionClass('REST') :CaptureArgs(0) {}
-
-sub no_id_PUT
+sub update_or_create_objects : POST PUT Chained('objects_no_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
-sub no_id_POST
-{
-       my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
-}
+=method_protected delete_many_objects
+
+Chained: L</objects_no_id>
+PathPart: none
+Args: 0
+Method: DELETE
+
+Calls L<Catalyst::Controller::DBIC::API/delete>. 
 
-sub no_id_DELETE
+=cut
+
+sub delete_many_objects : DELETE Chained('objects_no_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-    $c->forward('delete');
+    $self->delete($c);
 }
 
-sub no_id_GET
+=method_protected list_objects
+
+Chained: L</objects_no_id>
+PathPart: none
+Args: 0
+Method: GET
+
+Calls L<Catalyst::Controller::DBIC::API/list>. 
+
+=cut
+
+sub list_objects : GET Chained('objects_no_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-       $c->forward('list');
+    $self->list($c);
 }
 
-=method_protected with_id
+=method_protected update_or_create_one_object
 
 Chained: L</object_with_id>
 PathPart: none
-CaptureArgs: 0
+Args: 0
+Method: POST/PUT
 
-Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
-
-DELETE: L<Catalyst::Controller::DBIC::API/delete>
-POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
-GET: forwards to L<Catalyst::Controller::DBIC::API/item>
+Calls L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub with_id :Chained('object_with_id') :PathPart('') :ActionClass('REST') :CaptureArgs(0) {}
-
-sub with_id_PUT
+sub update_or_create_one_object : POST PUT Chained('object_with_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
-sub with_id_POST
-{
-       my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
-}
+=method_protected delete_one_object
+
+Chained: L</object_with_id>
+PathPart: none
+Args: 0
+Method: DELETE
+
+Calls L<Catalyst::Controller::DBIC::API/delete>.
 
-sub with_id_DELETE
+=cut
+
+sub delete_one_object : DELETE Chained('object_with_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-    $c->forward('delete');
+    $self->delete($c);
 }
 
-sub with_id_GET
+=method_protected list_one_object
+
+Chained: L</object_with_id>
+PathPart: none
+Args: 0
+Method: GET
+
+Calls L<Catalyst::Controller::DBIC::API/item>.
+
+=cut
+
+sub list_one_object : GET Chained('object_with_id') PathPart('') Args(0)
 {
        my ( $self, $c ) = @_;
-       $c->forward('item');
+    $self->item($c);
 }
 
 1;