/ 
Catalyst-Controller-Atompub-0.5.6
River stage zero No dependents
/ Catalyst::Controller::Atompub

NAME

Catalyst::Controller::Atompub - A Catalyst controller for the Atom Publishing Protocol

DESCRIPTION

Catalyst::Controller::Atompub provides a base class for the Atom Publishing Protocol servers. This module handles all core server processing based on the Atom Publishing Protocol described at http://www.ietf.org/rfc/rfc5023.txt.

Implementations must subclass the following modules.

At first, install sample samples/MyAtom in SAMPLES and read controller classes. The code is explained in Catalyst::Controller::Atompub::Service and Catalyst::Controller::Atompub::Collection.

This module was tested in July2007InteropTokyo and November2007Interop, and interoperated with other implementations. See http://intertwingly.net/wiki/pie/July2007InteropTokyo and http://www.intertwingly.net/wiki/pie/November2007Interop in detail.

SAMPLES

Sample codes are found in samples/ directory. The following resources are required:

  • Catalyst v5.7 or later

  • Catalyst::Model::DBIC::Schema v0.20 or later

  • Catalyst::View::TT v0.25 or later (MyBlog)

  • Catalyst Plugins (MyBlog, OurBlogs)

    Authentication
Authentication::Store::DBIC
Authentication::Credential::HTTP

  • SQLite v3.0 or later

    Initialize your database with init.sql before running the samples. The initialization script assums that database is test.db.

samples/MyAtom

This sample is minimum implementation of the Atom Publishing Protocol. It has a single collection containing Entry Resources. Cache controll and feed paging are not provided. Errors are ignored.

URI of the Service Document is http://localhost:3000/myservice .

This sample is a kind of tutorial.

samples/MyBlog

This sample implements many features of the Atom Publishing Protocol. It has two collections; one collection contains Entry Resources, the other contains Media Resources (images). The server provides basic authentication, cache controll and feed paging. Duplicate detection of resource names is also implemented. Errors are properly handled.

URI of the Service Document is http://localhost:3000/service . This sample also provides a HTML view at http://localhost:3000/html .

samples/OurBlogs

In this sample, collection URIs depend on the user. Authentication is required to get Service Documents at http://localhost:3000/service. In the Service Document, the collection URI is found and looks like http://localhost:3000/collection/<username>. Users are required to be authenticated before posting member resources to their own collection.

AUTHOR

Takeru INOUE <takeru.inoue _ gmail.com>

I would like to thank Masaki NAKAGAWA for his valuable suggestions.

LICENCE AND COPYRIGHT

Copyright (c) 2007, Takeru INOUE <takeru.inoue _ gmail.com>.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.