lib/Catalyst/Controller/DBIC/API/REST.pm

   1 package Catalyst::Controller::DBIC::API::REST;
   2
   3 #ABSTRACT: Provides a REST interface to DBIx::Class
   4 use Moose;
   5 BEGIN { extends 'Catalyst::Controller::DBIC::API'; }
   6
   7 __PACKAGE__->config(
   8     'default'   => 'application/json',
   9     'stash_key' => 'response',
  10     'map'       => {
  11         'application/x-www-form-urlencoded' => 'JSON',
  12         'application/json'                  => 'JSON',
  13     });
  14
  15 =head1 DESCRIPTION
  16
  17 Provides a REST style API interface to the functionality described in L<Catalyst::Controller::DBIC::API>.
  18
  19 By default provides the following endpoints:
  20
  21   $base (operates on lists of objects and accepts GET, PUT, POST and DELETE)
  22   $base/[identifier] (operates on a single object and accepts GET, PUT, POST and DELETE)
  23
  24 Where $base is the URI described by L</setup>, the chain root of the controller, and the request type will determine the L<Catalyst::Controller::DBIC::API> method to forward.
  25
  26 =method_protected setup
  27
  28 Chained: override
  29 PathPart: override
  30 CaptureArgs: 0
  31
  32 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.
  33
  34   __PACKAGE__->config
  35     ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } },
  36         ...
  37   );
  38
  39 =method_protected no_id
  40
  41 Chained: L</objects_no_id>
  42 PathPart: none
  43 CaptureArgs: 0
  44
  45 Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
  46
  47 DELETE: L<Catalyst::Controller::DBIC::API/delete>
  48 POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
  49 GET: forwards to L<Catalyst::Controller::DBIC::API/list>
  50
  51 =cut
  52
  53 sub no_id : Chained('objects_no_id') PathPart('') ActionClass('REST') {}
  54
  55 sub no_id_PUT
  56 {
  57         my ( $self, $c ) = @_;
  58     $c->forward('update_or_create');
  59 }
  60
  61 sub no_id_POST
  62 {
  63         my ( $self, $c ) = @_;
  64     $c->forward('update_or_create');
  65 }
  66
  67 sub no_id_DELETE
  68 {
  69         my ( $self, $c ) = @_;
  70     $c->forward('delete');
  71 }
  72
  73 sub no_id_GET
  74 {
  75         my ( $self, $c ) = @_;
  76         $c->forward('list');
  77 }
  78
  79 =method_protected with_id
  80
  81 Chained: L</object_with_id>
  82 PathPart: none
  83 CaptureArgs: 0
  84
  85 Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
  86
  87 DELETE: L<Catalyst::Controller::DBIC::API/delete>
  88 POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
  89 GET: forwards to L<Catalyst::Controller::DBIC::API/item>
  90
  91 =cut
  92
  93 sub with_id :Chained('object_with_id') :PathPart('') :ActionClass('REST') {}
  94
  95 sub with_id_PUT
  96 {
  97         my ( $self, $c ) = @_;
  98     $c->forward('update_or_create');
  99 }
 100
 101 sub with_id_POST
 102 {
 103         my ( $self, $c ) = @_;
 104     $c->forward('update_or_create');
 105 }
 106
 107 sub with_id_DELETE
 108 {
 109         my ( $self, $c ) = @_;
 110     $c->forward('delete');
 111 }
 112
 113 sub with_id_GET
 114 {
 115         my ( $self, $c ) = @_;
 116         $c->forward('item');
 117 }
 118
 119 1;