google_spreadsheet_fetcher 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13de044dc3ec95b8296d47bb5374e451cc6b10069b95536c560db70eeafa22d2
-  data.tar.gz: a95098f831784ceb09d2d9b7e36d15cb8f3e1145118a3359124edb660c978582
+  metadata.gz: 5a797f4e71d74b4c24d5005bf91c06e699baab814970e1c4d6070808550bfa41
+  data.tar.gz: 3822500ace1a0d202f0b6739b1e99f68163b4b5c1577b4ac434c470ef59a684a
 SHA512:
-  metadata.gz: f6155050646d3a53498c7fe12d6f435e59b8e0eff0fc6cccdc8c25ff2eaf38465409a8334ed0b08968ca208a42a46ce4a6965342cf39bc8e2f45face082eb5b5
-  data.tar.gz: fa6eacccacaae8c6d5a3d62dee48271c794cdc68d2470001ad97c0329e8cc642371cb61ae102667a7789bce022003e4f50e894e497af88e3297179c8f22f2ce3
+  metadata.gz: 4592c56919027ea291b6a773e0c83417051db6469a5aae1acf3324b016f90db6a83bb0c5a825afa7615a12e0e2c74abb55a46535e1fd84e37015bba50406920f
+  data.tar.gz: '09340c7e08bfcac42337476365ab53277b93b71946ef8797c52c9c7013dd77eb30b4ddd2a11e3ac13c61c441f2854f8aa8c4aaa27c6eb05b3f2f241c65ba138b'

data/google_spreadsheet_fetcher.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency 'google-api-client', '~> 0.9'
-  spec.add_dependency 'google_drive', '~> 2.1.3'
+  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/google_spreadsheet_fetcher.rb

@@ -1,10 +1,12 @@
+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"
 
 module GoogleSpreadsheetFetcher
   def self.config
-    @config ||= Config.new
+    @config ||= Config.default_config
   end
 
   def self.configure

data/lib/google_spreadsheet_fetcher/config.rb

@@ -1,7 +1,15 @@
-require 'active_support/configurable'
-
 module GoogleSpreadsheetFetcher
   class Config
-    attr_accessor :client_secrets_file_path
+    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_fetcher/error.rb

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

data/lib/google_spreadsheet_fetcher/fetcher.rb

@@ -7,99 +7,72 @@ module GoogleSpreadsheetFetcher
   class Fetcher
     OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
 
-    def initialize(credential_store_file, user_id, sheet_key, application_name: nil)
-      @client_secret_file = GoogleSpreadsheetFetcher.config.client_secrets_file_path
-      @credential_store_file = credential_store_file
+    # @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
-      @sheet_key = sheet_key
+      @config = config || GoogleSpreadsheetFetcher.config
       @application_name = application_name
     end
 
-    #
-    # Fetch all rows
-    #
-    # @param [String] ranges https://developers.google.com/sheets/api/guides/concepts#a1_notation
+    # @param [String] range(https://developers.google.com/sheets/api/guides/concepts#a1_notation)
+    # @param [Integer] skip
     def fetch_all_rows(range, skip: 0)
-      rows = service.batch_get_spreadsheet_values(@sheet_key, ranges: [range])&.value_ranges&.first&.values
-      return if rows.empty?
+      rows = service.batch_get_spreadsheet_values(@spreadsheet_id, ranges: [range])&.value_ranges&.first&.values
+      return [] if rows.blank?
 
       rows.slice!(0, skip)
       rows
     end
 
-    def fetch_all_rows_by_index(index, skip: 0)
-      sheet = sheet_by_index(index)
-      raise if sheet.nil?
-
-      range = "#{sheet.properties.title}!A:Z"
-      fetch_all_rows(range, skip: skip)
-    end
-
-    def fetch_all_rows_by_gid(gid, skip: 0)
-      sheet = sheet_by_gid(gid)
-      raise if sheet.nil?
-
-      range = "#{sheet.properties.title}!A:Z"
-      fetch_all_rows(range, skip: skip)
-    end
-
-    def fetch_all_rows_by_title(title, skip: 0)
-      sheet = sheet_by_title(title)
-      raise if sheet.nil?
+    def fetch_all_rows_by!(index: nil, sheet_id: nil, title: nil, skip: 0)
+      sheet = fetch_sheet_by!(index: index, sheet_id: sheet_id, title: title)
 
       range = "#{sheet.properties.title}!A:Z"
       fetch_all_rows(range, skip: skip)
     end
 
     def service
-      @service ||= begin
-        credentials = fetch_credentials
-
-        service = Google::Apis::SheetsV4::SheetsService.new
-        service.authorization = credentials
-        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(index)
-      service.get_spreadsheet(@sheet_key).sheets[index]
-    end
+    def fetch_sheet_by!(index: nil, sheet_id: nil, title: nil)
+      sheets = spreadsheet.sheets
+      raise SheetNotFound if sheets.blank?
 
-    def sheet_by_gid(gid)
-      service.get_spreadsheet(@sheet_key).sheets.find { |s| s.properties.sheet_id == gid }
-    end
+      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?
 
-    def sheet_by_title(title)
-      service.get_spreadsheet(@sheet_key).sheets.find { |s| s.properties.title == title }
+      raise SheetNotFound
     end
 
     def fetch_credentials
-      oob_uri = 'urn:ietf:wg:oauth:2.0:oob'
-
-      client_id = Google::Auth::ClientId.from_file(@client_secret_file)
-      token_store = Google::Auth::Stores::FileTokenStore.new(file: @credential_store_file)
-      authorizer = Google::Auth::UserAuthorizer.new(client_id, scopes, token_store)
+      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)
-
-      if credentials.nil?
-        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
-        credentials = authorizer.get_and_store_credentials_from_code(user_id: @user_id, code: code, base_url: oob_uri)
-      end
-
-      credentials
+      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 scopes
-      [
-        Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY
-      ]
+    def spreadsheet
+      service.get_spreadsheet(@spreadsheet_id)
     end
   end
 end

data/lib/google_spreadsheet_fetcher/version.rb

@@ -1,3 +1,3 @@
 module GoogleSpreadsheetFetcher
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_spreadsheet_fetcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Takahiro Ooishi
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: google_drive
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - google_spreadsheet_fetcher.gemspec
 - lib/google_spreadsheet_fetcher.rb
 - lib/google_spreadsheet_fetcher/config.rb
+- lib/google_spreadsheet_fetcher/error.rb
 - lib/google_spreadsheet_fetcher/fetcher.rb
 - lib/google_spreadsheet_fetcher/version.rb
 homepage: https://github.com/taka0125/google_spreadsheet_fetcher