sheet_zoukas 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd39b81cba9d9a4da4202e20062bf10ee50b12570ae929bf0ab33f3773d9614
-  data.tar.gz: d3579fdec88d34bbd76a504a0740c8ca15710bcfe92b026783ff6b80dedf358a
+  metadata.gz: 663a950de628221d592c40858718e1b92319135cd8f551cb4bd7973b505faf2c
+  data.tar.gz: 91fa4dc394f038fe894c5d7c9bf7ee6ab5d99887e7d3dfc52955cf675db0dcc4
 SHA512:
-  metadata.gz: ea44d0116850abefdfadf3bd353f09ca0d7155c16137e31410c13e3f24f4772c9f773b42270aa8e8fcdb738c2a4d1dc39d67ad132f3510a34d944d2f15f2bbf7
-  data.tar.gz: 530d626076a0fdd2db2759195d49d14300fa807db5e87de0e0b11d9c01b98276a1d1cde06175370d0399ddae0b87533ba3fac40cdc58e39dda26a739d358669d
+  metadata.gz: 752a3996cecaebb55dca1628cf8fbf6049573093e4891c89af4e26a7cb40824342f35571602237ddc20369c7e00bfd602395efa38aa6c3f3a5fa63339c4fdb22
+  data.tar.gz: 3f4304f53f08dd6498ba8e18cff7b62a61562a777008925f6e15e9011c46405ebe178c288f0be40a48fa40e13ace91fabb3ce3e3e05ea3eabef919be4539af70

data/CHANGELOG.md

@@ -1,5 +1,7 @@
-## [Unreleased]
-
 ## [0.1.0] - 2024-10-13
 
-- Initial release
+- Initial release v0.1.0
+
+## [0.2.0] - UNRELEASED
+
+- Added check for required environment variables before call to Google Sheets API

data/README.md

@@ -2,11 +2,16 @@
 
 Expose Google Sheets as JSON data
 
+[![Gem Version](https://badge.fury.io/rb/sheet_zoukas.svg)](https://badge.fury.io/rb/sheet_zoukas)
+
 ![Tests](https://github.com/eebbesen/sheet_zoukas/actions/workflows/ruby.yml/badge.svg)
 
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 
-Created to allow Google Sheets to be used as read-only databases. Associates each row's values with the corresponding header ("row") name.
+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](https://en.wikipedia.org/wiki/Jason_Mantzoukas) and Google Sheets. Because JSON.
 
 ## Installation
 
@@ -24,7 +29,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 This gem assumes the existence of a [Google service account](https://developers.google.com/identity/protocols/oauth2/service-account) with [the Google Sheets API](https://console.cloud.google.com/apis/library/sheets.googleapis.com) enabled. Several environment variables are required for this gem to work.
 
-#### Google auth values
+#### Required Google auth variables
+`SheetZoukas::REQUIRED_VARS`
 
 * GOOGLE_ACCOUNT_TYPE
 * GOOGLE_API_KEY
@@ -34,10 +40,11 @@ This gem assumes the existence of a [Google service account](https://developers.
 
 
 ### Notes
-* 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 display value
+* 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.
+* 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.
 
@@ -55,13 +62,15 @@ GitHub Action runs
 
 ### testing
 
-RSpec tests require the environment variables listed in spec_helper.rb's `REQUIRED_VARS` constant. Out of the box your tests that call Google (mocked with VCR) will fail because you do (should) not have access to my test account credentials.
+    $ rake spec
 
 ## Release
 Build
+
     $ rake build
 
 Test
+
     $ gem install pkg/sheet_zoukas-<VERSION>.gem
     $ irb
 
@@ -69,6 +78,7 @@ Test
     irb(main):002> SheetZoukas.retrieve_sheet_json('<GOOGLE_SPREADSHEET_ID>', '<TAB_NAME>')
 
 Release
+
     $ rake release
 
 ## Contributing

data/lib/sheet_zoukas/google_sheets.rb

@@ -9,7 +9,7 @@ module SheetZoukas
     DEFAULT_SCOPE = 'https://www.googleapis.com/auth/spreadsheets.readonly'
 
     def initialize(scope = DEFAULT_SCOPE)
-      @authorizer = Google::Auth::ServiceAccountCredentials.from_env(scope: scope)
+      init_authorizer(scope)
     end
 
     def retrieve_sheet(sheet_id, tab_name, range = nil)
@@ -25,5 +25,12 @@ module SheetZoukas
 
       "#{tab_name}!#{range}"
     end
+
+    private
+
+    # overriden in spec_helper so we don't try to authenticate with Google for tests
+    def init_authorizer(scope)
+      @authorizer = Google::Auth::ServiceAccountCredentials.from_env(scope: scope)
+    end
   end
 end

data/lib/sheet_zoukas/utils.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SheetZoukas
+  # Utility methods
+  class Utils
+    def self.vars_present?(required_vars, message)
+      all_present = true
+      required_vars.each do |var|
+        if ENV.fetch(var, '').strip.empty?
+          all_present = false
+          puts "⛔️ #{var} #{message}."
+        end
+      end
+      all_present
+    end
+  end
+end

data/lib/sheet_zoukas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SheetZoukas
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/sheet_zoukas.rb

@@ -3,16 +3,25 @@
 require_relative 'sheet_zoukas/data_converter'
 require_relative 'sheet_zoukas/google_sheets'
 require_relative 'sheet_zoukas/version'
+require_relative 'sheet_zoukas/utils'
 
 # Retrieve Google Sheets data
 module SheetZoukas
   class Error < StandardError; end
+  REQUIRED_VARS = %w[GOOGLE_ACCOUNT_TYPE GOOGLE_API_KEY GOOGLE_CLIENT_EMAIL GOOGLE_CLIENT_ID GOOGLE_PRIVATE_KEY].freeze
 
   class << self
     def retrieve_sheet_json(sheet_id, tab_name, range = nil)
+      SheetZoukas.exit_program unless SheetZoukas::Utils.vars_present?(REQUIRED_VARS,
+                                                                       'required for Google Sheets API calls')
+
       sheet = GoogleSheets.new
       data = sheet.retrieve_sheet(sheet_id, tab_name, range)
       DataConverter.new(data.values).convert
     end
+
+    def exit_program
+      raise StandardError, 'Error encountered'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sheet_zoukas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - eebbesen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-13 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-sheets_v4
@@ -41,6 +41,7 @@ files:
 - lib/sheet_zoukas.rb
 - lib/sheet_zoukas/data_converter.rb
 - lib/sheet_zoukas/google_sheets.rb
+- lib/sheet_zoukas/utils.rb
 - lib/sheet_zoukas/version.rb
 - sig/sheet_zoukas.rbs
 homepage: https://github.com/eebbesen/sheet_zoukas
@@ -48,9 +49,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/eebbesen/sheet_zoukas
-  changelog_uri: https://github.com/eebbesen/sheet_zoukas/releases/tag/v0.1.0
+  changelog_uri: https://github.com/eebbesen/sheet_zoukas/releases/tag/v0.2.0
   source_code_uri: https://github.com/eebbesen/sheet_zoukas
-  documentation_uri: https://github.com/eebbesen/sheet_zoukas/0.1.0/
+  documentation_uri: https://github.com/eebbesen/sheet_zoukas/0.2.0/
   bug_tracker_uri: https://github.com/eebbesen/sheet_zoukas/issues
   rubygems_mfa_required: 'true'
 post_install_message: