Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
This package reads RSS and Atom feeds and provides a caching mechanism that adheres to the feed specs.
branch: master

Merge pull request #60 from handlerbot/master

Add IgnoreCacheOnce() to Feed objects.
latest commit 2382fc0262
Jim Teeuwen authored
Failed to load latest commit information.
testdata Channel and Item handler example cleanups
LICENSE Switch to more liberal CC0 Public Domain license.
README.md Added link to example
atom.go adding categories to atom
author.go Making package easily usable with goinstall. Including the reference …
category.go Making package easily usable with goinstall. Including the reference …
channel.go added Extension to channel
cloud.go Making package easily usable with goinstall. Including the reference …
content.go Making package easily usable with goinstall. Including the reference …
database.go Removed logging
databaseHandler.go Ensured that New() feed function is functionally equivalent still
enclosure.go Making package easily usable with goinstall. Including the reference …
feed.go Add IgnoreCacheOnce() to Feed objects.
feed_test.go Fixes #44, crash when no handlers
generator.go Making package easily usable with goinstall. Including the reference …
image.go Making package easily usable with goinstall. Including the reference …
input.go Making package easily usable with goinstall. Including the reference …
item.go go fmt
link.go Making package easily usable with goinstall. Including the reference …
notes.md Used lists
rss.go Added specific error types rather than generic error types
source.go Making package easily usable with goinstall. Including the reference …
subtitle.go Making package easily usable with goinstall. Including the reference …
timeparser.go go fmt
timeparser_test.go go fmt

README.md

RSS

This package allows us to fetch Rss and Atom feeds from the internet. They are parsed into an object tree which is a hybrid of both the RSS and Atom standards.

Supported feeds are:

  • Rss v0.91, 0.92 and 2.0
  • Atom 1.0

The package allows us to maintain cache timeout management. This prevents us from querying the servers for feed updates too often and risk ip bans. Apart from setting a cache timeout manually, the package also optionally adheres to the TTL, SkipDays and SkipHours values specified in the feeds themselves.

Note that the TTL, SkipDays and SkipHour fields are only part of the RSS spec. For Atom feeds, we use the CacheTimeout in the Feed struct.

Because the object structure is a hybrid between both RSS and Atom specs, not all fields will be filled when requesting either an RSS or Atom feed. I have tried to create as many shared fields as possible but some of them simply do not occur in either the RSS or Atom spec.

The Feed object supports notifications of new channels and items. This is achieved by passing 2 function handlers to the feeder.New() function. They will be called whenever a feed is updated from the remote source and either a new channel or a new item is found that previously did not exist. This allows you to easily monitor a feed for changes. See src/feed_test.go for an example of how this works.

DEPENDENCIES

github.com/jteeuwen/go-pkg-xmlx

USAGE

An idiomatic example program can be found in testdata/example.go.

Something went wrong with that request. Please try again.