google_drive 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2752fea3fdb95778f8fc63299c853b2c59733db7
-  data.tar.gz: dabdc2d01823ea09bbb7a5c711b606ee99b9b55a
+  metadata.gz: 9f3de00c7d9e7589646ba3b4a85c5f94ffec2d2f
+  data.tar.gz: 09aea7b2c3900145d6415c6614f254ab347562c2
 SHA512:
-  metadata.gz: 6c14714081c816a87140ba645aad48076519cf7817f4d9ce606c5c09c0de682dc26db70a6b46e234b0789295a880e82bbb6af8d063b45cd34557897855a5d49b
-  data.tar.gz: 6a46e4256b8fe4f36e6bbaf1561c567ab2138ebf701121b73441c238f471dccddcfb708b125a4edd6e9ba6db510e75805ba0a1e49bfb8963830901c46e9e7f84
+  metadata.gz: d8357b2b90f33bc5a655904983a2ee77e46c768142ddc0e3ead86c313938a100992d89c2ee02f6d9a1e58ff696829f541859a1a9d7bf5741e0a51d7d6c05864b
+  data.tar.gz: f4aed23d0b698072149e54ac154667a4ea78eceaa19364962a89431035aa6131fdae58b1f83a5494431499c8d08a218dc4efce5f50f874692ea13d55fb423a5c

data/README.md

@@ -0,0 +1,139 @@
+This is a Ruby library to read/write files/spreadsheets in Google Drive/Docs.
+
+NOTE: This is NOT a library to create Google Drive App.
+
+
+## Migration from ver. 0.x.x / 1.x.x to to ver. 2.x.x
+
+There are some incompatible API changes. See
+[MIGRATING.md](https://github.com/gimite/google-drive-ruby/blob/master/MIGRATING.md).
+
+
+## How to install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google_drive'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install google_drive
+```
+
+If you need system wide installation, execute below:
+
+```
+$ sudo gem install google_drive
+```
+
+## How to use
+
+First, follow Step 1 and 2 of "Authorizing requests with OAuth 2.0" in [this
+page](https://developers.google.com/drive/v3/web/about-auth) to get a client
+ID and client secret for OAuth. Set "Application type" to "Other" in the form
+to create a client ID if you use GoogleDrive.saved_session method as in the
+example below.
+
+Next, create a file config.json which contains the client ID and crient secret
+you got above, which looks like:
+
+```json
+{
+  "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+  "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
+}
+```
+
+Note that when using the OAuth flow, the client will be able to access all files
+belonging to the the user who generated the token. To set permissions more
+specifically, you may want to consider using a service account.  [See full docs 
+in the login_with_oauth method.](https://github.com/gimite/google-drive-ruby/blob/lib/google_drive.rb)
+
+### Example to read/write files in Google Drive:
+
+```ruby
+require "google_drive"
+
+# Creates a session. This will prompt the credential via command line for the
+# first time and save it to config.json file for later usages.
+session = GoogleDrive.saved_session("config.json")
+
+# Gets list of remote files.
+session.files.each do |file|
+  p file.title
+end
+
+# Uploads a local file.
+session.upload_from_file("/path/to/hello.txt", "hello.txt", convert: false)
+
+# Downloads to a local file.
+file = session.file_by_title("hello.txt")
+file.download_to_file("/path/to/hello.txt")
+
+# Updates content of the remote file.
+file.update_from_file("/path/to/hello.txt")
+```
+
+### Example to read/write spreadsheets:
+
+```ruby
+require "google_drive"
+
+# Creates a session. This will prompt the credential via command line for the
+# first time and save it to config.json file for later usages.
+session = GoogleDrive.saved_session("config.json")
+
+# First worksheet of
+# https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg
+# Or https://docs.google.com/a/someone.com/spreadsheets/d/pz7XtlQC-PYx-jrVMJErTcg/edit?usp=drive_web
+ws = session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg").worksheets[0]
+
+# Gets content of A2 cell.
+p ws[2, 1]  #==> "hoge"
+
+# Changes content of cells.
+# Changes are not sent to the server until you call ws.save().
+ws[2, 1] = "foo"
+ws[2, 2] = "bar"
+ws.save
+
+# Dumps all cells.
+(1..ws.num_rows).each do |row|
+  (1..ws.num_cols).each do |col|
+    p ws[row, col]
+  end
+end
+
+# Yet another way to do so.
+p ws.rows  #==> [["fuga", ""], ["foo", "bar]]
+
+# Reloads the worksheet to get changes by other clients.
+ws.reload
+```
+
+## Full API documentation
+
+[API documentation in RubyDoc.info](http://www.rubydoc.info/gems/google_drive)
+
+## Source code
+
+[Github](http://github.com/gimite/google-drive-ruby)
+
+The license of this source is "New BSD Licence"
+
+## Supported environments
+
+Ruby 2.0.0 or later. Checked with Ruby 2.3.0.
+
+## Author
+
+[Hiroshi Ichikawa](http://gimite.net/en/index.php?Contact)

data/lib/google_drive.rb

@@ -48,6 +48,22 @@ module GoogleDrive
   #   session = GoogleDrive.login_with_oauth(credentials.access_token)
   #
   # For command-line apps, it would be easier to use saved_session method instead.
+  #
+  # To use service account authentication:
+  #
+  #  1. Go to the Credentials tab for your project in the Google API console: https://console.developers.google.com/apis/credentials
+  #  2. Create a service account key, and download the keys as JSON.  (This address ends in iam.gserviceaccount.com.)
+  #  3. Share the Drive folders or files with the client_email address in the JSON you downloaded.
+  #  3. Set a GOOGLE_CLIENT_EMAIL environmental variable based on the client_email.
+  #  4. Set a GOOGLE_PRIVATE_KEY environmental variable based on the private_key in the JSON.  Be careful to preserve newlines.
+  #  5. Create a GoogleDrive session from these environmental variables:
+  #
+  # session = GoogleDrive.login_with_oauth(Google::Auth::ServiceAccountCredentials.from_env(
+  #   'https://www.googleapis.com/auth/drive'
+  # ))
+  # The scope can be adjusted to be as broad or specific as necessary.
+  # The full list of scopes is available here: https://developers.google.com/drive/v2/web/scopes.
+  #
   def self.login_with_oauth(client_or_access_token, proxy = nil)
     Session.new(client_or_access_token, proxy)
   end
@@ -91,14 +107,15 @@ module GoogleDrive
   #   save
   def self.saved_session(
       path_or_config = nil, proxy = nil, client_id = nil, client_secret = nil)
-    config = case path_or_config
-             when String
-               Config.new(path_or_config)
-             when nil
-               Config.new(ENV['HOME'] + '/.ruby_google_drive.token')
-             else
-               path_or_config
-    end
+    config =
+      case path_or_config
+      when String
+        Config.new(path_or_config)
+      when nil
+        Config.new(ENV['HOME'] + '/.ruby_google_drive.token')
+      else
+        path_or_config
+      end
 
     config.scope ||= [
       'https://www.googleapis.com/auth/drive',
@@ -122,8 +139,6 @@ module GoogleDrive
         'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
     end
 
-    refresh_token = config.refresh_token
-
     credentials = Google::Auth::UserRefreshCredentials.new(
       client_id: config.client_id,
       client_secret: config.client_secret,

data/lib/google_drive/acl.rb

@@ -63,7 +63,7 @@ module GoogleDrive
     # https://developers.google.com/drive/v3/reference/permissions/create
     def push(params_or_entry, options = {})
       entry = params_or_entry.is_a?(AclEntry) ? params_or_entry : AclEntry.new(params_or_entry)
-      api_permission = @session.drive.create_permission(@file.id, entry.params, fields: '*')
+      api_permission = @session.drive.create_permission(@file.id, entry.params, {fields: '*'}.merge(options))
       new_entry = AclEntry.new(api_permission, self)
       @entries.push(new_entry)
       new_entry

data/lib/google_drive/collection.rb

@@ -60,6 +60,24 @@ module GoogleDrive
       files_with_type(nil, params, &block)
     end
 
+    # Same as Session#upload_from_file. It uploads file to current collection
+    def upload_from_file(path, title = nil, params = {})
+      params = {parents: [self.id]}.merge(params)
+      @session.upload_from_file(path, title, params)
+    end
+
+    # Same as Session#upload_from_io. It uploads file to current collection
+    def upload_from_io(io, title = 'Untitled', params = {})
+      params = {parents: [self.id]}.merge(params)
+      @session.upload_from_io(io, title, params)
+    end
+
+    # Same as Session#upload_from_string. It uploads file to current collection
+    def upload_from_string(content, title = 'Untitled', params = {})
+      params = {parents: [self.id]}.merge(params)
+      @session.upload_from_string(content, title, params)
+    end
+
     alias_method :contents, :files
 
     # Returns all the spreadsheets in the collection.

data/lib/google_drive/file.rb

@@ -78,7 +78,7 @@ module GoogleDrive
     # This returns zero or one file type. You may be able to download the file in other formats using
     # export_as_file, export_as_string, or export_to_io.
     def available_content_types
-      api_file.download_url ? [api_file.mime_type] : []
+      api_file.web_content_link ? [api_file.mime_type] : []
     end
 
     # Downloads the file to a local file. e.g.
@@ -86,7 +86,7 @@ module GoogleDrive
     #
     # To export the file in other formats, use export_as_file.
     def download_to_file(path, params = {})
-      @session.drive.get_file(id, download_dest: path)
+      @session.drive.get_file(id, {download_dest: path}.merge(params))
     end
 
     # Downloads the file and returns as a String.
@@ -101,8 +101,8 @@ module GoogleDrive
     # Downloads the file and writes it to +io+.
     #
     # To export the file in other formats, use export_to_io.
-    def download_to_io(io, _params = {})
-      @session.drive.get_file(id, download_dest: io)
+    def download_to_io(io, params = {})
+      @session.drive.get_file(id, {download_dest: io}.merge(params))
     end
 
     # Export the file to +path+ in content type +format+.

data/lib/google_drive/session.rb

@@ -6,8 +6,6 @@ require 'stringio'
 
 require 'rubygems'
 require 'nokogiri'
-require 'oauth'
-require 'oauth2'
 require 'googleauth'
 
 require 'google_drive/util'
@@ -42,21 +40,18 @@ module GoogleDrive
       if proxy
         fail(
           ArgumentError,
-          "Specifying a proxy object is no longer supported. Set ENV[\"http_proxy\"] instead.")
+          'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
       end
 
       if credentials_or_access_token
-        case credentials_or_access_token
-        when String
+        if credentials_or_access_token.is_a?(String)
           credentials = Google::Auth::UserRefreshCredentials.new(
             access_token: credentials_or_access_token)
-        when OAuth2::AccessToken
+        # 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 = Google::Auth::UserRefreshCredentials.new(
             access_token: credentials_or_access_token.token)
-        when OAuth::AccessToken
-          fail(
-            ArgumentError,
-            'OAuth1 is no longer supported. Use OAuth2 instead.')
         else
           credentials = credentials_or_access_token
         end
@@ -190,19 +185,28 @@ module GoogleDrive
     end
 
     # Returns GoogleDrive::Worksheet with given +url+.
-    # You must specify URL of cell-based feed of the worksheet.
+    # You must specify URL of either worksheet feed or cell-based feed of the worksheet.
     #
-    # e.g.
+    # 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(
-    #     "http://spreadsheets.google.com/feeds/" +
-    #     "cells/pz7XtlQC-PYxNmbBVgyiNWg/od6/private/full")
+    #     "https://spreadsheets.google.com/feeds/cells/" +
+    #     "1smypkyAz4STrKO4Zkos5Z4UPUJKvvgIza32LnlQ7OGw/od7/private/full")
     def worksheet_by_url(url)
-      unless url =~
-             %r{^https?://spreadsheets.google.com/feeds/cells/(.*)/(.*)/private/full((\?.*)?)$}
-        fail(GoogleDrive::Error, "URL is not a cell-based feed 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_url = "https://spreadsheets.google.com/feeds/worksheets/" +
-        "#{Regexp.last_match(1)}/private/full/#{Regexp.last_match(2)}#{Regexp.last_match(3)}"
+
       worksheet_feed_entry = request(:get, worksheet_feed_url)
       Worksheet.new(self, nil, worksheet_feed_entry)
     end
@@ -310,7 +314,7 @@ module GoogleDrive
     end
 
     # Uploads a file. Reads content from +io+.
-    # Returns a GoogleSpreadsheet::File object.
+    # Returns a GoogleDrive::File object.
     def upload_from_io(io, title = 'Untitled', params = {})
       upload_from_source(io, title, params)
     end
@@ -328,16 +332,15 @@ module GoogleDrive
 
     def execute_paged!(opts, &block) #:nodoc:
       if block
-
         page_token = nil
-        begin
+        loop do
           parameters          = (opts[:parameters] || {}).merge({page_token: page_token})
           (items, page_token) = execute_paged!(opts.merge(parameters: parameters))
           items.each(&block)
-        end while page_token
+          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
@@ -345,8 +348,8 @@ module GoogleDrive
         return [items, response.next_page_token]
 
       else
-        parameters               = (opts[:parameters] || {}).merge({page_token: nil})
-        (items, next_page_token) = execute_paged!(opts.merge(parameters: parameters))
+        parameters = (opts[:parameters] || {}).merge({page_token: nil})
+        (items, _) = execute_paged!(opts.merge(parameters: parameters))
         items
       end
     end
@@ -391,7 +394,7 @@ module GoogleDrive
         fields: '*',
       }
       for k, v in params
-        if ![:convert, :convert_mime_type].include?(k)
+        if ![:convert, :convert_mime_type, :parents].include?(k)
           api_params[k] = v
         end
       end
@@ -403,6 +406,9 @@ module GoogleDrive
       elsif params.fetch(:convert, true) && IMPORTABLE_CONTENT_TYPE_MAP.key?(content_type)
         file_metadata[:mime_type] = IMPORTABLE_CONTENT_TYPE_MAP[content_type]
       end
+      if params[:parents]
+        file_metadata[:parents] = params[:parents]
+      end
 
       file = self.drive.create_file(file_metadata, api_params)
       wrap_api_file(file)

data/lib/google_drive/worksheet.rb

@@ -255,18 +255,16 @@ module GoogleDrive
 
       # Shifts all cells below the row.
       self.max_rows += rows.size
-      r = num_rows
-      while r >= row_num
-        for c in 1..num_cols
+      num_rows.downto(row_num) do |r|
+        (1..num_cols).each do |c|
           self[r + rows.size, c] = self[r, c]
         end
-        r -= 1
       end
 
       # Fills in the inserted rows.
       num_cols = self.num_cols
       rows.each_with_index do |row, r|
-        for c in 0...[row.size, num_cols].max
+        (0...[row.size, num_cols].max).each do |c|
           self[row_num + r, 1 + c] = row[c] || ''
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-28 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,46 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: oauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
@@ -169,12 +129,9 @@ email:
 - gimite+github@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
-- doc_src/google_drive/acl.rb
+extra_rdoc_files: []
 files:
-- README.rdoc
-- doc_src/google_drive/acl.rb
+- README.md
 - lib/google_drive.rb
 - lib/google_drive/acl.rb
 - lib/google_drive/acl_entry.rb
@@ -196,9 +153,7 @@ licenses:
 - BSD-3-Clause
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--main"
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README.rdoc

@@ -1,101 +0,0 @@
-This is a Ruby library to read/write files/spreadsheets in Google Drive/Docs.
-
-NOTE: This is NOT a library to create Google Drive App.
-
-
-= Migration from ver. 0.x.x / 1.x.x to to ver. 2.x.x
-
-There are some incompatible API changes. See {MIGRATING.md}[https://github.com/gimite/google-drive-ruby/blob/master/MIGRATING.md].
-
-
-= How to install
-
-  $ sudo gem install google_drive
-
-
-= How to use
-
-First, follow Step 1 and 2 of "Authorizing requests with OAuth 2.0" in {this page}[https://developers.google.com/drive/v3/web/about-auth] to get a client ID and client secret for OAuth. Set "Application type" to "Other" in the form to create a client ID if you use GoogleDrive.saved_session method as in the example below.
-
-Next, create a file config.json which contains the client ID and crient secret you got above, which looks like:
-
-  {
-    "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
-    "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
-  }
-
-Example to read/write files in Google Drive:
-
-  require "google_drive"
-
-  # Creates a session. This will prompt the credential via command line for the
-  # first time and save it to config.json file for later usages.
-  session = GoogleDrive.saved_session("config.json")
-
-  # Gets list of remote files.
-  session.files.each do |file|
-    p file.title
-  end
-
-  # Uploads a local file.
-  session.upload_from_file("/path/to/hello.txt", "hello.txt", convert: false)
-
-  # Downloads to a local file.
-  file = session.file_by_title("hello.txt")
-  file.download_to_file("/path/to/hello.txt")
-
-  # Updates content of the remote file.
-  file.update_from_file("/path/to/hello.txt")
-
-Example to read/write spreadsheets:
-
-  require "google_drive"
-
-  # Creates a session. This will prompt the credential via command line for the
-  # first time and save it to config.json file for later usages.
-  session = GoogleDrive.saved_session("config.json")
-
-  # First worksheet of
-  # https://docs.google.com/spreadsheet/ccc?key=pz7XtlQC-PYx-jrVMJErTcg
-  # Or https://docs.google.com/a/someone.com/spreadsheets/d/pz7XtlQC-PYx-jrVMJErTcg/edit?usp=drive_web
-  ws = session.spreadsheet_by_key("pz7XtlQC-PYx-jrVMJErTcg").worksheets[0]
-
-  # Gets content of A2 cell.
-  p ws[2, 1]  #==> "hoge"
-
-  # Changes content of cells.
-  # Changes are not sent to the server until you call ws.save().
-  ws[2, 1] = "foo"
-  ws[2, 2] = "bar"
-  ws.save
-
-  # Dumps all cells.
-  (1..ws.num_rows).each do |row|
-    (1..ws.num_cols).each do |col|
-      p ws[row, col]
-    end
-  end
-
-  # Yet another way to do so.
-  p ws.rows  #==> [["fuga", ""], ["foo", "bar]]
-
-  # Reloads the worksheet to get changes by other clients.
-  ws.reload
-
-API document: http://www.rubydoc.info/gems/google_drive
-
-= Source code
-
-http://github.com/gimite/google-drive-ruby
-
-The license of this source is "New BSD Licence"
-
-
-= Supported environments
-
-Ruby 2.0.0 or later. Checked with Ruby 2.3.0.
-
-
-= Author
-
-Hiroshi Ichikawa - http://gimite.net/en/index.php?Contact

data/doc_src/google_drive/acl.rb

@@ -1,16 +0,0 @@
-module GoogleDrive
-  class Acl
-    # Returns the number of entries.
-    def size
-    end
-
-    # Returns GoogleDrive::AclEntry object at +index+.
-    def [](index)
-    end
-
-    # Iterates over GoogleDrive::AclEntry objects.
-    def each(&_block)
-      yield(entry)
-    end
-  end
-end