google_drive 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fff5ef1112cf60c78cc1cbd54372ec34a87e3aad
-  data.tar.gz: 5448d5cba8278598b46b432e1b5e812ac33e0f87
+  metadata.gz: 584b24ba7f2e0849c5209e2343f33f553dc920f6
+  data.tar.gz: b6a5d71757609057cb510ea4177a14e9cb8355a4
 SHA512:
-  metadata.gz: ffc511d0d0aba64d4510753abde1fac34fc4940bfc6233d04c0bd4093b3af53ae4c663aba856032b09e11300b10a7b31130dad7638abfb982b6e1a5d6aa3b8c5
-  data.tar.gz: 076cf4ceeaec5fb63ea8374a940c091544a413ca8c7cd5604d5a2cc642715e2f3513fb641230c560371d89bda2fb1a70d014631030ff2038c3be31b4d7fe9b41
+  metadata.gz: 34f581e48edad100d18590d9556f25fbdcf348332c5e05afda8a0de7ac93a41244f773614e9d67fcc1ac3941e07c1726e74bd3797ea95571eff3a01c88ebc71e
+  data.tar.gz: f8787070a461e3d712f9dd9ab42c342b48016fac29f433c854ab6722b4abc8963f0e643b1282d9e7f3a38f1f0a7be4bb638c9fc6373c32399a8530862f8347af

data/README.md

@@ -103,15 +103,15 @@ p ws.rows  #==> [["fuga", ""], ["foo", "bar]]
 ws.reload
 ```
 
-## Full API documentation
+## Learn more
 
-[API documentation in RubyDoc.info](http://www.rubydoc.info/gems/google_drive)
+* [API documentation](http://www.rubydoc.info/gems/google_drive/2.1.1)
+* [Authorization](https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md)
+* [Github](http://github.com/gimite/google-drive-ruby)
 
-## Source code
+## License
 
-[Github](http://github.com/gimite/google-drive-ruby)
-
-The license of this source is "New BSD Licence"
+New BSD Licence.
 
 ## Supported environments
 

data/lib/google_drive/access_token_credentials.rb

@@ -0,0 +1,19 @@
+module GoogleDrive
+  # A simple credentials class using an existing OAuth2 access_token.
+  #
+  # Based on:
+  # https://github.com/google/google-api-ruby-client/issues/296
+  #
+  # @api private
+  class AccessTokenCredentials
+    attr_reader :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def apply!(headers)
+      headers['Authorization'] = "Bearer #{@access_token}"
+    end
+  end
+end

data/lib/google_drive/acl.rb

@@ -16,7 +16,8 @@ module GoogleDrive
     include(Util)
     extend(Forwardable)
 
-    def initialize(session, file) #:nodoc:
+    # @api private
+    def initialize(session, file)
       @session = session
       @file = file
       api_permissions = @session.drive.list_permissions(@file.id, fields: '*')
@@ -33,11 +34,12 @@ module GoogleDrive
     # Also you can pass the second hash argument +options+, which specifies
     # optional query parameters for the API.
     # Possible keys of +options+ are,
-    # * :emailMessage  -- A custom message to include in notification emails
-    # * :sendNotificationEmails  -- Whether to send notification emails
-    #   when sharing to users or groups.
-    #
-    # NOTE: This sends email to the new people.
+    # * :email_message  -- A custom message to include in notification emails
+    # * :send_notification_email  -- Whether to send notification emails
+    #   when sharing to users or groups. (Default: true)
+    # * :transfer_ownership  -- Whether to transfer ownership to the specified user
+    #   and downgrade the current owner to a writer. This parameter is required as an
+    #   acknowledgement of the side effect. (Default: false)
     #
     # e.g.
     #   # A specific user can read or write.
@@ -57,7 +59,7 @@ module GoogleDrive
     #   # Set ACL without sending notification emails
     #   spreadsheet.acl.push(
     #       {type: "user", email_address: "example2@gmail.com", role: "reader"},
-    #       {sendNotificationEmails: false})
+    #       {send_notification_email: false})
     #
     # See here for parameter detais:
     # https://developers.google.com/drive/v3/reference/permissions/create
@@ -78,7 +80,8 @@ module GoogleDrive
       @entries.delete(entry)
     end
 
-    def update_role(entry) #:nodoc:
+    # @api private
+    def update_role(entry)
       api_permission = @session.drive.update_permission(
         @file.id, entry.id, {role: entry.role}, fields: '*')
       entry.api_permission = api_permission

data/lib/google_drive/acl_entry.rb

@@ -29,8 +29,12 @@ module GoogleDrive
     end
 
     attr_reader(:acl)
-    attr_reader(:params) #:nodoc:
-    attr_accessor(:api_permission) #:nodoc:
+
+    # @api private
+    attr_reader(:params)
+
+    # @api private
+    attr_accessor(:api_permission)
 
     # The role given to the scope. One of:
     # - "owner": The owner.

data/lib/google_drive/collection.rb

@@ -41,18 +41,19 @@ module GoogleDrive
     end
 
     # Returns all the files (including spreadsheets, documents, subcollections) in the collection.
-    #
     # You can specify parameters documented at
-    # https://developers.google.com/drive/v2/reference/files/list
+    # https://developers.google.com/drive/v3/web/search-parameters
     #
     # e.g.
     #
-    #   # Gets all the files in collection, including subcollections.
+    #   # Gets all the files in the collection, including subcollections.
     #   collection.files
+    #
     #   # Gets only files with title "hoge".
-    #   collection.files("q" => "title = 'hoge'")
+    #   collection.files(q: "name = 'hoge'")
+    #
     #   # Same as above with a placeholder.
-    #   collection.files("q" => ["title = ?", "hoge"])
+    #   collection.files(q: ["name = ?", "hoge"])
     #
     # By default, it returns the first 100 files. See document of GoogleDrive::Session#files method
     # for how to get all files.

data/lib/google_drive/config.rb

@@ -4,7 +4,8 @@
 require 'json'
 
 module GoogleDrive
-  class Config #:nodoc:
+  # @api private
+  class Config
     FIELDS = %w(client_id client_secret scope refresh_token).freeze
     attr_accessor(*FIELDS)
 

data/lib/google_drive/file.rb

@@ -23,7 +23,8 @@ module GoogleDrive
     include(Util)
     extend(Forwardable)
 
-    def initialize(session, api_file) #:nodoc:
+    # @api private
+    def initialize(session, api_file)
       @session = session
       @api_file = api_file
       @acl = nil

data/lib/google_drive/list.rb

@@ -15,7 +15,8 @@ module GoogleDrive
   class List
     include(Enumerable)
 
-    def initialize(worksheet) #:nodoc:
+    # @api private
+    def initialize(worksheet)
       @worksheet = worksheet
     end
 
@@ -90,19 +91,23 @@ module GoogleDrive
       map(&:to_hash)
     end
 
-    def get(index, key) #:nodoc:
+    # @api private
+    def get(index, key)
       @worksheet[index + 2, key_to_col(key)]
     end
 
-    def numeric_value(index, key) #:nodoc:
+    # @api private
+    def numeric_value(index, key)
       @worksheet.numeric_value(index + 2, key_to_col(key))
     end
 
-    def input_value(index, key) #:nodoc:
+    # @api private
+    def input_value(index, key)
       @worksheet.input_value(index + 2, key_to_col(key))
     end
 
-    def set(index, key, value) #:nodoc:
+    # @api private
+    def set(index, key, value)
       @worksheet[index + 2, key_to_col(key)] = value
     end
 

data/lib/google_drive/list_row.rb

@@ -17,7 +17,8 @@ module GoogleDrive
                    :assoc, :fetch, :flatten, :key, :invert, :size, :length, :rassoc,
                    :merge, :reject, :select, :sort, :to_a, :values_at)
 
-    def initialize(list, index) #:nodoc:
+    # @api private
+    def initialize(list, index)
       @list = list
       @index = index
     end

data/lib/google_drive/response_code_error.rb

@@ -8,7 +8,8 @@ require 'google_drive/error'
 module GoogleDrive
   # Raised when an HTTP request has returned an unexpected response code.
   class ResponseCodeError < GoogleDrive::Error
-    def initialize(code, body, method, url) #:nodoc:#
+    # @api private
+    def initialize(code, body, method, url)
       @code = code
       @body = body
       super('Response code %s for %s %s: %s' % [code, method, url, CGI.unescapeHTML(body)])

data/lib/google_drive/session.rb

@@ -18,10 +18,13 @@ require 'google_drive/worksheet'
 require 'google_drive/collection'
 require 'google_drive/file'
 require 'google_drive/config'
+require 'google_drive/access_token_credentials'
 
 module GoogleDrive
-  # Use GoogleDrive.login_with_oauth or GoogleDrive.saved_session to get
-  # GoogleDrive::Session object.
+  # 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.
   class Session
     include(Util)
     extend(Util)
@@ -137,13 +140,11 @@ module GoogleDrive
 
       if credentials_or_access_token
         if credentials_or_access_token.is_a?(String)
-          credentials = Google::Auth::UserRefreshCredentials.new(
-            access_token: credentials_or_access_token)
+          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 = Google::Auth::UserRefreshCredentials.new(
-            access_token: credentials_or_access_token.token)
+          credentials = AccessTokenCredentials.new(credentials_or_access_token.token)
         else
           credentials = credentials_or_access_token
         end
@@ -191,9 +192,11 @@ module GoogleDrive
         &block)
     end
 
-    # Returns GoogleDrive::File or its subclass whose title exactly matches +title+.
-    # Returns nil if not found. If multiple files with the +title+ are found, returns
-    # one of them.
+    # 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"])
@@ -205,15 +208,22 @@ module GoogleDrive
       end
     end
 
-    # Returns GoogleDrive::File or its subclass with a given +id+.
+    # 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).
     def file_by_id(id)
       api_file = self.drive.get_file(id, fields: '*')
       wrap_api_file(api_file)
     end
 
-    # Returns GoogleDrive::File or its subclass with a given +url+. +url+ must be eitehr of:
+    # 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).
     def file_by_url(url)
       file_by_id(url_to_id(url))
     end
@@ -411,7 +421,8 @@ module GoogleDrive
       upload_from_source(io, title, params)
     end
 
-    def wrap_api_file(api_file) #:nodoc:
+    # @api private
+    def wrap_api_file(api_file)
       case api_file.mime_type
       when 'application/vnd.google-apps.folder'
         return Collection.new(self, api_file)
@@ -422,7 +433,8 @@ module GoogleDrive
       end
     end
 
-    def execute_paged!(opts, &block) #:nodoc:
+    # @api private
+    def execute_paged!(opts, &block)
       if block
         page_token = nil
         loop do
@@ -446,7 +458,8 @@ module GoogleDrive
       end
     end
 
-    def request(method, url, params = {}) #:nodoc:
+    # @api private
+    def request(method, url, params = {})
       # Always uses HTTPS.
       url           = url.gsub(%r{^http://}, 'https://')
       data          = params[:data]

data/lib/google_drive/util.rb

@@ -4,7 +4,8 @@
 require 'cgi'
 
 module GoogleDrive
-  module Util #:nodoc:
+  # @api private
+  module Util
     EXT_TO_CONTENT_TYPE = {
       '.csv' => 'text/csv',
       '.tsv' => 'text/tab-separated-values',

data/lib/google_drive/worksheet.rb

@@ -15,7 +15,8 @@ module GoogleDrive
   class Worksheet
     include(Util)
 
-    def initialize(session, spreadsheet, worksheet_feed_entry) #:nodoc:
+    # @api private
+    def initialize(session, spreadsheet, worksheet_feed_entry)
       @session = session
       @spreadsheet = spreadsheet
       set_worksheet_feed_entry(worksheet_feed_entry)
@@ -188,29 +189,21 @@ module GoogleDrive
     end
 
     # Number of rows including empty rows.
-    def max_rows
-      reload_cells unless @cells
-      @max_rows
-    end
+    attr_reader :max_rows
 
     # Updates number of rows.
     # Note that update is not sent to the server until you call save().
     def max_rows=(rows)
-      reload_cells unless @cells
       @max_rows = rows
       @meta_modified = true
     end
 
     # Number of columns including empty columns.
-    def max_cols
-      reload_cells unless @cells
-      @max_cols
-    end
+    attr_reader :max_cols
 
     # Updates number of columns.
     # Note that update is not sent to the server until you call save().
     def max_cols=(cols)
-      reload_cells unless @cells
       @max_cols = cols
       @meta_modified = true
     end
@@ -222,7 +215,8 @@ module GoogleDrive
       @meta_modified = true
     end
 
-    def cells #:nodoc:
+    # @api private
+    def cells
       reload_cells unless @cells
       @cells
     end
@@ -310,7 +304,7 @@ module GoogleDrive
               <entry xmlns='http://www.w3.org/2005/Atom'
                      xmlns:gs='http://schemas.google.com/spreadsheets/2006'>
                 <title>#{h(title)}</title>
-                <gs:rowCount>#{h(self.max_rows)}</gs:rowCount>
+                <gs:rowCount>#{h(max_rows)}</gs:rowCount>
                 <gs:colCount>#{h(max_cols)}</gs:colCount>
               </entry>
             EOS
@@ -471,14 +465,18 @@ module GoogleDrive
     def set_worksheet_feed_entry(entry)
       @worksheet_feed_entry = entry
       @title = entry.css('title').text
+      set_max_values(entry)
       @updated = Time.parse(entry.css('updated').text)
       @meta_modified = false
     end
+    
+    def set_max_values(entry)
+      @max_rows = entry.css('gs|rowCount').text.to_i
+      @max_cols = entry.css('gs|colCount').text.to_i
+    end
 
     def reload_cells
       doc = @session.request(:get, cells_feed_url)
-      @max_rows = doc.css('gs|rowCount').text.to_i
-      @max_cols = doc.css('gs|colCount').text.to_i
 
       @num_cols = nil
       @num_rows = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -133,6 +133,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/google_drive.rb
+- lib/google_drive/access_token_credentials.rb
 - lib/google_drive/acl.rb
 - lib/google_drive/acl_entry.rb
 - lib/google_drive/api_client_fetcher.rb