Evening port of atom version

Author: bcomnes

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

CHANGELOG.md

@@ -0,0 +1,6 @@
+# jsonfeed-to-atom Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+* init

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Bret Comnes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,153 @@
+# jsonfeed-to-rss [![stability][0]][1]
+[![npm version][2]][3] [![build status][4]][5] [![coverage][12]][13]
+[![downloads][8]][9] [![js-standard-style][10]][11]
+
+Convert a JSON feed to an rss feed ([RSS 2.0.11][rss]).
+
+![JSON feed icon](/icon.png) 
+
+## Installation
+```console
+$ npm install jsonfeed-to-rss
+```
+
+## Usage
+
+```js
+const jsonfeedToRSS = require('jsonfeed-to-rss')
+const someJSONFeed = require('./load-some-json-feed-data.json')
+
+const rssFeed = jsonfeedToRSS(someJSONFeed) // Returns an rss 2.0.11 formatted json feed
+```
+
+Example input:
+
+```json
+{
+ "version": "https://jsonfeed.org/version/1",
+ "title": "bret.io log",
+ "home_page_url": "https://bret.io",
+ "feed_url": "https://bret.io/feed.json",
+ "description": "A running log of announcements, projects and accomplishments.",
+ "next_url": "https://bret.io/2017.json",
+ "icon": "https://bret.io/icon-512x512.png",
+ "author": {
+  "name": "Bret Comnes",
+  "url": "https://bret.io",
+  "avatar": "https://gravatar.com/avatar/8d8b82740cb7ca994449cccd1dfdef5f?size=512"
+ },
+ "items": [
+  {
+   "date_published": "2018-04-07T20:48:02.000Z",
+   "content_text": "Wee wooo this is some content. \n Maybe a new paragraph too",
+   "url": "https://bret.io/my-text-post",
+   "id": "https://bret.io/my-text-post-2018-04-07T20:48:02.000Z"
+  },
+  {
+   "date_published": "2018-04-07T22:06:43.000Z",
+   "content_html": "<p>Hello, world!</p>",
+   "title": "This is a blog title",
+   "url": "https://bret.io/my-blog-post",
+   "external_url": "https://example.com/some-external-link",
+   "id": "https://bret.io/my-blog-post-2018-04-07T22:06:43.000Z"
+  }
+ ]
+}
+```
+
+Example output:
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <title>bret.io log</title>
+  <id>https://bret.io/feed.xml</id>
+  <updated>2018-04-07T22:06:43.000Z</updated>
+  <link rel="self" type="application/atom+xml" href="https://bret.io/feed.xml"/>
+  <link rel="alternate" type="application/json" href="https://bret.io/feed.json"/>
+  <link rel="alternate" type="text/html" href="https://bret.io"/>
+  <link rel="next" href="https://bret.io/2017.xml"/>
+  <author>
+    <name>Bret Comnes</name>
+    <uri>https://bret.io</uri>
+  </author>
+  <generator uri="https://github.com/bcomnes/jsonfeed-to-atom#readme" version="1.0.0">jsonfeed-to-atom</generator>
+  <rights>© 2018 Bret Comnes</rights>
+  <subtitle>A running log of announcements, projects and accomplishments.</subtitle>
+  <entry>
+    <id>https://bret.io/my-text-post-2018-04-07T20:48:02.000Z</id>
+    <title>Wee wooo this is some content.</title>
+    <updated>2018-04-07T20:48:02.000Z</updated>
+    <published>2018-04-07T20:48:02.000Z</published>
+    <content type="text">Wee wooo this is some content. 
+ Maybe a new paragraph too</content>
+    <link rel="alternate" href="https://bret.io/my-text-post"/>
+  </entry>
+  <entry>
+    <id>https://bret.io/my-blog-post-2018-04-07T22:06:43.000Z</id>
+    <title>This is a blog title</title>
+    <updated>2018-04-07T22:06:43.000Z</updated>
+    <published>2018-04-07T22:06:43.000Z</published>
+    <content type="html">
+      <![CDATA[<p>Hello, world!</p>]]>
+    </content>
+    <link rel="alternate" href="https://bret.io/my-blog-post"/>
+    <link rel="related" href="https://example.com/some-external-link"/>
+  </entry>
+</feed>
+```
+
+## API
+### `jsonfeedToAtom(parsedJsonfeed, opts)`
+Coverts a parsed JSON feed into an atom feed.  Returns the string of the atom feed.
+
+Opts include:
+
+```js
+{
+  // a function that returns the atom feed url
+  feedURLFn: (feedURL, jf) => feedURL.replace(/\.json\b/, '.xml')
+}
+```
+
+## See also
+
+- [JSON Feed: Mapping RSS and Atom to JSON Feed](https://jsonfeed.org/mappingrssandatom)
+- [AtomEnabled: Developers > Syndication](https://web.archive.org/web/20160113103647/http://atomenabled.org/developers/syndication/#link)
+- [bcomnes/generate-feed](https://github.com/bcomnes/generate-feed)
+
+## License
+[MIT](https://tldrlegal.com/license/mit-license)
+
+[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
+[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
+[2]: https://img.shields.io/npm/v/jsonfeed-to-atom.svg?style=flat-square
+[3]: https://npmjs.org/package/jsonfeed-to-atom
+[4]: https://img.shields.io/travis/bcomnes/jsonfeed-to-atom/master.svg?style=flat-square
+[5]: https://travis-ci.org/bcomnes/jsonfeed-to-atom
+[8]: http://img.shields.io/npm/dm/jsonfeed-to-atom.svg?style=flat-square
+[9]: https://npmjs.org/package/jsonfeed-to-atom
+[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
+[11]: https://github.com/feross/standard
+[12]: https://img.shields.io/coveralls/bcomnes/jsonfeed-to-atom/master.svg?style=flat-square
+[13]: https://coveralls.io/github/bcomnes/jsonfeed-to-atom
+[rss]: http://www.rssboard.org/rss-specification
+
+
+RSS LINKS:
+
+http://www.rssboard.org/rss-specification
+https://jsonfeed.org/mappingrssandatom
+https://jsonfeed.org/version/1
+http://www.rssboard.org/rss-profile
+https://validator.w3.org/feed/docs/rss2.html
+http://web.resource.org/rss/1.0/modules/content/
+
+
+ITUNES RSS LINKS
+
+https://help.apple.com/itc/podcasts_connect/#/itc1723472cb
+https://help.apple.com/itc/podcasts_connect/#/itcbaf351599
+https://help.apple.com/itc/podcasts_connect/#/itca5b22233a
+https://gist.github.com/bcomnes/defb825462722d96da7b877e22dd7588
+https://www.apple.com/itunes/marketing-on-podcasts/identity-guidelines.html#messaging-and-style

generate-snapshot.js

@@ -0,0 +1,12 @@
+var fs = require('fs')
+var jsonfeedToRSS = require('./')
+var jsonfeedToRSSObj = require('./jsonfeed-to-rss-object')
+var testFeed = require('./test-feed.json')
+
+const rssObj = jsonfeedToRSSObj(testFeed)
+const rssFeed = jsonfeedToRSS(testFeed)
+
+fs.writeFileSync('snapshot.xml', rssFeed)
+fs.writeFileSync('snapshot.json', JSON.stringify(rssObj, null, ' '))
+
+console.log('update snapshot snapshot.xml')

icon.png

@@ -0,0 +1,17 @@
+
+/**
+ * Converts a parsed JSON feed to an rss feed document
+ * @module jsonfeed-to-rss
+ */
+
+const builder = require('xmlbuilder')
+const jsonfeedToRSSObject = require('./jsonfeed-to-rss-object')
+
+/**
+ * Convert a parsed JSON feed object into an rss 2.0.11 xml document
+ */
+module.exports = function jsonfeedToRSS (jsonfeed) {
+  const feedObj = jsonfeedToRSSObject(jsonfeed)
+  const feed = builder.create(feedObj, { encoding: 'utf-8', skipNullAttributes: true, skipNullValues: true })
+  return feed.end({ pretty: true })
+}

index.js

@@ -0,0 +1,106 @@
+const packageInfo = require('./package.json')
+const generateTitle = require('./lib/generate-title')
+
+module.exports = function jsonfeedToAtomObject (jf, opts) {
+  const now = new Date()
+  opts = Object.assign({
+    language: 'en-us',
+    copyright: `© ${now.getFullYear()} ${jf.author && jf.author.name ? jf.author.name : ''}`,
+    managingEditor: getManagingEditor(jf),
+    webMaster: getManagingEditor(jf),
+    idIsPermalink: false,
+    category: null,
+    ttl: null, // TODO default on ttl
+    skipHours: null,
+    skipDays: null,
+    relativeItemLinks: false // enable item level relative links
+  }, opts)
+
+  // 2.0.11 http://www.rssboard.org/rss-specification
+  // JSON Feed to rss mapping based off http://cyber.harvard.edu/rss/rss.html
+  // and http://www.rssboard.org/rss-profile and
+  // https://validator.w3.org/feed/docs/rss2.html
+
+  const { title, version, home_page_url: homePageURL, description } = jf
+  if (version !== 'https://jsonfeed.org/version/1') throw new Error('jsonfeed-to-atom: JSON feed version 1 required')
+  if (!title) throw new Error('jsonfeed-to-rss: missing title')
+  if (!homePageURL) throw new Error('jsonfeed-to-rss: JSON feed missing home_page_url property')
+  if (!description) throw new Error('jsonfeed-to-rss: JSON feed missing description property')
+
+  const rss = {
+    title,
+    link: homePageURL,
+    description,
+    language: opts.language,
+    copyright: opts.copyright,
+    managingEditor: opts.managingEditor,
+    webMaster: opts.webMaster,
+    pubDate: now.toUTCString(), // override with the newest pubdate thats less than now
+    lastBuildDate: now.toUTCString(),
+    category: opts.category, // no mapping, so leave as option
+    generator: `${packageInfo.name} ${packageInfo.version} (${packageInfo.homepage})`,
+    docs: 'http://www.rssboard.org/rss-specification',
+    // TODO: cloud
+    ttl: opts.ttl,
+    image: jf.icon ? {
+      url: jf.icon,
+      link: homePageURL,
+      title: title
+    } : undefined,
+    skipHours: opts.skipHours,
+    skipDays: opts.skipDays
+  }
+
+  if (jf.items) {
+    let mostRecentlyUpdated = '0'
+    rss.item = jf.items.map(item => {
+      // capture mostRecentlyUpdated date, if any
+      if (item.date_published && (item.date_published > mostRecentlyUpdated)) mostRecentlyUpdated = item.date_published
+      if (item.date_modified && (item.date_modified > mostRecentlyUpdated)) mostRecentlyUpdated = item.date_modified
+
+      // Generate item object
+      const rssItem = {
+        title: generateTitle(item),
+        link: item.external_url || item.url,
+        description: {
+          '#cdata': item.content_html || item.content_text
+        },
+        category: item.tags,
+        guid: {
+          '#text': item.id,
+          '@isPermaLink': opts.idIsPermalink
+        },
+        pubDate: item.date_published
+      }
+
+      if (item.attachments) {
+        rssItem.enclosure = item.attachments.map(attachment => ({
+          '@type': attachment.mime_type,
+          '@url': attachment.url,
+          '@length': attachment.size_in_bytes
+        }))
+      }
+      if (opts.relativeItemLinks) rssItem['@xml:base'] = item.url
+      return rssItem
+    })
+    // Replace pubdate date most recently updated or published
+    if (mostRecentlyUpdated > '0') rss.pubDate = new Date(mostRecentlyUpdated).toUTCString()
+  }
+
+  return {
+    rss: {
+      '@version': '2.0',
+      '@xml:base': homePageURL,
+      channel: rss
+    }
+  }
+}
+
+function getManagingEditor (jf) {
+  const {author} = jf
+  if (!author && (!author.url || author.name)) return null
+  let managingEditor = []
+  if (author.url) managingEditor.push(author.url)
+  if (author.name) managingEditor.push(`(${author.name})`)
+  return managingEditor.join(' ')
+}

jsonfeed-to-rss-object.js

@@ -0,0 +1,30 @@
+const striptags = require('striptags')
+const trimRight = require('trim-right')
+const trimLeft = require('trim-left')
+
+/**
+ *  Generate the required atom title for a JSON feed item
+ */
+module.exports = function generateTitle (item) {
+  // A fairly arbitrary attempt at generating titles.
+  // Ideally your JSON feed includes a title for every post. Most UI's will look strange without it
+  if (item.title) return item.title
+  if (item.summary) return truncate(cleanWhitespace(item.summary))
+  if (item.content_text) return truncate(cleanWhitespace(item.content_text))
+  if (item.content_html) return truncate(cleanWhitespace(striptags(item.content_html)))
+  throw new Error('jsonfeed-to-atom: can\'t generate a title for entry ' + item.id)
+}
+
+/**
+ * Removes title unfriendly whitespace
+ */
+function cleanWhitespace (str) {
+  return trimLeft(trimRight(str.split('\n')[0]))
+}
+
+/**
+ * Truncate a string to 100 characters with an ellipsis
+ */
+function truncate (string) {
+  return string.length > 100 ? string.slice(0, 100) + '…' : string
+}