sfc-utils 1.2.5

package/README.md

@@ -0,0 +1,47 @@
+# utils
+Importable util functions for our templates
+
+This package includes some helpful functions that you can use across SFC projects
+
+The `copy` directory includes the standard ways we copy data from sheets and docs into project data directories. If the sheets command is giving you trouble with types in GraphQL, please note that you can force the command to return only strings by setting the third param to `true`: 
+
+```
+googleAuth(project, null, true)
+```
+
+`brands.js` has all the LESS settings that are specific to each brand. They are applied to the project in `gatsby-config.js` using the modifyVars config option. Since it's done at build time, we can only make brand distinctions by deployable market. We cannot use this same override strategy to make a style change between CTPost and New Haven Register, for example (since they are both CT market).
+
+`nav.js` and `footer.js` both export the HTML needed for each markets' nav and footer settings. The styles controlling the actual look of these features exists at the project level.
+
+`topper.js` implements a cool standardized set of topper options. Great for templates! If story_settings is configured with the right columns, this should be standard across projects.
+
+`blueconic.js` handles the mapping of domains to the arbitrary string that the blueconic script lives on. Why is there an arbitrary string instead of a standard one? Maybe blueconic.houstonchronicle.com, for example? No one knows.
+
+`settings.js` reconciles the project-config.json file and a story_settings sheet (if present) into a single standard object.
+
+`specialnav.js` is a cool variant of `nav.js` that gives it a floating style for special projects, but works the same way.
+
+## Install
+```
+npm i git+https://github.com/sfchronicle/utils.git
+```
+
+## Import the functions
+
+```
+import { blendHDN, getSettings, appCheck } from 'sfc-utils'
+```
+
+## Use them
+
+```
+let isApp = appCheck()
+```
+
+## Troubleshooting
+
+If you get a message about a new function not existing in your project, you might need to force a reinstall of this package. The best way to do that is to completely uninstall it and then reinstall it:
+
+```
+npm uninstall sfc-utils && npm i git+https://github.com/sfchronicle/utils.git
+```

package/blueconic.js

@@ -0,0 +1,58 @@
+
+// Handle returning the right blueconic URL given the domain
+let getBlueconic = function(domain){
+  let blueconicURL = "https://cdn.blueconic.net/hearst.js" // Default, but it's not what we want
+  let subdomain = ""
+
+  // Set subdomain based on URL
+  let apex = domain.replace('https://', '')
+  apex = apex.replace('www.', '')
+  switch(apex){
+    case "sfchronicle.com": subdomain = "q777"; break;
+    case "beaumontenterprise.com": subdomain = "z680"; break;
+    case "chron.com": subdomain = "u566"; break;
+    case "ctinsider.com": subdomain = "z492"; break;
+    case "ctpost.com": subdomain = "t810"; break;
+    case "darientimes.com": subdomain = "y820"; break;
+    case "expressnews.com": subdomain = "l936"; break;
+    case "fairfieldcitizenonline.com": subdomain = "z590"; break;
+    case "fuelfix.com": subdomain = "z929"; break;
+    case "greenwichtime.com": subdomain = "y900"; break;
+    case "hearstmediact.com": subdomain = "j158"; break;
+    case "hearstmediatx.com": subdomain = "f857"; break;
+    case "houstonchronicle.com": subdomain = "r541"; break;
+    case "lmtonline.com": subdomain = "l997"; break;
+    case "middletownpress.com": subdomain = "w982"; break;
+    case "milfordmirror.com": subdomain = "y752"; break;
+    case "mrt.com": subdomain = "x822"; break;
+    case "myplainview.com": subdomain = "u652"; break;
+    case "mysanantonio.com": subdomain = "d810"; break;
+    case "ncadvertiser.com": subdomain = "h353"; break;
+    case "newmilfordspectrum.com": subdomain = "w020"; break;
+    case "newstimes.com": subdomain = "w740"; break;
+    case "ourmidland.com": subdomain = "d276"; break;
+    case "registercitizen.com": subdomain = "j198"; break;
+    case "seattlepi.com": subdomain = "p593"; break;
+    case "sfgate.com": subdomain = "u927"; break;
+    case "sheltonherald.com": subdomain = "f164"; break;
+    case "stamfordadvocate.com": subdomain = "h559"; break;
+    case "thehour.com": subdomain = "f775"; break;
+    case "theintelligencer.com": subdomain = "s232"; break;
+    case "theridgefieldpress.com": subdomain = "y653"; break;
+    case "timesunion.com": subdomain = "n730"; break;
+    case "trumbulltimes.com": subdomain = "o398"; break;
+    case "westport-news.com": subdomain = "c993"; break;
+    case "wiltonbulletin.com": subdomain = "t570"; break;
+    case "yourconroenews.com": subdomain = "z211"; break;
+    case "nhregister.com": subdomain = "y738"; break;
+  }
+	
+  // If we found a subdomain, swap in the new script
+  if (subdomain){
+    blueconicURL = `https://${subdomain}.${apex}/script.js`
+  }
+
+  return blueconicURL
+}
+
+module.exports = { getBlueconic }

package/brands.js

@@ -0,0 +1,180 @@
+
+// Set brand object to override CSS based on this market's styles
+let getBrands = function(market){
+	// We can add any Hearst global overrides here:
+	let defaultObj = {
+		styles: {
+			"@alert-red": "#d20000",
+			// Defaults
+			"@hed": '"Lora Bold", Georgia, serif',
+			"@hed-alt": '"Lora Regular", Georgia, serif',
+			"@serif-book": '"Lora Light", Georgia, serif',
+			"@serif-bold": '"Lora Light", Georgia, serif',
+
+			"@sans-light": '"Source Sans Pro Light", Helvetica, sans-serif',
+			"@sans-med": '"Source Sans Pro Regular", Helvetica, sans-serif',
+			"@sans-book": '"Source Sans Pro Regular", Helvetica, sans-serif',
+			"@sans-bold": '"Source Sans Pro Bold", Helvetica, sans-serif',
+		},
+		attributes: {
+			"subscribeLink": "https://www.hearst.com/newspapers?projects=true"
+		}
+	}
+
+	// Handle market-specific styles here:
+	let marketObj = {
+		/* San Franicsco Chronicle */
+		SFC: {
+			styles: {
+				"@brand": "#26A0A5",
+				"@hed": '"Tiempos Headline Black", Georgia, serif',
+				"@hed-alt": '"Tiempos Headline Light", Georgia, serif',
+				"@serif-book": '"Tiempos Regular", Georgia, serif',
+				"@serif-bold": '"Tiempos Bold", Georgia, serif',
+
+				"@sans-light": '"National Light", Helvetica, sans-serif',
+				"@sans-med": '"National Medium", Helvetica, sans-serif',
+				"@sans-book": '"National Book", Helvetica, sans-serif',
+				"@sans-bold": '"National Bold", Helvetica, sans-serif',
+			},
+			attributes: {
+				"marketPrefix": "sf",
+				"siteName": "The San Francisco Chronicle",
+				"twitter": "sfchronicle",
+				"gaAccount": "UA-1616916-26",
+				"subscribeLink": "https://www.sfchronicle.com/subproject"
+			}
+		},
+
+		/* Houston Chronicle */
+		Houston: {
+			styles: {
+				"@brand": "#ff7500",
+				"@hed": '"Marr Sans Condensed Semibold", Georgia, serif',
+				"@hed-alt": '"Publico Headline Medium", Georgia, serif',
+				"@serif-book": '"Publico Text Roman", Georgia, serif',
+				"@serif-bold": '"Publico Text Bold", Georgia, serif',
+
+				"@sans-light": '"Marr Sans Regular", Helvetica, sans-serif',
+				"@sans-med": '"Marr Sans Regular", Helvetica, sans-serif',
+				"@sans-book": '"Marr Sans Regular", Helvetica, sans-serif',
+				"@sans-bold": '"Marr Sans Semibold", Helvetica, sans-serif',
+			},
+			attributes: {
+				"marketPrefix": "hc",
+				"siteName": "The Houston Chronicle",
+				"twitter": "HoustonChron",
+				"invert": true,
+				"gaAccount": "UA-1616916-24",
+				"subscribeLink": "https://www.houstonchronicle.com/subproject"
+			}
+		},
+
+		/* Albany Times Union */
+		Albany: {
+			styles: {
+				"@brand": "#006FBA",
+				"@hed": '"ChronicleDispCond-Black", Georgia, serif',
+				"@hed-alt": '"ChronicleDispCond-Roman", Georgia, serif',
+				"@serif-book": '"ChronicleTextG2-Roman", Georgia, serif',
+				"@serif-bold": '"ChronicleTextG2-Bold", Georgia, serif',
+				"@base-font-size": "20px",
+
+				"@sans-light": '"HelveticaNeue-Roman", Helvetica, sans-serif',
+				"@sans-med": '"HelveticaNeue-Roman", Helvetica, sans-serif',
+				"@sans-book": '"HelveticaNeue-Roman", Helvetica, sans-serif',
+				"@sans-bold": '"HelveticaNeue-HeavyCond", Helvetica, sans-serif',
+			},
+			attributes: {
+				"marketPrefix": "tu",
+				"siteName": "Times Union",
+				"twitter": "timesunion",
+				"invert": true,
+				"gaAccount": "UA-1616916-7",
+				"subscribeLink": "https://www.timesunion.com/subproject"
+			}
+		},
+
+		/* San Antonio Express News */
+		SanAntonio: {
+			styles: {
+				"@brand": "#ba141a",
+			},
+			attributes: {
+				"marketPrefix": "sa",
+				"siteName": "Express News",
+				"twitter": "ExpressNews",
+				"invert": true,
+				"gaAccount": "UA-1616916-27",
+				"subscribeLink": "https://www.expressnews.com/subproject"
+			}
+		},
+
+		/* Connecticut */
+		CT: {
+			styles: {
+				"@brand": "#900900",
+			},
+			attributes: {
+				"marketPrefix": "in",
+				"siteName": "CTInsider",
+				"twitter": "insider_ct",
+				"invert": true,
+				"gaAccount": "UA-1616916-99",
+				"subscribeLink": "https://www.ctinsider.com/subproject"
+			}
+		},
+
+		/* Connecticut */
+		Texcom: {
+			styles: {
+				"@brand": "#900900",
+			},
+			attributes: {
+				"marketPrefix": "texcom/mrt",
+				"siteName": "Midland Reporter-Telegram",
+				"twitter": "mwtnews",
+				"invert": true,
+				"gaAccount": "UA-1616916-99",
+				"subscribeLink": "/subproject"
+			}
+		},
+
+		/* Connecticut */
+		Midcom: {
+			styles: {
+				"@brand": "#900900",
+			},
+			attributes: {
+				"marketPrefix": "midcom/mid",
+				"siteName": "Midland Daily News",
+				"twitter": "MDN",
+				"invert": true,
+				"gaAccount": "UA-1616916-99",
+				"subscribeLink": "/subproject"
+			}
+		},
+
+		/* Misc */
+		TK: {
+			styles: {
+				"@brand": "#900900",
+			},
+			attributes: {
+				"marketPrefix": "tk",
+				"siteName": "Hearst Digital News",
+				"twitter": "Hearst",
+				"invert": true,
+			}
+		}
+	}
+
+	// Combine global and market styles to return the final object
+	let combinedStyles = {
+		styles: Object.assign(defaultObj.styles, marketObj[market].styles),
+		attributes: Object.assign(defaultObj.attributes, marketObj[market].attributes)
+	}
+	return combinedStyles
+}
+
+module.exports = { getBrands }

package/copy/c2p_sheet.js

@@ -0,0 +1,186 @@
+/*
+
+If confirmed through the startup prompt, this task will create a C2P sheet that handles the metadata for this project
+
+*/
+
+var { google } = require("googleapis");
+var api = google.sheets("v4");
+var writeFile = require("write");
+var authObj = require("./googleauth");
+var fs = require("fs");
+var os = require("os");
+var path = require("path");
+
+// Get config so we're ready to write it back out
+// let config = fs.readFileSync('../project-config.json')
+// let configData = JSON.parse(config)
+
+let googleAuth = (configData) => {
+  var auth = null;
+  authObj
+    .authenticate({ fallback: false })
+    .then((resp) => {
+      auth = resp;
+      createSheet(auth, false, configData).catch(() => {
+        // If the first attempt failed, then make another req using the fallback
+        authObj.authenticate({ fallback: true }).then((resp) => {
+          auth = resp;
+          createSheet(auth, true, configData);
+        });
+      });
+    })
+    .catch(() => {
+      // Failure if we fall back but there's no token
+      auth = authObj.task();
+      createSheet(auth, true, configData);
+    });
+};
+
+let createSheet = (auth, fallback, configData) => {
+  console.log(configData, "config data from create sheet");
+  return new Promise((resolveAll, rejectAll) => {
+    let gmail;
+    if (!fallback) {
+      // Only need gmail to share if it's not a fallback
+      try {
+        let credsLocation = path.join(os.homedir(), ".credentials.json");
+        let credsData = JSON.parse(fs.readFileSync(credsLocation, "utf-8"));
+        gmail = credsData.gmail;
+      } catch (err) {
+        // If we had any trouble getting the gmail address, fail out
+        console.log(err);
+        rejectAll();
+        return;
+      }
+      if (!gmail) {
+        // If gmail is blank, fail out
+        console.log("'gmail' is blank in credentials file!");
+        rejectAll();
+        return;
+      }
+    }
+
+    const drive = google.drive({ version: "v3", auth });
+    const body = { title: "New C2P sheet" };
+    const templateId = "1juVrba9UNHVZV13e23o0gcwOw8YzX_1b7uxTI_jv7_4";
+    drive.files.copy(
+      {
+        fileId: templateId, // Base template
+        resource: body,
+        //'copyCollaborators': true // This doesn't work unfortunately
+      },
+      (err, resp) => {
+        console.log(resp);
+        // Make edits to the sheet to match the repo details
+        let resources = {
+          auth: auth,
+          spreadsheetId: resp.data.id,
+          resource: {
+            valueInputOption: "RAW",
+            data: [
+              {
+                range: "story_settings!A2",
+                values: [[configData.PROJECT.MARKET_KEY]],
+              },
+              {
+                range: "story_settings!B2",
+                values: [[configData.PROJECT.SLUG]],
+              },
+              {
+                range: "story_settings!C2",
+                values: [[configData.PROJECT.SUBFOLDER]],
+              },
+              {
+                range: "system_settings!A2",
+                values: [[configData.PROJECT.SLUG]], // Repo is usually slug by default
+              },
+            ],
+          },
+        };
+        api.spreadsheets.values.batchUpdate(
+          resources,
+          (updateErr, updateResp) => {
+            if (updateErr) {
+              console.log("Data Error :", updateErr);
+            }
+          }
+        );
+
+        // Write out config with new sheet added
+        configData.GOOGLE_SHEETS = [resp.data.id];
+        writeFile("project-config.json", JSON.stringify(configData, null, 2));
+
+        // Okay, now give the team permissions
+        if (err) {
+          console.log("An error prevented the creation of this sheet!");
+          rejectAll();
+        } else {
+          // If this is a fallback, it was created with the user's account, so we shouldn't need to share it -- finish up
+          if (fallback) {
+            console.log(
+              "The above errors were a failure to create the new sheet with a service account! Your default token was used instead."
+            );
+            console.log(
+              "Your new C2P sheet should be live at this URL:",
+              `https://docs.google.com/spreadsheets/d/${resp.data.id}/edit`
+            );
+            resolveAll();
+          } else {
+            const permission = {
+              type: "user",
+              role: "writer",
+              emailAddress: gmail,
+            };
+            drive.permissions.create(
+              {
+                resource: permission,
+                fileId: resp.data.id, // Modify the created file
+              },
+              (permErr, permResp) => {
+                //console.log("permResp", permResp, permErr)
+                if (permErr) {
+                  console.log("An error prevented the sharing of this sheet!");
+                  rejectAll();
+                } else {
+                  console.log(
+                    "Your new C2P sheet should be live at this URL:",
+                    `https://docs.google.com/spreadsheets/d/${resp.data.id}/edit`
+                  );
+                  console.log(
+                    `NOTE: It may take a few seconds before your gmail, ${gmail}, has access`
+                  );
+                  // Now share with the service account
+                  const permission2 = {
+                    type: "user",
+                    role: "writer",
+                    emailAddress: "sfchronicle-gatsby@zinc-proton-250521.iam.gserviceaccount.com",
+                  };
+                  drive.permissions.create(
+                    {
+                      resource: permission2,
+                      fileId: resp.data.id, // Modify the created file
+                    },
+                    (permErr, permResp) => {
+                      if (permErr) {
+                        console.log("An error prevented the sharing of this sheet with the service account!");
+                        rejectAll();
+                      } else {
+                        console.log(
+                          `Sheet also shared with service account for quick deploying!`
+                        );
+                        resolveAll();
+                      }
+                    }
+                  )
+                }
+              }
+            );
+          }
+        }
+      }
+    );
+  });
+};
+
+module.exports = { googleAuth };

package/copy/docs.js

@@ -0,0 +1,177 @@
+/*
+
+
+  * Uses the Google Drive API to parse Google Doc with ArchieML generate JSON file
+  * Docs must be shared with the service account email before they can be accessed with this task
+  * @param {object} config standard object from project-config.json or project.json
+  * @param {string} directory optional alternate path to directory in which to save the output
+  * @param {array} filenames optional array of objects with name and id key/values used to specify a filename for a specific doc
+
+
+ */
+
+var { google } = require("googleapis");
+var async = require("async");
+var url = require("url");
+var writeFile = require("write");
+var authObj = require("./googleauth");
+var archieml = require("archieml");
+var htmlparser = require("htmlparser2");
+var Entities = require("html-entities").AllHtmlEntities;
+
+let googleAuth = (config, directory = null, filenames = null) => {
+  var auth = null;
+  authObj
+    .authenticate({ fallback: false })
+    .then((resp) => {
+      auth = resp;
+      grabDocs(auth, config, directory, filenames).catch(() => {
+        // If the first attempt failed, then make another req using the fallback
+        authObj.authenticate({ fallback: true }).then((resp) => {
+          auth = resp;
+          grabDocs(auth, config, directory, filenames);
+        });
+      });
+    })
+    .catch(() => {
+      // Failure if we fall back but there's no token
+      auth = authObj.task();
+      grabDocs(auth, config, directory, filenames);
+    });
+};
+
+var camelCase = function (str) {
+  return str.replace(/[^\w]+(\w)/g, function (all, match) {
+    return match.toUpperCase();
+  });
+};
+
+/*
+ * Large document sets may hit rate limits; you can find details on your quota at:
+ * https://console.developers.google.com/apis/api/drive.googleapis.com/quotas?project=<project>
+ * where <project> is the project you authenticated with using `grunt google-auth`
+ */
+let grabDocs = (auth, config, directory = null, filenames = null) => {
+  return new Promise((resolve, reject) => {
+    var drive = google.drive({
+      auth,
+      version: "v3",
+    });
+
+    async.eachLimit(
+      config.GOOGLE_DOCS,
+      3, // adjust this up or down based on rate limiting
+      async function (fileId) {
+        var meta = await drive.files
+          .get({
+            fileId,
+          })
+          .catch(() => {
+            // Maybe service account we doesn't have permissions -- try with normal token
+            reject();
+          });
+        if (!meta) {
+          return;
+        }
+
+        var filename = meta.data.name.replace(/\s+/g, "_");
+
+        //find the appropriate filename if filenames arr is included in params
+        if (filenames) {
+          let match = filenames.find((f) => f.id === fileId);
+          filename = match.name;
+        }
+
+        //specify directory if included in params
+        directory = directory || "src/data/";
+
+        //build file path
+        var file_path = `${directory}${filename}.json`;
+
+        drive.files.export(
+          { fileId: fileId, mimeType: "text/html" },
+          function (err, docHtml) {
+            var handler = new htmlparser.DomHandler(function (error, dom) {
+              var tagHandlers = {
+                _base: function (tag) {
+                  var str = "";
+                  tag.children.forEach(function (child) {
+                    if ((func = tagHandlers[child.name || child.type]))
+                      str += func(child);
+                  });
+                  return str;
+                },
+                text: function (textTag) {
+                  return textTag.data;
+                },
+                span: function (spanTag) {
+                  return tagHandlers._base(spanTag);
+                },
+                p: function (pTag) {
+                  return tagHandlers._base(pTag) + "\n";
+                },
+                a: function (aTag) {
+                  var href = aTag.attribs.href;
+                  if (href === undefined) return "";
+
+                  // extract real URLs from Google's tracking
+                  // from: http://www.google.com/url?q=http%3A%2F%2Fwww.sfchronicle.com...
+                  // to: http://www.sfchronicle.com...
+                  if (
+                    aTag.attribs.href &&
+                    url.parse(aTag.attribs.href, true).query &&
+                    url.parse(aTag.attribs.href, true).query.q
+                  ) {
+                    href = url.parse(aTag.attribs.href, true).query.q;
+                  }
+
+                  var str = '<a href="' + href + '">';
+                  str += tagHandlers._base(aTag);
+                  str += "</a>";
+                  return str;
+                },
+                li: function (tag) {
+                  return "* " + tagHandlers._base(tag) + "\n";
+                },
+              };
+
+              ["ul", "ol"].forEach(function (tag) {
+                tagHandlers[tag] = tagHandlers.span;
+              });
+              ["h1", "h2", "h3", "h4", "h5", "h6"].forEach(function (tag) {
+                tagHandlers[tag] = tagHandlers.p;
+              });
+
+              var body = dom[0].children[1];
+              var parsedText = tagHandlers._base(body);
+
+              // Convert html entities into the characters as they exist in the google doc
+              var entities = new Entities();
+              parsedText = entities.decode(parsedText);
+
+              // Remove smart quotes from inside tags
+              parsedText = parsedText.replace(/<[^<>]*>/g, function (match) {
+                return match.replace(/”|“/g, '"').replace(/‘|’/g, "'");
+              });
+
+              // Parse with Archie
+              var parsed = archieml.load(parsedText);
+
+              // Create the file
+              writeFile(file_path, JSON.stringify(parsed, null, 2));
+            });
+
+            var parser = new htmlparser.Parser(handler);
+            parser.write(docHtml.data);
+            parser.done();
+            console.log("\x1b[32m", file_path + " created successfully");
+            // Exit the promise
+            resolve(true);
+          }
+        );
+      }
+    );
+  });
+};
+
+module.exports = { googleAuth };