Takeru INOUE (井上武) > Catalyst-Controller-Atompub-0.5.6 > Catalyst::Controller::Atompub::Collection

Download:
Catalyst-Controller-Atompub-0.5.6.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Catalyst::Controller::Atompub::Collection - A Catalyst controller for the Atom Collection Resources

SYNOPSIS ^

    # Use the Catalyst helper
    $ perl script/myatom_create.pl controller MyCollection Atompub::Collection

    # And edit lib/MyAtom/Controller/MyCollection.pm
    package MyAtom::Controller::MyCollection;
    use base 'Catalyst::Controller::Atompub::Collection';

    # List resources in a Feed Document, which must be implemented in
    # the mehtod with "Atompub(list)" attribute
    sub get_feed :Atompub(list) {
        my($self, $c) = @_;

        # Skeleton of the Feed (XML::Atom::Feed) was prepared by
        # C::C::Atompub
        my $feed = $self->collection_resource->body;

        # Retrieve Entries sorted in descending order
        my $rs = $c->model('DBIC::Entries')->search({}, {
            order_by => 'edited desc',
        });

        # Add Entries to the Feed
        while (my $entry_resource = $rs->next) {
            my $entry = XML::Atom::Entry->new(\$entry_resource->xml);
            $feed->add_entry($entry);
        }

        # Return true on success
        1;
    }

    # Create new Entry in the method with "Atompub(create)" attribute
    sub create_entry :Atompub(create) {
        my($self, $c) = @_;

        # URI of the new Entry, which was determined by C::C::Atompub
        my $uri = $self->entry_resource->uri;

        # app:edited element, which was assigned by C::C::Atompub,
        # is coverted into ISO 8601 format like '2007-01-01 00:00:00'
        my $edited = $self->edited->iso;

        # POSTed Entry (XML::Atom::Entry)
        my $entry = $self->entry_resource->body;

        # Create new Entry
        $c->model('DBIC::Entries')->create({
            uri    => $uri,
            edited => $edited,
            xml    => $entry->as_xml,
        });

        # Return true on success
        1;
    }

    # Search the requested Entry in the method with "Atompub(read)"
    # attribute
    sub get_entry :Atompub(read) {
        my($self, $c) = @_;

        my $uri = $c->entry_resource->uri;

        # Retrieve the Entry
        my $rs = $c->model('DBIC::Entries')->find({ uri => $uri });

        # Set the Entry
        my $entry = XML::Atom::Entry->new(\$rs->xml);
        $self->entry_resource->body($entry);

        # Return true on success
        1;
    }

    # Update the requested Entry in the method with "Atompub(update)"
    # attribute
    sub update_entry :Atompub(update) {
        my($self, $c) = @_;

        my $uri = $c->entry_resource->uri;

        # app:edited element, which was assigned by C::C::Atompub,
        # is coverted into ISO 8601 format like '2007-01-01 00:00:00'
        my $edited = $self->edited->iso;

        # PUTted Entry (XML::Atom::Entry)
        my $entry = $self->entry_resource->body;

        # Update the Entry
        $c->model('DBIC::Entries')->find({ uri => $uri })->update({
            uri => $uri,
            edited => $edited,
            xml => $entry->as_xml,
        });

        # Return true on success
        1;
    }

    # Delete the requested Entry in the method with "Atompub(delete)"
    # attribute
    sub delete_entry :Atompub(delete) {
        my($self, $c) = @_;

        my $uri = $c->entry_resource->uri;

        # Delete the Entry
        $c->model('DBIC::Entries')->find({ uri => $uri })->delete;

        # Return true on success
        1;
    }

    # Access to http://localhost:3000/mycollection and get Feed Document

DESCRIPTION ^

Catalyst::Controller::Atompub::Collection provides the following features:

SUBCLASSING ^

One or more subclasses are required in your Atompub server implementation. In the subclasses, methods with the following attributes must be defined.

sub xxx :Atompub(list)

Lists resources in a Feed Document.

This method is expected to add Entries and other elements to a skeleton of the Feed. The following accessors can be used.

- $controller->collection_resource->uri

URI of Collection

- $controller->collection_resource->body

Skeleton of Feed (XML::Atom::Feed)

Returns true on success, false otherwise.

sub xxx :Atompub(create)

Creates new resource.

Returns true on success, false otherwise.

sub xxx :Atompub(read)

Searchs the requested resource.

Returns true on success, false otherwise.

sub xxx :Atompub(update)

Updates the requested resource.

Returns true on success, false otherwise.

sub xxx :Atompub(delete)

Deletes the requested resource.

The implementation is expected to delete the resource. If the collection contains Media Resources, corresponding Media Link Entry must be deleted at once.

Returns true on success, false otherwise.

METHODS ^

The following methods can be overridden to change the default behaviors.

$controller->find_version($uri)

By overriding find_version method, cache control and versioning are enabled.

The implementation is expected to return ETag and/or Last-Modified value of the requested URI:

    package MyAtom::Controller::MyCollection;

    sub find_version {
        my($self, $c, $uri) = @_;

        # Retrieve ETag and/or Last-Modified of $uri

        return (etag => $etag, last_modified => $last_modified);
    }

When a resource of the URI does not exist, the implementation must return an empty array.

The behavior of Atompub server will be changed in the following manner:

$controller->make_edit_uri($c, [@args])

By default, if the Slug header is "Entry 1", the resource URI will be like:

    http://localhost:3000/mycollection/entry_1.atom

This default behavior can be changed by overriding find_version method:

    package MyAtom::Controller::MyCollection;

    sub make_edit_uri {
        my($self, $c, @args) = @_;

        my @uris = $self->SUPER::make_edit_uri($c, @args);

        # Modify @uris as you like

        return @uris;
    }

Arguments @args are media types of POSTed resources.

This method returns an array of resource URIs; the first element is a URI of the Entry Resource (including Media Link Entry), and the second one is a URI of the Media Resource if exists.

$controller->default($c)

$controller->edit_uri($c)

$controller->make_collection_uri($c)

The collection URI can be changed, by overriding default and edit_uri methods and modify the attributes.

In the following example, the collection URI is changed like /mycollection/<username> by overriding default and edit_uri methods. The new parameter <username> is obtained by $c->req->captures->[0] in the collection, or $c->user->username in the service document.

Override make_collection_uri method, if collection URI has to be changed.

See samples/OurBlogs in details.

    package MyAtom::Controller::MyCollection;

    sub default :LocalRegex('^(\w+)$') {
        my($self, $c) = @_;
        $self->NEXT::default($c);
    }

    sub edit_uri :LocalRegex('^(\w+)/([.\w]+)$') {
        my($self, $c) = @_;
        $self->NEXT::edit_uri($c);
    }

    sub make_collection_uri {
        my($self, $c) = @_;
        my $class = ref $self || $self;
        $class->NEXT::make_collection_uri($c).'/'
            .(ref $c->controller eq $class ? $c->req->captures->[0] : $c->user->username);
    }

$controller->do_list

$controller->do_create

$controller->do_read

$controller->do_update

$controller->do_delete

ACCESSORS ^

$controller->resource

$controller->rc

An accessor for a resource object except Media Link Entry.

$controller->collection_resource

An accessor for a Collection Resource object.

$controller->entry_resource

An accessor for an Entry Resource objecgt.

$controller->media_resource

An accessor for a Media Resource object.

$controller->media_link_entry

An accessor for a Media Link Entry object.

$controller->edited

An accessor for a app:edited, which is applied for the POSTed/PUTted Entry Resource.

INTERNAL INTERFACES ^

$controller->auto

$controller->_list

$controller->_create

$controller->_read

$controller->_update

$controller->_delete

$controller->_is_modified

$controller->create_action

FEED PAGING ^

This module does not provide paging of Feed Documents. Paging mechanism should be implemented in a method with "Atompub(list)" attribute.

CONFIGURATION ^

By default (no configuration), Collections accept Entry Documents (application/atom+xml) and any atom:category element.

Acceptable atom:category elements can be set like:

    Controller::EntryCollection:
        collection:
            title: Diary
            categories:
              - fixed: yes
                scheme: http://example.com/cats/big3
                category:
                  - term: animal
                    label: animal
                  - term: vegetable
                    label: vegetable
                  - term: mineral
                    scheme: http://example.com/dogs/big3
                    label: mineral

Acceptable media types is configured like:

    Controller::MediaCollection:
        collection:
            title: Photo
            accept:
              - image/png
              - image/jpeg
              - image/gif

ERROR HANDLING ^

See ERROR HANDLING in Catalyst::Controller::Atompub::Base.

SAMPLES ^

See SAMPLES in Catalyst::Controller::Atompub.

SEE ALSO ^

XML::Atom XML::Atom::Service Atompub Catalyst::Controller::Atompub

AUTHOR ^

Takeru INOUE <takeru.inoue _ gmail.com>

LICENCE AND COPYRIGHT ^

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

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.

syntax highlighting: