reallysimple 0.4.6 → 0.4.9

package/package.json

@@ -1,23 +1,23 @@
 {
-	"name": "reallysimple", 
-	"description": "Reads an RSS-like feed and calls back with a JavaScript structure, hiding all the history. It really is simple. ;-)",
-	"version": "0.4.6", 
+	"name": "reallysimple",
+	"description": "A Node package that reads RSS-like feeds and calls back with a simple, consistent JavaScript object. Easy to use, hides the history.",
+	"version": "0.4.9",
 	"author": "Dave Winer <dave@scripting.com>",
 	"license": "MIT",
 	"files": [
 		"reallysimple.js"
-		],
+	],
 	"main": "reallysimple.js",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/scripting/reallysimple.git"
-		},
-	"dependencies" : {
-		"opml": "*",
+	},
+	"dependencies": {
+		"davefeedread": "^0.5.19",
 		"daveutils": "*",
-		"davefeedread": "*"
-		},
+		"opml": "^0.4.24"
+	},
 	"engines": {
 		"node": "*"
-		}
 	}
+}

package/readme.md

@@ -1,66 +1,28 @@
 # reallysimple
 
-JavaScript code to read a feed. Calls back with a simple JavaScript object, easily represented in JSON. Hides all the history.
+A Node package that reads RSS-like feeds and calls back with a simple, consistent JavaScript object. Easy to use, hides the history.
 
-#### What formats are supported?
-
-RSS, Atom, and RDF.
-
-#### Why?
-
-I wanted to make reading a feed from a JavaScript app as easy as possible. 
-
-To hide all the history to get it out of your way. 
+#### Code example
 
-If developers can quickly put together an app that uses feeds, people will try out more ideas, add feed support to more apps.
+I always like to see the code first...
 
-I needed to simplify feed reading for the scripting system in Drummer. For scripting, simplicity is everything. Why not share the simplicity with lower level code.
+```javascript
 
-There probably is a small tradeoff in performance, you can probably write faster code by going straight to the feedparser level. And that's fine for applications that require the maximum performance, perhaps where you're reading a thousand feeds per sectond. 
+Here's <a href="https://github.com/scripting/reallysimple/blob/main/example/test.json">the file</a> that's created when you run the code. 
 
-#### A coding example
+#### Why?
 
-Here's how you call the package.
+I needed a simple routine to call when I wanted to read a feed. 
 
-```javascript
+#### What formats are supported?
 
-Here's <a href="https://github.com/scripting/reallysimple/blob/main/example/test.json">the file</a> that's created when you run that code. 
+RSS, Atom, and RDF.
 
 #### What we build on
 
 Thanks to Dan MacTough for the <a href="https://www.npmjs.com/package/feedparser">feedparser</a> package.
 
-It also builds on the davefeedread package, which simplifies the programming interface to feedparser.
-
-This package further simplifies the struct returned by <a href="https://www.npmjs.com/package/davefeedread">davefeedread</a>.
-
-#### Work notes
-
-4/7/22; 11:37:16 AM by DW
-
-Clean up the readme file. Simplify the example app. Review docs. Start to invite collaborators to the repo, still private.
-
-3/21/22; 10:19:22 AM by DW
-
-Reviewing the way we represent links in items in the API. 
-
-The question is this -- how can we get a link to the item from the item. 
-
-The answer, on reflection -- rely on the link element as the permalink. 
-
-3/7/22; 10:27:47 AM by DW
-
-Start the reallysimple repo. Publish the NPM package. 
-
-3/6/22; 11:27:52 AM by DW
-
-It now understands various elements from the source namespace, including source:account, source:localtime and source:outline.
-
-Started a new private GitHub repo for the project and saved the files. 
-
-Added it to my NPM sub-menu, this is going to be a supported project.
-
 #### Comments, questions?
 
-Please post your comments and questions in the <a href="https://github.com/scripting/reallysimple/issues/new">issues section</a> of this repo.
+Post comments and questions in the <a href="https://github.com/scripting/reallysimple/issues/new">issues section</a> of this repo.
 

package/readme.opml

@@ -2,7 +2,7 @@
 <opml version="2.0">
 	<head>
 		<title>readme.md</title>
-		<dateModified>Thu, 07 Apr 2022 15:38:10 GMT</dateModified>
+		<dateModified>Sat, 11 Jun 2022 20:01:27 GMT</dateModified>
 		<expansionState></expansionState>
 		<vertScrollState>1</vertScrollState>
 		<windowTop>300</windowTop>
@@ -12,48 +12,24 @@
 		</head>
 	<body created="Sat, 05 Mar 2022 16:54:13 GMT" text="readme.md">
 		<outline created="Sat, 05 Mar 2022 16:54:15 GMT" text="# reallysimple">
-			<outline created="Mon, 07 Mar 2022 15:05:45 GMT" text="JavaScript code to read a feed. Calls back with a simple JavaScript object, easily represented in JSON. Hides all the history."></outline>
+			<outline created="Sat, 11 Jun 2022 15:59:23 GMT" text="A Node package that reads RSS-like feeds and calls back with a simple, consistent JavaScript object. Easy to use, hides the history."></outline>
 			</outline>
-		<outline created="Thu, 17 Mar 2022 15:42:49 GMT" text="#### What formats are supported?">
-			<outline created="Thu, 17 Mar 2022 15:42:57 GMT" text="RSS, Atom, and RDF."></outline>
+		<outline created="Sat, 11 Jun 2022 16:24:18 GMT" text="#### Code example">
+			<outline created="Sat, 11 Jun 2022 16:20:10 GMT" text="I always like to see the code first..."></outline>
+			<outline text="&lt;%includeExample (&quot;example1&quot;)%&gt;"></outline>
+			<outline created="Mon, 07 Mar 2022 15:10:30 GMT" text="Here's &lt;a href=&quot;https://github.com/scripting/reallysimple/blob/main/example/test.json&quot;&gt;the file&lt;/a&gt; that's created when you run the code. "></outline>
 			</outline>
-		<outline text="#### Why?">
-			<outline created="Thu, 17 Mar 2022 15:40:05 GMT" text="I wanted to make reading a feed from a JavaScript app as easy as possible. "></outline>
-			<outline created="Thu, 17 Mar 2022 15:40:29 GMT" text="To hide all the history to get it out of your way. "></outline>
-			<outline created="Mon, 07 Mar 2022 15:16:54 GMT" text="If developers can quickly put together an app that uses feeds, people will try out more ideas, add feed support to more apps."></outline>
-			<outline created="Mon, 07 Mar 2022 15:17:44 GMT" text="I needed to simplify feed reading for the scripting system in Drummer. For scripting, simplicity is everything. Why not share the simplicity with lower level code."></outline>
-			<outline created="Mon, 07 Mar 2022 15:18:12 GMT" text="There probably is a small tradeoff in performance, you can probably write faster code by going straight to the feedparser level. And that's fine for applications that require the maximum performance, perhaps where you're reading a thousand feeds per sectond. "></outline>
+		<outline created="Sat, 11 Jun 2022 16:00:30 GMT" text="#### Why?">
+			<outline created="Sat, 11 Jun 2022 16:00:36 GMT" text="I needed a simple routine to call when I wanted to read a feed. "></outline>
 			</outline>
-		<outline created="Mon, 07 Mar 2022 15:11:02 GMT" text="#### A coding example">
-			<outline created="Mon, 07 Mar 2022 15:11:09 GMT" text="Here's how you call the package."></outline>
-			<outline text="&lt;%includeExample (&quot;example1&quot;)%&gt;"></outline>
-			<outline created="Mon, 07 Mar 2022 15:10:30 GMT" text="Here's &lt;a href=&quot;https://github.com/scripting/reallysimple/blob/main/example/test.json&quot;&gt;the file&lt;/a&gt; that's created when you run that code. "></outline>
+		<outline created="Thu, 17 Mar 2022 15:42:49 GMT" text="#### What formats are supported?">
+			<outline created="Thu, 17 Mar 2022 15:42:57 GMT" text="RSS, Atom, and RDF."></outline>
 			</outline>
 		<outline created="Mon, 07 Mar 2022 15:25:06 GMT" text="#### What we build on">
 			<outline created="Mon, 07 Mar 2022 15:25:07 GMT" text="Thanks to Dan MacTough for the &lt;a href=&quot;https://www.npmjs.com/package/feedparser&quot;&gt;feedparser&lt;/a&gt; package."></outline>
-			<outline created="Mon, 07 Mar 2022 15:25:33 GMT" text="It also builds on the davefeedread package, which simplifies the programming interface to feedparser."></outline>
-			<outline created="Thu, 17 Mar 2022 15:46:06 GMT" text="This package further simplifies the struct returned by &lt;a href=&quot;https://www.npmjs.com/package/davefeedread&quot;&gt;davefeedread&lt;/a&gt;."></outline>
-			</outline>
-		<outline created="Sat, 05 Mar 2022 17:30:26 GMT" text="#### Work notes">
-			<outline created="Thu, 07 Apr 2022 15:37:15 GMT" text="4/7/22; 11:37:16 AM by DW">
-				<outline created="Thu, 07 Apr 2022 15:37:17 GMT" text="Clean up the readme file. Simplify the example app. Review docs. Start to invite collaborators to the repo, still private."></outline>
-				</outline>
-			<outline created="Mon, 21 Mar 2022 14:19:22 GMT" text="3/21/22; 10:19:22 AM by DW">
-				<outline created="Mon, 21 Mar 2022 14:19:22 GMT" text="Reviewing the way we represent links in items in the API. "></outline>
-				<outline created="Mon, 21 Mar 2022 14:27:17 GMT" text="The question is this -- how can we get a link to the item from the item. "></outline>
-				<outline created="Mon, 21 Mar 2022 14:27:44 GMT" text="The answer, on reflection -- rely on the link element as the permalink. "></outline>
-				</outline>
-			<outline created="Mon, 07 Mar 2022 15:27:46 GMT" text="3/7/22; 10:27:47 AM by DW">
-				<outline created="Mon, 07 Mar 2022 15:27:47 GMT" text="Start the reallysimple repo. Publish the NPM package. "></outline>
-				</outline>
-			<outline created="Sun, 06 Mar 2022 16:27:50 GMT" text="3/6/22; 11:27:52 AM by DW">
-				<outline created="Sun, 06 Mar 2022 16:27:53 GMT" text="It now understands various elements from the source namespace, including source:account, source:localtime and source:outline."></outline>
-				<outline created="Sun, 06 Mar 2022 16:28:33 GMT" text="Started a new private GitHub repo for the project and saved the files. "></outline>
-				<outline created="Sun, 06 Mar 2022 16:29:01 GMT" text="Added it to my NPM sub-menu, this is going to be a supported project."></outline>
-				</outline>
 			</outline>
 		<outline created="Mon, 07 Mar 2022 15:26:41 GMT" text="#### Comments, questions?">
-			<outline created="Mon, 07 Mar 2022 15:26:47 GMT" text="Please post your comments and questions in the &lt;a href=&quot;https://github.com/scripting/reallysimple/issues/new&quot;&gt;issues section&lt;/a&gt; of this repo."></outline>
+			<outline created="Mon, 07 Mar 2022 15:26:47 GMT" text="Post comments and questions in the &lt;a href=&quot;https://github.com/scripting/reallysimple/issues/new&quot;&gt;issues section&lt;/a&gt; of this repo."></outline>
 			</outline>
 		</body>
 	</opml>

package/reallysimple.js

@@ -1,4 +1,4 @@
-var myProductName = "reallysimple"; myVersion = "0.4.6";    
+var myProductName = "reallysimple"; myVersion = "0.4.9";    
 
 exports.readFeed = readFeed;
 exports.convertFeedToOpml = convertFeedToOpml;
@@ -10,18 +10,26 @@ const davefeedread = require ("davefeedread");
 
 const allowedHeadNames = [
 	"title", "link", "description", "language", "copyright", "managingEditor", "webMaster", "lastBuildDate", "pubDate", "category",
-	"generator", "docs", "cloud", "ttl", "image", "rating", "textInput", "skipHours", "skipDays", "source:account", "source:localtime"
+	"generator", "docs", "cloud", "ttl", "image", "rating", "textInput", "skipHours", "skipDays", "source:account", "source:localtime", "linkToSelf"
 	];
 const allowedItemNames = [
 	"title", "link", "description", "author", "category", "comments", "enclosures", "guid", "pubDate", "source", "source:outline", "source:likes"
 	];
+const allowedEnclosureNames = [
+	"url", "type", "length"
+	];
 
 var config = {
 	timeOutSecs: 3
 	}
 
 function isEmptyObject (obj) {
-	return (Object.keys (obj).length === 0);
+	try {
+		return (Object.keys (obj).length === 0);
+		}
+	catch (err) {
+		return (true); //6/8/22 by DW
+		}
 	}
 function getItemPermalink (item) { 
 	var rssguid = item ["rss:guid"], returnedval = undefined;
@@ -155,6 +163,11 @@ function convertFeed (oldFeed) {
 			delete newFeed.image;
 			}
 		}
+	if (newFeed.cloud !== undefined) { //6/11/22 by DW
+		if (isEmptyObject (newFeed.cloud)) {
+			delete newFeed.cloud;
+			}
+		}
 	
 	newFeed.items = new Array ();
 	oldFeed.items.forEach (function (item) {
@@ -189,6 +202,21 @@ function convertFeed (oldFeed) {
 				delete newItem.source;
 				}
 			}
+		
+		if (newItem.enclosure !== undefined) { //6/11/22 by DW
+			var enc = new Object ();
+			for (var x in newItem.enclosure) {
+				allowedEnclosureNames.forEach (function (name) {
+					if (x == name) {
+						if (newItem.enclosure [x] != null) {
+							enc [x] = newItem.enclosure [x];
+							}
+						}
+					});
+				}
+			newItem.enclosure = enc;
+			}
+		
 		newFeed.items.push (newItem);
 		});