embulk-output-google_sheets_ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d69ca03f0c92a37fa74bd5ca901d64d00279fc76b600f65d9126bffc339993a7
-  data.tar.gz: 19a5c30537e2e4b0d5d43dab1455e4c88404d97d8ebabfbfb9b1621168be0436
+SHA1:
+  metadata.gz: 500291acae92860089b343c2e66eb086486618f7
+  data.tar.gz: 13410dd78807a8c274077e8bdb08993617d2c657
 SHA512:
-  metadata.gz: 01bb9447433ec9d61dd7e5722bf8879f3e503f16c46d95a57bfddc18e1110c22ae285c03cb540afe30cc877d4e8c5d2df4567565ce64716e4aad6fae249d7572
-  data.tar.gz: d5f2bb8960981e2f5724ea593161bd642cd51e72582191b93637c1fb18f12656b20e0ad009bd13faa8999d78ade17d6dc05a21a823f2aad19a8baa902d1a6bcd
+  metadata.gz: c19e4bc6ffcf5d5a9f0e7d2e36361eb94a207242bd54338c9508ab293160b4832f1453dd8a7f2fc68438e795789c469eed8e3aa5659ed49a66914bd30a2a2278
+  data.tar.gz: 1b1944d8bec7627980219198bb36d8ceea9aabb96e32b6200edce8fb3d96017d2cb079711a77310c7580c6d1368583292b8fd7378a4ebf27abe66907cd0b0c15

data/.gitignore

@@ -3,4 +3,6 @@
 /tmp/
 /.bundle/
 /Gemfile.lock
-/vendor/
+/vendor/
+
+authorized_user_credentials.json

data/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org/'
 gemspec
+
+gem "highline"

data/README.md

@@ -4,15 +4,46 @@ Dumps records to Google Sheets.
 
 ## Overview
 
-* **Plugin type**: output
-* **Load all or nothing**: yes
-* **Resume supported**: no
-* **Cleanup supported**: no
+- **Plugin type**: output
+- **Load all or nothing**: yes
+- **Resume supported**: no
+- **Cleanup supported**: no
 
 ## Configuration
 
-- **spreadsheet_id**: Spreadsheet ID (string, required)
-- **credentials_path**: Credentials JSON path (string, default: `"credentials.json"`)
+| name             | type   | requirement | default              | description                            |
+| :--------------- | :----- | :---------- | :------------------- | :------------------------------------- |
+| spreadsheet_id   | string | required    |                      |                                        |
+| credentials_path | string | optional    | `"credentials.json"` | keyfile path                           |
+| range            | string | optional    | `"A1"`               |                                        |
+| auth_method      | string | optional    | `service_account`    | `service_account` or `authorized_user` |
+
+##### about credentials_path
+
+- if `auth_method` is `service_account`, set the service account credential json file path.
+- if `auth_method` is `authorized_user`, this plugin supposes the format is the below.
+  https://github.com/medjed/embulk-input-google_spreadsheets#prepare-json-file-for-auth_method-authorized_user
+
+```json
+{
+  "client_id": "xxxxxxxxxxx.apps.googleusercontent.com",
+  "client_secret": "xxxxxxxxxxx",
+  "refresh_token": "xxxxxxxxxxx"
+}
+```
+
+## Prepare JSON file for auth_method: authorized_user
+
+You may use [example/setup_authorized_user_credentials.rb](example/setup_authorized_user_credentials.rb) to prepare OAuth token.
+
+Go to GCP console > API Manager > Credentials > Create 'OAuth Client ID'. Get the client id and client secret.
+
+Run `setup_authorized_user_credentials.rb` to get `refresh_token`.
+
+```
+bundle --path vendor/bundle
+bundle exec ruby example/setup_authorized_user_credentials.rb
+```
 
 ## Example
 
@@ -24,6 +55,18 @@ out:
   range: A1
 ```
 
+## Prepare JSON file for auth_method: authorized_user
+
+You may use [example/setup_authorized_user_credentials.rb](example/setup_authorized_user_credentials.rb) to prepare OAuth token.
+
+Go to GCP console > API Manager > Credentials > Create 'OAuth Client ID'. Get the client id and client secret.
+
+Run `setup_authorized_user_credentials.rb` to get `refresh_token`.
+
+```
+bundle --path vendor/bundle
+bundle exec ruby example/setup_authorized_user_credentials.rb
+```
 
 ## Build
 

data/embulk-output-google_sheets_ruby.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'embulk-output-google_sheets_ruby'
-  spec.version       = '0.1.0'
+  spec.version       = '0.1.1'
   spec.authors       = ['ariarijp']
   spec.summary       = 'Google Sheets Ruby output plugin for Embulk'
   spec.description   = 'Dumps records to Google Sheets.'

data/example/setup_authorized_user_credentials.rb

@@ -0,0 +1,34 @@
+require 'googleauth'
+require 'google/apis/sheets_v4'
+require 'highline/import'
+require 'json'
+
+puts 'Before setup, open this page https://developers.google.com/identity/protocols/OAuth2'
+puts 'then get OAuth 2.0 credentials such as a client ID and client secret according to the above page.'
+puts
+
+credentials = Google::Auth::UserRefreshCredentials.new(
+  client_id: ask('Enter client_id: '),
+  client_secret: ask('Enter client_secret: '),
+  scope: Google::Apis::SheetsV4::AUTH_SPREADSHEETS,
+  redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
+)
+
+credentials.code = ask(
+  "1. Open this page '#{credentials.authorization_uri.to_s}'.\n" \
+  '2. Enter the authorization code shown in the page: '
+) {|q| q.echo = false}
+
+credentials.fetch_access_token!
+
+data = {
+  client_id: credentials.client_id,
+  client_secret: credentials.client_secret,
+  refresh_token: credentials.refresh_token,
+}.to_json
+file = File.expand_path('authorized_user_credentials.json', __dir__)
+File.open(file, 'w') do |f|
+  f.write(data)
+end
+
+puts "Success. See '#{file}'."

data/lib/embulk/output/google_sheets_ruby.rb

@@ -17,7 +17,8 @@ module Embulk
           'range' => config.param('range', :string, default: 'A1'),
           'credentials_path' => config.param('credentials_path',
                                              :string,
-                                             default: 'credentials.json')
+                                             default: 'credentials.json'),
+          'auth_method' => config.param('auth_method', :string, default: 'service_account')
         }
 
         yield(task)
@@ -29,6 +30,7 @@ module Embulk
         @spreadsheet_id = task['spreadsheet_id']
         @credentials_path = task['credentials_path']
         @range = task['range']
+        @auth_method = task['auth_method']
         @rows = []
         @rows << schema.map(&:name)
 
@@ -55,13 +57,20 @@ module Embulk
       end
 
       def authorize
-        authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
-          json_key_io: File.open(@credentials_path),
-          scope: SCOPE
-        )
-        authorizer.fetch_access_token!
-
-        authorizer
+        case @auth_method
+        when 'service_account'
+          return Google::Auth::ServiceAccountCredentials.make_creds(
+            json_key_io: File.open(@credentials_path),
+            scope: SCOPE
+            )
+        when 'authorized_user'
+          return Google::Auth::UserRefreshCredentials.make_creds(
+            json_key_io: File.open(@credentials_path),
+            scope: SCOPE
+            )
+        else
+          raise ConfigError.new("Unknown auth method: #{auth_method}")
+        end
       end
 
       def update_sheet(value_range)

metadata

@@ -1,66 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: embulk-output-google_sheets_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ariarijp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2019-08-01 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.8'
-  type: :runtime
+  name: google-api-client
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.6
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.6
 - !ruby/object:Gem::Dependency
-  name: embulk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.39
-  type: :development
+  name: embulk
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.39
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,12 +80,13 @@ files:
 - README.md
 - Rakefile
 - embulk-output-google_sheets_ruby.gemspec
+- example/setup_authorized_user_credentials.rb
 - lib/embulk/output/google_sheets_ruby.rb
 homepage: https://github.com/ariarijp/embulk-output-google_sheets_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,9 +101,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
 specification_version: 4
 summary: Google Sheets Ruby output plugin for Embulk
 test_files: []