reallysimple 0.4.1 → 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/package.json +1 -1
  2. package/readme.md +23 -7
  3. package/readme.opml +17 -7
  4. package/reallysimple.js +21 -6
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "reallysimple",
3
3
  "description": "Reads an RSS-like feed and calls back with a JavaScript structure, hiding all the history. It really is simple. ;-)",
4
- "version": "0.4.1",
4
+ "version": "0.4.4",
5
5
  "author": "Dave Winer <dave@scripting.com>",
6
6
  "license": "MIT",
7
7
  "files": [
package/readme.md CHANGED
@@ -1,16 +1,22 @@
1
1
  # reallysimple
2
2
 
3
- Reads an RSS-like feed and calls back with a JavaScript structure, hiding all the history.
3
+ JavaScript code to read a feed. Calls back with a simple JavaScript object, easily represented in JSON. Hides all the history.
4
+
5
+ #### What formats are supported?
6
+
7
+ RSS, Atom, and RDF.
4
8
 
5
9
  #### Why?
6
10
 
7
- If it's easier to use RSS, more people will use it. If programmers can quickly put together an app that uses RSS, people will try out more ideas, add RSS support to more apps. I see this as a good thing.
11
+ I wanted to make reading a feed from a JavaScript app as easy as possible.
8
12
 
9
- I also want to include RSS verbs in a scripting language I'm working on. For scripting, simplicity is everything.
13
+ To hide all the history to get it out of your way.
10
14
 
11
- 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.
15
+ If developers can quickly put together an app that uses feeds, people will try out more ideas, add feed support to more apps.
12
16
 
13
- #### An example
17
+ 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.
18
+
19
+ 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.
14
20
 
15
21
  #### A coding example
16
22
 
@@ -34,12 +40,22 @@ Here's what shows up in the console when you run that code.
34
40
 
35
41
  #### What we build on
36
42
 
37
- Thanks to Dan MacTough for the feedparser package which we build on.
43
+ Thanks to Dan MacTough for the <a href="https://www.npmjs.com/package/feedparser">feedparser</a> package.
38
44
 
39
- It also builds on the davefeedread package, which simplifies the programming interface to feedparser, and returns the same complicated structure returned by feedparser.
45
+ It also builds on the davefeedread package, which simplifies the programming interface to feedparser.
46
+
47
+ This package further simplifies the struct returned by <a href="https://www.npmjs.com/package/davefeedread">davefeedread</a>.
40
48
 
41
49
  #### Work notes
42
50
 
51
+ 3/21/22; 10:19:22 AM by DW
52
+
53
+ Reviewing the way we represent links in items in the API.
54
+
55
+ The question is this -- how can we get a link to the item from the item.
56
+
57
+ The answer, on reflection -- rely on the link element as the permalink.
58
+
43
59
  3/7/22; 10:27:47 AM by DW
44
60
 
45
61
  Start the reallysimple repo. Publish the NPM package.
package/readme.opml CHANGED
@@ -2,7 +2,7 @@
2
2
  <opml version="2.0">
3
3
  <head>
4
4
  <title>readme.md</title>
5
- <dateModified>&lt;%dateModified%></dateModified>
5
+ <dateModified>Sun, 27 Mar 2022 16:05:47 GMT</dateModified>
6
6
  <expansionState></expansionState>
7
7
  <vertScrollState>1</vertScrollState>
8
8
  <windowTop>300</windowTop>
@@ -12,14 +12,18 @@
12
12
  </head>
13
13
  <body created="Sat, 05 Mar 2022 16:54:13 GMT" text="readme.md">
14
14
  <outline created="Sat, 05 Mar 2022 16:54:15 GMT" text="# reallysimple">
15
- <outline created="Mon, 07 Mar 2022 15:05:45 GMT" text="Reads an RSS-like feed and calls back with a JavaScript structure, hiding all the history."></outline>
15
+ <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>
16
+ </outline>
17
+ <outline created="Thu, 17 Mar 2022 15:42:49 GMT" text="#### What formats are supported?">
18
+ <outline created="Thu, 17 Mar 2022 15:42:57 GMT" text="RSS, Atom, and RDF."></outline>
16
19
  </outline>
17
20
  <outline text="#### Why?">
18
- <outline created="Mon, 07 Mar 2022 15:16:54 GMT" text="If it's easier to use RSS, more people will use it. If programmers can quickly put together an app that uses RSS, people will try out more ideas, add RSS support to more apps. I see this as a good thing."></outline>
19
- <outline created="Mon, 07 Mar 2022 15:17:44 GMT" text="I also want to include RSS verbs in a scripting language I'm working on. For scripting, simplicity is everything. "></outline>
21
+ <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>
22
+ <outline created="Thu, 17 Mar 2022 15:40:29 GMT" text="To hide all the history to get it out of your way. "></outline>
23
+ <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>
24
+ <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>
20
25
  <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>
21
26
  </outline>
22
- <outline created="Mon, 07 Mar 2022 15:10:25 GMT" text="#### An example"></outline>
23
27
  <outline created="Mon, 07 Mar 2022 15:11:02 GMT" text="#### A coding example">
24
28
  <outline created="Mon, 07 Mar 2022 15:11:09 GMT" text="Here's how you call the package."></outline>
25
29
  <outline created="Mon, 07 Mar 2022 15:12:02 GMT" text="const reallysimple = require (&quot;reallysimple&quot;);"></outline>
@@ -34,10 +38,16 @@
34
38
  <outline created="Mon, 07 Mar 2022 15:10:30 GMT" text="Here's what shows up in the console when you run that code. "></outline>
35
39
  </outline>
36
40
  <outline created="Mon, 07 Mar 2022 15:25:06 GMT" text="#### What we build on">
37
- <outline created="Mon, 07 Mar 2022 15:25:07 GMT" text="Thanks to Dan MacTough for the feedparser package which we build on."></outline>
38
- <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, and returns the same complicated structure returned by feedparser. "></outline>
41
+ <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>
42
+ <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>
43
+ <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>
39
44
  </outline>
40
45
  <outline created="Sat, 05 Mar 2022 17:30:26 GMT" text="#### Work notes">
46
+ <outline created="Mon, 21 Mar 2022 14:19:22 GMT" text="3/21/22; 10:19:22 AM by DW">
47
+ <outline created="Mon, 21 Mar 2022 14:19:22 GMT" text="Reviewing the way we represent links in items in the API. "></outline>
48
+ <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>
49
+ <outline created="Mon, 21 Mar 2022 14:27:44 GMT" text="The answer, on reflection -- rely on the link element as the permalink. "></outline>
50
+ </outline>
41
51
  <outline created="Mon, 07 Mar 2022 15:27:46 GMT" text="3/7/22; 10:27:47 AM by DW">
42
52
  <outline created="Mon, 07 Mar 2022 15:27:47 GMT" text="Start the reallysimple repo. Publish the NPM package. "></outline>
43
53
  </outline>
package/reallysimple.js CHANGED
@@ -1,18 +1,19 @@
1
- var myProductName = "reallysimple"; myVersion = "0.4.1";
1
+ var myProductName = "reallysimple"; myVersion = "0.4.4";
2
2
 
3
3
  exports.readFeed = readFeed;
4
4
  exports.convertFeedToOpml = convertFeedToOpml;
5
5
 
6
6
  const utils = require ("daveutils");
7
7
  const request = require ("request");
8
- const feedRead1 = require ("davefeedread");
8
+ const opml = require ("opml");
9
+ const davefeedread = require ("davefeedread");
9
10
 
10
11
  const allowedHeadNames = [
11
12
  "title", "link", "description", "language", "copyright", "managingEditor", "webMaster", "lastBuildDate", "pubDate", "category",
12
13
  "generator", "docs", "cloud", "ttl", "image", "rating", "textInput", "skipHours", "skipDays", "source:account", "source:localtime"
13
14
  ];
14
15
  const allowedItemNames = [
15
- "title", "link", "description", "author", "category", "comments", "enclosure", "guid", "pubDate", "source", "source:outline", "source:likes"
16
+ "title", "link", "description", "author", "category", "comments", "enclosures", "guid", "pubDate", "source", "source:outline", "source:likes"
16
17
  ];
17
18
 
18
19
  var config = {
@@ -95,6 +96,13 @@ function convertFeed (oldFeed) {
95
96
  }
96
97
  return (theNewOutline);
97
98
  }
99
+ function removeExtraAttributes (theOutline) {
100
+ opml.visitAll (theOutline, function (theNode) {
101
+ if (theNode.flincalendar !== undefined) {
102
+ delete theNode.flincalendar;
103
+ }
104
+ });
105
+ }
98
106
  function getHeadValuesFromFirstItem () { //3/6/22 by DW
99
107
  if (oldFeed.items.length > 0) {
100
108
  var item = oldFeed.items [0];
@@ -150,10 +158,18 @@ function convertFeed (oldFeed) {
150
158
  if (x == name) {
151
159
  if (x == "source:outline") {
152
160
  val = convertOutline (item ["source:outline"]);
161
+ removeExtraAttributes (val); //3/27/22 by DW
153
162
  newItem.outline = val;
154
163
  }
155
164
  else {
156
- newItem [x] = val;
165
+ if (x == "enclosures") {
166
+ if (item.enclosures.length > 0) {
167
+ newItem.enclosure = item.enclosures [0];
168
+ }
169
+ }
170
+ else {
171
+ newItem [x] = val;
172
+ }
157
173
  }
158
174
  }
159
175
  });
@@ -170,7 +186,7 @@ function convertFeed (oldFeed) {
170
186
  }
171
187
 
172
188
  function readFeed (url, callback) {
173
- feedRead1.parseUrl (url, config.timeOutSecs, function (err, theFeed) {
189
+ davefeedread.parseUrl (url, config.timeOutSecs, function (err, theFeed) {
174
190
  if (err) {
175
191
  callback (err);
176
192
  }
@@ -179,4 +195,3 @@ function readFeed (url, callback) {
179
195
  }
180
196
  });
181
197
  }
182
-