SheetZoukas

Expose Google Sheets as JSON data

Created to allow Google Sheets to be used as read-only datastores. Associates each row's values with the corresponding header ("column") name.

Why is it called SheetZoukas?

The name is a questionable portmanteau of Jason Mantzoukas and Google Sheets. Because JSON.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add sheet_zoukas

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install sheet_zoukas

Usage

Requirements

This gem assumes the existence of a Google service account with the Google Sheets API enabled. Several environment variables are required for this gem to work.

Required Google auth variables

SheetZoukas::REQUIRED_VARS

• GOOGLE_ACCOUNT_TYPE
• GOOGLE_API_KEY
• GOOGLE_CLIENT_EMAIL
• GOOGLE_CLIENT_ID
• GOOGLE_PRIVATE_KEY

Notes

• Sheets are accessed with the https://www.googleapis.com/auth/spreadsheets.readonly scope
• All data exposed as strings. You can convert data to other types as you ingest this gem's output.
• All data is exposed as the value you see when viewing the sheet
  • This impacts dates. For example, if your spreadsheet does not display the year as part of a date, this gem will not include a year in it's output for those cells.
• No nil values, just empty strings. You can convert empty strings to nil as you ingest this gem's output.
• Row values outside of header range will not be captured. You must have a non-blank header for the row data to be included in this gem's output.
• Performance: this gem has not been tested with large Google Sheets. If you encounter performance issues consider passing in cell ranges to iteratively get your dataset ala pagination.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

linting

GitHub Action runs

• RuboCop
• Bundler Audit

testing

Note: When recording VCR cassettes falid environment variables will need to be initialized in spec/spec_helper.rb will need to be uncommented

$ rake spec

Release

Build

$ rake build

Maual test

$ gem install pkg/sheet_zoukas-<VERSION>.gem
$ irb

irb(main):001> require 'sheet_zoukas'
irb(main):002> SheetZoukas.retrieve_sheet_json('<GOOGLE_SPREADSHEET_ID>', '<TAB_NAME>')

Release

$ rake release

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eebbesen/sheet_zoukas.

License

The gem is available as open source under the terms of the MIT License.