a library for generating RSS feeds
Clojure
Latest commit 8e3760f Nov 28, 2016 @yogthos committed on GitHub Update project.clj
Permalink
Failed to load latest commit information.
src/clj_rss
test/clj_rss
.gitignore
.travis.yml
README.md
project.clj

README.md

clj-rss

A library for generating RSS feeds from Clojure

Continuous Integration status

Installation

Leiningen

Clojars Project

Usage

The channel-xml function accepts a map of tags representing a channel, followed by 0 or more maps for items (or a seq of items) and outputs an XML string. Each item must be a map of valid RSS tags.

The following characters in the content of :description and :title tags will be escaped: <, &, >, ". Both :pubDate and :lastBuildDate keys are expected to be instances of java.util.Date or one of its subclasses. These will be converted to standard RSS date strings in the resulting XML.

If you need to get the data in a structured format, use channel instead.

Examples

Creating a channel with some items:

(require '[clj-rss.core :as rss])

(rss/channel-xml {:title "Foo" :link "http://foo/bar" :description "some channel"}
                 {:title "Foo"}
                 {:title "post" :author "author@foo.bar"}
                 {:description "bar"})

Creating a feed from a sequence of items:

(let [items [{:title "Foo"} {:title "Bar"} {:title "Baz"}]]
  (rss/channel {:title "Foo" :link "http://foo/bar" :description "some channel"}
               items))

Creating items with complex tags:

(rss/channel-xml {:title "Foo" :link "http://foo/bar" :description "some channel"}
                 {:title "test"
                  :category [{:domain "http://www.foo.com/bar"} "BAZ"]})

(rss/channel-xml {:title "Foo" :link "http://foo/bar" :description "some channel"}
                 {:title "test"
                  :category [[{:domain "http://www.microsoft.com"} "MSFT"]
                             [{:domain "http://www.apple.com"} "AAPL"]]})

(rss/channel-xml {:title "Foo" :link "http://foo/bar" :description "some channel"}
              {:title "test"
              :category ["MSFT" "AAPL"]})                             

Items can contain raw HTML if the tag is enclosed in <![CDATA[ ... ]]>:

  {:title "HTML Item"
   :description "<![CDATA[ <h1><a href='http://foo/bar'>Foo</a></h1> ]]>"}

To get the raw data structure use:

(rss/channel {:title "Foo" :link "http://foo/bar" :description "some channel"}
             {:title "test"})

Pass in false as first parameter to disable content validation:

(rss/channel-xml false {:title "Foo" :link "http://foo/bar" :description "some channel"}
                       {:title "test"
                        :category [{:domain "http://www.foo.com/bar"} "BAZ"]})

(rss/channel false {:title "Foo" :link "http://foo/bar" :description "some channel"}
                   {:title "test"})

The output XML can be validated at http://validator.w3.org/feed/#validate_by_input

For more information on valid RSS tags and their content please refer to the official RSS 2.0 specification http://cyber.law.harvard.edu/rss/rss.html

License

Copyright Yogthos 2012

Distributed under the Eclipse Public License, the same as Clojure.