sheet_zoukas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bd39b81cba9d9a4da4202e20062bf10ee50b12570ae929bf0ab33f3773d9614
+  data.tar.gz: d3579fdec88d34bbd76a504a0740c8ca15710bcfe92b026783ff6b80dedf358a
+SHA512:
+  metadata.gz: ea44d0116850abefdfadf3bd353f09ca0d7155c16137e31410c13e3f24f4772c9f773b42270aa8e8fcdb738c2a4d1dc39d67ad132f3510a34d944d2f15f2bbf7
+  data.tar.gz: 530d626076a0fdd2db2759195d49d14300fa807db5e87de0e0b11d9c01b98276a1d1cde06175370d0399ddae0b87533ba3fac40cdc58e39dda26a739d358669d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-13
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 J2EEbbesen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 eebbesen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# SheetZoukas
+
+Expose Google Sheets as JSON data
+
+![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.
+
+## 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](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
+
+* GOOGLE_ACCOUNT_TYPE
+* GOOGLE_API_KEY
+* GOOGLE_CLIENT_EMAIL
+* GOOGLE_CLIENT_ID
+* GOOGLE_PRIVATE_KEY
+
+
+### 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
+    * 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](https://rubygems.org).
+
+### linting
+
+GitHub Action runs
+* RuboCop
+* Bundler Audit
+
+### 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.
+
+## Release
+Build
+    $ rake build
+
+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](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require 'bundler/audit/task'
+
+Bundler::Audit::Task.new

data/lib/sheet_zoukas/data_converter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SheetZoukas
+  # convert spreadsheet data to JSON
+  class DataConverter
+    def initialize(data)
+      @data = data
+    end
+
+    def convert
+      init_headers
+      init_rows
+
+      @rows.map do |row|
+        @headers.zip(row).to_h
+      end
+    end
+
+    private
+
+    def init_headers
+      @headers = @data[0]
+    end
+
+    def init_rows
+      @rows = @data[1..]
+    end
+  end
+end

data/lib/sheet_zoukas/google_sheets.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'google/apis/sheets_v4'
+require 'googleauth'
+
+module SheetZoukas
+  # Interact with Google Sheets API
+  class GoogleSheets
+    DEFAULT_SCOPE = 'https://www.googleapis.com/auth/spreadsheets.readonly'
+
+    def initialize(scope = DEFAULT_SCOPE)
+      @authorizer = Google::Auth::ServiceAccountCredentials.from_env(scope: scope)
+    end
+
+    def retrieve_sheet(sheet_id, tab_name, range = nil)
+      sheets = Google::Apis::SheetsV4::SheetsService.new
+      sheets.authorization = @authorizer
+
+      computed_range = SheetZoukas::GoogleSheets.send :create_range, tab_name, range
+      sheets.get_spreadsheet_values(sheet_id, computed_range)
+    end
+
+    private_class_method def self.create_range(tab_name, range = nil)
+      return tab_name unless range
+
+      "#{tab_name}!#{range}"
+    end
+  end
+end

data/lib/sheet_zoukas/version.rb

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

data/lib/sheet_zoukas.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'sheet_zoukas/data_converter'
+require_relative 'sheet_zoukas/google_sheets'
+require_relative 'sheet_zoukas/version'
+
+# Retrieve Google Sheets data
+module SheetZoukas
+  class Error < StandardError; end
+
+  class << self
+    def retrieve_sheet_json(sheet_id, tab_name, range = nil)
+      sheet = GoogleSheets.new
+      data = sheet.retrieve_sheet(sheet_id, tab_name, range)
+      DataConverter.new(data.values).convert
+    end
+  end
+end

data/sig/sheet_zoukas.rbs

@@ -0,0 +1,4 @@
+module SheetZoukas
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sheet_zoukas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- eebbesen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-sheets_v4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Expose Google Sheets as JSON data
+email:
+- eebbesen.git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sheet_zoukas.rb
+- lib/sheet_zoukas/data_converter.rb
+- lib/sheet_zoukas/google_sheets.rb
+- lib/sheet_zoukas/version.rb
+- sig/sheet_zoukas.rbs
+homepage: https://github.com/eebbesen/sheet_zoukas
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eebbesen/sheet_zoukas
+  changelog_uri: https://github.com/eebbesen/sheet_zoukas/releases/tag/v0.1.0
+  source_code_uri: https://github.com/eebbesen/sheet_zoukas
+  documentation_uri: https://github.com/eebbesen/sheet_zoukas/0.1.0/
+  bug_tracker_uri: https://github.com/eebbesen/sheet_zoukas/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Expose Google Sheets as JSON data
+test_files: []