Proposed v2.0.2 rewrite using google-spreadsheet@3.1.15

.github/workflows/pr-check.yml

@@ -0,0 +1,28 @@
+name: Check PR
+on: 
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: Linting and Testing
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Use Node JS LTS
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+
+    - name: Install npm dependencies
+      run: npm install
+
+    - name: Run build steps
+      run: npm build -s
+
+    - name: Run default tests
+      run: npm test -s
+      env:
+          GOOGLE_SERVICE_ACCOUNT_SECURE_CREDENTIALS: ${{ secrets.GOOGLE_SERVICE_ACCOUNT_SECURE_CREDENTIALS }}

.gitignore

@@ -26,3 +26,5 @@ node_modules
 
 # Users Environment Variables
 .lock-wscript
+
+secure-credentials.json

CHANGELOG.md

@@ -1,3 +1,24 @@
+# 2.0.2
+## Changes
+- Add guard for parsing worksheets that don't contain cells; i.e. charts
+
+# 2.0.1
+## Changes
+- Fix bug with `allWorksheets: true` and added additional test
+
+# 2.0.0
+## New
+- Tests and CI using Github Actions to repo
+
+## Changes
+- Fixed security vulnerabilities reported by `npm audit`
+- Updated google-spreadsheet depenedncy
+- Removed support for public published sheets due to deprecated authentication options 
+- Examples now use async await
+- Changed internal workings to use 0 based indexes for rows and columns
+- Changed internal workings to use cleaner async await code
+- Introduced standard js as the enforced linter as part of the CI actions
+
 # 1.0.0
 ## New
 - Service Account auth support

README.md

@@ -1,10 +1,13 @@
 google-spreadsheet-to-json
 ==========================
 
-[![NPM version](https://badge.fury.io/js/google-spreadsheet-to-json.png)](http://badge.fury.io/js/google-spreadsheet-to-json) [![Build Status (master branch of bassarisse/google-spreadsheet-to-json)](https://travis-ci.org/bassarisse/google-spreadsheet-to-json.svg?branch=master)](https://travis-ci.org/bassarisse/google-spreadsheet-to-json)
+** 2020-02-20 : This fork of `bassarisse/google-spreadsheet-to-json` project adds more tests; implements against the Google v4 API using the latest version of `theoephraim/node-google-spreadsheet` and Service Account credentials. **
 
-A simple tool to export Google Spreadsheets to JSON files. Can be used though Node API or CLI.
+Please raise an issue or suggestions on the original repo and tag me @johnbeech you see space for improvements - like missing tests or broken functionality.
+
+## Description
 
+A simple tool to export Google Spreadsheets to JSON files. Can be used though Node API or CLI.
 
 ## Installation
 
@@ -18,7 +21,6 @@ Node API:
 $ npm install --save google-spreadsheet-to-json
 ```
 
-
 ## Help
 
 ```
@@ -66,34 +68,40 @@ You can also redirect the output if you omit the filename:
 $ gsjson abc123456789 >> data.json
 ```
 
-
 ## Usage (Node API)
 
 With the exception of `beautify` and the file path, the same options from the CLI applies here (options like `include-header` becomes `includeHeader`).
 
 ```javascript
-var gsjson = require('google-spreadsheet-to-json');
-
-gsjson({
-    spreadsheetId: 'abc123456789',
-    // other options...
-})
-.then(function(result) {
-    console.log(result.length);
-    console.log(result);
-})
-.catch(function(err) {
-    console.log(err.message);
-    console.log(err.stack);
-});
+const gsjson = require('google-spreadsheet-to-json');
+
+const credentials = {
+  client_email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
+  private_key: process.env.GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY
+}
+
+async function example () {
+  try {
+    const result = await gsjson({
+      spreadsheetId: 'abc123456789',
+      credentials
+      // other options...
+    })
+    console.log(result.length)
+    console.log(result)
+  } catch (ex) {
+    console.log(ex.message)
+    console.log(ex.stack)
+  }
+}
+
+example()
 ```
 
-
 ### Notes
 
-- A spreadsheet ID can be extracted from its URL.
-- If an array is passed on the `worksheet` option (in CLI, this can be done by repeating the argument) or the `allWorksheets` option is used, the output from each worksheet is returned inside an array (the order is not guaranteed).
-
+- A spreadsheet ID can be extracted from its URL - for example `https://docs.google.com/spreadsheets/d/1G2_YLuQeKXCtpOWshqIBazzUeefuOMDZ5q10F2u9MHw/edit#gid=0` becomes `1G2_YLuQeKXCtpOWshqIBazzUeefuOMDZ5q10F2u9MHw`
+- If an array is passed on the `worksheet` option (in CLI, this can be done by repeating the argument) or the `allWorksheets` option is used, the output from each worksheet is returned inside an array; however the order is not guaranteed.
 
 ## About authentication
 
@@ -108,22 +116,29 @@ For quick tests, there's a method to acquire a temporary token:
 
 For more detailed information regarding auth methods: https://github.com/theoephraim/node-google-spreadsheet
 
-
 ## Known issues
 
-- Public spreadsheets can only be used without authentication if the option "File > Publish to the web" is used in the Google Spreadsheets GUI, even if the spreadsheet is visible to everyone. This problem won't occur when authenticated.
+- Public spreadsheets are not currently supported - although there is a way to access raw JSON from a spreadsheet which could be supported in future: `https://spreadsheets.google.com/feeds/cells/1G2_YLuQeKXCtpOWshqIBazzUeefuOMDZ5q10F2u9MHw/1/public/full?alt=json` - this works if the option "File > Publish to the web" is used in the Google Spreadsheets GUI, even if the spreadsheet is visible to everyone. This problem won't occur when authenticated.
 
+## Examples
 
-## Examples & change log
+See [EXAMPLES.md](./EXAMPLES.md)
 
-See specific files.
+## Change Log
 
+See [CHANGELOG.md](./CHANGELOG.md)
 
 ## TO-DO
 
 - Improve options documentation (especially header size)
 - Create more test cases
 
-
 ## License
 google-spreadsheet-to-json is free and unencumbered public domain software. For more information, see the accompanying UNLICENSE file.
+
+
+## Contributors
+
+- @bassarisse Bruno Assarisse
+- @cigolpl Mateusz
+- @johnbeech John Beech (Connected Web)

example.js

@@ -1,13 +1,23 @@
-var gsjson = require('./index')
+const gsjson = require('./')
 
-gsjson({
-    spreadsheetId: 'spreadsheetId',
-    token: 'token'
-})
-.then(function(res) {
-    console.log(res)
-    console.log(res.length)
-})
-.catch(function(err) {
-    console.log(err.stack)
-})
+const credentials = {
+  client_email: process.env.GOOGLE_SERVICE_ACCOUNT_EMAIL,
+  private_key: process.env.GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY
+}
+
+async function example () {
+  try {
+    const result = await gsjson({
+      spreadsheetId: 'abc123456789',
+      credentials
+      // other options...
+    })
+    console.log(result.length)
+    console.log(result)
+  } catch (ex) {
+    console.log(ex.message)
+    console.log(ex.stack)
+  }
+}
+
+example()

gsjson.js

@@ -1,66 +1,64 @@
 #!/usr/bin/env node
 
-var fs = require('fs')
-var program = require('commander')
-var Promise = require('bluebird')
-var helper = require('./helper')
-var packageData = require('./package.json')
+const fs = require('fs')
+const program = require('commander')
+const Promise = require('bluebird')
+const helper = require('./helper')
+const packageData = require('./package.json')
 
 program
-    .version(packageData.version)
-    .usage('<spreadsheet-id> [file] [options]')
-    .option('-b, --beautify', 'Beautify final JSON')
-    .option('-s, --credentials <s>', 'Service Account credentials JSON data or file path')
-    .option('-t, --token <token>', 'Auth token acquired externally')
-    .option('-y, --tokentype <tokentype>', 'Type of the informed token (defaults to "Bearer")')
-    .option('-w, --worksheet <n>', 'Worksheet index (zero-based) or title (defaults to first worksheet, can be repeated)', handlePossibleList)
-    .option('-a, --all-worksheets', 'Return all worksheets (worksheet option is ignored)')
-    .option('-c, --hash <column>', 'Column to hash the final object')
-    .option('-m, --property-mode <mode>', 'How to handle property names: "camel" (default), "pascal", "nospace" or "none"', /^(camel|pascal|nospace|none)$/i, 'camel')
-    .option('-i, --vertical', 'Use the first column as header')
-    .option('-l, --list-only', 'Just list the values in arrays')
-    .option('-0, --include-header', 'Include header when using "list-only" option')
-    .option('--header-start <n>', 'Header start line (auto-detected by default)')
-    .option('--header-size <n>', 'Header lines quantity (defaults to 1)')
-    .option('--ignore-col <n>', 'Column name (Excel-like labels) to be ignored (can be repeated, number are also supported)', handlePossibleList)
-    .option('--ignore-row <n>', 'Row number to be ignored (can be repeated)', handlePossibleList)
-    .parse(process.argv)
+  .version(packageData.version)
+  .usage('<spreadsheet-id> [file] [options]')
+  .option('-b, --beautify', 'Beautify final JSON')
+  .option('-s, --credentials <s>', 'Service Account credentials JSON data or file path')
+  .option('-t, --token <token>', 'Auth token acquired externally')
+  .option('-y, --tokentype <tokentype>', 'Type of the informed token (defaults to "Bearer")')
+  .option('-w, --worksheet <n>', 'Worksheet index (zero-based) or title (defaults to first worksheet, can be repeated)', handlePossibleList)
+  .option('-a, --all-worksheets', 'Return all worksheets (worksheet option is ignored)')
+  .option('-c, --hash <column>', 'Column to hash the final object')
+  .option('-m, --property-mode <mode>', 'How to handle property names: "camel" (default), "pascal", "nospace" or "none"', /^(camel|pascal|nospace|none)$/i, 'camel')
+  .option('-i, --vertical', 'Use the first column as header')
+  .option('-l, --list-only', 'Just list the values in arrays')
+  .option('-0, --include-header', 'Include header when using "list-only" option')
+  .option('--header-start <n>', 'Header start line (auto-detected by default)')
+  .option('--header-size <n>', 'Header lines quantity (defaults to 1)')
+  .option('--ignore-col <n>', 'Column name (Excel-like labels) to be ignored (can be repeated, number are also supported)', handlePossibleList)
+  .option('--ignore-row <n>', 'Row number to be ignored (can be repeated)', handlePossibleList)
+  .parse(process.argv)
+
+const options = program.opts()
+options.spreadsheetId = program.args[0] || program.spreadsheetId
 
 if (program.args.length < 1) {
-    program.help()
+  program.help()
 }
 
-program.spreadsheetId = program.args[0] || program.spreadsheetId
-
-var filename = program.args[1]
+const filename = program.args[1]
 
-helper.spreadsheetToJson(program)
-.then(function(result) {
+helper.spreadsheetToJson(options)
+  .then(function (result) {
     return JSON.stringify(result, null, program.beautify ? 4 : null)
-})
-.then(function(result) {
-
+  })
+  .then(function (result) {
     if (filename) {
-        return Promise.promisify(fs.writeFile)(filename, result, 'utf-8')
+      return Promise.promisify(fs.writeFile)(filename, result, 'utf-8')
     } else {
-        process.stdout.write(result)
+      process.stdout.write(result)
     }
-
-})
-.catch(function(err) {
+  })
+  .catch(function (err) {
     throw err
-})
-
-function handlePossibleList(val, memo) {
+  })
 
-    if (typeof memo !== 'undefined') {
-        if (Array.isArray(memo)) {
-            memo.push(val)
-            return memo
-        } else {
-            return [memo, val]
-        }
+function handlePossibleList (val, memo) {
+  if (typeof memo !== 'undefined') {
+    if (Array.isArray(memo)) {
+      memo.push(val)
+      return memo
+    } else {
+      return [memo, val]
     }
+  }
 
-    return val
+  return val
 }