NAME

Dancer::Plugin::Feed - Easy to generate feed rss or atom for Dancer applications.

VERSION

version 1.131470

SYNOPSIS

    use Dancer;
    use Dancer::Plugin::Feed;
    use Try::Tiny;

    get '/feed/:format' => sub {
        my $feed;
        try {
            $feed = create_feed(
                format  => params->{format},
                title   => 'my great feed',
                entries => [ map { title => "entry $_" }, 1 .. 10 ],
            );
        }
        catch {
            my ( $exception ) = @_;

            if ( $exception->does('FeedInvalidFormat') ) {
                return $exception->message;
            }
            elsif ( $exception->does('FeedNoFormat') ) {
                return $exception->message;
            }
            else {
                $exception->rethrow;
            }
        };

        return $feed;
    };

    dance;

DESCRIPTION

Provides an easy way to generate RSS or Atom feed. This module relies on XML::Feed. Please, consult the documentation of XML::Feed and XML::Feed::Entry.

CONFIGURATION

 plugins:
   Feed:
     title: my great feed
     format: Atom

FUNCTIONS

create_feed

This function returns a XML feed. All parameters can be define in the configuration

AcceptEd parameters are:

format (required): The Content-Type header will be set to the appropriate value
entries: An arrayref containing a list of entries. Each item will be transformed to an XML::Feed::Entry object. Each entry is an hashref. Some common attributes for these hashrefs are "title", "link", "summary", "content", "author", "issued" and "modified". Check XML::Feed::Entry for more details.
title
base
link
tagline
description
author
language
copyright
self_link
modified