congregator-rssreader

Congregator RSS-feed Reader
====================================================

#### Introduction:
This is an attempt to make a rss-feed parser that can parse the html content of an rss-entry as well as the entries themselves. It will give you an output of formatted JSON-articles which can be processed at will. It also has the ability to visit the article links and fetch a processed version of the content (done by node-read). Now go and build your own feedly! :)

#### Built with:
* node.js
* cheerio
* node-read
* feedparser

#### Example use:
``js
var debug = require('debug')('rssreader:testapp');
var util = require('util');
var events = require('events');
var ipc = new events.EventEmitter();

function isActive (element) {
return element.active;
}

var handleEntry = function (item, callback) {
debug(util.inspect(item, { colors: true }));
callback(null, item);
};

var getFeeds = function (options, callback) {
var feeds = require('./template');
callback(null, feeds.filter(isActive));
};

var RssReader = require('rssreader');

var rssReader = new RssReader({
getSources: getFeeds,
handleEntry: handleEntry,
ipc: ipc,
sockets: 15,
waitTime: 10000,
timeOut: 5000
});

console.log('running rss-reader');

rssReader.run();
`

#### Example template (see the /example folder for more elaborate templates):
`json
{
"active": true,
"origin": "feed",
"name": "hackernews",
"url": "https://news.ycombinator.com/rss",
"linkref": "url",
"category": 1,
"format": "desktop",
"body": true,
"template": {
"elements": [
{
"name": "guid",
"type": "url",
"required": true,
"items": [
{
"selector": "guid"
},
{
"selector": "link"
},
{
"selector": "title",
"decode": true
}
]
},
{
"name": "title",
"required": true,
"items": [
{
"selector": "title"
}
]
},
{
"name": "url",
"type": "url",
"required": true,
"items": [
{
"selector": "link"
}
]
},
{
"name": "image",
"type": "url",
"items": [
{
"selector": "enclosures[0].url"
}
],
"fallback": "https://news.ycombinator.com/y18.gif"
}
]
}
}
`

#### Example output:
`js
[
{
"origin": "feed",
"source": "https://news.ycombinator.com/",
"host": "news.ycombinator.com",
"ranking": 24,
"category": 1,
"guid": "http://blog.ycombinator.com/last-day-to-apply-to-yc-hacks",
"title": "Last day to apply to YC Hacks",
"url": "http://blog.ycombinator.com/last-day-to-apply-to-yc-hacks",
"image": "https://news.ycombinator.com/y18.gif",
"content": {
"title": "Last day to apply to YC Hacks",
"body": "

#### TODO
* description of the templating system
* better description of how to use the module
* full test suite