google_drive 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bb3a0f8730150b91a7372abbb1d0692e5188562
-  data.tar.gz: 1766484d57fae5b79cefd07023b9c8694c654d98
+  metadata.gz: ea4f78acd448f0bec2b79cce06961178ba502ad3
+  data.tar.gz: 4c0ddf477184f57e660de0ddbf89254b0a8d14cf
 SHA512:
-  metadata.gz: 3d125e0cae9a4d27d9ca3d79102843c28452090433a05ac22b320e8dd04581249b21f962753c65fdf729e87ce8bdad3c144fef45d9dac426e9d2fd8a43c0b1a4
-  data.tar.gz: abab1ce0c9c4e9abb56287a7af477bef976f2d6d02610da9409703bdac7cbe68b0a0ac4d63d27aa072240c4b9ac68092bc90938a898c7138109529fee267781a
+  metadata.gz: 4620ee74e9995463e97fbc6f59f2eb03ad317550ec7e7d43047ae26f960b40a0f1e4f6de567839ff00254550e42301f2d0eed78a9681c88d2fa7537249aba19b
+  data.tar.gz: 49b0e4cbf285044fd58219d34308c94556623ea63274661f96f22da88ccd7c5c6157862525c5f1250b4dcc593d5cdf5455cc2ee0fb30ebb214859f607b5e099a

data/README.rdoc

@@ -1,13 +1,13 @@
-This is a Ruby 1.9/2.0 library to read/write files/spreadsheets in Google Drive/Docs.
+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.
 
 
-= Incompatibility introduced in ver. 1.0.0
+= Migration from 0.3.x or before to ver. 1.0.x
 
-Ver. 1.0.0 is not 100% backward compatible with 0.3.x. Some methods have been removed. Especially, GoogleDrive.login has been removed, and you must use GoogleDrive.login_with_oauth instead, as in the example code below.
+Ver. 0.3.x and the versions before no longer works, because the API used was deprecated and shut down. You need to migrate to ver. 1.0.x.
 
-I recommend to switch to the new API. But if you somehow want to continue using the old API, you can keep using it by requiring "google_drive_v0" instead of "google_drive" and use GoogleDriveV0 class instead of GoogleDrive class. It should continue working at least until April 20, 2015 when Google stops support of Documents List API.
+Ver. 1.0.x is not 100% backward compatible with 0.3.x. Some methods have been removed. Especially, GoogleDrive.login has been removed, and you must use GoogleDrive.saved_session or GoogleDrive.login_with_oauth instead, as in the example code below.
 
 
 = How to install
@@ -17,83 +17,76 @@ I recommend to switch to the new API. But if you somehow want to continue using
 
 = How to use
 
-First, follow "Create a client ID and client secret" in {this page}[https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret for OAuth.
+First, follow "Create a client ID and client secret" in {this page}[https://developers.google.com/drive/web/auth/web-server] 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.
 
 Example to read/write files in Google Drive:
 
-  require "rubygems"
   require "google/api_client"
   require "google_drive"
 
-  # Authorizes with OAuth and gets an access token.
-  client = Google::APIClient.new
-  auth = client.authorization
-  auth.client_id = "YOUR CLIENT ID"
-  auth.client_secret = "YOUR CLIENT SECRET"
-  auth.scope =
-      "https://www.googleapis.com/auth/drive " +
-      "https://spreadsheets.google.com/feeds/"
-  auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
-  print("1. Open this page:\n%s\n\n" % auth.authorization_uri)
-  print("2. Enter the authorization code shown in the page: ")
-  auth.code = $stdin.gets.chomp
-  auth.fetch_access_token!
-  access_token = auth.access_token
+  # The client ID and client secret you obtained in the step above.
+  CLIENT_ID = ...
+  CLIENT_SECRET = ...
+
+  # Creates a session. This will prompt the credential via command line for the
+  # first time and save it to ./stored_token.json file for later usages.
+  #
+  # If you are developing a Web app, and you want to ask the user to log in in
+  # the Web app instead of via command line, follow the example code in:
+  # http://gimite.net/doc/google-drive-ruby/GoogleDrive.html#method-c-login_with_oauth
+  session = GoogleDrive.saved_session("./stored_token.json", nil, CLIENT_ID, CLIENT_SECRET)
 
-  # Creates a session.
-  session = GoogleDrive.login_with_oauth(access_token)
-  
   # Gets list of remote files.
-  for file in session.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)
-  
+  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 "rubygems"
+Example to read/write spreadsheets:
+
   require "google/api_client"
   require "google_drive"
 
   # Same as the code above to get access_token...
-  
+
   # Creates a session.
   session = GoogleDrive.login_with_oauth(access_token)
-  
+
   # 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()
-  
+  ws.save
+
   # Dumps all cells.
-  for row in 1..ws.num_rows
-    for col in 1..ws.num_cols
+  (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()
+  ws.reload
 
 API document: http://gimite.net/doc/google-drive-ruby/
 

data/lib/google_drive.rb

@@ -124,9 +124,10 @@ module GoogleDrive
       auth = client.authorization
       auth.client_id = client_id
       auth.client_secret = client_secret
-      auth.scope =
-          "https://www.googleapis.com/auth/drive " +
+      auth.scope = [
+          "https://www.googleapis.com/auth/drive",
           "https://spreadsheets.google.com/feeds/"
+      ]
       auth.redirect_uri = "urn:ietf:wg:oauth:2.0:oob"
 
       if token_data

data/lib/google_drive/acl.rb

@@ -33,6 +33,13 @@ module GoogleDrive
         # :scope_type, :scope and :role. See GoogleDrive::AclEntry#scope_type and
         # GoogleDrive::AclEntry#role for the document of the fields.
         #
+        # 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.
         #
         # e.g.
@@ -47,16 +54,20 @@ module GoogleDrive
         #   # Anyone who knows the link can read.
         #   spreadsheet.acl.push(
         #       {:type => "anyone", :withLink => true, :role => "reader"})
+        #   # Set ACL without sending notification emails
+        #   spreadsheet.acl.push(
+        #       {:type => "user", :value => "example2@gmail.com", :role => "reader"},
+        #       {:sendNotificationEmails => false})
         #
         # See here for parameter detais:
         # https://developers.google.com/drive/v2/reference/permissions/insert
-        def push(params_or_entry)
+        def push(params_or_entry, options = {})
           entry = params_or_entry.is_a?(AclEntry) ? params_or_entry : AclEntry.new(params_or_entry)
           new_permission = @session.drive.permissions.insert.request_schema.new(entry.params)
           api_result = @session.execute!(
               :api_method => @session.drive.permissions.insert,
               :body_object => new_permission,
-              :parameters => { "fileId" => @file.id })
+              :parameters => options.merge({ "fileId" => @file.id }))
           new_entry = AclEntry.new(api_result.data, self)
           @entries.push(new_entry)
           return new_entry

data/lib/google_drive/acl_entry.rb

@@ -22,7 +22,7 @@ module GoogleDrive
           if acl
             @api_permission = params_or_api_permission
             @params = nil
-            delegate_api_methods(self, @api_permission)
+            delegate_api_methods(self, @api_permission, ["value"])
           else
             @api_permission = nil
             @params = convert_params(params_or_api_permission)
@@ -63,7 +63,18 @@ module GoogleDrive
 
         # The value of the scope. See type.
         def value
-          return @params ? @params["value"] : @api_permission.value
+          if @params
+            return @params["value"]
+          else
+            case @api_permission.type
+              when "user", "group"
+                return @api_permission.email_address
+              when "domain"
+                return @api_permission.domain
+              else
+                return nil
+            end
+          end
         end
 
         alias scope value

data/lib/google_drive/session.rb

@@ -460,7 +460,10 @@ module GoogleDrive
               # Human-readable new spreadsheet/document.
               when /\/d\/([^\/]+)/
                 return $1
-              # Human-readable folder view.
+              # Human-readable new collection page.
+              when /^\/drive\/[^\/]+\/([^\/]+)/
+                return $1
+              # Human-readable old folder view.
               when /\/folderview$/
                 if (uri.query || "").split(/&/).find(){ |s| s=~ /^id=(.*)$/ }
                   return $1
@@ -472,7 +475,7 @@ module GoogleDrive
                 end
             end
             case uri.fragment
-              # Human-readable collection page.
+              # Human-readable old collection page.
               when /^folders\/(.+)$/
                 return $1
             end

data/lib/google_drive/spreadsheet.rb

@@ -6,7 +6,6 @@ require "time"
 require "google_drive/util"
 require "google_drive/error"
 require "google_drive/worksheet"
-require "google_drive/table"
 require "google_drive/acl"
 require "google_drive/file"
 
@@ -43,17 +42,6 @@ module GoogleDrive
           return "https://spreadsheets.google.com/feeds/spreadsheets/private/full/" + self.id
         end
         
-        # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-        # March 2012.
-        #
-        # Tables feed URL of the spreadsheet.
-        def tables_feed_url
-          warn(
-              "DEPRECATED: Google Spreadsheet Table and Record feeds are deprecated and they " +
-              "will not be available after March 2012.")
-          return "https://spreadsheets.google.com/feeds/%s/tables" % self.id
-        end
-
         # Returns worksheets of the spreadsheet as array of GoogleDrive::Worksheet.
         def worksheets
           doc = @session.request(:get, self.worksheets_feed_url)
@@ -95,18 +83,6 @@ module GoogleDrive
           return Worksheet.new(@session, self, doc.root)
         end
 
-        # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-        # March 2012.
-        #
-        # Returns list of tables in the spreadsheet.
-        def tables
-          warn(
-              "DEPRECATED: Google Spreadsheet Table and Record feeds are deprecated and they " +
-              "will not be available after March 2012.")
-          doc = @session.request(:get, self.tables_feed_url)
-          return doc.css("entry").map(){ |e| Table.new(@session, e) }.freeze()
-        end
-        
     end
     
 end

data/lib/google_drive/util.rb

@@ -153,15 +153,15 @@ module GoogleDrive
           return new_params
         end
 
-        def singleton_class(obj)
+        def get_singleton_class(obj)
           class << obj
             return self
           end
         end
 
         def delegate_api_methods(obj, api_obj, exceptions = [])
-          sc = singleton_class(obj)
-          names = api_obj.class.keys.keys - exceptions
+          sc = get_singleton_class(obj)
+          names = api_obj.class.keys.keys - exceptions.map(&:to_s)
           names.each() do |name|
             sc.__send__(:define_method, name) do
               api_obj.__send__(name)

data/lib/google_drive/worksheet.rb

@@ -7,7 +7,6 @@ require "uri"
 
 require "google_drive/util"
 require "google_drive/error"
-require "google_drive/table"
 require "google_drive/list"
 
 
@@ -307,7 +306,12 @@ module GoogleDrive
               value = @cells[[row, col]]
               entry = cell_entries[[row, col]]
               id = entry.css("id").text
-              edit_url = entry.css("link[rel='edit']")[0]["href"]
+              edit_link = entry.css("link[rel='edit']")[0]
+              if !edit_link
+                raise(GoogleDrive::Error,
+                    "The user doesn't have write permission to the spreadsheet: %p" % self.spreadsheet)
+              end
+              edit_url = edit_link["href"]
               xml << <<-EOS
                 <entry>
                   <batch:id>#{h(row)},#{h(col)}</batch:id>
@@ -368,54 +372,6 @@ module GoogleDrive
           return !@modified.empty?
         end
 
-        # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-        # March 2012.
-        #
-        # Creates table for the worksheet and returns GoogleDrive::Table.
-        # See this document for details:
-        # http://code.google.com/intl/en/apis/spreadsheets/docs/3.0/developers_guide_protocol.html#TableFeeds
-        def add_table(table_title, summary, columns, options)
-          
-          warn(
-              "DEPRECATED: Google Spreadsheet Table and Record feeds are deprecated and they " +
-              "will not be available after March 2012.")
-          default_options = { :header_row => 1, :num_rows => 0, :start_row => 2}
-          options = default_options.merge(options)
-
-          column_xml = ""
-          columns.each() do |index, name|
-            column_xml += "<gs:column index='#{h(index)}' name='#{h(name)}'/>\n"
-          end
-
-          xml = <<-"EOS"
-            <entry xmlns="http://www.w3.org/2005/Atom"
-              xmlns:gs="http://schemas.google.com/spreadsheets/2006">
-              <title type='text'>#{h(table_title)}</title>
-              <summary type='text'>#{h(summary)}</summary>
-              <gs:worksheet name='#{h(self.title)}' />
-              <gs:header row='#{options[:header_row]}' />
-              <gs:data numRows='#{options[:num_rows]}' startRow='#{options[:start_row]}'>
-                #{column_xml}
-              </gs:data>
-            </entry>
-          EOS
-
-          result = @session.request(:post, self.spreadsheet.tables_feed_url, :data => xml)
-          return Table.new(@session, result)
-          
-        end
-
-        # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-        # March 2012.
-        #
-        # Returns list of tables for the workwheet.
-        def tables
-          warn(
-              "DEPRECATED: Google Spreadsheet Table and Record feeds are deprecated and they " +
-              "will not be available after March 2012.")
-          return self.spreadsheet.tables.select(){ |t| t.worksheet_title == self.title }
-        end
-
         # List feed URL of the worksheet.
         def list_feed_url
           return @worksheet_feed_entry.css(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_drive
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Hiroshi Ichikawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -71,6 +71,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -78,6 +81,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,11 +133,9 @@ files:
 - lib/google_drive/file.rb
 - lib/google_drive/list.rb
 - lib/google_drive/list_row.rb
-- lib/google_drive/record.rb
 - lib/google_drive/response_code_error.rb
 - lib/google_drive/session.rb
 - lib/google_drive/spreadsheet.rb
-- lib/google_drive/table.rb
 - lib/google_drive/util.rb
 - lib/google_drive/worksheet.rb
 - lib/google_drive_v0.rb

data/lib/google_drive/record.rb

@@ -1,31 +0,0 @@
-# Author: Hiroshi Ichikawa <http://gimite.net/>
-# The license of this source is "New BSD Licence"
-
-require "google_drive/util"
-require "google_drive/error"
-
-
-module GoogleDrive
-
-    # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-    # March 2012.
-    #
-    # Use GoogleDrive::Table#records to get GoogleDrive::Record objects.
-    class Record < Hash
-        include(Util)
-
-        def initialize(session, entry) #:nodoc:
-          @session = session
-          entry.css("gs|field").each() do |field|
-            self[field["name"]] = field.inner_text
-          end
-        end
-
-        def inspect #:nodoc:
-          content = self.map(){ |k, v| "%p => %p" % [k, v] }.join(", ")
-          return "\#<%p:{%s}>" % [self.class, content]
-        end
-
-    end
-
-end

data/lib/google_drive/table.rb

@@ -1,60 +0,0 @@
-# Author: Hiroshi Ichikawa <http://gimite.net/>
-# The license of this source is "New BSD Licence"
-
-require "google_drive/util"
-require "google_drive/error"
-require "google_drive/record"
-
-
-module GoogleDrive
-
-    # DEPRECATED: Table and Record feeds are deprecated and they will not be available after
-    # March 2012.
-    #
-    # Use GoogleDrive::Worksheet#add_table to create table.
-    # Use GoogleDrive::Worksheet#tables to get GoogleDrive::Table objects.
-    class Table
-
-        include(Util)
-
-        def initialize(session, entry) #:nodoc:
-          @columns = {}
-          @worksheet_title = entry.css("gs|worksheet")[0]["name"]
-          @records_url = entry.css("content")[0]["src"]
-          @edit_url = entry.css("link[rel='edit']")[0]["href"]
-          @session = session
-        end
-
-        # Title of the worksheet the table belongs to.
-        attr_reader(:worksheet_title)
-
-        # Adds a record.
-        def add_record(values)
-          fields = ""
-          values.each() do |name, value|
-            fields += "<gs:field name='#{h(name)}'>#{h(value)}</gs:field>"
-          end
-          xml =<<-EOS
-            <entry
-                xmlns="http://www.w3.org/2005/Atom"
-                xmlns:gs="http://schemas.google.com/spreadsheets/2006">
-              #{fields}
-            </entry>
-          EOS
-          @session.request(:post, @records_url, :data => xml)
-        end
-
-        # Returns records in the table.
-        def records
-          doc = @session.request(:get, @records_url)
-          return doc.css("entry").map(){ |e| Record.new(@session, e) }
-        end
-
-        # Deletes this table. Deletion takes effect right away without calling save().
-        def delete
-          @session.request(:delete, @edit_url, :header => {"If-Match" => "*"})
-        end
-
-    end
-    
-end