google_spreadsheet_bulk_fetcher 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c750dce50e2eefaf085870396c8f78688d8873cdb84d09ec488cab63fa2949bd
+  data.tar.gz: fc5ef752e2abad5202b56f7032b6d8b15e1b5fa72add76878e618d8d54ecb813
+SHA512:
+  metadata.gz: eb1f9ee0d9f106e4751be54dfc40f064f91c8c26a1579fe697d969faf6df5631c8c93fe5147dff792d54e320a898d05ce1188a2c154b06c02e2120728bbb7277
+  data.tar.gz: 78b087d242de68336c51391844d645f34b371f2648a09ea3fdb6eb2817b92c4b491c140df9db0a44efbb817e92f49dd62065040e0d188c17303cb5e9fc6fbe86

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_spreadsheet_bulk_fetcher.gemspec
+gemspec

data/README.md

@@ -0,0 +1,56 @@
+# GoogleSpreadsheetBulkFetcher
+
+Use OAuth 2 authentication to retrieve the values of all sheets with a single API access.
+
+Fork from taka0125/google_spreadsheet_fetcher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_spreadsheet_bulk_fetcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_spreadsheet_bulk_fetcher
+
+## Usage
+
+- Make project. https://cloud.google.com/resource-manager/docs/creating-managing-projects
+- Enable Google Drive API
+- Make OAuth 2.0 Client. (other)
+- Download client secret json
+
+```ruby
+sheet_key = 'example_sheet_id'
+
+GoogleSpreadsheetBulkFetcher.configure do |config|
+  config.client_secrets_file = 'client_secrets_file_path.json'
+  config.credential_store_file = 'credential_store_file_path.json'
+end
+
+user_id = 'sample'
+fetcher = GoogleSpreadsheetBulkFetcher::Fetcher.new(sheet_key, user_id)
+fetcher.fetch
+
+fetcher.all_rows_by!(index: 0)
+fetcher.all_rows_by!(title: 'sheet_title')
+fetcher.all_rows_by!(sheet_id: 1234567890)
+```
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/YuyaYokosuka/google_spreadsheet_bulk_fetcher.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_spreadsheet_bulk_fetcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/google_spreadsheet_bulk_fetcher.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_spreadsheet_bulk_fetcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_spreadsheet_bulk_fetcher"
+  spec.version       = GoogleSpreadsheetBulkFetcher::VERSION
+  spec.authors       = ["Yuya Yokosuka"]
+  spec.email         = ["yuya.yokosuka@gmail.com"]
+
+  spec.summary       = %q{Google Spreadsheet bulk fetcher}
+  spec.description   = %q{Use OAuth 2 authentication to retrieve the values of all sheets with a single API access.}
+  spec.homepage      = "https://github.com/YuyaYokosuka/google_spreadsheet_bulk_fetcher"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency 'google-api-client', '~> 0.9'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/google_spreadsheet_bulk_fetcher.rb

@@ -0,0 +1,16 @@
+require "active_support/json"
+require "active_support/core_ext"
+require "google_spreadsheet_bulk_fetcher/version"
+require "google_spreadsheet_bulk_fetcher/config"
+require "google_spreadsheet_bulk_fetcher/error"
+require "google_spreadsheet_bulk_fetcher/fetcher"
+
+module GoogleSpreadsheetBulkFetcher
+  def self.config
+    @config ||= Config.default_config
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/google_spreadsheet_bulk_fetcher/config.rb

@@ -0,0 +1,17 @@
+require 'active_support/configurable'
+
+module GoogleSpreadsheetBulkFetcher
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :client_secrets_file
+    config_accessor :credential_store_file
+    config_accessor :scopes
+
+    def self.default_config
+      new.tap do |config|
+        config.scopes = [Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY]
+      end
+    end
+  end
+end

data/lib/google_spreadsheet_bulk_fetcher/error.rb

@@ -0,0 +1,4 @@
+module GoogleSpreadsheetBulkFetcher
+  class SpreadsheetNotFound < StandardError; end
+  class SheetNotFound < StandardError; end
+end

data/lib/google_spreadsheet_bulk_fetcher/fetcher.rb

@@ -0,0 +1,105 @@
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'shellwords'
+
+module GoogleSpreadsheetBulkFetcher
+  class Fetcher
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+    # @param [String] spreadsheet_id
+    # @param [String] user_id
+    # @param [GoogleSpreadsheetBulkFetcher::Config] config
+    # @param [String] application_name
+    def initialize(spreadsheet_id, user_id, config: nil, application_name: nil)
+      @spreadsheet_id = spreadsheet_id
+      @user_id = user_id
+      @config = config || GoogleSpreadsheetBulkFetcher.config
+      @application_name = application_name
+
+      @spreadsheet = nil
+    end
+
+    def fetch
+      @spreadsheet = service.get_spreadsheet(@spreadsheet_id, fields: 'sheets(properties,data.rowData.values(formattedValue))')
+      self
+    end
+
+    # @param [Integer] index
+    # @param [Integer] sheet_id
+    # @param [String] title
+    # @param [Integer] skip
+    # @param [Boolean] structured
+    def all_rows_by!(index: nil, sheet_id: nil, title: nil, skip: 0, structured: false)
+      sheet = sheet_by!(index: index, sheet_id: sheet_id, title: title)
+      sheet_to_array(sheet, skip: skip, structured: structured)
+    end
+
+    def service
+      @service ||= Google::Apis::SheetsV4::SheetsService.new.tap do |service|
+        service.authorization = fetch_credentials
+        service.client_options.application_name = @application_name if @application_name.present?
+      end
+    end
+
+    private
+
+    def sheet_by!(index: nil, sheet_id: nil, title: nil)
+      raise SpreadsheetNotFound if @spreadsheet.sheets.blank?
+
+      if index.present?
+        return @spreadsheet.sheets.find { |sheet| sheet.properties.index == index }
+      elsif sheet_id.present?
+        return @spreadsheet.sheets.find { |sheet| sheet.properties.sheet_id == sheet_id }
+      elsif title.present?
+        return @spreadsheet.sheets.find { |sheet| sheet.properties.title == title }
+      end
+
+      raise SheetNotFound
+    end
+
+    def sheet_to_array(sheet, skip: 0, structured: false)
+      sheet_data = sheet&.data&.first
+      return [] if sheet_data.nil?
+
+      rows = sheet_data.row_data.map do |row_data|
+        values = row_data.values
+        next [''] if values.nil?
+
+        values.map { |cell| cell&.formatted_value || "" }
+      end
+
+      headers = rows.first
+      count = headers.count
+
+      if structured
+        rows.delete_at(0)
+        rows.slice!(0, skip)
+        rows.map { |r| headers.zip(r).to_h }
+      else
+        rows.slice!(0, skip)
+        rows.map { |r| fill_array(r, count) }
+      end
+    end
+
+    def fetch_credentials
+      client_id = Google::Auth::ClientId.from_file(@config.client_secrets_file)
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: @config.credential_store_file)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, @config.scopes, token_store)
+
+      credentials = authorizer.get_credentials(@user_id)
+      return credentials if credentials.present?
+
+      url = authorizer.get_authorization_url(base_url: OOB_URI)
+      escaped_url = url.shellescape
+      system("open #{escaped_url}")
+      puts "Open #{url} in your browser and enter the resulting code: "
+      code = STDIN.gets
+      authorizer.get_and_store_credentials_from_code(user_id: @user_id, code: code, base_url: OOB_URI)
+    end
+
+    def fill_array(items, count, fill: '')
+      items + (count - items.count).times.map { fill }
+    end
+  end
+end

data/lib/google_spreadsheet_bulk_fetcher/version.rb

@@ -0,0 +1,3 @@
+module GoogleSpreadsheetBulkFetcher
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: google_spreadsheet_bulk_fetcher
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuya Yokosuka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use OAuth 2 authentication to retrieve the values of all sheets with
+  a single API access.
+email:
+- yuya.yokosuka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- google_spreadsheet_bulk_fetcher.gemspec
+- lib/google_spreadsheet_bulk_fetcher.rb
+- lib/google_spreadsheet_bulk_fetcher/config.rb
+- lib/google_spreadsheet_bulk_fetcher/error.rb
+- lib/google_spreadsheet_bulk_fetcher/fetcher.rb
+- lib/google_spreadsheet_bulk_fetcher/version.rb
+homepage: https://github.com/YuyaYokosuka/google_spreadsheet_bulk_fetcher
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Google Spreadsheet bulk fetcher
+test_files: []