google_drive 2.1.7 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1a4942b505b1a7c2b0c9f5c5ad4b6b07def0a52
-  data.tar.gz: 8a85586bb36e68b20d899fabdea7c10a1e60e3bd
+  metadata.gz: a307d368da1d8c3aaddcc80fce8e3ab842e31fbc
+  data.tar.gz: f638dfeb91a08128bfca2e547973efd2b1172a42
 SHA512:
-  metadata.gz: 32427d7303d783f1d846e81dc6eb201691e584550f6cb8a85a35b8fad129ba5993d79347504c94ff68c7b74d57dc9d29b26286a213fbd96d7b33f66b7ff94b4e
-  data.tar.gz: 56ec22afaab23abaf16ee0b398b65eadecb296353a44f6a0c81e30bc5a979a3890c75f908c11b460de276f1b7edacdf650f4d3f20b9b687bb817fba8751663e2
+  metadata.gz: f6ead9f1d7cedf6efedd25b88b0d36d8599c63824ed616d3401eebaf9d0431c29e4d41ef6e4ec1cfa1754de76dc47c23754946c17334bcd264929e37ffd1e40a
+  data.tar.gz: 56a2e06379ea4a54efbc2c2ac53d65c1f93b89ab7036f6989ce79b143c45b3d43dee68d1fe9d9102b1133a5aab82f94d6d1ce8332475eafd2e2b55c65be4e87b

data/README.md

@@ -1,15 +1,28 @@
+# google-drive-ruby [![Build Status](https://travis-ci.org/gimite/google-drive-ruby.svg?branch=master)](https://travis-ci.org/gimite/google-drive-ruby)
+
 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
+* [Migration from ver. 0.x.x / 1.x.x](#migration)
+* [How to install](#install)
+* [How to use](#use)
+* [API documentation](http://www.rubydoc.info/gems/google_drive)
+* [Authorization](https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md)
+* [Github](http://github.com/gimite/google-drive-ruby)
+* [License](#license)
+* [Supported environments](#environments)
+* [Author](#author)
+
+
+## <a name="migration">Migration from ver. 0.x.x / 1.x.x</a>
 
 There are some incompatible API changes. See
 [MIGRATING.md](https://github.com/gimite/google-drive-ruby/blob/master/MIGRATING.md).
 
 
-## How to install
+## <a name="install">How to install</a>
 
 Add this line to your application's Gemfile:
 
@@ -35,7 +48,7 @@ If you need system wide installation, execute below:
 $ sudo gem install google_drive
 ```
 
-## How to use
+## <a name="use">How to use</a>
 
 ### Authorization
 
@@ -107,20 +120,17 @@ p ws.rows  #==> [["fuga", ""], ["foo", "bar]]
 ws.reload
 ```
 
-## Learn more
 
-* [API documentation](http://www.rubydoc.info/gems/google_drive)
-* [Authorization](https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md)
-* [Github](http://github.com/gimite/google-drive-ruby)
-
-## License
+## <a name="license">License</a>
 
 New BSD Licence.
 
-## Supported environments
 
-Ruby 2.0.0 or later. Checked with Ruby 2.3.0.
+## <a name="environments">Supported environments</a>
+
+Ruby 2.0.0 or later. Checked with Ruby 2.4.1.
+
 
-## Author
+## <a name="author">Author</a>
 
 [Hiroshi Ichikawa](http://gimite.net/en/index.php?Contact)

data/lib/google_drive/collection.rb

@@ -6,25 +6,27 @@ require 'google_drive/error'
 require 'google_drive/spreadsheet'
 
 module GoogleDrive
+  # Represents a folder in Google Drive.
+  #
   # Use GoogleDrive::Session#root_collection, GoogleDrive::Collection#subcollections,
   # or GoogleDrive::Session#collection_by_url to get GoogleDrive::Collection object.
   class Collection < GoogleDrive::File
     include(Util)
 
-    alias_method :collection_feed_url, :document_feed_url
+    alias collection_feed_url document_feed_url
 
-    # Adds the given GoogleDrive::File to the collection.
+    # Adds the given GoogleDrive::File to the folder.
     def add(file)
       @session.drive.update_file(file.id, add_parents: self.id, fields: '', supports_team_drives: true)
       nil
     end
 
-    # Removes the given GoogleDrive::File from the collection.
+    # Removes the given GoogleDrive::File from the folder.
     def remove(file)
       @session.drive.update_file(file.id, remove_parents: self.id, fields: '', supports_team_drives: true)
     end
 
-    # Creates a sub-collection with given title. Returns GoogleDrive::Collection object.
+    # Creates a sub-folder with given title. Returns GoogleDrive::Collection object.
     def create_subcollection(title)
       file_metadata = {
         name: title,
@@ -34,19 +36,21 @@ module GoogleDrive
       file = @session.drive.create_file(file_metadata, fields: '*', supports_team_drives: true)
       @session.wrap_api_file(file)
     end
+    
+    alias create_subfolder create_subcollection
 
-    # Returns true if this is a root collection
+    # Returns true if this is a root folder.
     def root?
       !api_file.parents || api_file.parents.empty?
     end
 
-    # Returns all the files (including spreadsheets, documents, subcollections) in the collection.
+    # Returns all the files (including spreadsheets, documents, subfolders) in the folder.
     # You can specify parameters documented at
     # https://developers.google.com/drive/v3/web/search-parameters
     #
     # e.g.
     #
-    #   # Gets all the files in the collection, including subcollections.
+    #   # Gets all the files in the folder, including subfolders.
     #   collection.files
     #
     #   # Gets only files with title "hoge".
@@ -61,19 +65,19 @@ module GoogleDrive
       files_with_type(nil, params, &block)
     end
 
-    # Same as Session#upload_from_file. It uploads file to current collection
+    # Uploads a file to this folder. See Session#upload_from_file for details.
     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
+    # Uploads a file to this folder. See Session#upload_from_io for details.
     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
+    # Uploads a file to this folder. See Session#upload_from_string for details.
     def upload_from_string(content, title = 'Untitled', params = {})
       params = {parents: [self.id]}.merge(params)
       @session.upload_from_string(content, title, params)
@@ -81,7 +85,7 @@ module GoogleDrive
 
     alias_method :contents, :files
 
-    # Returns all the spreadsheets in the collection.
+    # Returns all the spreadsheets in the folder.
     #
     # By default, it returns the first 100 spreadsheets. See document of GoogleDrive::Session#files method
     # for how to get all spreadsheets.
@@ -89,7 +93,7 @@ module GoogleDrive
       files_with_type('application/vnd.google-apps.spreadsheet', params, &block)
     end
 
-    # Returns all the Google Docs documents in the collection.
+    # Returns all the Google Docs documents in the folder.
     #
     # By default, it returns the first 100 documents. See document of GoogleDrive::Session#files method
     # for how to get all documents.
@@ -97,33 +101,39 @@ module GoogleDrive
       files_with_type('application/vnd.google-apps.document', params, &block)
     end
 
-    # Returns all its subcollections.
+    # Returns all its subfolders.
     #
-    # By default, it returns the first 100 subcollections. See document of GoogleDrive::Session#files method
-    # for how to get all subcollections.
+    # By default, it returns the first 100 subfolders. See document of GoogleDrive::Session#files method
+    # for how to get all subfolders.
     def subcollections(params = {}, &block)
       files_with_type('application/vnd.google-apps.folder', params, &block)
     end
+    
+    alias subfolders subcollections
 
-    # Returns a file (can be a spreadsheet, document, subcollection or other files) in the
-    # collection which exactly matches +title+ as GoogleDrive::File.
-    # Returns nil if not found. If multiple collections with the +title+ are found, returns
+    # Returns a file (can be a spreadsheet, document, subfolder or other files) in the
+    # folder which exactly matches +title+ as GoogleDrive::File.
+    # Returns nil if not found. If multiple folders with the +title+ are found, returns
     # one of them.
     #
-    # If given an Array, does a recursive subcollection traversal.
+    # If given an Array, does a recursive subfolder traversal.
     def file_by_title(title)
       file_by_title_with_type(title, nil)
     end
+    
+    alias file_by_name file_by_title
 
-    # Returns its subcollection whose title exactly matches +title+ as GoogleDrive::Collection.
-    # Returns nil if not found. If multiple collections with the +title+ are found, returns
+    # Returns its subfolder 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.
     #
-    # If given an Array, does a recursive subcollection traversal.
+    # If given an Array, does a recursive subfolder traversal.
     def subcollection_by_title(title)
       file_by_title_with_type(title, 'application/vnd.google-apps.folder')
     end
 
+    alias subfolder_by_name subcollection_by_title
+    
     # Returns URL of the deprecated contents feed.
     def contents_url
       document_feed_url + '/contents'
@@ -144,6 +154,8 @@ module GoogleDrive
         files_with_type(type, q: ['name = ?', title], page_size: 1)[0]
       end
     end
+    
+    alias file_by_name_with_type file_by_title_with_type
 
     private
 
@@ -159,4 +171,6 @@ module GoogleDrive
       @session.files(params, &block)
     end
   end
+  
+  Folder = Collection
 end

data/lib/google_drive/config.rb

@@ -6,7 +6,7 @@ require 'json'
 module GoogleDrive
   # @api private
   class Config
-    FIELDS = %w(client_id client_secret scope refresh_token).freeze
+    FIELDS = %w(client_id client_secret scope refresh_token type).freeze
     attr_accessor(*FIELDS)
 
     def initialize(config_path)

data/lib/google_drive/file.rb

@@ -65,6 +65,8 @@ module GoogleDrive
       reload_metadata if params[:reload]
       api_file.name
     end
+    
+    alias name title
 
     # URL to view/edit the file in a Web browser.
     #

data/lib/google_drive/session.rb

@@ -93,7 +93,12 @@ module GoogleDrive
     #   save
     def self.from_config(config, options = {})
       if config.is_a?(String)
-        config = Config.new(config)
+        config_path = config
+        config = Config.new(config_path)
+        if config.type == 'service_account'
+          return from_service_account_key(
+              config_path, options[:scope] || DEFAULT_SCOPE)
+        end
       end
 
       config.scope ||= DEFAULT_SCOPE
@@ -198,7 +203,7 @@ module GoogleDrive
     # 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.
+    # If given an Array, traverses folders by title. e.g.
     #   session.file_by_title(["myfolder", "mysubfolder/even/w/slash", "myfile"])
     def file_by_title(title)
       if title.is_a?(Array)
@@ -207,6 +212,8 @@ module GoogleDrive
         files(q: ['name = ?', title], page_size: 1)[0]
       end
     end
+      
+    alias file_by_name file_by_title
 
     # Returns a file (including a spreadsheet and a folder) with a given +id+.
     #
@@ -285,6 +292,8 @@ module GoogleDrive
     def spreadsheet_by_title(title)
       spreadsheets(q: ['name = ?', title], page_size: 1)[0]
     end
+      
+    alias spreadsheet_by_name spreadsheet_by_title
 
     # Returns GoogleDrive::Worksheet with given +url+.
     # You must specify URL of either worksheet feed or cell-based feed of the worksheet.
@@ -313,47 +322,50 @@ module GoogleDrive
       Worksheet.new(self, nil, worksheet_feed_entry)
     end
 
-    # Returns the root collection.
+    # Returns the root folder.
     def root_collection
       @root_collection ||= file_by_id('root')
     end
+      
+    alias root_folder root_collection
 
-    # Returns the top-level collections (direct children of the root collection).
+    # Returns the top-level folders (direct children of the root folder).
     #
-    # By default, it returns the first 100 collections. See document of files method for how to get
-    # all collections.
+    # By default, it returns the first 100 folders. See document of files method for how to get
+    # all folders.
     def collections(params = {}, &block)
       root_collection.subcollections(params, &block)
     end
+      
+    alias folders collections
 
-    # Returns a top-level collection whose title exactly matches +title+ as
+    # Returns a top-level folder whose title exactly matches +title+ as
     # GoogleDrive::Collection.
-    # Returns nil if not found. If multiple collections with the +title+ are found, returns
+    # Returns nil if not found. If multiple folders with the +title+ are found, returns
     # one of them.
     def collection_by_title(title)
       root_collection.subcollection_by_title(title)
     end
+      
+    alias folders_by_name collection_by_title
 
     # Returns GoogleDrive::Collection with given +url+.
-    # You must specify either of:
-    # - URL of the page you get when you go to https://docs.google.com/ with your browser and
-    #   open a collection
-    # - URL of collection (folder) feed
+    #
+    # You must specify the URL of the page you get when you go to https://drive.google.com/
+    # with your browser and open a folder.
     #
     # 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")
+    #     "https://drive.google.com/drive/folders/1u99gpfHIk08RVK5q_vXxUqkxR1r6FUJH")
     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)
+        fail(GoogleDrive::Error, 'The file with the URL is not a folder: %s' % url)
       end
       file
     end
+      
+    alias folder_by_url collection_by_url
 
     # Creates new spreadsheet and returns the new GoogleDrive::Spreadsheet.
     #
@@ -547,7 +559,7 @@ module GoogleDrive
           # Human-readable new spreadsheet/document.
         when /\/d\/([^\/]+)/
           return Regexp.last_match(1)
-          # Human-readable new collection page.
+          # Human-readable new folder page.
         when /^\/drive\/[^\/]+\/([^\/]+)/
           return Regexp.last_match(1)
           # Human-readable old folder view.
@@ -558,7 +570,7 @@ module GoogleDrive
           return Regexp.last_match(1) if (uri.query || '').split(/&/).find { |s| s =~ /^key=(.*)$/ }
         end
         case uri.fragment
-          # Human-readable old collection page.
+          # Human-readable old folder page.
         when /^folders\/(.+)$/
           return Regexp.last_match(1)
         end

data/lib/google_drive/spreadsheet.rb

@@ -12,7 +12,8 @@ require 'google_drive/file'
 module GoogleDrive
   # A spreadsheet.
   #
-  # Use methods in GoogleDrive::Session to get GoogleDrive::Spreadsheet object.
+  # e.g., Use methods spreadsheet_by_title, spreadsheet_by_url, create_spreadsheet in GoogleDrive::Session
+  # to get GoogleDrive::Spreadsheet object.
   class Spreadsheet < GoogleDrive::File
     include(Util)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.8
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2018-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A library to read/write files/spreadsheets in Google Drive/Docs.