Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 2.08 KB

MIGRATING.md

File metadata and controls

38 lines (23 loc) · 2.08 KB
Raw

Migrating from version 2.x.x

With version 3.x.x, google-drive-ruby switched from Google Sheets API V3 to V4. This causes some incompatibilities.

  • You now need to enable "Google Sheets API" in the API library page for your project if you use GoogleDrive::Spreadsheet or GoogleDrive::Worksheet.
  • There is no API change in google-drive-ruby. But some methods slighty changed their behavior:
    • GoogleDrive::Worksheet#updated now returns the time the spreadsheet was last updated, instead of the worksheet.
    • GoogleDrive::Worksheet#worksheet_feed_entry and GoogleDrive::Worksheet#cells_feed_url now requires additional network fetch because the library no longer depends on them. It is recommended to use GoogleDrive::Worksheet#properties instead.

Migrating from version 1.x.x

google-drive-ruby 1.x.x depends on google-api-client 0.8.x and Google Drive API V2.

google-drive-ruby 2.x.x and later depend on google-api-client 0.9.x or later and Google Drive API V3.

Each of them involves incompatible API changes. The users of google-drive-ruby may be affected by these changes.

Here are some changes likely affecting google-drive-ruby users:

If you pass an instance of Google::APIClient to GoogleDrive.login_with_oauth, it will no longer work, because Google::APIClient.new was removed. See Authorization document for new ways to pass credentials.

The field "title" in search queries was renamed to "name". e.g.,

session.files(q: "title = 'hoge'")

must be rewritten to:

session.files(q: "name = 'hoge'")

Migrating from version 0.x.x

Ver. 0.x.x no longer works, because the API used was deprecated and shut down. You need to migrate to ver. 1.x.x or later.

Ver. 1.x.x and later are not 100% backward compatible with 0.x.x. Some methods have been removed. Especially, GoogleDrive.login has been removed, and you must use OAuth. See Authorization document for details.