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/'
]

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) ⇒ Session

Returns a new instance of Session


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/google_drive/session.rb', line 134

def initialize(credentials_or_access_token, proxy = nil)
  if proxy
    fail(
      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)
  else
    @fetcher = nil
  end
end

Instance Attribute Details

#on_auth_failObject

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


159
160
161
# File 'lib/google_drive/session.rb', line 159

def on_auth_fail
  @on_auth_fail
end

Class Method Details

.from_access_token(access_token) ⇒ Object

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


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

def self.from_access_token(access_token)
  Session.new(access_token)
end

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

Returns GoogleDrive::Session constructed from a config JSON file at config.

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

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/google_drive/session.rb', line 94

def self.from_config(config, options = {})
  if config.is_a?(String)
    config = Config.new(config)
  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
    config.client_id = '452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com'
    config.client_secret = '1U3-Krii5x1oLPrwD5zgn-ry'
  elsif !config.client_id || !config.client_secret
    fail(ArgumentError, 'client_id and client_secret must be both specified or both omitted')
  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("\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)
end

.from_credentials(credentials) ⇒ 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.


51
52
53
# File 'lib/google_drive/session.rb', line 51

def self.from_credentials(credentials)
  Session.new(credentials)
end

.from_service_account_key(json_key_path_or_io, scope = DEFAULT_SCOPE) ⇒ 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.


65
66
67
68
69
70
71
72
73
74
75
# File 'lib/google_drive/session.rb', line 65

def self.(json_key_path_or_io, scope = DEFAULT_SCOPE)
  if json_key_path_or_io.is_a?(String)
    open(json_key_path_or_io) do |f|
      (f, scope)
    end
  else
    credentials = Google::Auth::ServiceAccountCredentials.make_creds(
        json_key_io: json_key_path_or_io, scope: scope)
    Session.new(credentials)
  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_dummyObject

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_title(title) ⇒ Object

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


333
334
335
# File 'lib/google_drive/session.rb', line 333

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

#collection_by_url(url) ⇒ Object

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

  • URL of the page you get when you go to docs.google.com/ with your browser and open a collection

  • URL of collection (folder) feed

e.g.

session.collection_by_url(
  "https://drive.google.com/#folders/" +
  "0B9GfDpQ2pBVUODNmOGE0NjIzMWU3ZC00NmUyLTk5NzEtYaFkZjY1MjAyxjMc")
session.collection_by_url(
  "http://docs.google.com/feeds/default/private/full/folder%3A" +
  "0B9GfDpQ2pBVUODNmOGE0NjIzMWU3ZC00NmUyLTk5NzEtYaFkZjY1MjAyxjMc")

350
351
352
353
354
355
356
# File 'lib/google_drive/session.rb', line 350

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

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

Returns the top-level collections (direct children of the root collection).

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


325
326
327
# File 'lib/google_drive/session.rb', line 325

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

#create_spreadsheet(title = 'Untitled') ⇒ Object

Creates new spreadsheet and returns the new GoogleDrive::Spreadsheet.

e.g.

session.create_spreadsheet("My new sheet")

362
363
364
365
366
367
368
369
# File 'lib/google_drive/session.rb', line 362

def create_spreadsheet(title = 'Untitled')
   = {
    name:    title,
    mime_type: 'application/vnd.google-apps.spreadsheet'
  }
  file = self.drive.create_file(, fields: '*')
  wrap_api_file(file)
end

#driveObject

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


162
163
164
# File 'lib/google_drive/session.rb', line 162

def drive
  @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.


437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
# File 'lib/google_drive/session.rb', line 437

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
    return [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).


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

def file_by_id(id)
  api_file = self.drive.get_file(id, fields: '*')
  wrap_api_file(api_file)
end

#file_by_title(title) ⇒ Object

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 collections by title. e.g.

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

203
204
205
206
207
208
209
# File 'lib/google_drive/session.rb', line 203

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 eitehr of:

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

  • URL of worksheet-based feed of a spreadseet

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


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

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'")
session.files(q: ["name = ?", "hoge"])  # Same as above with a placeholder

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

185
186
187
188
189
190
191
192
193
# File 'lib/google_drive/session.rb', line 185

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

#inspectObject


489
490
491
# File 'lib/google_drive/session.rb', line 489

def inspect
  '#<%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.


462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# File 'lib/google_drive/session.rb', line 462

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

  if params[:header]
    extra_header = params[:header]
  elsif data
    extra_header = { 'Content-Type' => 'application/atom+xml;charset=utf-8' }
  else
    extra_header = {}
  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/
      fail((response.code == '401' ? AuthenticationError : ResponseCodeError)
             .new(response.code, response.body, method, url))
    end
    return convert_response(response, response_type)
  end
end

#root_collectionObject

Returns the root collection.


317
318
319
# File 'lib/google_drive/session.rb', line 317

def root_collection
  @root_collection ||= file_by_id('root')
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")

256
257
258
259
260
261
262
# File 'lib/google_drive/session.rb', line 256

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

#spreadsheet_by_title(title) ⇒ Object

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


285
286
287
# File 'lib/google_drive/session.rb', line 285

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")
session.spreadsheet_by_url(
  "https://spreadsheets.google.com/feeds/" +
  "worksheets/1L3-kvwJblyW_TvjYD-7pE-AXxw5_bkb6S_MljuIPVL0/private/full")

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

def spreadsheet_by_url(url)
  file = file_by_url(url)
  unless file.is_a?(Spreadsheet)
    fail(GoogleDrive::Error, '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'")
session.spreadsheets(q: ["name = ?", "hoge"])  # Same as above with a placeholder

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


242
243
244
245
246
247
248
249
# File 'lib/google_drive/session.rb', line 242

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")

406
407
408
409
410
411
412
413
414
415
416
# File 'lib/google_drive/session.rb', line 406

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.


420
421
422
# File 'lib/google_drive/session.rb', line 420

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")

386
387
388
# File 'lib/google_drive/session.rb', line 386

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")

301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/google_drive/session.rb', line 301

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

  worksheet_feed_entry = request(:get, worksheet_feed_url)
  Worksheet.new(self, nil, worksheet_feed_entry)
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.


425
426
427
428
429
430
431
432
433
434
# File 'lib/google_drive/session.rb', line 425

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