Fix Israel ?i=on logic for RSS and more

Author: mjradwin

README.md

@@ -1,4 +1,4 @@
-# hebcal-rest-api
+# @hebcal/rest-api
 Jewish holidays and Hebrew calendar as plain JSON objects, RSS, and CSV export
 
 ## Installation
@@ -79,11 +79,9 @@ Converts to lowercase and replaces non-word characters with hyphen ('-')
 <dd></dd>
 <dt><a href="#formatLeyningResult">formatLeyningResult(reading)</a> ⇒ <code>Object</code></dt>
 <dd></dd>
-<dt><a href="#getLinkAndGuid">getLinkAndGuid(ev, il)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
-<dd></dd>
 <dt><a href="#eventsToRss">eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate])</a> ⇒ <code>string</code></dt>
 <dd></dd>
-<dt><a href="#eventToRssItem">eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location)</a> ⇒ <code>string</code></dt>
+<dt><a href="#eventToRssItem">eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl)</a> ⇒ <code>string</code></dt>
 <dd></dd>
 <dt><a href="#eventToFullCalendar">eventToFullCalendar(ev, tzid, il)</a> ⇒ <code>Object</code></dt>
 <dd><p>Converts a Hebcal event to a FullCalendar.io object</p>
@@ -298,16 +296,6 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 | --- | --- |
 | reading | <code>leyn.Leyning</code> | 
 
-<a name="getLinkAndGuid"></a>
-
-## getLinkAndGuid(ev, il) ⇒ <code>Array.&lt;string&gt;</code>
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| ev | <code>Event</code> | 
-| il | <code>boolean</code> | 
-
 <a name="eventsToRss"></a>
 
 ## eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate]) ⇒ <code>string</code>
@@ -324,7 +312,7 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 
 <a name="eventToRssItem"></a>
 
-## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location) ⇒ <code>string</code>
+## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl) ⇒ <code>string</code>
 **Kind**: global function  
 
 | Param | Type |
@@ -334,6 +322,7 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 | lastBuildDate | <code>string</code> | 
 | dayFormat | <code>Intl.DateTimeFormat</code> | 
 | location | <code>Location</code> | 
+| mainUrl | <code>string</code> | 
 
 <a name="eventToFullCalendar"></a>
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/rest-api",
-  "version": "3.3.4",
+  "version": "3.4.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal"
@@ -21,7 +21,7 @@
     "url": "https://github.com/hebcal/hebcal-rest-api/issues"
   },
   "dependencies": {
-    "@hebcal/core": "^3.15.0",
+    "@hebcal/core": "^3.17.0",
     "@hebcal/geo-sqlite": "^3.4.1",
     "@hebcal/leyning": "^4.4.0"
   },
@@ -52,20 +52,20 @@
   },
   "devDependencies": {
     "@ava/babel": "^1.0.1",
-    "@babel/core": "^7.14.0",
-    "@babel/preset-env": "^7.14.1",
+    "@babel/core": "^7.14.3",
+    "@babel/preset-env": "^7.14.2",
     "@babel/register": "^7.13.16",
     "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^18.1.0",
+    "@rollup/plugin-commonjs": "^19.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
     "ava": "^3.15.0",
     "core-js": "^3.12.1",
     "eslint": "^7.26.0",
     "eslint-config-google": "^0.14.0",
-    "jsdoc": "^3.6.6",
+    "jsdoc": "^3.6.7",
     "jsdoc-to-markdown": "^5.0.3",
-    "rollup": "^2.47.0",
+    "rollup": "^2.48.0",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

rest-api.d.ts

@@ -31,7 +31,7 @@ declare module '@hebcal/rest-api' {
    * @param [evPubDate] - if true, use event time as pubDate (false uses lastBuildDate)
    */
   export function eventsToRss(events: Event[], location: Location, mainUrl: string, selfUrl: string, lang?: string, evPubDate?: boolean): string;
-  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location): string;
+  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string): string;
   export function getDownloadFilename(options: HebrewCalendar.Options): string;
   export function pad2(number: number): string;
   export function pad4(number: number): string;

src/classic-rest-api.js

@@ -4,6 +4,7 @@ import {
   getCalendarTitle,
   getEventCategories,
   toISOString,
+  appendIsraelAndTracking,
 } from './common';
 import countryNames from './countryNames.json';
 import holidayDescription from './holidays.json';
@@ -104,13 +105,7 @@ export function eventToClassicApiObject(ev, options, leyning=true) {
     }
     const url = ev.url();
     if (url) {
-      if (url.substring(0, 22) == 'https://www.hebcal.com') {
-        const suffix = options.il ? 'i=on&' : '';
-        result.link = `${url}?${suffix}utm_source=js&utm_medium=api`;
-      } else {
-        const sep = url.indexOf('?') == -1 ? '?' : '&';
-        result.link = url + sep + 'utm_source=hebcal.com&utm_medium=api';
-      }
+      result.link = appendIsraelAndTracking(url, options.il, 'js', 'api');
     }
   }
   const memo = ev.memo || holidayDescription[ev.basename()];

src/common.js

@@ -266,3 +266,22 @@ export function makeTorahMemoText(ev, il) {
   }
   return memo;
 }
+
+/**
+ * @private
+ * @param {string} url
+ * @param {boolean} il
+ * @param {string} utmSource
+ * @param {string} utmMedium
+ * @return {string}
+ */
+export function appendIsraelAndTracking(url, il, utmSource, utmMedium) {
+  if (url.substring(0, 22) !== 'https://www.hebcal.com') {
+    utmSource = 'hebcal.com';
+  } else if (il && url.indexOf('?') === -1) {
+    url += '?i=on';
+  }
+  const sep = url.indexOf('?') === -1 ? '?' : '&';
+  const utm = `utm_source=${utmSource}&utm_medium=${utmMedium}`;
+  return url + sep + utm;
+}

src/fullcalendar.js

@@ -1,5 +1,6 @@
 import {Locale, flags, Zmanim} from '@hebcal/core';
-import {getEventCategories, makeTorahMemoText, toISOString} from './common';
+import {getEventCategories, makeTorahMemoText, toISOString,
+  appendIsraelAndTracking} from './common';
 import holidayDescription from './holidays.json';
 
 /**
@@ -35,13 +36,7 @@ export function eventToFullCalendar(ev, tzid, il) {
   }
   const url = ev.url();
   if (url) {
-    if (url.substring(0, 22) == 'https://www.hebcal.com') {
-      const suffix = il ? 'i=on&' : '';
-      result.url = `${url}?${suffix}utm_source=js&utm_medium=fc`;
-    } else {
-      const sep = url.indexOf('?') == -1 ? '?' : '&';
-      result.url = url + sep + 'utm_source=hebcal.com&utm_medium=fc';
-    }
+    result.url = appendIsraelAndTracking(url, il, 'js', 'fc');
   }
   const desc = ev.getDesc();
   const candles = desc === 'Havdalah' || desc === 'Candle lighting';

src/rss.js

@@ -1,32 +1,27 @@
-import {getEventCategories, makeAnchor} from './common';
+import {getEventCategories, makeAnchor, appendIsraelAndTracking} from './common';
 import {Locale, HebrewCalendar} from '@hebcal/core';
 
-const utmParam = 'utm_source=shabbat1c&utm_medium=rss';
-
 /**
+ * @private
  * @param {Event} ev
  * @param {boolean} il
+ * @param {string} mainUrl
  * @return {string[]}
  */
-function getLinkAndGuid(ev, il) {
+function getLinkAndGuid(ev, il, mainUrl) {
   let link;
   let guid;
   const dt = ev.eventTime || ev.getDate().greg();
   const dtStr0 = dt.toISOString();
   const dtStr = encodeURIComponent(dtStr0.substring(0, ev.eventTime ? 19 : 10));
   const url0 = ev.url();
-  const url = url0 && il ? url0 + '?i=on' : url0;
-  if (url) {
-    const question = url.indexOf('?');
-    if (question == -1) {
-      link = url + '?' + utmParam;
-    } else {
-      link = url + '&' + utmParam;
-    }
+  const url = appendIsraelAndTracking(url0 || mainUrl, il, 'shabbat1c', 'rss').replace(/&/g, '&');
+  if (url0) {
+    link = url;
     guid = link + '&dt=' + dtStr;
   } else {
     const anchor = makeAnchor(ev.getDesc());
-    guid = link = 'https://www.hebcal.com/shabbat?' + utmParam + '&dt=' + dtStr + '#' + anchor;
+    guid = link = url + '&dt=' + dtStr + '#' + anchor;
   }
   return [link, guid];
 }
@@ -51,21 +46,21 @@ export function eventsToRss(events, location, mainUrl, selfUrl, lang='en-US', ev
     month: 'long',
     year: 'numeric',
   });
-  mainUrl = mainUrl.replace(/&/g, '&');
+  const mainUrlEsc = appendIsraelAndTracking(mainUrl, location.getIsrael(), 'shabbat1c', 'rss').replace(/&/g, '&');
   selfUrl = selfUrl.replace(/&/g, '&');
   let str = `<?xml version="1.0" encoding="UTF-8"?>
 <rss version="2.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" xmlns:atom="http://www.w3.org/2005/Atom">
 <channel>
 <title>${title}</title>
-<link>${mainUrl}&amp;${utmParam}</link>
+<link>${mainUrlEsc}</link>
 <atom:link href="${selfUrl}" rel="self" type="application/rss+xml" />
 <description>Weekly Shabbat candle lighting times for ${cityDescr}</description>
 <language>${lang}</language>
 <copyright>Copyright (c) ${thisYear} Michael J. Radwin. All rights reserved.</copyright>
 <lastBuildDate>${lastBuildDate}</lastBuildDate>
 `;
   events.forEach((ev) => {
-    str += eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location);
+    str += eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl);
   });
   str += '</channel>\n</rss>\n';
   return str;
@@ -96,13 +91,14 @@ function getPubDate(ev, evPubDate, evDate, lastBuildDate) {
  * @param {string} lastBuildDate
  * @param {Intl.DateTimeFormat} dayFormat
  * @param {Location} location
+ * @param {string} mainUrl
  * @return {string}
  */
-export function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location) {
+export function eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl) {
   let subj = ev.render();
   const evDate = ev.getDate().greg();
   const pubDate = getPubDate(ev, evPubDate, evDate, lastBuildDate);
-  const linkGuid = getLinkAndGuid(ev, location.getIsrael());
+  const linkGuid = getLinkAndGuid(ev, location.getIsrael(), mainUrl);
   const link = linkGuid[0];
   const guid = linkGuid[1];
   const description = dayFormat.format(evDate);

src/rss.spec.js

@@ -3,6 +3,13 @@ import test from 'ava';
 import {HebrewCalendar, Location} from '@hebcal/core';
 import {eventsToRss, eventToRssItem} from './rss';
 
+const dayFormat = new Intl.DateTimeFormat('en-US', {
+  weekday: 'long',
+  day: '2-digit',
+  month: 'long',
+  year: 'numeric',
+});
+
 test('eventsToRss', (t) => {
   const location = new Location(41.85003, -87.65005, false, 'America/Chicago', 'Chicago', 'US', 4887398);
   const options = {
@@ -41,19 +48,14 @@ test('eventToRssItem', (t) => {
     location: location,
   };
   const events = HebrewCalendar.calendar(options).slice(0, 3);
-  const dayFormat = new Intl.DateTimeFormat('en-US', {
-    weekday: 'long',
-    day: '2-digit',
-    month: 'long',
-    year: 'numeric',
-  });
   const lastBuildDate = 'Mon, 22 Jun 2020 20:03:18 GMT';
-  const items = events.map((ev) => eventToRssItem(ev, true, lastBuildDate, dayFormat, location));
+  const mainUrl = 'https://www.hebcal.com/shabbat?city=Eilat';
+  const items = events.map((ev) => eventToRssItem(ev, true, lastBuildDate, dayFormat, location, mainUrl));
   const expected = [
     '<item>\n' +
     '<title>Candle lighting: 18:43</title>\n' +
-    '<link>https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-06T15%3A43%3A00#candle-lighting</link>\n' +
-    '<guid isPermaLink="false">https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-06T15%3A43%3A00#candle-lighting</guid>\n' +
+    '<link>https://www.hebcal.com/shabbat?city=Eilat&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-06T15%3A43%3A00#candle-lighting</link>\n' +
+    '<guid isPermaLink="false">https://www.hebcal.com/shabbat?city=Eilat&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-06T15%3A43%3A00#candle-lighting</guid>\n' +
     '<description>Friday, April 06, 1990</description>\n' +
     '<category>candles</category>\n' +
     '<pubDate>Fri, 06 Apr 1990 15:43:00 GMT</pubDate>\n' +
@@ -62,8 +64,8 @@ test('eventToRssItem', (t) => {
     '</item>\n',
     '<item>\n' +
     '<title>Havdalah (50 min): 19:52</title>\n' +
-    '<link>https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-07T16%3A52%3A00#havdalah</link>\n' +
-    '<guid isPermaLink="false">https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-07T16%3A52%3A00#havdalah</guid>\n' +
+    '<link>https://www.hebcal.com/shabbat?city=Eilat&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-07T16%3A52%3A00#havdalah</link>\n' +
+    '<guid isPermaLink="false">https://www.hebcal.com/shabbat?city=Eilat&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=1990-04-07T16%3A52%3A00#havdalah</guid>\n' +
     '<description>Saturday, April 07, 1990</description>\n' +
     '<category>havdalah</category>\n' +
     '<pubDate>Sat, 07 Apr 1990 16:52:00 GMT</pubDate>\n' +
@@ -86,14 +88,8 @@ test('parsha', (t) => {
     end: new Date(2020, 10, 28),
     sedrot: true,
   });
-  const dayFormat = new Intl.DateTimeFormat('en-US', {
-    weekday: 'long',
-    day: '2-digit',
-    month: 'long',
-    year: 'numeric',
-  });
   const location = Location.lookup('Kiev');
-  const item = eventToRssItem(events[0], true, '', dayFormat, location);
+  const item = eventToRssItem(events[0], true, '', dayFormat, location, '');
   const expected = '<item>\n' +
     '<title>Parashat Vayetzei</title>\n' +
     '<link>https://www.hebcal.com/sedrot/vayetzei-20201128?utm_source=shabbat1c&amp;utm_medium=rss</link>\n' +
@@ -105,6 +101,25 @@ test('parsha', (t) => {
   t.is(item, expected);
 });
 
+test('parsha-il', (t) => {
+  const events = HebrewCalendar.calendar({
+    start: new Date(2020, 10, 28),
+    end: new Date(2020, 10, 28),
+    sedrot: true,
+  });
+  const location = Location.lookup('Jerusalem');
+  const item = eventToRssItem(events[0], true, '', dayFormat, location, '');
+  const expected = '<item>\n' +
+    '<title>Parashat Vayetzei</title>\n' +
+    '<link>https://www.hebcal.com/sedrot/vayetzei-20201128?i=on&amp;utm_source=shabbat1c&amp;utm_medium=rss</link>\n' +
+    '<guid isPermaLink="false">https://www.hebcal.com/sedrot/vayetzei-20201128?i=on&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2020-11-28</guid>\n' +
+    '<description>Saturday, November 28, 2020</description>\n' +
+    '<category>parashat</category>\n' +
+    '<pubDate>Sat, 28 Nov 2020 00:00:00 GMT</pubDate>\n' +
+    '</item>\n';
+  t.is(item, expected);
+});
+
 test('fastStartEnd', (t) => {
   const location = Location.lookup('Tel Aviv');
   const options = {
@@ -115,19 +130,14 @@ test('fastStartEnd', (t) => {
     candlelighting: true,
   };
   const events = HebrewCalendar.calendar(options);
-  const dayFormat = new Intl.DateTimeFormat('en-US', {
-    weekday: 'long',
-    day: '2-digit',
-    month: 'long',
-    year: 'numeric',
-  });
   const lastBuildDate = 'Mon, 22 Jun 2020 20:03:18 GMT';
-  const items = events.map((ev) => eventToRssItem(ev, true, lastBuildDate, dayFormat, location));
+  const mainUrl = 'https://www.hebcal.com/shabbat?city=Tel+Aviv';
+  const items = events.map((ev) => eventToRssItem(ev, true, lastBuildDate, dayFormat, location, mainUrl));
   const expected = [
     '<item>\n' +
       '<title>Fast begins: 04:09</title>\n' +
-      '<link>https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T01%3A09%3A00#fast-begins</link>\n' +
-      '<guid isPermaLink="false">https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T01%3A09%3A00#fast-begins</guid>\n' +
+      '<link>https://www.hebcal.com/shabbat?city=Tel+Aviv&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T01%3A09%3A00#fast-begins</link>\n' +
+      '<guid isPermaLink="false">https://www.hebcal.com/shabbat?city=Tel+Aviv&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T01%3A09%3A00#fast-begins</guid>\n' +
       '<description>Sunday, June 27, 2021</description>\n' +
       '<category>zmanim</category>\n' +
       '<pubDate>Sun, 27 Jun 2021 01:09:00 GMT</pubDate>\n' +
@@ -142,8 +152,8 @@ test('fastStartEnd', (t) => {
       '</item>\n',
     '<item>\n' +
       '<title>Fast ends: 20:25</title>\n' +
-      '<link>https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T17%3A25%3A00#fast-ends</link>\n' +
-      '<guid isPermaLink="false">https://www.hebcal.com/shabbat?utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T17%3A25%3A00#fast-ends</guid>\n' +
+      '<link>https://www.hebcal.com/shabbat?city=Tel+Aviv&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T17%3A25%3A00#fast-ends</link>\n' +
+      '<guid isPermaLink="false">https://www.hebcal.com/shabbat?city=Tel+Aviv&amp;utm_source=shabbat1c&amp;utm_medium=rss&amp;dt=2021-06-27T17%3A25%3A00#fast-ends</guid>\n' +
       '<description>Sunday, June 27, 2021</description>\n' +
       '<category>zmanim</category>\n' +
       '<pubDate>Sun, 27 Jun 2021 17:25:00 GMT</pubDate>\n' +