Moved email subject translation to back-end (#192)

Author: DanielBrierton

.gitignore

@@ -29,3 +29,9 @@ node_modules
 
 .idea
 *~
+
+# i18n dictionaries from crowdin, except en_US
+web/locale/*
+!web/locale/en_US
+email-templates/*
+!email-templates/*-en_US

crowdin.yaml

@@ -50,3 +50,8 @@ files:
     dest: '/invite-parent-guardian.text.txt'
     translation: '/email-templates/invite-parent-guardian-%locale_with_underscore%/%file_name%.ejs'
     type: 'txt'
+
+  -
+    source: '/web/locale/en_US/messages.po'
+    dest: '/messages.po'
+    translation: '/web/locale/%locale_with_underscore%/%original_file_name%'

email-notifications.js

@@ -1,26 +1,44 @@
 'use strict';
 
+var fs = require('fs');
+var path = require('path');
+var I18NHelper = require('cp-i18n-lib');
+var i18nHelper = new I18NHelper({
+  poFilePath: path.resolve('web/locale/'),
+  poFileName: 'messages.po',
+  domain: 'coder-dojo-platform'
+});
+
 module.exports = function (options) {
   var seneca = this;
   var plugin = 'email-notifications';
-  var fs = require('fs');
-  var path = require('path');
+
   var so = seneca.options();
 
   options = seneca.util.deepextend({}, so[plugin], options);
 
   seneca.add({role: plugin, cmd: 'send'}, send_notification);
 
   function send_notification (args, done) {
+    var subject = args.subject;
+    var subjectVariables = args.subjectVariables || [];
+    var subjectTranslation;
     if (options.sendemail && options.email) {
       var emailCode = args.code + args.locality;
       if (!fs.existsSync(path.join(__dirname, '/email-templates/', emailCode))) emailCode = args.code + 'en_US';
+      if (!args.to) return done(null, {ok: false, why: 'No recipient set.'});
+
+      subjectTranslation = i18nHelper.getClosestTranslation(args.locality, subject);
+      if (subjectTranslation === null) {
+        return done(null, {ok: false, why: 'Invalid email subject.'});
+      }
+
       seneca.act({
         role: 'mail', cmd: 'send',
         from: options.sendFrom,
         code: emailCode,
         to: args.to,
-        subject: args.subject,
+        subject: subjectTranslation.fetch(subjectVariables),
         content: args.content
       }, done);
     } else {

package.json

@@ -18,8 +18,10 @@
   "license": "ISC",
   "dependencies": {
     "async": "0.9.0",
+    "cp-i18n-lib": "git+https://github.com/CoderDojo/cp-i18n-lib.git",
     "cuid": "1.2.5",
     "ejs": "1.0.0",
+    "jed": "1.1.0",
     "js-yaml": "3.2.7",
     "le_node": "1.1.0",
     "lodash": "3.7.0",
@@ -29,6 +31,7 @@
     "optimist": "0.6.1",
     "pg": "4.4.0",
     "pg-large-object": "0.0.1",
+    "po2json": "0.4.2",
     "postgrator": "2.2.0",
     "request": "2.58.0",
     "seneca": "0.7.2",

profiles.js

@@ -638,7 +638,7 @@ module.exports = function (options) {
     var invitedParentEmail = data.invitedParentEmail;
     var childId = data.childId;
     var emailSubject = data.emailSubject;
-    var zenHostname = args.zenHostname;
+    var zenHostname = process.env.HOSTNAME || '127.0.0.1:8000';
 
     var childQuery = {
       userId: childId
@@ -795,7 +795,7 @@ module.exports = function (options) {
   }
 
   function cmd_change_avatar (args, done) {
-    var hostname = args.zenHostname;
+    var hostname = process.env.HOSTNAME || '127.0.0.1:8000';
     var file = args.file;
 
     if (!_.contains(args.fileType, 'image')) return done(null, {ok: false, why: 'Avatar upload: file must be an image.'});
@@ -1100,7 +1100,7 @@ module.exports = function (options) {
     }
 
     function emailNinja (parentProfile, done) {
-      var zenHostname = args.zenHostname;
+      var zenHostname = process.env.HOSTNAME || '127.0.0.1:8000';
       var content = {
         ninjaName: ninjaProfile.name,
         parentName: parentProfile.name,

users.js

@@ -80,7 +80,7 @@ module.exports = function (options) {
     var locality = args.locality || 'en_US';
     var emailCode = 'auth-register-';
     var emailSubject = args.emailSubject;
-    var zenHostname = args.zenHostname;
+    var zenHostname = process.env.HOSTNAME || '127.0.0.1:8000';
     delete args.isChampion;
 
     if (args.initUserType.name === 'attendee-u13') {
@@ -328,7 +328,7 @@ module.exports = function (options) {
     var locality = args.locality || 'en_US';
     var emailCode = 'auth-create-reset-';
     var emailSubject = args.emailSubject;
-    var zenHostname = args.zenHostname || '127.0.0.1:8000';
+    var zenHostname = process.env.HOSTNAME || '127.0.0.1:8000';
 
     args = {};
     if (void 0 !== nick) args.nick = nick;