Class: GoogleDrive::Session

Inherits:
Object
  • Object
show all
Extended by:
Util
Includes:
Util
Defined in:
lib/google_drive/session.rb

Overview

A session for Google Drive operations.

Use from_credentials, from_access_token, from_service_account_key or from_config class method to construct a GoogleDrive::Session object.

Constant Summary collapse

DEFAULT_SCOPE = 
[
  'https://www.googleapis.com/auth/drive',
  'https://spreadsheets.google.com/feeds/'
].freeze

Constants included from Util

Util::EXT_TO_CONTENT_TYPE, Util::IMPORTABLE_CONTENT_TYPE_MAP

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

concat_url, construct_and_query, construct_query, convert_params, delegate_api_methods, encode_query, get_singleton_class, h

Constructor Details

#initialize(credentials_or_access_token, proxy = nil, client_options = nil, request_options = nil) ⇒ Session

Returns a new instance of Session.



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/google_drive/session.rb', line 181

def initialize(
    credentials_or_access_token, proxy = nil, client_options = nil,
    request_options = nil
)
  if proxy
    raise(
      ArgumentError,
      'Specifying a proxy object is no longer supported. ' \
      'Set ENV["http_proxy"] instead.'
    )
  end

  if credentials_or_access_token
    if credentials_or_access_token.is_a?(String)
      credentials = AccessTokenCredentials.new(credentials_or_access_token)
    # Equivalent of credentials_or_access_token.is_a?(OAuth2::AccessToken),
    # without adding dependency to "oauth2" library.
    elsif credentials_or_access_token
          .class
          .ancestors
          .any? { |m| m.name == 'OAuth2::AccessToken' }
      credentials =
        AccessTokenCredentials.new(credentials_or_access_token.token)
    else
      credentials = credentials_or_access_token
    end
    @fetcher = ApiClientFetcher.new(
      credentials, client_options, request_options
    )
  else
    @fetcher = nil
  end
end

Instance Attribute Details

#on_auth_fail ⇒ Object

Proc or Method called when authentication has failed. When this function returns true, it tries again.



217
218
219
 
# File 'lib/google_drive/session.rb', line 217

def on_auth_fail
  @on_auth_fail
end

Class Method Details

.from_access_token(access_token, client_options = nil, request_options = nil) ⇒ Object

Constructs a GoogleDrive::Session object from OAuth2 access token string.

See from_config documentation for an explanation of client_options and request_options.



64
65
66
 
# File 'lib/google_drive/session.rb', line 64

def self.from_access_token(access_token, client_options = nil, request_options = nil)
  Session.new(access_token, nil, client_options, request_options)
end

.from_config(config, options = {}) ⇒ Object

Returns GoogleDrive::Session constructed from a config JSON file at config, potenially modified with options.

config is the path to the config file.

This will prompt the credential via command line for the first time and save it to config for later usages.

See github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md for a usage example.

You can also provide a config object that must respond to:

client_id
client_secret
refesh_token
refresh_token=
scope
scope=
save

options is a hash which may contain the following keys:

client_secret: if present, this will overwrite config.client_secret
client_id: if present, this will overwrite config.client_id
client_options: a hash or ::Google::Apis::ClientOptions. See
  https://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/ClientOptions
  for an explanation of legal sub-fields.
request_options: a hash or ::Google::Apis::RequestOptions. See
  https://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/RequestOptions
  for an explanation of legal sub-fields.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/google_drive/session.rb', line 126

def self.from_config(config, options = {})
  if config.is_a?(String)
    config_path = config
    config = Config.new(config_path)
    if config.type == 'service_account'
      return (
        config_path, options[:scope] || DEFAULT_SCOPE, options[:client_options],
        options[:request_options]
      )
    end
  end

  config.scope ||= DEFAULT_SCOPE

  if options[:client_id] && options[:client_secret]
    config.client_id = options[:client_id]
    config.client_secret = options[:client_secret]
  end
  if !config.client_id || !config.client_secret
    raise(
      ArgumentError,
      'client_id or client_secret is missing in the config. Follow ' \
      'https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md ' \
      'to provide a valid config. google_drive library no longer provides ' \
      'the default credential due to a limitation of Google API.'
    )
  end

  credentials = Google::Auth::UserRefreshCredentials.new(
    client_id: config.client_id,
    client_secret: config.client_secret,
    scope: config.scope,
    redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
  )

  if config.refresh_token
    credentials.refresh_token = config.refresh_token
    credentials.fetch_access_token!
  else
    $stderr.print(
      format("\n1. Open this page:\n%s\n\n", credentials.authorization_uri)
    )
    $stderr.print('2. Enter the authorization code shown in the page: ')
    credentials.code = $stdin.gets.chomp
    credentials.fetch_access_token!
    config.refresh_token = credentials.refresh_token
  end

  config.save

  Session.new(
    credentials, nil, options[:client_options], options[:request_options]
  )
end

.from_credentials(credentials, client_options = nil, request_options = nil) ⇒ Object

Constructs a GoogleDrive::Session object from OAuth2 credentials such as Google::Auth::UserRefreshCredentials.

See github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md for a usage example.

See from_config documentation for an explanation of client_options and request_options.



56
57
58
 
# File 'lib/google_drive/session.rb', line 56

def self.from_credentials(credentials, client_options = nil, request_options = nil)
  Session.new(credentials, nil, client_options, request_options)
end

.from_service_account_key(json_key_path_or_io, scope = DEFAULT_SCOPE, client_options = nil, request_options = nil) ⇒ Object

Constructs a GoogleDrive::Session object from a service account key JSON.

You can pass either the path to a JSON file, or an IO-like object with the JSON.

See github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md for a usage example.

As with from_config, you can configure Google API client behavior with client_options and request_options. Unlike in from_config, these are passed as positional arguments.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/google_drive/session.rb', line 80

def self.(
    json_key_path_or_io, scope = DEFAULT_SCOPE, client_options = nil,
    request_options = nil
)
  if json_key_path_or_io.is_a?(String)
    open(json_key_path_or_io) do |f|
      (f, scope, client_options, request_options)
    end
  else
    credentials = Google::Auth::ServiceAccountCredentials.make_creds(
      json_key_io: json_key_path_or_io, scope: scope
    )
    Session.new(credentials, nil, client_options, request_options)
  end
end

.login_with_oauth(credentials_or_access_token, proxy = nil) ⇒ Object

Equivalent of either from_credentials or from_access_token.



38
39
40
 
# File 'lib/google_drive/session.rb', line 38

def self.(credentials_or_access_token, proxy = nil)
  Session.new(credentials_or_access_token, proxy)
end

.new_dummy ⇒ Object

Creates a dummy GoogleDrive::Session object for testing.



43
44
45
 
# File 'lib/google_drive/session.rb', line 43

def self.new_dummy
  Session.new(nil)
end

Instance Method Details

#collection_by_id(id) ⇒ Object Also known as: folder_by_id

Returns GoogleDrive::Collection with given id.

e.g.

# https://drive.google.com/drive/folders/1rPPuzAew4tO3ORc88Vz1JscPCcnrX7-J
session.collection_by_id("1rPPuzAew4tO3ORc88Vz1JscPCcnrX7-J")



466
467
468
469
470
471
472
473
474
475
 
# File 'lib/google_drive/session.rb', line 466

def collection_by_id(id)
  file = file_by_id(id)
  unless file.is_a?(Collection)
    raise(
      GoogleDrive::Error,
      format('The file with the ID is not a folder: %s', id)
    )
  end
  file
end

#collection_by_title(title) ⇒ Object Also known as: folders_by_name

Returns a top-level folder whose title exactly matches title as GoogleDrive::Collection. Returns nil if not found. If multiple folders with the title are found, returns one of them.



433
434
435
 
# File 'lib/google_drive/session.rb', line 433

def collection_by_title(title)
  root_collection.subcollection_by_title(title)
end

#collection_by_url(url) ⇒ Object Also known as: folder_by_url

Returns GoogleDrive::Collection with given url.

You must specify the URL of the page you get when you go to drive.google.com/ with your browser and open a folder.

e.g.

session.collection_by_url(
  "https://drive.google.com/drive/folders/" \
  "1u99gpfHIk08RVK5q_vXxUqkxR1r6FUJH")



448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google_drive/session.rb', line 448

def collection_by_url(url)
  file = file_by_url(url)
  unless file.is_a?(Collection)
    raise(
      GoogleDrive::Error,
      format('The file with the URL is not a folder: %s', url)
    )
  end
  file
end

#collections(params = {}, &block) ⇒ Object Also known as: folders

Returns the top-level folders (direct children of the root folder).

By default, it returns the first 100 folders. See document of files method for how to get all folders.



423
424
425
 
# File 'lib/google_drive/session.rb', line 423

def collections(params = {}, &block)
  root_collection.subcollections(params, &block)
end

#create_collection(title, file_properties = {}) ⇒ Object Also known as: create_folder

Creates a top-level folder with given title. Returns GoogleDrive::Collection object.



481
482
483
 
# File 'lib/google_drive/session.rb', line 481

def create_collection(title, file_properties = {})
  create_file(title, file_properties.merge(mime_type: 'application/vnd.google-apps.folder'))
end

#create_file(title, file_properties = {}) ⇒ Object

Creates a file with given title and properties. Returns objects with the following types: GoogleDrive::Spreadsheet, GoogleDrive::File, GoogleDrive::Collection

You can pass a MIME Type using the file_properties-function parameter, for example: create_file(‘Document Title’, mime_type: ‘application/vnd.google-apps.document’)

A list of available Drive MIME Types can be found here: developers.google.com/drive/v3/web/mime-types



505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google_drive/session.rb', line 505

def create_file(title, file_properties = {})
  file_metadata = {
    name: title,
  }.merge(file_properties)

  file = drive_service.create_file(
    file_metadata, fields: '*', supports_all_drives: true
  )

  wrap_api_file(file)
end

#create_spreadsheet(title = 'Untitled', file_properties = {}) ⇒ Object

Creates a spreadsheet with given title. Returns GoogleDrive::Spreadsheet object.

e.g.

session.create_spreadsheet("My new sheet")



492
493
494
 
# File 'lib/google_drive/session.rb', line 492

def create_spreadsheet(title = 'Untitled', file_properties = {})
  create_file(title, file_properties.merge(mime_type: 'application/vnd.google-apps.spreadsheet'))
end

#drive_service ⇒ Object Also known as: drive

Returns an instance of Google::Apis::DriveV3::DriveService.



220
221
222
 
# File 'lib/google_drive/session.rb', line 220

def drive_service
  @fetcher.drive
end

#execute_paged!(opts, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/google_drive/session.rb', line 588

def execute_paged!(opts, &block)
  if block
    page_token = nil
    loop do
      parameters =
        (opts[:parameters] || {}).merge(page_token: page_token)
      (items, page_token) =
        execute_paged!(opts.merge(parameters: parameters))
      items.each(&block)
      break unless page_token
    end

  elsif opts[:parameters] && opts[:parameters].key?(:page_token)
    response = opts[:method].call(**opts[:parameters])
    items    = response.__send__(opts[:items_method_name]).map do |item|
      opts[:converter] ? opts[:converter].call(item) : item
    end
    [items, response.next_page_token]

  else
    parameters = (opts[:parameters] || {}).merge(page_token: nil)
    (items,) = execute_paged!(opts.merge(parameters: parameters))
    items
  end
end

#file_by_id(id) ⇒ Object

Returns a file (including a spreadsheet and a folder) with a given id.

Returns an instance of GoogleDrive::File or its subclass (GoogleDrive::Spreadsheet, GoogleDrive::Collection).



287
288
289
290
 
# File 'lib/google_drive/session.rb', line 287

def file_by_id(id)
  api_file = drive_service.get_file(id, fields: '*', supports_all_drives: true)
  wrap_api_file(api_file)
end

#file_by_title(title) ⇒ Object Also known as: file_by_name

Returns a file (including a spreadsheet and a folder) whose title exactly matches title.

Returns an instance of GoogleDrive::File or its subclass (GoogleDrive::Spreadsheet, GoogleDrive::Collection). Returns nil if not found. If multiple files with the title are found, returns one of them.

If given an Array, traverses folders by title. e.g.:

session.file_by_title(
  ["myfolder", "mysubfolder/even/w/slash", "myfile"])



273
274
275
276
277
278
279
 
# File 'lib/google_drive/session.rb', line 273

def file_by_title(title)
  if title.is_a?(Array)
    root_collection.file_by_title(title)
  else
    files(q: ['name = ?', title], page_size: 1)[0]
  end
end

#file_by_url(url) ⇒ Object

Returns a file (including a spreadsheet and a folder) with a given url. url must be the URL of the page you open to access a document/spreadsheet in your browser.

Returns an instance of GoogleDrive::File or its subclass (GoogleDrive::Spreadsheet, GoogleDrive::Collection).



298
299
300
 
# File 'lib/google_drive/session.rb', line 298

def file_by_url(url)
  file_by_id(url_to_id(url))
end

#files(params = {}, &block) ⇒ Object

Returns list of files for the user as array of GoogleDrive::File or its subclass. You can specify parameters documented at developers.google.com/drive/v3/web/search-parameters

e.g.

session.files
session.files(q: "name = 'hoge'")
# Same as above with a placeholder
session.files(q: ["name = ?", "hoge"])

By default, it returns the first 100 files. You can get all files by calling with a block:

session.files do |file|
  p file
end

Or passing “pageToken” parameter:

page_token = nil
begin
  (files, page_token) = session.files(page_token: page_token)
  p files
end while page_token



252
253
254
255
256
257
258
259
260
261
 
# File 'lib/google_drive/session.rb', line 252

def files(params = {}, &block)
  params = convert_params(params)
  execute_paged!(
    method: drive_service.method(:list_files),
    parameters: { fields: '*', supports_all_drives: true, include_items_from_all_drives: true }.merge(params),
    items_method_name: :files,
    converter: proc { |af| wrap_api_file(af) },
    &block
  )
end

#inspect ⇒ Object 



646
647
648
 
# File 'lib/google_drive/session.rb', line 646

def inspect
  format('#<%p:0x%x>', self.class, object_id)
end

#request(method, url, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/google_drive/session.rb', line 615

def request(method, url, params = {})
  # Always uses HTTPS.
  url           = url.gsub(%r{^http://}, 'https://')
  data          = params[:data]
  auth          = params[:auth] || :wise
  response_type = params[:response_type] || :xml

  extra_header = if params[:header]
                   params[:header]
                 elsif data
                   {
                     'Content-Type' => 'application/atom+xml;charset=utf-8'
                   }
                 else
                   {}
                 end
  extra_header = { 'GData-Version' => '3.0' }.merge(extra_header)

  loop do
    response = @fetcher.request_raw(method, url, data, extra_header, auth)
    next if response.code == '401' && @on_auth_fail && @on_auth_fail.call
    unless response.code =~ /^2/
      raise(
        (response.code == '401' ? AuthenticationError : ResponseCodeError)
          .new(response.code, response.body, method, url)
      )
    end
    return convert_response(response, response_type)
  end
end

#root_collection ⇒ Object Also known as: root_folder

Returns the root folder.



413
414
415
 
# File 'lib/google_drive/session.rb', line 413

def root_collection
  @root_collection ||= file_by_id('root')
end

#sheets_service ⇒ Object

Returns an instance of Google::Apis::SheetsV4::SheetsService.



227
228
229
 
# File 'lib/google_drive/session.rb', line 227

def sheets_service
  @fetcher.sheets
end

#spreadsheet_by_key(key) ⇒ Object

Returns GoogleDrive::Spreadsheet with given key.

e.g.

# https://docs.google.com/spreadsheets/d/1L3-kvwJblyW_TvjYD-7pE-AXxw5_bkb6S_MljuIPVL0/edit
session.spreadsheet_by_key(
  "1L3-kvwJblyW_TvjYD-7pE-AXxw5_bkb6S_MljuIPVL0")



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/google_drive/session.rb', line 332

def spreadsheet_by_key(key)
  file = file_by_id(key)
  unless file.is_a?(Spreadsheet)
    raise(
      GoogleDrive::Error,
      format('The file with the ID is not a spreadsheet: %s', key)
    )
  end
  file
end

#spreadsheet_by_title(title) ⇒ Object Also known as: spreadsheet_by_name

Returns GoogleDrive::Spreadsheet with given title. Returns nil if not found. If multiple spreadsheets with the title are found, returns one of them.



366
367
368
 
# File 'lib/google_drive/session.rb', line 366

def spreadsheet_by_title(title)
  spreadsheets(q: ['name = ?', title], page_size: 1)[0]
end

#spreadsheet_by_url(url) ⇒ Object

Returns GoogleDrive::Spreadsheet with given url. You must specify either of:

  • URL of the page you open to access the spreadsheet in your browser

  • URL of worksheet-based feed of the spreadseet

e.g.

session.spreadsheet_by_url(
  "https://docs.google.com/spreadsheets/d/" \
  "1L3-kvwJblyW_TvjYD-7pE-AXxw5_bkb6S_MljuIPVL0/edit")



352
353
354
355
356
357
358
359
360
361
 
# File 'lib/google_drive/session.rb', line 352

def spreadsheet_by_url(url)
  file = file_by_url(url)
  unless file.is_a?(Spreadsheet)
    raise(
      GoogleDrive::Error,
      format('The file with the URL is not a spreadsheet: %s', url)
    )
  end
  file
end

#spreadsheets(params = {}, &block) ⇒ Object

Returns list of spreadsheets for the user as array of GoogleDrive::Spreadsheet. You can specify parameters documented at developers.google.com/drive/v3/web/search-parameters

e.g.

session.spreadsheets
session.spreadsheets(q: "name = 'hoge'")
# Same as above with a placeholder
session.spreadsheets(q: ["name = ?", "hoge"])

By default, it returns the first 100 spreadsheets. See document of files method for how to get all spreadsheets.



315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google_drive/session.rb', line 315

def spreadsheets(params = {}, &block)
  params = convert_params(params)
  query  = construct_and_query(
    [
      "mimeType = 'application/vnd.google-apps.spreadsheet'",
      params[:q]
    ]
  )
  files(params.merge(q: query), &block)
end

#upload_from_file(path, title = nil, params = {}) ⇒ Object

Uploads a local file. Returns a GoogleSpreadsheet::File object.

e.g.

# Uploads a text file and converts to a Google Docs document:
session.upload_from_file("/path/to/hoge.txt")

# Uploads without conversion:
session.upload_from_file("/path/to/hoge.txt", "Hoge", convert: false)

# Uploads with explicit content type:
session.upload_from_file(
  "/path/to/hoge", "Hoge", content_type: "text/plain")

# Uploads a text file and converts to a Google Spreadsheet:
session.upload_from_file("/path/to/hoge.csv", "Hoge")
session.upload_from_file(
  "/path/to/hoge", "Hoge", content_type: "text/csv")



556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/google_drive/session.rb', line 556

def upload_from_file(path, title = nil, params = {})
  # TODO: Add a feature to upload to a folder.
  file_name = ::File.basename(path)
  default_content_type =
    EXT_TO_CONTENT_TYPE[::File.extname(file_name).downcase] ||
    'application/octet-stream'
  upload_from_source(
    path,
    title || file_name,
    { content_type: default_content_type }.merge(params)
  )
end

#upload_from_io(io, title = 'Untitled', params = {}) ⇒ Object

Uploads a file. Reads content from io. Returns a GoogleDrive::File object.



571
572
573
 
# File 'lib/google_drive/session.rb', line 571

def upload_from_io(io, title = 'Untitled', params = {})
  upload_from_source(io, title, params)
end

#upload_from_string(content, title = 'Untitled', params = {}) ⇒ Object

Uploads a file with the given title and content. Returns a GoogleSpreadsheet::File object.

e.g.

# Uploads and converts to a Google Docs document:
session.upload_from_string(
    "Hello world.", "Hello", content_type: "text/plain")

# Uploads without conversion:
session.upload_from_string(
    "Hello world.", "Hello", content_type: "text/plain", convert: false)

# Uploads and converts to a Google Spreadsheet:
session.upload_from_string(
  "hoge\tfoo\n", "Hoge", content_type: "text/tab-separated-values")
session.upload_from_string(
  "hoge,foo\n", "Hoge", content_type: "text/tsv")



534
535
536
 
# File 'lib/google_drive/session.rb', line 534

def upload_from_string(content, title = 'Untitled', params = {})
  upload_from_source(StringIO.new(content), title, params)
end

#worksheet_by_url(url) ⇒ Object

Returns GoogleDrive::Worksheet with given url. You must specify URL of either worksheet feed or cell-based feed of the worksheet.

e.g.:

# Worksheet feed URL
session.worksheet_by_url(
  "https://spreadsheets.google.com/feeds/worksheets/" \
  "1smypkyAz4STrKO4Zkos5Z4UPUJKvvgIza32LnlQ7OGw/private/full/od7")
# Cell-based feed URL
session.worksheet_by_url(
  "https://spreadsheets.google.com/feeds/cells/" \
  "1smypkyAz4STrKO4Zkos5Z4UPUJKvvgIza32LnlQ7OGw/od7/private/full")



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/google_drive/session.rb', line 385

def worksheet_by_url(url)
  case url
  when %r{^https?://spreadsheets.google.com/feeds/worksheets/(.*)/.*/full/(.*)$}
    spreadsheet_id = Regexp.last_match(1)
    worksheet_feed_id = Regexp.last_match(2)
  when %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full(\?.*)?$}
    spreadsheet_id = Regexp.last_match(1)
    worksheet_feed_id = Regexp.last_match(2)
  else
    raise(
      GoogleDrive::Error,
      'URL is neither a worksheet feed URL nor a cell-based feed URL: ' \
      "#{url}"
    )
  end

  spreadsheet = spreadsheet_by_key(spreadsheet_id)
  worksheet = spreadsheet.worksheets.find{ |ws| ws.worksheet_feed_id == worksheet_feed_id }
  unless worksheet
    raise(
      GoogleDrive::Error,
      "Worksheet not found for the given URL: #{url}"
    )
  end
  worksheet
end

#wrap_api_file(api_file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



576
577
578
579
580
581
582
583
584
585
 
# File 'lib/google_drive/session.rb', line 576

def wrap_api_file(api_file)
  case api_file.mime_type
  when 'application/vnd.google-apps.folder'
    Collection.new(self, api_file)
  when 'application/vnd.google-apps.spreadsheet'
    Spreadsheet.new(self, api_file)
  else
    File.new(self, api_file)
  end
end