google_spreadsheet_fetcher 1.9.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3660f6d65df012ef4f8dab6b94a6546c5fff27c188728228af19733f21d5114
-  data.tar.gz: ac69095de2b42ca87b8f4cc94a1789ef06a6daed653864fc731f4c258fcaa4b8
+  metadata.gz: a18dded3ae272e466b1ef230e2b026bbef6dcbdc3504ede64efc98d6be084d84
+  data.tar.gz: 602af299a3764c525d76f0594023c8b84784f53993dbc651ff8605148ce47385
 SHA512:
-  metadata.gz: 5e384e728280389bc97dde41209c092f4a7fc5260b90fcbdbb98791265845d1873bddb4ddb30bf8dae170de548a32812ba7635e802beb5fec1e10aa4c2ab5473
-  data.tar.gz: 3e924a4be7fbef426b1ec35102145c9cb19148794ee1452256b8ddbaadfcdecb2be6cdc815064b5664478622f72c2e380a1ee0586fa57716212b68edcdcf91ee
+  metadata.gz: 5513c2c32a6fdc869cf6d628d4ca4b6808c84b42107f25ba2dd765c3c173339216a71020fe4003d94c12ef3f117e9a1f702b546c0e2abe31f59402edb223ae80
+  data.tar.gz: 8bdeae4bc5fd457095957dcca62cc9bdf9aff6e36d689d817fd84bb2fa2e3752fa25aef17da3753511d44d8b16757d358b1cd127faa9eb9f840051be1ce90630

data/README.md

@@ -1,6 +1,6 @@
 # GoogleSpreadsheetFetcher
 
-Use OAuth 2 authentication to retrieve data from Google Spreadsheet.
+Provides access to Google spreadsheets
 
 ## Installation
 
@@ -20,18 +20,11 @@ Or install it yourself as:
 
 ## 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'
 
 GoogleSpreadsheetFetcher.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'
@@ -53,6 +46,14 @@ fetcher.all_rows_by!(title: 'sheet_title')
 fetcher.all_rows_by!(sheet_id: 1234567890)
 ```
 
+### Use Service Account
+
+https://github.com/taka0125/google_spreadsheet_fetcher/wiki/Use-Service-Account
+
+### Use OAuth2
+
+https://github.com/taka0125/google_spreadsheet_fetcher/wiki/Use-OAuth2
+
 ## 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.

data/lib/google_spreadsheet_fetcher/authorizer/interface.rb

@@ -0,0 +1,9 @@
+module GoogleSpreadsheetFetcher
+  module Authorizer
+    module Interface
+      def fetch_credentials!(user_id: nil)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/authorizer/oauth2/authorizer.rb

@@ -0,0 +1,51 @@
+# https://github.com/googleapis/google-api-ruby-client/blob/main/docs/oauth-web.md
+
+require 'googleauth'
+require 'googleauth/web_user_authorizer'
+require 'googleauth/stores/file_token_store'
+
+module GoogleSpreadsheetFetcher
+  module Authorizer
+    module Oauth2
+      class Authorizer
+        include Interface
+
+        def initialize(config: nil, callback_uri: nil)
+          @config = config || ::GoogleSpreadsheetFetcher::Authorizer::Oauth2::Config.new
+          @callback_uri = callback_uri || ::GoogleSpreadsheetFetcher::Authorizer::Oauth2::RackApplication::CALLBACK_PATH
+          @web_user_authorizer = build_web_user_authorizer
+
+          freeze
+        end
+
+        def fetch_credentials!(user_id: nil)
+          web_user_authorizer.get_credentials(user_id || config.user_id)
+        end
+
+        def fetch_credentials
+          fetch_credentials!
+        rescue StandardError
+          nil
+        end
+
+        def get_authorization_url(rack_request)
+          web_user_authorizer.get_authorization_url(request: rack_request)
+        end
+
+        def handle_auth_callback(rack_request)
+          web_user_authorizer.handle_auth_callback(config.user_id, rack_request)
+        end
+
+        private
+
+        attr_reader :config, :callback_uri, :web_user_authorizer
+
+        def build_web_user_authorizer
+          ::Google::Auth::WebUserAuthorizer.new(
+            config.client_id, ::GoogleSpreadsheetFetcher.config.scopes, config.token_store, callback_uri
+          )
+        end
+      end
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/authorizer/oauth2/config.rb

@@ -0,0 +1,28 @@
+module GoogleSpreadsheetFetcher
+  module Authorizer
+    module Oauth2
+      class Config
+        attr_reader :client_secrets_json_path, :user_id, :token_store, :client_id
+
+        def initialize(client_secrets_json_path: nil, user_id: nil, token_store: nil)
+          @client_secrets_json_path = client_secrets_json_path || ::GoogleSpreadsheetFetcher.config.client_secrets_file
+          @user_id = user_id || ::GoogleSpreadsheetFetcher.config.user_id
+          @token_store = token_store || default_token_store
+          @client_id = ::Google::Auth::ClientId.from_file(self.client_secrets_json_path)
+
+          freeze
+        end
+
+        private
+
+        def default_token_store
+          store = ::GoogleSpreadsheetFetcher.config.token_store
+          return store if store.present?
+
+          file = ::GoogleSpreadsheetFetcher.config.credential_store_file
+          ::Google::Auth::Stores::FileTokenStore.new(file: file)
+        end
+      end
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/authorizer/oauth2/rack_application.rb

@@ -0,0 +1,70 @@
+require 'securerandom'
+
+module GoogleSpreadsheetFetcher
+  module Authorizer
+    module Oauth2
+      class RackApplication
+        AUTHORIZE_PATH = '/authorize'.freeze
+        CALLBACK_PATH = '/oauth2callback'.freeze
+
+        def initialize(config: nil)
+          @config = config || ::GoogleSpreadsheetFetcher::Authorizer::Oauth2::Config.new
+          @authorizer = ::GoogleSpreadsheetFetcher::Authorizer::Oauth2::Authorizer.new(config: config)
+
+          freeze
+        end
+
+        def call(env)
+          path = env['PATH_INFO']
+          request_method = env['REQUEST_METHOD']
+
+          return handle_authorize(env) if path == AUTHORIZE_PATH && request_method == 'GET'
+          return handle_callback(env) if path == CALLBACK_PATH && request_method == 'GET'
+
+          plain_response(400, 'invalid access')
+        end
+
+        def cookie_settings(secret: nil)
+          {
+            domain: 'localhost',
+            path: '/',
+            expire_after: 3600*24,
+            secret: secret || SecureRandom.uuid
+          }
+        end
+
+        private
+
+        attr_reader :config, :authorizer
+
+        def handle_authorize(env)
+          request = ::Rack::Request.new(env)
+
+          credentials = authorizer.fetch_credentials
+          if credentials.nil?
+            redirect_url = authorizer.get_authorization_url(request)
+
+            return redirect_response(redirect_url)
+          end
+
+          plain_response(200, 'authorized')
+        end
+
+        def handle_callback(env)
+          request = ::Rack::Request.new(env)
+          authorizer.handle_auth_callback(request)
+
+          plain_response(200, 'token stored')
+        end
+
+        def redirect_response(url)
+          [302, {'location' => url}, []]
+        end
+
+        def plain_response(status, text)
+          [status, {'content-type' => 'text/plain'}, [text]]
+        end
+      end
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/authorizer/service_account.rb

@@ -0,0 +1,27 @@
+module GoogleSpreadsheetFetcher
+  module Authorizer
+    class ServiceAccount
+      include Interface
+
+      def initialize(credential, scope: nil)
+        @credential = credential
+        @scope = scope || ::GoogleSpreadsheetFetcher.config.scopes
+
+        freeze
+      end
+
+      def setup!; end
+
+      def fetch_credentials!(user_id: nil)
+        ::Google::Auth::ServiceAccountCredentials.make_creds(
+          json_key_io: StringIO.new(credential),
+          scope: scope
+        ).tap(&:fetch_access_token!)
+      end
+
+      private
+
+      attr_reader :credential, :scope
+    end
+  end
+end

data/lib/google_spreadsheet_fetcher/bulk_fetcher.rb

@@ -1,6 +1,3 @@
-require 'google/apis/sheets_v4'
-require 'shellwords'
-
 module GoogleSpreadsheetFetcher
   class BulkFetcher
     # @param [String] spreadsheet_id

data/lib/google_spreadsheet_fetcher/config.rb

@@ -4,14 +4,17 @@ module GoogleSpreadsheetFetcher
   class Config
     include ActiveSupport::Configurable
 
+    config_accessor :authorizer
+
     config_accessor :client_secrets_file
     config_accessor :credential_store_file # required if token_store not set
     config_accessor :token_store # required if credential_store_file not set
     config_accessor :scopes
+    config_accessor :user_id
 
     def self.default_config
       new.tap do |config|
-        config.scopes = [Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY]
+        config.scopes = [::Google::Apis::SheetsV4::AUTH_SPREADSHEETS_READONLY]
       end
     end
   end

data/lib/google_spreadsheet_fetcher/fetcher.rb

@@ -1,10 +1,5 @@
-require 'google/apis/sheets_v4'
-require 'shellwords'
-
 module GoogleSpreadsheetFetcher
   class Fetcher
-    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
-
     # @param [String] spreadsheet_id
     # @param [String] user_id
     # @param [GoogleSpreadsheetFetcher::Config] config

data/lib/google_spreadsheet_fetcher/sheets_service_builder.rb

@@ -1,12 +1,5 @@
-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
@@ -14,31 +7,20 @@ module GoogleSpreadsheetFetcher
       @user_id = user_id
       @config = config || GoogleSpreadsheetFetcher.config
       @application_name = application_name
-      @token_store = @config.token_store || Google::Auth::Stores::FileTokenStore.new(file: @config.credential_store_file)
     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?
+    def build(authorizer: nil)
+      authorizer = authorizer || config.authorizer || ::GoogleSpreadsheetFetcher::Authorizer::Oauth2::Authorizer.new
+      raise 'Authorizer is not configured' if authorizer.blank?
+
+      ::Google::Apis::SheetsV4::SheetsService.new.tap do |service|
+        service.authorization = authorizer.fetch_credentials!(user_id: user_id)
+        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)
-      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
+    attr_reader :user_id, :config, :application_name
   end
 end

data/lib/google_spreadsheet_fetcher/version.rb

@@ -1,3 +1,3 @@
 module GoogleSpreadsheetFetcher
-  VERSION = "1.9.1"
+  VERSION = "2.0.1"
 end

data/lib/google_spreadsheet_fetcher.rb

@@ -1,13 +1,21 @@
-require "active_support"
-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/sheet_url"
-require "google_spreadsheet_fetcher/bulk_fetcher"
-require "google_spreadsheet_fetcher/sheets_service_builder"
+require 'active_support'
+require 'active_support/json'
+require 'active_support/core_ext'
+require 'googleauth'
+require 'google/apis/sheets_v4'
+
+require 'google_spreadsheet_fetcher/version'
+require 'google_spreadsheet_fetcher/config'
+require 'google_spreadsheet_fetcher/error'
+require 'google_spreadsheet_fetcher/authorizer/interface'
+require 'google_spreadsheet_fetcher/authorizer/service_account'
+require 'google_spreadsheet_fetcher/authorizer/oauth2/config'
+require 'google_spreadsheet_fetcher/authorizer/oauth2/rack_application'
+require 'google_spreadsheet_fetcher/authorizer/oauth2/authorizer'
+require 'google_spreadsheet_fetcher/fetcher'
+require 'google_spreadsheet_fetcher/sheet_url'
+require 'google_spreadsheet_fetcher/bulk_fetcher'
+require 'google_spreadsheet_fetcher/sheets_service_builder'
 
 module GoogleSpreadsheetFetcher
   def self.config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_spreadsheet_fetcher
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Takahiro Ooishi
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
@@ -25,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -89,19 +117,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".github/workflows/release.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- google_spreadsheet_fetcher.gemspec
 - lib/google_spreadsheet_fetcher.rb
+- lib/google_spreadsheet_fetcher/authorizer/interface.rb
+- lib/google_spreadsheet_fetcher/authorizer/oauth2/authorizer.rb
+- lib/google_spreadsheet_fetcher/authorizer/oauth2/config.rb
+- lib/google_spreadsheet_fetcher/authorizer/oauth2/rack_application.rb
+- lib/google_spreadsheet_fetcher/authorizer/service_account.rb
 - lib/google_spreadsheet_fetcher/bulk_fetcher.rb
 - lib/google_spreadsheet_fetcher/config.rb
 - lib/google_spreadsheet_fetcher/error.rb
@@ -128,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Google Spreadsheet fetcher

data/.github/workflows/main.yml

@@ -1,40 +0,0 @@
-name: rspec
-
-on:
-  push:
-    branches:
-      - main
-
-  pull_request:
-    branches:
-      - main
-
-env:
-  RAILS_ENV: test
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-
-      matrix:
-        ruby:
-          - 2.6
-          - 2.7
-          - 3.0
-          - 3.1
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: |
-          bundle exec rspec
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}

data/.github/workflows/release.yml

@@ -1,33 +0,0 @@
-name: Release gem
-
-on:
-  workflow_dispatch:
-    inputs:
-      rubygems-otp-code:
-        description: RubyGems OTP code
-        required: true
-
-permissions:
-  contents: write
-
-jobs:
-  release-gem:
-    runs-on: ubuntu-latest
-    env:
-      GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-      GEM_HOST_OTP_CODE: ${{ github.event.inputs.rubygems-otp-code }}
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0 # bundle exec rake release で git tag を見るため、tagをfetchするようにしている
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.1.1
-      - name: Bundle install
-        run: bundle install
-      - name: Setup git config # bundle exec rake release でgit tagが打たれていない場合、タグを打ってpushしてくれるため用意している
-        run: |
-          git config --global user.email "taka0125@gmail.com"
-          git config --global user.name "Takahiro Ooishi"
-      - name: Release gem
-        run: bundle exec rake release

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/Rakefile

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "google_spreadsheet_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

@@ -1,8 +0,0 @@
-#!/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_fetcher.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'google_spreadsheet_fetcher/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "google_spreadsheet_fetcher"
-  spec.version       = GoogleSpreadsheetFetcher::VERSION
-  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}
-  spec.homepage      = "https://github.com/taka0125/google_spreadsheet_fetcher"
-  spec.licenses      = ['MIT']
-
-  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