NAME¶

Atompub::Client - A client for the Atom Publishing Protocol

SYNOPSIS¶

    use Atompub::Client;
    my $client = Atompub::Client->new;
    $client->username('Melody');
    $client->password('Nelson');
    #$client->proxy( $proxy_uri );
    # Get a Service Document
    my $service = $client->getService($service_uri);
    my @workspaces = $service->workspaces;
    my @collections = $workspaces[0]->collections;
    # CRUD an Entry Resource; assuming that the 0-th collection supports
    # Entry Resources
    my $collection_uri = $collections[0]->href;
    my $name = 'New Post';
    my $entry = XML::Atom::Entry->new;
    $entry->title($name);
    $entry->content('Content of my post.');
    my $edit_uri = $client->createEntry($collection_uri, $entry, $name);
    my $feed = $client->getFeed($collection_uri);
    my @entries = $feed->entries;
    $entry = $client->getEntry($edit_uri);
    $client->updateEntry($edit_uri, $entry);
    $client->deleteEntry($edit_uri);
    # CRUD a Media Resource; assuming that the 1-st collection supports
    # Media Resources
    my $collection_uri = $collections[1]->href;
    my $name = 'My Photo';
    my $edit_uri = $client->createMedia($collection_uri, 'sample1.png',
                                        'image/png', $name);
    # Get a href attribute of an "edit-media" link
    my $edit_media_uri = $client->resource->edit_media_link;
    my $binary = $client->getMedia($edit_media_uri);
    $client->updateMedia($edit_media_uri, 'sample2.png', 'image/png');
    $client->deleteEntry($edit_media_uri);
    # Access to the requested HTTP::Request object
    my $request  = $client->request;
    # Access to the received HTTP::Response object
    my $response = $client->response;
    # Access to the received resource (XML::Atom object or binary data)
    my $resource = $client->resource;

DESCRIPTION¶

Atompub::Client implements a client for the Atom Publishing Protocol described at <http://www.ietf.org/rfc/rfc5023.txt>.

The client supports the following features:

• Authentication

  Atompub::Client supports the Basic and WSSE Authentication described in <http://www.intertwingly.net/wiki/pie/DifferentlyAbledClients>.

• Service Document

  Atompub::Client understands Service Documents, in which information of collections are described, such as URIs, acceptable media types, and allowable categories.

• Media Resource support

  Media Resources (binary data) as well as Entry Resources are supported. You can create and edit Media Resources such as image and video by using Atompub::Client.

• Media type check

  Atompub::Client checks media types of resources before creating and editing them to the collection. Acceptable media types are shown in app:accept elements in the Service Document.

• Category check

  Atompub::Client checks categories in Entry Resources before creating and editing them to the collection. Allowable categories are shown in app:categories elements in the Service Document.

• Cache controll and versioning

  On-memory cache and versioning, which are controlled by ETag and Last-Modified header, are implemented in Atompub::Client.

• Naming resources by Slug header

  The client can specify Slug header when creating a resource, which may be used as part of the resource URI.

METHODS¶

Accessors¶

INTERNAL INTERFACES¶

ERROR HANDLING¶

Methods return "undef" on error, and the error message can be retrieved using the errstr method.

SEE ALSO¶

XML::Atom XML::Atom::Service 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.