google_spreadsheet_fetcher 1.2.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8931e371e571bd4765be2b63a647d8028d4ed763abddd82dacf9f6d70f30a987
-  data.tar.gz: ce41e8fa0daf651ea25ffecb195a74dad258d4a9ad6b5abde05c80999de3609a
+  metadata.gz: adf35fcabe96fa86ae6e1a6e30d728531471b24c8a1e358e7bf7506db08286ba
+  data.tar.gz: e6fa6c579750fb93ab46f28bfdf8f6ddda7d00b2c00c79dd29aff62ea9e269eb
 SHA512:
-  metadata.gz: 325db541542d87960f7bd388be44f6d4977bb6e74df8804bfdeb152fd8b82f1079d1c0387bd8e1e878a629e2266aa3baad58264e5c4696056158b9d1f6e34377
-  data.tar.gz: 9e297605b02343a4f688df0790b1c1e980689c74e092477967f385687dc36773f17ca1326a2521d0c9196a04c4c21dfc42e23b3127cc209cda88809eefae33ff
+  metadata.gz: 40492b6fbe256c65df40a92fc1e4a9d941a2eb25feb82f9f04a68226eb3d4b60defb5d5ba9cebf4dae042d8cb0e8c8ed2b60d76d9b61f2c886d646b04ba88d3d
+  data.tar.gz: 1ccab637e4927b1031c6e4b262461fb108a5728582bc9e7c9ffd31f29545c23ab146640da89543a56912958bf200452874e8cb5614329eb1ece7ccdc5a909e1d

data/README.md

@@ -25,20 +25,32 @@ Or install it yourself as:
 - Make OAuth 2.0 Client. (other)
 - Download client secret json
 
+
 ```ruby
-credential_store_file = Rails.root.join('config', 'credential-oauth2-supporter.json').to_s
-sheet_key = 'YOUR_SHEET_KEY'
+sheet_key = 'example_sheet_id'
 
 GoogleSpreadsheetFetcher.configure do |config|
-  config.client_secrets_file_path = Rails.root.join('config', 'client_secrets_pokota_supporter.json').to_s
+  config.client_secrets_file = 'client_secrets_file_path.json'
+  config.credential_store_file = 'credential_store_file_path.json'
 end
 
 user_id = 'sample'
-fetcher = GoogleSpreadsheetFetcher::Fetcher.new(credential_store_file, user_id, sheet_key)
 
-fetcher.fetch_by_index(0)
-fetcher.fetch_by_title('title')
-fetcher.fetch_by_gid('gid')
+fetcher = GoogleSpreadsheetFetcher::Fetcher.new(sheet_key, user_id)
+
+fetcher.fetch_all_rows_by!(index: 0)
+fetcher.fetch_all_rows_by!(title: 'sheet_title')
+fetcher.fetch_all_rows_by!(sheet_id: 1234567890)
+
+
+# or, you can do a bulk fetching. In this case, you only need to access the API once,
+# but it will take a little longer on first fetch.
+fetcher = GoogleSpreadsheetFetcher::BulkFetcher.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

data/google_spreadsheet_fetcher.gemspec

@@ -6,8 +6,8 @@ require 'google_spreadsheet_fetcher/version'
 Gem::Specification.new do |spec|
   spec.name          = "google_spreadsheet_fetcher"
   spec.version       = GoogleSpreadsheetFetcher::VERSION
-  spec.authors       = ["Takahiro Ooishi"]
-  spec.email         = ["taka0125@gmail.com"]
+  spec.authors       = ["Takahiro Ooishi", "Yuya Yokosuka"]
+  spec.email         = ["taka0125@gmail.com", "yuya.yokosuka@gmail.com"]
 
   spec.summary       = %q{Google Spreadsheet fetcher}
   spec.description   = %q{Google Spreadsheet fetcher}

data/lib/google_spreadsheet_fetcher.rb

@@ -1,8 +1,11 @@
+require "active_support/json"
 require "active_support/core_ext"
 require "google_spreadsheet_fetcher/version"
 require "google_spreadsheet_fetcher/config"
 require "google_spreadsheet_fetcher/error"
 require "google_spreadsheet_fetcher/fetcher"
+require "google_spreadsheet_fetcher/bulk_fetcher"
+require "google_spreadsheet_fetcher/sheets_service_builder"
 
 module GoogleSpreadsheetFetcher
   def self.config

data/lib/google_spreadsheet_fetcher/bulk_fetcher.rb

@@ -0,0 +1,82 @@
+require 'google/apis/sheets_v4'
+require 'shellwords'
+
+module GoogleSpreadsheetFetcher
+  class BulkFetcher
+    # @param [String] spreadsheet_id
+    # @param [String] user_id
+    # @param [GoogleSpreadsheetFetcher::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 || GoogleSpreadsheetFetcher.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 ||= GoogleSpreadsheetFetcher::SheetsServiceBuilder.new(@user_id, config: @config, application_name: @application_name).build
+    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 fill_array(items, count, fill: '')
+      items + (count - items.count).times.map { fill }
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/config.rb

@@ -1,3 +1,5 @@
+require 'active_support/configurable'
+
 module GoogleSpreadsheetFetcher
   class Config
     include ActiveSupport::Configurable

data/lib/google_spreadsheet_fetcher/error.rb

@@ -1,3 +1,4 @@
 module GoogleSpreadsheetFetcher
+  class SpreadsheetNotFound < StandardError; end
   class SheetNotFound < StandardError; end
 end

data/lib/google_spreadsheet_fetcher/fetcher.rb

@@ -1,6 +1,4 @@
-require 'googleauth'
-require 'googleauth/stores/file_token_store'
-require "google/apis/sheets_v4"
+require 'google/apis/sheets_v4'
 require 'shellwords'
 
 module GoogleSpreadsheetFetcher
@@ -14,71 +12,66 @@ module GoogleSpreadsheetFetcher
     def initialize(spreadsheet_id, user_id, config: nil, application_name: nil)
       @spreadsheet_id = spreadsheet_id
       @user_id = user_id
-      @config = config || GoogleSpreadsheetFetcher.config
+      @config = config
       @application_name = application_name
     end
 
-    # @param [String] range(https://developers.google.com/sheets/api/guides/concepts#a1_notation)
+    def fetch_all_rows_by!(index: nil, sheet_id: nil, title: nil, skip: 0, structured: false)
+      sheet = fetch_sheet_by!(index: index, sheet_id: sheet_id, title: title)
+      fetch_all_rows(sheet, skip: skip, structured: structured)
+    end
+
+    def service
+      @service ||= GoogleSpreadsheetFetcher::SheetsServiceBuilder.new(@user_id, config: @config, application_name: @application_name).build
+    end
+
+    private
+
+    # @param [Google::Apis::SheetsV4::Sheet] sheet
     # @param [Integer] skip
-    def fetch_all_rows(range, skip: 0, structured: false)
-      rows = service.batch_get_spreadsheet_values(@spreadsheet_id, ranges: [range])&.value_ranges&.first&.values
+    # @param [Boolean] structured
+    def fetch_all_rows(sheet, skip: 0, structured: false)
+      # https://developers.google.com/sheets/api/guides/concepts#a1_notation
+      range = "#{sheet.properties.title}!A:ZZ"
+      rows = service.get_spreadsheet_values(@spreadsheet_id, range)&.values
       return [] if rows.blank?
 
+      headers = rows.first
+      count = headers.count
+
       if structured
-        headers = rows.delete_at(0)
+        rows.delete_at(0)
         rows.slice!(0, skip)
         rows.map { |r| headers.zip(r).to_h }
       else
         rows.slice!(0, skip)
-        rows
-      end
-    end
-
-    def fetch_all_rows_by!(index: nil, sheet_id: nil, title: nil, skip: 0, structured: false)
-      sheet = fetch_sheet_by!(index: index, sheet_id: sheet_id, title: title)
-
-      range = "#{sheet.properties.title}!A:Z"
-      fetch_all_rows(range, 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?
+        rows.map { |r| fill_array(r, count) }
       end
     end
 
-    private
-
     def fetch_sheet_by!(index: nil, sheet_id: nil, title: nil)
       sheets = spreadsheet.sheets
       raise SheetNotFound if sheets.blank?
 
-      return sheets[index] if index.present?
-      return sheets.find { |s| s.properties.sheet_id == sheet_id } if sheet_id.present?
-      return sheets.find { |s| s.properties.title == title } if title.present?
+      sheet = if index.present?
+                sheets[index]
+              elsif sheet_id.present?
+                sheets.find { |s| s.properties.sheet_id == sheet_id }
+              elsif title.present?
+                sheets.find { |s| s.properties.title == title }
+              end
+
+      return sheet if sheet.present?
 
       raise SheetNotFound
     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)
+    def spreadsheet
+      @spreadsheet ||= service.get_spreadsheet(@spreadsheet_id)
     end
 
-    def spreadsheet
-      service.get_spreadsheet(@spreadsheet_id)
+    def fill_array(items, count, fill: "")
+      items + (count - items.count).times.map { fill }
     end
   end
 end

data/lib/google_spreadsheet_fetcher/sheets_service_builder.rb

@@ -0,0 +1,44 @@
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'shellwords'
+
+module GoogleSpreadsheetFetcher
+  class SheetsServiceBuilder
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+    # @param [String] user_id
+    # @param [GoogleSpreadsheetFetcher::Config] config
+    # @param [String] application_name
+    def initialize(user_id, config: nil, application_name: nil)
+      @user_id = user_id
+      @config = config || GoogleSpreadsheetFetcher.config
+      @application_name = application_name
+    end
+
+    def build
+      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 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
+  end
+end

data/lib/google_spreadsheet_fetcher/version.rb

@@ -1,3 +1,3 @@
 module GoogleSpreadsheetFetcher
-  VERSION = "1.2.0"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: google_spreadsheet_fetcher
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Takahiro Ooishi
+- Yuya Yokosuka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client
@@ -83,6 +84,7 @@ dependencies:
 description: Google Spreadsheet fetcher
 email:
 - taka0125@gmail.com
+- yuya.yokosuka@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -97,9 +99,11 @@ files:
 - bin/setup
 - google_spreadsheet_fetcher.gemspec
 - lib/google_spreadsheet_fetcher.rb
+- lib/google_spreadsheet_fetcher/bulk_fetcher.rb
 - lib/google_spreadsheet_fetcher/config.rb
 - lib/google_spreadsheet_fetcher/error.rb
 - lib/google_spreadsheet_fetcher/fetcher.rb
+- lib/google_spreadsheet_fetcher/sheets_service_builder.rb
 - lib/google_spreadsheet_fetcher/version.rb
 homepage: https://github.com/taka0125/google_spreadsheet_fetcher
 licenses: []