VSinerva/freesewing
1
0
Fork 0
Code Activity

Merge branch 'newsletter' into develop

Browse source
This commit is contained in:
Joost De Cock 2022-06-28 12:59:44 +02:00
commit d2bcfc25c2
7 changed files with 465 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
config/newsletter-testers.mjs Normal file
View file

@ -0,0 +1,10 @@
export const testers = [
{
email: 'joost@joost.at',
ehash: 'asefsdfsdfsdlfsllehash',
},
{
email: 'joost@decock.org',
ehash: 'zlasdadfsdlfsjjuehash',
},
]

286
config/templates/newsletter.html Normal file
View file

@ -0,0 +1,286 @@
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office">
<head>
<!-- Template from https://tedgoas.github.io/Cerberus/ -->
<meta charset="utf-8"> <!-- utf-8 works for most cases -->
<meta name="viewport" content="width=device-width"> <!-- Forcing initial-scale shouldn't be necessary -->
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <!-- Use the latest (edge) version of IE rendering engine -->
<meta name="x-apple-disable-message-reformatting"> <!-- Disable auto-scale in iOS 10 Mail entirely -->
<meta name="format-detection" content="telephone=no,address=no,email=no,date=no,url=no"> <!-- Tell iOS not to automatically link certain text strings. -->
<meta name="color-scheme" content="light">
<meta name="supported-color-schemes" content="light">
<title>FreeSewing Newsletter</title> <!-- The title tag shows in email notifications, like Android 4.4. -->
<!-- What it does: Makes background images in 72ppi Outlook render at correct size. -->
<!--[if gte mso 9]>
<xml>
<o:OfficeDocumentSettings>
<o:AllowPNG/>
<o:PixelsPerInch>96</o:PixelsPerInch>
</o:OfficeDocumentSettings>
</xml>
<![endif]-->
<!-- Web Font / @font-face : BEGIN -->
<!-- NOTE: If web fonts are not required, lines 23 - 41 can be safely removed. -->
<!-- Desktop Outlook chokes on web font references and defaults to Times New Roman, so we force a safe fallback font. -->
<!--[if mso]>
<style>
* {
font-family: sans-serif !important;
}
</style>
<![endif]-->
<!-- All other clients get the webfont reference; some will render the font and others will silently fail to the fallbacks. More on that here: http://stylecampaign.com/blog/2015/02/webfont-support-in-email/ -->
<!--[if !mso]><!-->
<!-- insert web font reference, eg: <link href='https://fonts.googleapis.com/css?family=Roboto:400,700' rel='stylesheet' type='text/css'> -->
<!--<![endif]-->
<!-- Web Font / @font-face : END -->
<!-- CSS Reset : BEGIN -->
<style>
/* What it does: Tells the email client that only light styles are provided but the client can transform them to dark. A duplicate of meta color-scheme meta tag above. */
:root {
color-scheme: light;
supported-color-schemes: light;
}
/* What it does: Remove spaces around the email design added by some email clients. */
/* Beware: It can remove the padding / margin and add a background color to the compose a reply window. */
html,
body {
margin: 0 auto !important;
padding: 0 !important;
height: 100% !important;
width: 100% !important;
}
/* What it does: Stops email clients resizing small text. */
* {
-ms-text-size-adjust: 100%;
-webkit-text-size-adjust: 100%;
}
/* What it does: Centers email on Android 4.4 */
div[style*="margin: 16px 0"] {
margin: 0 !important;
}
/* What it does: forces Samsung Android mail clients to use the entire viewport */
#MessageViewBody, #MessageWebViewDiv{
width: 100% !important;
}
/* What it does: Stops Outlook from adding extra spacing to tables. */
table,
td {
mso-table-lspace: 0pt !important;
mso-table-rspace: 0pt !important;
}
/* What it does: Fixes webkit padding issue. */
table {
border-spacing: 0 !important;
border-collapse: collapse !important;
table-layout: fixed !important;
margin: 0 auto !important;
}
/* What it does: Uses a better rendering method when resizing images in IE. */
img {
-ms-interpolation-mode:bicubic;
}
/* What it does: Prevents Windows 10 Mail from underlining links despite inline CSS. Styles for underlined links should be inline. */
a {
text-decoration: none;
}
/* What it does: A work-around for email clients meddling in triggered links. */
a[x-apple-data-detectors], /* iOS */
.unstyle-auto-detected-links a,
.aBn {
border-bottom: 0 !important;
cursor: default !important;
color: inherit !important;
text-decoration: none !important;
font-size: inherit !important;
font-family: inherit !important;
font-weight: inherit !important;
line-height: inherit !important;
}
/* What it does: Prevents Gmail from displaying a download button on large, non-linked images. */
.a6S {
display: none !important;
opacity: 0.01 !important;
}
/* What it does: Prevents Gmail from changing the text color in conversation threads. */
.im {
color: inherit !important;
}
/* If the above doesn't work, add a .g-img class to any image in question. */
img.g-img + div {
display: none !important;
}
h1 { line-height: 36px; }
h2 { line-height: 28px; }
/* What it does: Removes right gutter in Gmail iOS app: https://github.com/TedGoas/Cerberus/issues/89 */
/* Create one of these media queries for each additional viewport size you'd like to fix */
/* iPhone 4, 4S, 5, 5S, 5C, and 5SE */
@media only screen and (min-device-width: 320px) and (max-device-width: 374px) {
u ~ div .email-container {
min-width: 320px !important;
}
}
/* iPhone 6, 6S, 7, 8, and X */
@media only screen and (min-device-width: 375px) and (max-device-width: 413px) {
u ~ div .email-container {
min-width: 375px !important;
}
}
/* iPhone 6+, 7+, and 8+ */
@media only screen and (min-device-width: 414px) {
u ~ div .email-container {
min-width: 414px !important;
}
}
</style>
<!-- CSS Reset : END -->
<!-- Progressive Enhancements : BEGIN -->
<style>
/* What it does: Hover styles for buttons */
.button-td,
.button-a {
transition: all 100ms ease-in;
}
.button-td-primary:hover,
.button-a-primary:hover {
background: #212529 !important;
border-color: #212529 !important;
}
/* Media Queries */
@media screen and (max-width: 600px) {
/* What it does: Adjust typography on small screens to improve readability */
.email-container p {
font-size: 17px !important;
}
}
</style>
<!-- Progressive Enhancements : END -->
</head>
<!--
The email background color (#ffffff) is defined in three places:
1. body tag: for most email clients
2. center tag: for Gmail and Inbox mobile apps and web versions of Gmail, GSuite, Inbox, Yahoo, AOL, Libero, Comcast, freenet, Mail.ru, Orange.fr
3. mso conditional: For Windows 10 Mail
-->
<body width="100%" style="margin: 0; padding: 0 !important; mso-line-height-rule: exactly; background-color: #ffffff;">
<center role="article" aria-roledescription="email" lang="en" style="width: 100%; background-color: #ffffff;">
<!--[if mso | IE]>
<table role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%" style="background-color: #ffffff;">
<tr>
<td>
<![endif]-->
<!-- Visually Hidden Preheader Text : BEGIN -->
<div style="max-height:0; overflow:hidden; mso-hide:all;" aria-hidden="true">
This season's edition of the FreeSewing Newsletter, a long-read with news and updates from the FreeSewing community
</div>
<!-- Visually Hidden Preheader Text : END -->
<!-- Create white space after the desired preview text so email clients don’t pull other distracting text into the inbox preview. Extend as necessary. -->
<!-- Preview Text Spacing Hack : BEGIN -->
<div style="display: none; font-size: 1px; line-height: 1px; max-height: 0px; max-width: 0px; opacity: 0; overflow: hidden; mso-hide: all; font-family: sans-serif;">
&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;&zwnj;&nbsp;
</div>
<!-- Preview Text Spacing Hack : END -->
<!--
Set the email width. Defined in two places:
1. max-width for all clients except Desktop Windows Outlook, allowing the email to squish on narrow but never go wider than 600px.
2. MSO tags for Desktop Windows Outlook enforce a 600px width.
-->
<div style="max-width: 600px; margin: 0 auto;" class="email-container">
<!--[if mso]>
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="600">
<tr>
<td>
<![endif]-->
<!-- Email Body : BEGIN -->
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: auto;">
<!-- 1 Column Text + Button : BEGIN -->
<tr>
<td style="background-color: #ffffff;">
<table role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%">
<tr>
<td style="padding: 20px; font-family: sans-serif; font-size: 16px; line-height: 22px; color: #212529;">
{{{ content }}}
</td>
</tr>
</table>
</td>
</tr>
<!-- 1 Column Text + Button : END -->
<!-- Clear Spacer : BEGIN -->
<tr>
<td aria-hidden="true" height="40" style="font-size: 0px; line-height: 0px;">
&nbsp;
</td>
</tr>
<!-- Clear Spacer : END -->
</table>
<!-- Email Body : END -->
<!-- Email Footer : BEGIN -->
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: auto;">
<tr>
<td style="padding: 20px; font-family: sans-serif; font-size: 12px; line-height: 15px; text-align: center; color: #495057;">
FreeSewing<br><span class="unstyle-auto-detected-links">67 Plantin en Moretuslei<br>Antwerp / Belgium<br>info@freesewing.org</span>
<br><br>
<unsubscribe style="color: #ffffff; text-decoration: underline;">
You can <a href="{{{ unsubscribe }}}">unsubscribe</a> at any time. Or just reply and tell us you want out.
</unsubscribe>
</td>
</tr>
</table>
<!-- Email Footer : END -->
<!--[if mso]>
</td>
</tr>
</table>
<![endif]-->
</div>
<!--[if mso | IE]>
</td>
</tr>
</table>
<![endif]-->
</center>
</body>
</html>

1
package.json
View file

@ -142,6 +142,7 @@
"handlebars": "^4.7.7",
"jsonfile": "^6.1.0",
"postcss": "^8.4.5",
"rehype-format": "^4.0.1",
"remark-cli": "^10.0.1",
"remark-frontmatter": "^4.0.1",
"remark-lint-emphasis-marker": "^3.1.1",

102
scripts/newsletter-lib.mjs Normal file
View file

@ -0,0 +1,102 @@
import fs from 'fs'
import path from 'path'
import axios from 'axios'
import { unified } from 'unified'
import markdown from 'remark-parse'
import remark2rehype from 'remark-rehype'
import format from 'rehype-format'
import html from 'rehype-stringify'
import mustache from 'mustache'
import nodemailer from 'nodemailer'
import { testers } from '../config/newsletter-testers.mjs'
import { fileURLToPath } from 'url';
// Current working directory
const cwd = path.dirname(fileURLToPath(import.meta.url))
const backend = "https://backend.freesewing.org/"
const asHtml = async (text) => {
let content = await unified().use(markdown).use(remark2rehype).use(format).use(html).process(text)
return content.contents
}
const getToken = async () => {
let res = await axios.post(`${backend}login`, {
username: process.env.FS_USER,
password: process.env.FS_PASSWORD,
})
if (res.data) return res.data.token
else if (res.err) return console.log(err)
}
const getSubscribers = async (test = true) => {
if (test) return testers
let token = await getToken()
let res = await axios.get(`${backend}admin/subscribers`, {
headers: { Authorization: 'Bearer ' + token },
})
if (res.data) return res.data
else return false
}
const send = async (test = true) => {
const template = fs.readFileSync(`${cwd}/../config/templates/newsletter.html`, 'utf8')
let edition
try {
edition = await axios.get(`https://posts.freesewing.org/newsletters?slug_eq=${process.env.NL_EDITION}`, 'utf8')
} catch (err) {
console.log(err)
process.exit()
}
const text = edition.body
const subscribers = await getSubscribers(test)
const content = await asHtml(text)
const inject = { content }
const smtp = nodemailer.createTransport({
host: process.env.SMTP_HOST,
auth: {
user: process.env.SMTP_USER,
pass: process.env.SMTP_PASS,
},
})
let i = 1
let subs = subscribers.length
for (let sub of subscribers) {
// If your SMTP relay start rate-limiting midway through
// you can use this if loop to start just after the last
// successful delivery
if (i > 0) {
let unsub = `${backend}unsubscribe/${sub.ehash}`
inject.unsubscribe = unsub
let body = mustache.render(template, inject)
console.log(`${i}/${subs} Sending to ${sub.email}`)
await smtp.sendMail({
from: '"FreeSewing" <info@freesewing.org>',
to: sub.email,
subject: 'FreeSewing newsletter: Spring 2021',
headers: {
Language: 'en',
'List-Owner': 'joost@joost.at',
'List-Subscribe': 'https://freesewing.org/community/newsletter/',
'List-Unsubscribe': unsub,
},
text,
html: body,
})
}
i++
}
}
const sendTest = () => send(true)
const sendReal = () => send(false)
export {
sendTest,
sendReal,
}

4
scripts/send-real-newsletter.mjs Normal file
View file

@ -0,0 +1,4 @@
import 'dotenv/config'
import { sendReal } from './newsletter-lib.mjs'
sendReal()

4
scripts/send-test-newsletter.mjs Normal file
View file

@ -0,0 +1,4 @@
import 'dotenv/config'
import { sendTest } from './newsletter-lib.mjs'
sendTest()

58
yarn.lock
View file

@ -13902,6 +13902,13 @@ hast-util-embedded@^1.0.0:
dependencies:
hast-util-is-element "^1.1.0"
hast-util-embedded@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/hast-util-embedded/-/hast-util-embedded-2.0.0.tgz#877f4261044854743fc2621f728930ca61c8376f"
integrity sha512-vEr54rDu2CheBM4nLkWbW8Rycf8HhkA/KsrDnlyKnvBTyhyO+vAG6twHnfUbiRGo56YeUBNCI4HFfHg3Wu+tig==
dependencies:
hast-util-is-element "^2.0.0"
hast-util-has-property@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/hast-util-has-property/-/hast-util-has-property-2.0.0.tgz#c15cd6180f3e535540739fcc9787bcffb5708cae"
@ -13914,6 +13921,15 @@ hast-util-heading-rank@^2.0.0:
dependencies:
"@types/hast" "^2.0.0"
hast-util-is-body-ok-link@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/hast-util-is-body-ok-link/-/hast-util-is-body-ok-link-2.0.0.tgz#e0df6947b2676d2acac55c611755d359f264958e"
integrity sha512-S58hCexyKdD31vMsErvgLfflW6vYWo/ixRLPJTtkOvLld24vyI8vmYmkgLA5LG3la2ME7nm7dLGdm48gfLRBfw==
dependencies:
"@types/hast" "^2.0.0"
hast-util-has-property "^2.0.0"
hast-util-is-element "^2.0.0"
hast-util-is-element@^1.0.0, hast-util-is-element@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/hast-util-is-element/-/hast-util-is-element-1.1.0.tgz#3b3ed5159a2707c6137b48637fbfe068e175a425"
@ -13927,6 +13943,16 @@ hast-util-is-element@^2.0.0:
"@types/hast" "^2.0.0"
"@types/unist" "^2.0.0"
hast-util-phrasing@^2.0.0:
version "2.0.1"
resolved "https://registry.yarnpkg.com/hast-util-phrasing/-/hast-util-phrasing-2.0.1.tgz#48a63391688d242500f1b435665f29b9d81cc6b2"
integrity sha512-Lw+gVihgE0Ye1TsToZqui0puQnHbZ0dFQe0c/Z2QJWGYRIc72DpH3UHLV8zU48sjIPord88MTSeYEbLQMp5A9g==
dependencies:
hast-util-embedded "^2.0.0"
hast-util-has-property "^2.0.0"
hast-util-is-body-ok-link "^2.0.0"
hast-util-is-element "^2.0.0"
hast-util-sanitize@^3.0.0:
version "3.0.2"
resolved "https://registry.yarnpkg.com/hast-util-sanitize/-/hast-util-sanitize-3.0.2.tgz#b0b783220af528ba8fe6999f092d138908678520"
@ -14251,6 +14277,11 @@ html-webpack-plugin@^5.5.0:
pretty-error "^4.0.0"
tapable "^2.0.0"
html-whitespace-sensitive-tag-names@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/html-whitespace-sensitive-tag-names/-/html-whitespace-sensitive-tag-names-2.0.0.tgz#80c7512c969de90c94279641068fafb5fa6da468"
integrity sha512-SQdIvTTtnHAx72xGUIUudvVOCjeWvV1U7rvSFnNGxTGRw3ZC7RES4Gw6dm1nMYD60TXvm6zjk/bWqgNc5pjQaw==
htmlparser2@^6.0.0, htmlparser2@^6.1.0:
version "6.1.0"
resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7"
@ -23919,6 +23950,21 @@ rehype-autolink-headings@^6.1.1:
unified "^10.0.0"
unist-util-visit "^4.0.0"
rehype-format@^4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/rehype-format/-/rehype-format-4.0.1.tgz#0d4ad47733699dd8e3fcd9f73d04f210246b39e1"
integrity sha512-HA92WeqFri00yiClrz54IIpM9no2DH9Mgy5aFmInNODoAYn+hN42a6oqJTIie2nj0HwFyV7JvOYx5YHBphN8mw==
dependencies:
"@types/hast" "^2.0.0"
hast-util-embedded "^2.0.0"
hast-util-is-element "^2.0.0"
hast-util-phrasing "^2.0.0"
hast-util-whitespace "^2.0.0"
html-whitespace-sensitive-tag-names "^2.0.0"
rehype-minify-whitespace "^5.0.0"
unified "^10.0.0"
unist-util-visit-parents "^5.0.0"
rehype-highlight@^5.0.1:
version "5.0.2"
resolved "https://registry.yarnpkg.com/rehype-highlight/-/rehype-highlight-5.0.2.tgz#de952123cd4d9672f21a4a38d3b119b88a08eafa"
@ -23940,6 +23986,18 @@ rehype-minify-whitespace@^4.0.0:
hast-util-whitespace "^1.0.4"
unist-util-is "^4.0.0"
rehype-minify-whitespace@^5.0.0:
version "5.0.1"
resolved "https://registry.yarnpkg.com/rehype-minify-whitespace/-/rehype-minify-whitespace-5.0.1.tgz#79729a0146aa97a9d43e1eb4b5884974e2f37e77"
integrity sha512-PPp4lWJiBPlePI/dv1BeYktbwkfgXkrK59MUa+tYbMPgleod+4DvFK2PLU0O0O60/xuhHfiR9GUIUlXTU8sRIQ==
dependencies:
"@types/hast" "^2.0.0"
hast-util-embedded "^2.0.0"
hast-util-is-element "^2.0.0"
hast-util-whitespace "^2.0.0"
unified "^10.0.0"
unist-util-is "^5.0.0"
rehype-sanitize@^5.0.1:
version "5.0.1"
resolved "https://registry.yarnpkg.com/rehype-sanitize/-/rehype-sanitize-5.0.1.tgz#dac01a7417bdd329260c74c74449697b4be5eb56"