Go to file
Jim Teeuwen 31df4852b3 Merge pull request #68 from virtualsue/master
Add newline to error message
2015-08-25 08:12:15 +02:00
testdata Add newline to error message 2015-08-24 23:19:08 +01:00
LICENSE Switch to more liberal CC0 Public Domain license. 2011-03-19 14:48:01 +01:00
README.md Added link to example 2014-01-23 23:07:07 -02:00
atom.go differentiate between published and updated 2015-07-26 23:04:53 +02:00
author.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
category.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
channel.go added Extension to channel 2014-01-23 17:37:50 -02:00
cloud.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
content.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
database.go Removed logging 2014-10-04 12:54:27 +01:00
databaseHandler.go Ensured that New() feed function is functionally equivalent still 2014-10-14 18:51:13 +01:00
enclosure.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
feed.go Add IgnoreCacheOnce() to Feed objects. 2015-03-01 22:41:15 -08:00
feed_test.go Fixes #44, crash when no handlers 2014-10-10 21:35:26 +03:00
generator.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
image.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
input.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
item.go differentiate between published and updated 2015-07-26 23:04:53 +02:00
link.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
notes.md Used lists 2014-11-16 17:41:15 +01:00
rss.go Also fetch images described as href attributes 2015-08-18 00:39:40 +02:00
source.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
subtitle.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
timeparser.go go fmt 2014-03-24 22:01:26 -05:00
timeparser_test.go go fmt 2014-03-24 22:01:26 -05:00

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.