Merge pull request #3 from jameslawler/add-itunes

Add itunes

Author: jameslawler

README.md

@@ -7,6 +7,7 @@
 Parse RSS data into a simple object structure. Currently supports;
 * RSS 2.0 specification
 * Atom 1.0 specification
+* Itunes elements for both RSS 2.0 and Atom 1.0 feeds
 
 ## Installation
 
@@ -32,50 +33,85 @@ return fetch('http://www.nasa.gov/rss/dyn/breaking_news.rss')
 
 ```js
 {
- type: undefined,
- title: undefined,
+ type: undefined, // either `rss-v2` or `atom-v1`
+ title: undefined, // title of the channel
  links: [{
- url: undefined,
- rel: undefined
+ url: undefined, // url of the channel
+ rel: undefined // type of url (eg. alternate)
  }],
- description: undefined,
- language: undefined,
- copyright: undefined,
+ description: undefined, // description of the channel
+ language: undefined, // language of the channel in `en-us`
+ copyright: undefined, // copyright information about the channel
  authors: [{
- name: undefined
+ name: undefined // channel author names
  }],
- lastUpdated: undefined,
- lastPublished: undefined,
+ lastUpdated: undefined, // last updated date for the channel
+ lastPublished: undefined, // last published date for the channel
  categories: [{
- name: undefined
+ name: undefined // categories the channel belong too
  }],
  image: {
- url: undefined,
- title: undefined,
- description: undefined,
- width: undefined,
- height: undefined
+ url: undefined, // channel image url
+ title: undefined, // channel image title
+ description: undefined, // channel image description
+ width: undefined, // channel image width (pixels)
+ height: undefined // channel image height (pixels)
  },
- items: [{
- title: undefined,
+ itunes: { // itunes specific channel information
+ author: [{
+ name: undefined // channel author names
+ }],
+ block: undefined, // if `yes` then the entire podcast isn't shown in iTunes directory
+ categories: [{
+ name: undefined, // channel category names
+ subCategories:[{
+ name: undefined // sub category names
+ }]
+ }],
+ image: undefined, // channel image url
+ explicit: undefined, // `yes`/`no` to indicate if channel contains explicit content
+ complete: undefined, // `yes` indicates the feed won't publish any new items in the future
+ newFeedUrl: undefined, // a url pointing to the new feed location
+ owner: {
+ name: undefined, // owner name of the channel
+ email: undefined, // owner email address of the channel
+ },
+ subtitle: undefined, // sub title of the channel
+ summary: undefined, // summary of the channel
+ },
+ items: [{ // list of items in the feed
+ title: undefined, // item title
  links: [{
- url: undefined,
- rel: undefined
+ url: undefined, // item link url
+ rel: undefined // type of item link
  }],
- description: undefined,
- content: undefined,
+ description: undefined, // item description
+ content: undefined, // item HTML content
  categories: [{
- name: undefined
+ name: undefined // categories the item belongs too
  }],
  authors: [{
- name: undefined
+ name: undefined // item author names
  }],
- published: undefined,
+ published: undefined, // item published date
  enclosures: [{
- url: undefined,
- length: undefined,
- mimeType: undefined
- }]
+ url: undefined, // item media url
+ length: undefined, // item media length (bytes)
+ mimeType: undefined // item media mime type (eg audio/mpeg)
+ }],
+ itunes: { // itunes specific item information
+ authors: [{
+ name: undefined, // item author names
+ }],
+ block: undefined, // `yes` indicates the item won't be displayed in the iTunes directory
+ duration: undefined, // HH:MM:SS length of the item
+ explicit: undefined, // `yes`/`no` to indicate if item contains explicit content
+ image: undefined, // image url for the item
+ isClosedCaptioned: undefined, // `yes` indicates if the item contains closed captioning
+ order: undefined, // item order number
+ subtitle: undefined, // item subtitle
+ summary: undefined, // item summary
+ }
  }]
 }
 ```

model/rss.js

@@ -25,6 +25,28 @@ model.rss = {
  width: undefined,
  height: undefined
  },
+ itunes: {
+ author: [{
+ name: undefined
+ }],
+ block: undefined,
+ categories: [{
+ name: undefined,
+ subCategories:[{
+ name: undefined
+ }]
+ }],
+ image: undefined,
+ explicit: undefined,
+ complete: undefined,
+ newFeedUrl: undefined,
+ owner: {
+ name: undefined,
+ email: undefined,
+ },
+ subtitle: undefined,
+ summary: undefined,
+ },
  items: [{
  title: undefined,
  links: [{
@@ -44,6 +66,19 @@ model.rss = {
  url: undefined,
  length: undefined,
  mimeType: undefined
- }]
+ }],
+ itunes: {
+ authors: [{
+ name: undefined,
+ }],
+ block: undefined,
+ duration: undefined,
+ explicit: undefined,
+ image: undefined,
+ isClosedCaptioned: undefined,
+ order: undefined,
+ subtitle: undefined,
+ summary: undefined,
+ }
  }]
 };

package.json

@@ -1,6 +1,6 @@
 {
  "name": "react-native-rss-parser",
- "version": "1.0.1",
+ "version": "1.1.0",
  "description": "React Native compatible package to parse RSS feeds",
  "main": "index.js",
  "scripts": {

parsers/atomv1.js

@@ -1,5 +1,6 @@
 var utils = require('./utils');
 var model = require('../model/rss');
+var itunesParser = require('./itunes');
 
 exports.parse = function(document) {
  let parsedFeed = Object.assign({}, model.rss);
@@ -29,6 +30,7 @@ function mapChannelFields(document, parsedFeed) {
  parsedFeed.lastPublished = getChannelLastPublished(channelNode);
  parsedFeed.categories = getChannelCategories(channelNode);
  parsedFeed.image = getChannelImage(channelNode);
+ parsedFeed.itunes = itunesParser.parseChannel(channelNode);
 
  return parsedFeed;
 }
@@ -106,7 +108,8 @@ function mapItems(document) {
  authors: getItemAuthors(item),
  categories: getItemCategories(item),
  published: getItemPublished(item),
- enclosures: getItemEnclosures(item)
+ enclosures: getItemEnclosures(item),
+ itunes: itunesParser.parseItem(item)
  };
  });
 }

parsers/itunes.js

@@ -0,0 +1,128 @@
+var utils = require('./utils');
+var namespaces = require('./namespaces');
+
+exports.parseChannel = function(node) {
+ return {
+ authors: getAuthors(node),
+ block: getBlock(node),
+ categories: getCategories(node),
+ complete: getComplete(node),
+ explicit: getExplicit(node),
+ image: getImage(node),
+ newFeedUrl: getNewFeedUrl(node),
+ owner: getOwner(node),
+ subtitle: getSubtitle(node),
+ summary: getSummary(node)
+ }
+};
+
+exports.parseItem = function(node) {
+ return {
+ authors: getAuthors(node),
+ block: getBlock(node),
+ duration: getDuration(node),
+ explicit: getExplicit(node),
+ image: getImage(node),
+ isClosedCaptioned: getIsClosedCaptioned(node),
+ order: getOrder(node),
+ subtitle: getSubtitle(node),
+ summary: getSummary(node),
+ };
+};
+
+function getAuthors(node) {
+ const authors = utils.getElementTextContentArray(node, 'author', namespaces.itunes);
+
+ return authors.map(function(author) {
+ return {
+ name: author
+ };
+ });
+}
+
+function getBlock(node) {
+ return utils.getElementTextContent(node, 'block', namespaces.itunes);
+}
+
+function getCategories(node) {
+ const categories = utils.getChildElements(node, 'category', namespaces.itunes);
+
+ return categories.map(function(category) {
+ return {
+ name: category.getAttribute('text'),
+ subCategories: getSubCategories(category)
+ }
+ });
+}
+
+function getSubCategories(node) {
+ const categories = utils.getChildElements(node, 'category', namespaces.itunes);
+
+ if (categories.length === 0) {
+ return [];
+ }
+
+ return categories.map(function(category) {
+ return {
+ name: category.getAttribute('text')
+ }
+ });
+}
+
+function getComplete(node) {
+ return utils.getElementTextContent(node, 'complete', namespaces.itunes);
+}
+
+function getDuration(node) {
+ return utils.getElementTextContent(node, 'duration', namespaces.itunes);
+}
+
+function getExplicit(node) {
+ return utils.getElementTextContent(node, 'explicit', namespaces.itunes);
+}
+
+function getImage(node) {
+ const images = utils.getChildElements(node, 'image', namespaces.itunes);
+
+ if (images.length > 0) {
+ return images[0].getAttribute('href');
+ }
+
+ return undefined;
+}
+
+function getIsClosedCaptioned(node) {
+ return utils.getElementTextContent(node, 'isClosedCaptioned', namespaces.itunes);
+}
+
+function getNewFeedUrl(node) {
+ return utils.getElementTextContent(node, 'new-feed-url', namespaces.itunes);
+}
+
+function getOrder(node) {
+ return utils.getElementTextContent(node, 'order', namespaces.itunes);
+}
+
+function getOwner(node) {
+ const owners = utils.getChildElements(node, 'owner', namespaces.itunes);
+
+ if (owners.length === 0) {
+ return {
+ name: undefined,
+ email: undefined
+ };
+ }
+
+ return {
+ name: utils.getElementTextContent(owners[0], 'name', namespaces.itunes),
+ email: utils.getElementTextContent(owners[0], 'email', namespaces.itunes),
+ };
+}
+
+function getSubtitle(node) {
+ return utils.getElementTextContent(node, 'subtitle', namespaces.itunes);
+}
+
+function getSummary(node) {
+ return utils.getElementTextContent(node, 'summary', namespaces.itunes);
+}

parsers/namespaces.js

@@ -0,0 +1 @@
+exports.itunes = 'http://www.itunes.com/dtds/podcast-1.0.dtd';

parsers/rssv2.js

@@ -1,5 +1,6 @@
 var utils = require('./utils');
 var model = require('../model/rss');
+var itunesParser = require('./itunes');
 
 exports.parse = function(document) {
  let parsedFeed = Object.assign({}, model.rss);
@@ -30,6 +31,7 @@ function mapChannelFields(document, parsedFeed) {
  parsedFeed.lastPublished = getChannelLastPublished(channelNode);
  parsedFeed.categories = getChannelCategories(channelNode);
  parsedFeed.image = getChannelImage(channelNode);
+ parsedFeed.itunes = itunesParser.parseChannel(channelNode);
 
  return parsedFeed;
 }
@@ -124,7 +126,8 @@ function mapItems(document) {
  authors: getItemAuthors(item),
  categories: getItemCategories(item),
  published: getItemPublished(item),
- enclosures: getItemEnclosures(item)
+ enclosures: getItemEnclosures(item),
+ itunes: itunesParser.parseItem(item)
  };
  });
 }