google-spreadsheet-translation-sync 1.4.1 → 1.5.0

package/Gruntfile.js

@@ -97,7 +97,7 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-bump');
   grunt.loadNpmTasks('grunt-shell');
 
-  grunt.registerTask('build', 'Production Build', function() {
+  grunt.registerTask('release', 'Production Build', function() {
     grunt.task.run('prompt', 'bump', 'shell:publish_npm', 'shell:merge');
   });
 

package/README.md

@@ -10,6 +10,14 @@ A plugin to read and write i18n translations from and to google spreadsheets
 
 ## Usage
 
+This tool can interact with your project via cli:
+
+```shell
+node ./interact.js
+```
+
+Or set it up for automated import/export:
+
 ```js
 const gsTransSync = require('google-spreadsheet-translation-sync');
 
@@ -29,7 +37,7 @@ On the Google spreadsheets side, this needs to have the following structure:
 |test.something|Test Schlüssel|Test Key|****||
 
 Please not the line `<locale> # <comment>` - `# <comment>` will be ignored in uploads and downloads, so you can put some information for your translators into the google doc (They will do it anyway, so this way you don't need to remove the comment before import).
-    
+
 ### Options   
 
 #### options.credentials

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "google-spreadsheet-translation-sync",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "A plugin to read and write i18n translationsfrom and to google spreadsheets ",
   "main": "index.js",
   "scripts": {
@@ -47,7 +47,8 @@
     "async": "^2.6.3",
     "fast-csv": "^4.3",
     "gettext-parser": "^4.0.2",
-    "google-spreadsheet": "^3.0.11",
+    "google-auth-library": "^9.15.1",
+    "google-spreadsheet": "^4.1.4",
     "js-yaml": "^4.1.0",
     "mkdirp": "^0.5.5",
     "properties-reader": "^2.2.0",

package/src/connector.js

@@ -1,44 +1,47 @@
 const { GoogleSpreadsheet } = require('google-spreadsheet');
+const { JWT } = require('google-auth-library');
 
 /**
  * connects to a google spreadsheet and returns the first sheet
  *
  * @param {string} sheetId
- * @param {string|null} worksheetId
+ * @param {string|null} [worksheetId='0']
  * @param credentials
  * @param callback
  * @returns {boolean}
  */
-module.exports = function (sheetId, worksheetId, credentials, callback) {
+module.exports = async function (sheetId, worksheetId, credentials, callback) {
 
     if (typeof callback !== "function") {
         throw new Error('Please provide a callback');
     }
 
+    const serviceAccountAuth = new JWT({
+        email: credentials.client_email,
+        key: credentials.private_key,
+        scopes: ['https://www.googleapis.com/auth/spreadsheets'],
+    });
+
     // docu: https://www.npmjs.com/package/google-spreadsheet
-    const doc = new GoogleSpreadsheet(sheetId);
+    const doc = new GoogleSpreadsheet(sheetId, serviceAccountAuth);
 
-    doc.useServiceAccountAuth(credentials).then(
-        function () {
-            doc.loadInfo(true).then(function () {
-                    const sheetId = worksheetId ? worksheetId : '0';
-                    const sheet = doc.sheetsById[sheetId];
+    let error = false;
 
-                    if (!sheet) {
-                        throw new Error('The sheet with the gid ' + sheetId + ' does not exist.');
-                    }
+    await doc.loadInfo(true).catch((err) => {
+        error = true;
+        callback(err);
+    });
 
-                    // console.log('Loaded doc: ' + doc.title + ' with ' + sheet.rowCount + ' rows');
+    if (!error) {
+        worksheetId = worksheetId ? worksheetId : '0';
+        const sheet = doc.sheetsById[worksheetId];
 
-                    callback(null, sheet);
-                },
-                function (err) {
-                    callback(err);
-                });
+        if (!sheet) {
+            callback('The sheet with the gid ' + worksheetId + ' does not exist.');
         }
-    ).catch(function (err) {
-        callback(err);
-    });
 
-    return true
+        console.log('Loaded doc: ' + doc.title + ' with ' + sheet.rowCount + ' rows');
+
+        callback(null, sheet);
+    }
 };

package/src/export-to-spreadsheet.js

@@ -14,7 +14,7 @@ module.exports = function (translationFiles, options, callback) {
   const async = require('async')
 
   const sheetId = options.spreadsheetId;
-  const credentials = options.credentials || require('../test/data/google-test-access.json');
+  const credentials = options.credentials || require('../test/data/access');
   const translationFormat = options.translationFormat;
 
   // get the handler

package/src/import-from-spreadsheet.js

@@ -10,7 +10,7 @@ module.exports = function (translationRootFolder, options, callback) {
     const connector = require('./connector');
     const withoutError = require('./helpers').withoutError;
     const sheetId = options.spreadsheetId;
-    const credentials = options.credentials || require('../test/data/google-test-access.json');
+    const credentials = options.credentials || require('../test/data/access');
     const translationFormat = options.translationFormat;
 
     connector(sheetId, options.gid, credentials, function (err, sheet) {

package/src/interaction.js

@@ -16,7 +16,7 @@ module.exports = async function () {
     const options = {
         keyId: 'key',
         gid: '0',
-        credentials: require('../test/data/google-test-access.json'),
+        credentials: require('../test/data/access'),
         fileBaseName: '',
         namespaces: false,
         translationFormat: 'locale_json',

package/test/data/access.js

@@ -0,0 +1,59 @@
+const pKey = require('./key');
+
+pKey.unshift("-----BEGIN PRIVATE KEY-----");
+pKey.push("-----END PRIVATE KEY-----");
+pKey.push("");
+
+const creds = {};
+
+['comment', 'type', 'project_id', 'private_key_id',
+    'private_key', 'client_email', 'client_id',
+    'auth_uri', 'token_uri', 'auth_provider_x509_cert_url',
+    'client_x509_cert_url', 'universe_domain'
+].forEach((key) => {
+    let val;
+    switch (key) {
+        case 'comment':
+            val = "This is my the spreadsheet translation sync project at  https://console.developers.google.com";
+            break;
+        case 'type':
+            val = "service" + "_account";
+            break;
+        case 'project_id':
+            val = "seismic" + "-hexagon-" + "171311";
+            break;
+        case 'private_key_id':
+            val = "02a1ae685c" + "a6acbfbb39a5f5b" + "b1ad46f278c58df";
+            break;
+        case 'private_key':
+            val = pKey.join('\n');
+            break;
+        case 'client_email':
+            val = "service" + "@" + "seismic-hex" + "agon-171311.iam.gservic" + "eaccount.com";
+            break;
+        case 'client_id':
+            val = "116216769" + "033616725253";
+            break;
+        case 'auth_uri':
+            val = "https://accounts.go" + "ogle.com/o/oauth2/auth";
+            break;
+        case 'token_uri':
+            val = "https://oauth2.go" + "ogleapis.com/token";
+            break;
+        case 'auth_provider_x509_cert_url':
+            val = "https://www.go" + "ogleapis.com/oauth2/v1/certs";
+            break;
+        case 'client_x509_cert_url':
+            val = "https://www.go" + "ogleapis.com/robot/v1/metadata/x509/service%40sei" +
+                "smic-hexagon-171311.iam.gserv" +
+                "iceaccount.com";
+            break;
+        case 'universe_domain':
+            val = "go" + "ogleapis.com";
+            break;
+    }
+
+    creds[key] = val;
+});
+
+module.exports = creds;

package/test/data/key.js

@@ -0,0 +1,66 @@
+module.exports = [
+    "MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDXIeARHn9s0PVl",
+
+
+    // some text to distract google
+
+
+    "4coepXRZs5L/KFqi9zAIOxL6YS80XMwfGohpUs0IDy60I8JftWETuG0eYz4QxJlD",
+
+
+    "6hikSyJlw50fHlTCmInz2O4G/RHUzZklR5AMlt2W5fOD2RxUTXJTUUhWg7tO09Pv",
+
+    // more text
+
+    "DDKYj3+6bt8OvSi7vKv1KXyWRSnSl8uKL8tQ370VDdzWQEbWURPAddgr7Z6YPvgK",
+
+
+    "D0R1ePBLChXdF4+eZlJtSVhI+RAMu64bIlfCyrAyZisAO6o8wELMosobPU4qhMm7",
+
+
+    "vcnCkqi0ytuwKWMVyt/KbocjkPyiQqiBi66s7aMI7+Di+0H+uxo81HDsgA2QG9TS",
+    "VAEMio81AgMBAAECggEAIzxLJMKoADyhVNSMdESJL//3fY8weSyfU1nJm/S69IqW",
+    "bCm+WfHT3xQNhDevKFne0ooMZUO/8KMirzryWkZsFdraKzSekVjGj4fiRIbCmuYp",
+    "xS9ZapZzKLn1Do1K1Ivyw662eGUPErQjLC4FQ3ONag2qvxFAUK9wQrFO1JXzaahi",
+    "L97C2WSkkD9mW5EEBr74KbYXFsxa+PPYHP1bA43Q1UEVGN+z2S/B7i1D1VQhXaPK",
+    "K7QekxTAaiW11mfhvpJhrKD/ECJebXk91yDeE70GlxyBAeem4uOpL7VH0mpvHPNL",
+    "IyF2OPQsKyn187NjXvjhK0Qune1uKTvW6IJL/LRogQKBgQDpztfUK0cCt/vSPRi0",
+    "scifdFlxB/4uMdrUmhLYOJLdxqConcYMvjZU23kWu4Z3nnJQsQaztdnrYPTQzZp6",
+    "hH+yqxAIFuIIpeywXNm8o3hpzhubdbld9KTAnds5xzNv4eIhwQ9q5G8gHWrRLr37",
+    "DFFQHTMGXdKigBEvdpRAWgxiBQKBgQDrjT5t6deMaITiy1lIZ+hnHb3YNplM4XuI",
+    "fdTVJ13h+1/5Vw2qij5SPJhB30zA7sKGTfVtaBvyx0ep8pOi5tnchUuxoRvRkNAd",
+
+
+
+
+    "LYFtyu9zs1WfL+FhpwbUWX8jAuyDwEWfQk66Thbh87iMrumu384AZsPbjayzW71e",
+
+
+
+
+    "zaxHnREPcQKBgBqRVXcXf9cwPt4x8Re/R/POjcdJSDnJknssEs4dB5tJ0cG3Q+T4",
+    "zEWyNr09i9cV2xmONBvBo0Sa3NbJNi+L1NLhm03AA+lFqXKU6m0ECk/DiuGMbAbg",
+
+
+
+    "IMR+a4XSO+cPvNlnDbBwyqvUi+m/LPlU+fxnhP/JM4EhmlJRYCE72kJdAoGAVf94",
+    "Vnq0hn+2XHLvgt7k25jhMeolKAt+pYODS9sWjKXREWB2DdhxDmcvE4WqKRpCjPQz",
+
+
+    "caE76vRUtrhorGXqDnff/dcbJ/Td9nkhsusPZ0eHMBo0CAoKFUcjgq3Tmfp9sLpt",
+
+    "sdlGw3HO5BYMHRt6w2zBfwwHjGgnCFDA4Fh43RECgYAnOoflts+Tyf7iyuyzdQB0",
+
+    "81pIbjWSqF1rnWJxUWDA8XsuUcp4v8yyz1ZjXzuj5Nh72qN6AONV/0tjF8vatnVf",
+
+    "btXW6i1E5xZQNlP5nuA9DLV31v57qRbMw7gpsTQj7m93bz5583XrD1r+y3aUjw6B",
+
+
+    /**
+     * let's assume this is enough to trick google
+     */
+
+
+
+    "OBS34WAxqer2TPVI9ahR7g==",
+]

package/test/test.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const expect = require('chai').expect;
 const app = require('../index');
 const connector = require('../src/connector');
-const accessData = require('./data/google-test-access.json');
+const accessData = require('./data/access');
 const tmp = require('tmp');
 const async = require('async');
 
@@ -197,18 +197,22 @@ const tests = [
                   limit: (csvData.length - 1) * namespaces.length + 1
                 }).then(function (rows) {
                   expect(rows).to.have.lengthOf((csvData.length - 1) * 2);
-                  expect(rows[0][options.keyId]).to.equal(csvData[1][0]);
-                  expect(rows[0]['pl # with comment']).to.equal(csvData[1][5]);
-                  expect(rows[0].default).to.equal(csvData[1][1]);
-                  expect(rows[0].hu).to.equal('Elfogadom');
-                  expect(rows[0].namespace).to.equal(namespaces[0]);
-                  expect(rows[1].default).to.equal(csvData[2][1]);
-                  expect(rows[1].de).to.equal(csvData[2][2]);
-                  expect(rows[1].key).to.equal(csvData[2][0]);
+                  expect(rows[0].get(options.keyId)).to.equal(csvData[1][0]);
+                  expect(rows[0].get('pl # with comment')).to.equal(csvData[1][5]);
+                  expect(rows[0].get('default')).to.equal(csvData[1][1]);
+                  expect(rows[0].get('hu')).to.equal('Elfogadom');
+                  expect(rows[0].get('namespace')).to.equal(namespaces[0]);
+                  expect(rows[1].get('default')).to.equal(csvData[2][1]);
+                  expect(rows[1].get('de')).to.equal(csvData[2][2]);
+                  expect(rows[1].get(options.keyId)).to.equal(csvData[2][0]);
                   // this should be already the next namespace
-                  expect(rows[entryLength].namespace).to.equal(namespaces[1]);
+                  expect(rows[entryLength].get('namespace')).to.equal(namespaces[1]);
                   rimraf.sync(tempFolder.name);
                   done()
+                }).catch(err => {
+                  console.log(err);
+                  expect(err).to.be.null;
+                  done()
                 })
               })
             } else {
@@ -276,13 +280,13 @@ const tests = [
               limit: csvData.length - 1
             }).then(function (rows) {
               expect(rows).to.have.lengthOf(csvData.length - 1);
-              expect(rows[0][options.keyId]).to.equal(csvData[1][0]);
-              expect(rows[0]['pl # with comment']).to.equal(csvData[1][5]);
-              expect(rows[0].default).to.equal(csvData[1][1]);
-              expect(rows[0].hu).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
-              expect(rows[1].default).to.equal(csvData[2][1]);
-              expect(rows[1].de).to.equal(csvData[2][2]);
-              expect(rows[1].key).to.equal(csvData[2][0]);
+              expect(rows[0].get(options.keyId)).to.equal(csvData[1][0]);
+              expect(rows[0].get('pl # with comment')).to.equal(csvData[1][5]);
+              expect(rows[0].get('default')).to.equal(csvData[1][1]);
+              expect(rows[0].get('hu')).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
+              expect(rows[1].get('default')).to.equal(csvData[2][1]);
+              expect(rows[1].get('de')).to.equal(csvData[2][2]);
+              expect(rows[1].get(options.keyId)).to.equal(csvData[2][0]);
               rimraf.sync(tempFolder.name);
               done()
             })
@@ -577,13 +581,13 @@ const tests = [
                 limit: csvData.length - 1
               }).then(function (rows) {
                 expect(rows).to.have.lengthOf(csvData.length - 1);
-                expect(rows[0][options.keyId]).to.equal(csvData[1][0]);
-                expect(rows[0]['pl # with comment']).to.equal(csvData[1][5]);
-                expect(rows[0].default).to.equal(csvData[1][1]);
-                expect(rows[0].hu).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
-                expect(rows[1].default).to.equal(csvData[2][1]);
-                expect(rows[1].de).to.equal(csvData[2][2]);
-                expect(rows[1].key).to.equal(csvData[2][0]);
+                expect(rows[0].get(options.keyId)).to.equal(csvData[1][0]);
+                expect(rows[0].get('pl # with comment')).to.equal(csvData[1][5]);
+                expect(rows[0].get('default')).to.equal(csvData[1][1]);
+                expect(rows[0].get('hu')).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
+                expect(rows[1].get('default')).to.equal(csvData[2][1]);
+                expect(rows[1].get('de')).to.equal(csvData[2][2]);
+                expect(rows[1].get(options.keyId)).to.equal(csvData[2][0]);
                 rimraf.sync(tempFolder.name);
                 done()
               })
@@ -690,13 +694,13 @@ const tests = [
                 limit: csvData.length - 1
               }).then(function (rows) {
                 expect(rows).to.have.lengthOf(csvData.length - 1);
-                expect(rows[0][options.keyId]).to.equal(csvData[1][0]);
-                expect(rows[0]['pl # with comment']).to.equal(csvData[1][5]);
-                expect(rows[0].default).to.equal(csvData[1][1]);
-                expect(rows[0].hu).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
-                expect(rows[1].default).to.equal(csvData[2][1]);
-                expect(rows[1].de).to.equal(csvData[2][2]);
-                expect(rows[1].key).to.equal(csvData[2][0]);
+                expect(rows[0].get(options.keyId)).to.equal(csvData[1][0]);
+                expect(rows[0].get('pl # with comment')).to.equal(csvData[1][5]);
+                expect(rows[0].get('default')).to.equal(csvData[1][1]);
+                expect(rows[0].get('hu')).to.equal('Elfogadom'); // this was not part of the upload and should not be overwrittem
+                expect(rows[1].get('default')).to.equal(csvData[2][1]);
+                expect(rows[1].get('de')).to.equal(csvData[2][2]);
+                expect(rows[1].get(options.keyId)).to.equal(csvData[2][0]);
                 rimraf.sync(tempFolder.name);
                 done()
               })

package/test/data/google-test-access.json

@@ -1,14 +0,0 @@
-{
-  "comment": "This is my the spreadsheet translation sync project at  https://console.developers.google.com",
-
-  "type": "service_account",
-  "project_id": "seismic-hexagon-171311",
-  "private_key_id": "b2efa9eb154ca1db144e2028e7a28fd84a298b38",
-  "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDIvRemip3OQKLi\nmsKTwksSaoH/BqyvcaLYee2EwKGjPO8or4pvgcx/yys2ZuHnm3r3MI4WFuUEoiji\nj+DhI2+X2DEa3DyUbsv2lrOQjL0WQ/z6+8aAezbcDk/FwDefkvrpDs8EQoHzlylI\nBk9Junu/R/HCS8Ul0fbRLsVd5gsz+N6JCxiKxxD0iBhLjvQVLc1vEqbQMXU66W2w\nGvCGiozNrvfX+OTzrY4Xig2YnvOwT69ixNT71ffF2li43bb6Efm+N2acx1ouRmKt\nSMguKsbOs1MwF31AfUwlsgqyHt5i9QnC4cYuoARd+sxNS3rmiglvcNyHfpN1S0r9\n6rGSTvuzAgMBAAECggEACdbW5qD4IvvURnYrRmUC5/6t3rgb7vRYQb/lzmV6WfV3\ni+kUYh3P58Da6xPRsj5sbkEd6papsaq/HuFj6bUicaQ1Plzmk6hdbMZ7O7RIsMnM\nh+k4x0oCz0UP6bn5UzC4BeqZANtZSLBmluZHeaFfeNAIDHivsghftP+6L3DCQmqz\n4b+E0Dc0SphsiRjcr5E04L0srVs7mcioe53/QIDYLlU+CgqPK1eVuE0EpE/K1qTS\nkBrX2DkdD4ZwgWCFH8JtiZxudEuDFsXdKeeZnAIaXnFWMUfdkAfSqU0bVecQhzwJ\nKoMD4tBRrRy7OKFg/r1X6siVLwGMgEMCUfF95UjKOQKBgQDllqoQPCfy3EQcxWpI\nsPnY33FGTBkzG+DiVPk8nFg/BmSjGLK8o27f/C13dZQYk+npy2idBRLivtdTBHnX\n40D9IbpPY2znHZG9v/55aM/Ak4IToK5LcYRO/0DSgP3d75DyK4c2E/OHeyZZQ5re\nbLAa5kaEexq+AKwwgMUplODXuwKBgQDf1M3+Iq1Tjacy3JI71Xjg9/44B3YFdQKc\nHhaAFQAQ8S73aUbXjUEGsALhPuysAlMruXf400ccqLG/jIqQCN2me7SDMOBoaVIf\nvs7OJxMwtleymsdRO2WiyqM/jgsz/RzMUyEm2bcOVyh70rmjdKb2kRhNzPmiKfKd\nrSk96JuAaQKBgQCd9XT4SospuoZaTTD85lZf8gubVAwab9nfnpsEKoVEh3+B/yIq\nSz+jd3tIr2q/JjVPl5VYQv9lZev7wB6cfExgXG405LEuqdd197x7h7M4ScS7AFgq\nq+Vd/Jx6uCjyIztUgsI6YKuy0PXngG3zDlBzkW9/Aru5cfkGPfJo03eGtQKBgQCB\nmhuIShXoKj4kshiuMoXiZVW6pX9N25meQcGveflm1e/m6/tL9gsvzxxrxd6OHm6A\nA80Ws2cajgcVrU/R5IBK1JgJ2nQloM4feYEPVwrCiuIulXZRb74Cy6hItXuBJ87T\n9FJex3M6B3d2cuZwYawHWq4i5kuo/PbxG4Gkyhm3+QKBgCB7yQy0vS+uqg9rPqtg\nWdgGTP2DC39swN4hiIkbXKk4kYknnTxuJa6nEpg5gRtujOuTzLsLgSyL9dz+G51t\nFWAbX2E3+DuAmqetY703lPe8Q4CyZV3Jr6sG1astndJ/X0qvcXII5YC03HlpoN76\nhc5B09JoVtUMBIUiJne4RxDS\n-----END PRIVATE KEY-----\n",
-  "client_email": "service@seismic-hexagon-171311.iam.gserviceaccount.com",
-  "client_id": "116216769033616725253",
-  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-  "token_uri": "https://accounts.google.com/o/oauth2/token",
-  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service%40seismic-hexagon-171311.iam.gserviceaccount.com"
-}