lightair/turbo-rss
1
0
Fork 0
mirror of https://github.com/LightAir/turbo-rss.git synced 2026-02-04 12:06:20 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #35 from maxnowack/master

Browse Source 
added support for custom elements and namespaces
This commit is contained in:
Dylan Greene
2014-12-08 10:11:38 +02:00
parent 8156995897 16ea3467ae
commit b921efd1fa
3 changed files with 288 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
lib/rss.js
View File

@@ -10,6 +10,16 @@ function ifTruePush(bool, array, data) {
} }
} }
function ifTruePushArray(bool, array, dataArray) {
if(!bool) {
return;
}
dataArray.forEach(function(item) {
ifTruePush(item, array, item);
});
}
function generateXML (data){ function generateXML (data){
var channel = []; var channel = [];
@@ -40,6 +50,8 @@ function generateXML (data){
}); });
} }
ifTruePushArray(data.custom_elements, channel, data.custom_elements);
data.items.forEach(function(item) { data.items.forEach(function(item) {
var item_values = [ var item_values = [
{ title: { _cdata: item.title } } { title: { _cdata: item.title } }
@@ -84,6 +96,8 @@ function generateXML (data){
} }
} }
ifTruePushArray(item.custom_elements, item_values, item.custom_elements);
channel.push({ item: item_values }); channel.push({ item: item_values });
}); });
@@ -96,6 +110,10 @@ function generateXML (data){
version: '2.0' version: '2.0'
}; };
Object.keys(data.custom_namespaces).forEach(function(name) {
_attr['xmlns:' + name] = data.custom_namespaces[name];
});
//only add namespace if GeoRSS is true //only add namespace if GeoRSS is true
if(data.geoRSS){ if(data.geoRSS){
_attr['xmlns:geo'] = 'http://www.w3.org/2003/01/geo/wgs84_pos#'; _attr['xmlns:geo'] = 'http://www.w3.org/2003/01/geo/wgs84_pos#';
@@ -130,6 +148,8 @@ function RSS (options, items) {
this.ttl = options.ttl; this.ttl = options.ttl;
//option to return feed as GeoRSS is set automatically if feed.lat/long is used //option to return feed as GeoRSS is set automatically if feed.lat/long is used
this.geoRSS = options.geoRSS || false; this.geoRSS = options.geoRSS || false;
this.custom_namespaces = options.custom_namespaces || {};
this.custom_elements = options.custom_elements || [];
this.items = items || []; this.items = items || [];
this.item = function (options) { this.item = function (options) {
@@ -144,7 +164,8 @@ function RSS (options, items) {
date: options.date, date: options.date,
lat: options.lat, lat: options.lat,
long: options.long, long: options.long,
enclosure: options.enclosure || false enclosure: options.enclosure || false,
custom_elements: options.custom_elements || []
}; };
this.items.push(item); this.items.push(item);

44
readme.md
View File

@@ -37,6 +37,8 @@ var feed = new RSS(feedOptions);
* `pubDate` _optional_ **Date object or date string** The publication date for content in the feed * `pubDate` _optional_ **Date object or date string** The publication date for content in the feed
* `ttl` _optional_ **integer** Number of minutes feed can be cached before refreshing from source. * `ttl` _optional_ **integer** Number of minutes feed can be cached before refreshing from source.
* `hub` _optional_ **PubSubHubbub hub url** Where is the PubSubHub hub located. * `hub` _optional_ **PubSubHubbub hub url** Where is the PubSubHub hub located.
* `custom_namespaces` _optional_ **object** Put additional namespaces in <rss> element (without 'xmlns:' prefix)
* `custom_elements` _optional_ **array** Put additional elements in the feed (node-xml syntax)
#### Add items to a feed #### Add items to a feed
@@ -64,6 +66,7 @@ feed.item(itemOptions);
if the content should be presented as unread. if the content should be presented as unread.
* `lat` _optional_ **number** The latitude coordinate of the item. * `lat` _optional_ **number** The latitude coordinate of the item.
* `long` _optional_ **number** The longitude coordinate of the item. * `long` _optional_ **number** The longitude coordinate of the item.
* `custom_elements` _optional_ **array** Put additional elements in the item (node-xml syntax)
##### Feed XML ##### Feed XML
@@ -96,7 +99,34 @@ var feed = new RSS({
language: 'en', language: 'en',
categories: ['Category 1','Category 2','Category 3'], categories: ['Category 1','Category 2','Category 3'],
pubDate: 'May 20, 2012 04:00:00 GMT', pubDate: 'May 20, 2012 04:00:00 GMT',
ttl: '60' ttl: '60',
customNamespaces: {
'itunes': 'http://www.itunes.com/dtds/podcast-1.0.dtd'
},
custom: [
{'itunes:subtitle': 'A show about everything'},
{'itunes:author': 'John Doe'},
{'itunes:summary': 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store'},
{'itunes:owner': [
{'itunes:name': 'John Doe'},
{'itunes:email': 'john.doe@example.com'}
]},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything.jpg'
}
}},
{'itunes:category': [
{_attr: {
text: 'Technology'
}},
{'itunes:category': {
_attr: {
text: 'Gadgets'
}
}}
]}
]
}); });
/* loop over data and add to feed */ /* loop over data and add to feed */
@@ -110,7 +140,17 @@ feed.item({
date: 'May 27, 2012', // any format that js Date can parse. date: 'May 27, 2012', // any format that js Date can parse.
lat: 33.417974, //optional latitude field for GeoRSS lat: 33.417974, //optional latitude field for GeoRSS
long: -111.933231, //optional longitude field for GeoRSS long: -111.933231, //optional longitude field for GeoRSS
enclosure: {url:'...', file:'path-to-file'} // optional enclosure enclosure: {url:'...', file:'path-to-file'}, // optional enclosure
custom: [
{'itunes:author': 'John Doe'},
{'itunes:subtitle': 'A short primer on table spices'},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg'
}
}},
{'itunes:duration': '7:04'}
]
}); });
// cache the xml to send to clients // cache the xml to send to clients

196
test/rss.test.js
View File

@@ -262,5 +262,201 @@ describe('rss module', function(done) {
expect(result).to.equal(expectedResult); expect(result).to.equal(expectedResult);
done(); done();
}); });
it('should work with custom elements', function(done) {
var feed = new RSS({
title: 'title',
description: 'description',
feed_url: 'http://example.com/rss.xml',
site_url: 'http://example.com',
author: 'Dylan Greene',
pubDate: 'May 20, 2012 04:00:00 GMT',
language: 'en',
ttl: '60',
custom_elements: [
{'itunes:subtitle': 'A show about everything'},
{'itunes:author': 'John Doe'},
{'itunes:summary': 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store'},
{'itunes:owner': [
{'itunes:name': 'John Doe'},
{'itunes:email': 'john.doe@example.com'}
]},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything.jpg'
}
}},
{'itunes:category': [
{_attr: {
text: 'Technology'
}},
{'itunes:category': {
_attr: {
text: 'Gadgets'
}
}}
]}
]
}); });
feed.item({
title: 'item 1',
description: 'description 1',
url: 'http://example.com/article1',
date: 'May 24, 2012 04:00:00 GMT',
custom_elements: [
{'itunes:author': 'John Doe'},
{'itunes:subtitle': 'A short primer on table spices'},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg'
}
}},
{'itunes:duration': '7:04'}
]
});
var expectedResult ='<?xml version="1.0" encoding="UTF-8"?>\n'+
'<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">'+
'<channel>' +
'<title><![CDATA[title]]></title>' +
'<description><![CDATA[description]]></description>' +
'<link>http://example.com</link>' +
'<generator>RSS for Node</generator>' +
'<lastBuildDate>' + new Date().toUTCString() +'</lastBuildDate>' +
'<atom:link href="http://example.com/rss.xml" rel="self" type="application/rss+xml"/>' +
'<author><![CDATA[Dylan Greene]]></author>' +
'<pubDate>Sun, 20 May 2012 04:00:00 GMT</pubDate>' +
'<language><![CDATA[en]]></language>' +
'<ttl>60</ttl>' +
'<itunes:subtitle>A show about everything</itunes:subtitle>' +
'<itunes:author>John Doe</itunes:author>' +
'<itunes:summary>All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store</itunes:summary>' +
'<itunes:owner>' +
'<itunes:name>John Doe</itunes:name>' +
'<itunes:email>john.doe@example.com</itunes:email>' +
'</itunes:owner>' +
'<itunes:image href="http://example.com/podcasts/everything/AllAboutEverything.jpg"/>' +
'<itunes:category text="Technology">' +
'<itunes:category text="Gadgets"/>' +
'</itunes:category>' +
'<item>' +
'<title><![CDATA[item 1]]></title>' +
'<description><![CDATA[description 1]]></description>' +
'<link>http://example.com/article1</link>' +
'<guid isPermaLink="true">http://example.com/article1</guid>' +
'<dc:creator><![CDATA[Dylan Greene]]></dc:creator>' +
'<pubDate>Thu, 24 May 2012 04:00:00 GMT</pubDate>' +
'<itunes:author>John Doe</itunes:author>' +
'<itunes:subtitle>A short primer on table spices</itunes:subtitle>' +
'<itunes:image href="http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg"/>' +
'<itunes:duration>7:04</itunes:duration>' +
'</item>' +
'</channel>' +
'</rss>';
var result = feed.xml();
expect(result).to.equal(expectedResult);
done();
});
it('should work with custom namespaces', function(done) {
var feed = new RSS({
title: 'title',
description: 'description',
feed_url: 'http://example.com/rss.xml',
site_url: 'http://example.com',
author: 'Dylan Greene',
pubDate: 'May 20, 2012 04:00:00 GMT',
language: 'en',
ttl: '60',
custom_namespaces: {
'itunes': 'http://www.itunes.com/dtds/podcast-1.0.dtd'
},
custom_elements: [
{'itunes:subtitle': 'A show about everything'},
{'itunes:author': 'John Doe'},
{'itunes:summary': 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store'},
{'itunes:owner': [
{'itunes:name': 'John Doe'},
{'itunes:email': 'john.doe@example.com'}
]},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything.jpg'
}
}},
{'itunes:category': [
{_attr: {
text: 'Technology'
}},
{'itunes:category': {
_attr: {
text: 'Gadgets'
}
}}
]}
]
});
feed.item({
title: 'item 1',
description: 'description 1',
url: 'http://example.com/article1',
date: 'May 24, 2012 04:00:00 GMT',
custom_elements: [
{'itunes:author': 'John Doe'},
{'itunes:subtitle': 'A short primer on table spices'},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg'
}
}},
{'itunes:duration': '7:04'}
]
});
var expectedResult ='<?xml version="1.0" encoding="UTF-8"?>\n'+
'<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd">'+
'<channel>' +
'<title><![CDATA[title]]></title>' +
'<description><![CDATA[description]]></description>' +
'<link>http://example.com</link>' +
'<generator>RSS for Node</generator>' +
'<lastBuildDate>' + new Date().toUTCString() +'</lastBuildDate>' +
'<atom:link href="http://example.com/rss.xml" rel="self" type="application/rss+xml"/>' +
'<author><![CDATA[Dylan Greene]]></author>' +
'<pubDate>Sun, 20 May 2012 04:00:00 GMT</pubDate>' +
'<language><![CDATA[en]]></language>' +
'<ttl>60</ttl>' +
'<itunes:subtitle>A show about everything</itunes:subtitle>' +
'<itunes:author>John Doe</itunes:author>' +
'<itunes:summary>All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store</itunes:summary>' +
'<itunes:owner>' +
'<itunes:name>John Doe</itunes:name>' +
'<itunes:email>john.doe@example.com</itunes:email>' +
'</itunes:owner>' +
'<itunes:image href="http://example.com/podcasts/everything/AllAboutEverything.jpg"/>' +
'<itunes:category text="Technology">' +
'<itunes:category text="Gadgets"/>' +
'</itunes:category>' +
'<item>' +
'<title><![CDATA[item 1]]></title>' +
'<description><![CDATA[description 1]]></description>' +
'<link>http://example.com/article1</link>' +
'<guid isPermaLink="true">http://example.com/article1</guid>' +
'<dc:creator><![CDATA[Dylan Greene]]></dc:creator>' +
'<pubDate>Thu, 24 May 2012 04:00:00 GMT</pubDate>' +
'<itunes:author>John Doe</itunes:author>' +
'<itunes:subtitle>A short primer on table spices</itunes:subtitle>' +
'<itunes:image href="http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg"/>' +
'<itunes:duration>7:04</itunes:duration>' +
'</item>' +
'</channel>' +
'</rss>';
var result = feed.xml();
expect(result).to.equal(expectedResult);
done();
});
});