google_drive 1.0.6 → 2.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63bf6efd4050300790543c7ed135632f86e61432
-  data.tar.gz: 481431da22d9bbebbf0a44067eaef26e7b05dc57
+  metadata.gz: 55c7313948e140230848e220a36ab07648790d38
+  data.tar.gz: aea2dafd3efb8cce5911a5a0475a51276bdef75f
 SHA512:
-  metadata.gz: ff5e59d1b8b1a3bfcc59a6bda70d03b71f179d896e9dcb7c7cac836ce674569929a06dcfc5e792f19fac1d23398c4b043a64951b3597544acaae42a351a652d9
-  data.tar.gz: 77f7e1b096e71e4cfe7f3c4cb745f0efa9ce202fd41bfbbb38fb52a341ac7d4d1b3af55927d9cef7ec3eadf79ac41d7b5cef9a7a269af83554c2707308625835
+  metadata.gz: b4866bc23c4cad36082f3487ad90f9b15cca81fb789c19a869770eb9d40b10651b1e40e4a10833f39a802884dba4f8a0b9855c57d4160ca9aa56ddd3621bc1fd
+  data.tar.gz: cf998e7d7ed9073c7f5f3bb3d10a29ea45fc79c99f9f1fa3c2d23d306c17e2e2e38a6d6a289db115ee678ff66179c76f2484db5d3dd42349ebccf1c27cc9b2fc

data/README.rdoc

@@ -3,11 +3,9 @@ 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 0.3.x or before to ver. 1.0.x
+= Migration from ver. 0.x.x / 1.x.x to to ver. 2.x.x
 
-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.
-
-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.
+There are some incompatible API changes. See {MIGRATING.md}[https://github.com/gimite/google-drive-ruby/blob/master/MIGRATING.md].
 
 
 = How to install
@@ -28,7 +26,6 @@ Next, create a file config.json which contains the client ID and crient secret y
 
 Example to read/write files in Google Drive:
 
-  require "google/api_client"
   require "google_drive"
 
   # Creates a session. This will prompt the credential via command line for the
@@ -52,7 +49,6 @@ Example to read/write files in Google Drive:
 
 Example to read/write spreadsheets:
 
-  require "google/api_client"
   require "google_drive"
 
   # Creates a session. This will prompt the credential via command line for the
@@ -97,7 +93,7 @@ The license of this source is "New BSD Licence"
 
 = Supported environments
 
-Ruby 1.9.x or later. Checked with Ruby 1.9.3 and 2.2.1.
+Ruby 2.0.0 or later. Checked with Ruby 2.3.0.
 
 
 = Author

data/doc_src/google_drive/acl.rb

@@ -1,20 +1,16 @@
 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
-        
+  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

data/lib/google_drive.rb

@@ -2,177 +2,147 @@
 # The license of this source is "New BSD Licence"
 
 require 'json'
-require 'google/api_client'
+require 'googleauth'
 
 require 'google_drive/session'
 
 module GoogleDrive
-    # Authenticates with given OAuth2 token.
-    #
-    # +access_token+ can be either OAuth2 access_token string, or OAuth2::AccessToken.
-    #
-    # OAuth2 code example for Web apps:
-    #
-    #   require "rubygems"
-    #   require "google/api_client"
-    #   client = Google::APIClient.new
-    #   auth = client.authorization
-    #   # Follow Step 1 and 2 of “Authorizing requests with OAuth 2.0” in
-    #   # https://developers.google.com/drive/v3/web/about-auth to get a client ID and client secret.
-    #   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 = "http://example.com/redirect"
-    #   auth_url = auth.authorization_uri
-    #   # Redirect the user to auth_url and get authorization code from redirect URL.
-    #   auth.code = authorization_code
-    #   auth.fetch_access_token!
-    #   session = GoogleDrive.login_with_oauth(auth.access_token)
-    #
-    # auth.access_token expires in 1 hour. If you want to restore a session afterwards, you can store
-    # auth.refresh_token somewhere after auth.fetch_access_token! above, and use this code:
-    #
-    #   require "rubygems"
-    #   require "google/api_client"
-    #   client = Google::APIClient.new
-    #   auth = client.authorization
-    #   # Follow "Create a client ID and client secret" in
-    #   # https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret.
-    #   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 = "http://example.com/redirect"
-    #   auth.refresh_token = refresh_token
-    #   auth.fetch_access_token!
-    #   session = GoogleDrive.login_with_oauth(auth.access_token)
-    #
-    # OAuth2 code example for command-line apps:
-    #
-    #   require "rubygems"
-    #   require "google/api_client"
-    #   client = Google::APIClient.new
-    #   auth = client.authorization
-    #   # Follow "Create a client ID and client secret" in
-    #   # https://developers.google.com/drive/web/auth/web-server] to get a client ID and client secret.
-    #   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!
-    #   session = GoogleDrive.login_with_oauth(auth.access_token)
-    #
-    # See this document for details:
-    #
-    # - https://developers.google.com/drive/web/about-auth
-    def self.login_with_oauth(client_or_access_token, proxy = nil)
-      return Session.new(client_or_access_token, proxy)
-    end
-
-    # Returns GoogleDrive::Session constructed from a config JSON file at +path+.
-    #
-    # Follow the following steps to use this method:
-    #
-    # 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.
-    #
-    # Next, create a file config.json which contains the client ID and client secret you got
-    # above, which looks like:
-    #
-    #   {
-    #     "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
-    #     "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
-    #   }
-    #
-    # Then you can construct a GoogleDrive::Session by:
-    #
-    #   session = GoogleDrive.saved_session("config.json")
-    #
-    # This will prompt the credential via command line for the first time and save it to
-    # config.json file for later usages.
-    #
-    # +path+ defaults to ENV["HOME"] + "/.ruby_google_drive.token".
-    #
-    # If the file doesn't exist or client ID/secret are not given in the file, the default client
-    # ID/secret embedded in the library is used.
-    #
-    # You can also provide a config object that must respond to:
-    #   client_id
-    #   client_secret
-    #   refesh_token
-    #   refresh_token=
-    #   scope
-    #   scope=
-    #   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
+  # Authenticates with given OAuth2 token.
+  #
+  # +access_token+ can be either OAuth2 access_token string, OAuth2::AccessToken
+  # or credentials generated by googleauth library.
+  #
+  # OAuth2 code example for Web apps:
+  #
+  #   require "googleauth"
+  #   
+  #   credentials = Google::Auth::UserRefreshCredentials.new(
+  #     client_id: "YOUR CLIENT ID",
+  #     client_secret: "YOUR CLIENT SECRET",
+  #     scope: [
+  #       "https://www.googleapis.com/auth/drive",
+  #       "https://spreadsheets.google.com/feeds/",
+  #     ],
+  #     redirect_uri: "http://example.com/redirect")
+  #   auth_url = credentials.authorization_uri
+  #   # Redirect the user to auth_url and get authorization code from redirect URL.
+  #   credentials.code = authorization_code
+  #   credentials.fetch_access_token!
+  #   session = GoogleDrive.login_with_oauth(credentials)
+  #
+  # auth.access_token expires in 1 hour. If you want to restore a session afterwards, you can store
+  # auth.refresh_token somewhere after auth.fetch_access_token! above, and use this code:
+  #
+  #   require "googleauth"
+  #   
+  #   credentials = Google::Auth::UserRefreshCredentials.new(
+  #     client_id: "YOUR CLIENT ID",
+  #     client_secret: "YOUR CLIENT SECRET",
+  #     scope: [
+  #       "https://www.googleapis.com/auth/drive",
+  #       "https://spreadsheets.google.com/feeds/",
+  #     ],
+  #     redirect_uri: "http://example.com/redirect")
+  #   auth.refresh_token = refresh_token
+  #   auth.fetch_access_token!
+  #   session = GoogleDrive.login_with_oauth(auth.access_token)
+  #
+  # For command-line apps, it would be easier to use saved_session method instead.
+  def self.login_with_oauth(client_or_access_token, proxy = nil)
+    Session.new(client_or_access_token, proxy)
+  end
 
-      config.scope ||= [
-          'https://www.googleapis.com/auth/drive',
-          'https://spreadsheets.google.com/feeds/',
-      ]
+  # Returns GoogleDrive::Session constructed from a config JSON file at +path+.
+  #
+  # Follow the following steps to use this method:
+  #
+  # 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.
+  #
+  # Next, create a file config.json which contains the client ID and client secret you got
+  # above, which looks like:
+  #
+  #   {
+  #     "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+  #     "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
+  #   }
+  #
+  # Then you can construct a GoogleDrive::Session by:
+  #
+  #   session = GoogleDrive.saved_session("config.json")
+  #
+  # This will prompt the credential via command line for the first time and save it to
+  # config.json file for later usages.
+  #
+  # +path+ defaults to ENV["HOME"] + "/.ruby_google_drive.token".
+  #
+  # If the file doesn't exist or client ID/secret are not given in the file, the default client
+  # ID/secret embedded in the library is used.
+  #
+  # You can also provide a config object that must respond to:
+  #   client_id
+  #   client_secret
+  #   refesh_token
+  #   refresh_token=
+  #   scope
+  #   scope=
+  #   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
 
-      if client_id && client_secret
-        config.client_id = client_id
-        config.client_secret = client_secret
-      end
-      if !config.client_id && !config.client_secret
-        config.client_id = "452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com"
-        config.client_secret = "1U3-Krii5x1oLPrwD5zgn-ry"
-      elsif !config.client_id || !config.client_secret
-        raise(ArgumentError, "client_id and client_secret must be both specified or both omitted")
-      end
+    config.scope ||= [
+      'https://www.googleapis.com/auth/drive',
+      'https://spreadsheets.google.com/feeds/'
+    ]
 
-      if proxy
-        raise(
-            ArgumentError,
-            'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
-      end
+    if client_id && client_secret
+      config.client_id = client_id
+      config.client_secret = client_secret
+    end
+    if !config.client_id && !config.client_secret
+      config.client_id = '452925651630-egr1f18o96acjjvphpbbd1qlsevkho1d.apps.googleusercontent.com'
+      config.client_secret = '1U3-Krii5x1oLPrwD5zgn-ry'
+    elsif !config.client_id || !config.client_secret
+      fail(ArgumentError, 'client_id and client_secret must be both specified or both omitted')
+    end
 
-      refresh_token = config.refresh_token
+    if proxy
+      fail(
+        ArgumentError,
+        'Specifying a proxy object is no longer supported. Set ENV["http_proxy"] instead.')
+    end
 
-      client = Google::APIClient.new(
-        :application_name => 'google_drive Ruby library',
-        :application_version => '0.4.0'
-      )
+    refresh_token = config.refresh_token
 
-      auth = client.authorization
-      auth.client_id = config.client_id
-      auth.client_secret = config.client_secret
-      auth.scope = config.scope
-      auth.redirect_uri = 'urn:ietf:wg:oauth:2.0:oob'
+    credentials = Google::Auth::UserRefreshCredentials.new(
+      client_id: config.client_id,
+      client_secret: config.client_secret,
+      scope: config.scope,
+      redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
 
-      if config.refresh_token
-        auth.refresh_token = config.refresh_token
-        auth.fetch_access_token!
-      else
-        $stderr.print("\n1. Open this page:\n%s\n\n" % auth.authorization_uri)
-        $stderr.print('2. Enter the authorization code shown in the page: ')
-        auth.code = $stdin.gets.chomp
-        auth.fetch_access_token!
-        config.refresh_token = auth.refresh_token
-      end
+    if config.refresh_token
+      credentials.refresh_token = config.refresh_token
+      credentials.fetch_access_token!
+    else
+      $stderr.print("\n1. Open this page:\n%s\n\n" % credentials.authorization_uri)
+      $stderr.print('2. Enter the authorization code shown in the page: ')
+      credentials.code = $stdin.gets.chomp
+      credentials.fetch_access_token!
+      config.refresh_token = credentials.refresh_token
+    end
 
-      config.save
+    config.save
 
-      return GoogleDrive.login_with_oauth(client)
-    end
+    GoogleDrive.login_with_oauth(credentials)
+  end
 end

data/lib/google_drive/acl.rb

@@ -3,106 +3,90 @@
 # Author: Hiroshi Ichikawa <http://gimite.net/>
 # The license of this source is "New BSD Licence"
 
-require "google_drive/acl_entry"
+require 'google_drive/acl_entry'
 
 module GoogleDrive
+  # ACL (access control list) of a spreadsheet.
+  #
+  # Use GoogleDrive::Spreadsheet#acl to get GoogleDrive::Acl object.
+  # See GoogleDrive::Spreadsheet#acl for usage example.
+  #
+  # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
+  class Acl
+    include(Util)
+    extend(Forwardable)
 
-    # ACL (access control list) of a spreadsheet.
-    #
-    # Use GoogleDrive::Spreadsheet#acl to get GoogleDrive::Acl object.
-    # See GoogleDrive::Spreadsheet#acl for usage example.
-    #
-    # This code is based on https://github.com/guyboertje/gdata-spreadsheet-ruby .
-    class Acl
-
-        include(Util)
-        extend(Forwardable)
-
-        def initialize(session, file) #:nodoc:
-          @session = session
-          @file = file
-          api_result = @session.execute!(
-              :api_method => @session.drive.permissions.list,
-              :parameters => { "fileId" => @file.id })
-          @entries = api_result.data.items.map(){ |i| AclEntry.new(i, self) }
-        end
-
-        def_delegators(:@entries, :size, :[], :each)
-
-        # Adds a new entry. +entry+ is either a GoogleDrive::AclEntry or a Hash with keys
-        # :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.
-        #   # A specific user can read or write.
-        #   spreadsheet.acl.push(
-        #       {:type => "user", :value => "example2@gmail.com", :role => "reader"})
-        #   spreadsheet.acl.push(
-        #       {:type => "user", :value => "example3@gmail.com", :role => "writer"})
-        #   # Publish on the Web.
-        #   spreadsheet.acl.push(
-        #       {:type => "anyone", :role => "reader"})
-        #   # 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, 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 => options.merge({ "fileId" => @file.id }))
-          new_entry = AclEntry.new(api_result.data, self)
-          @entries.push(new_entry)
-          return new_entry
-        end
+    def initialize(session, file) #:nodoc:
+      @session = session
+      @file = file
+      api_permissions = @session.drive.list_permissions(@file.id, fields: '*')
+      @entries = api_permissions.permissions.map { |perm| AclEntry.new(perm, self) }
+    end
 
-        # Deletes an ACL entry.
-        #
-        # e.g.
-        #   spreadsheet.acl.delete(spreadsheet.acl[1])
-        def delete(entry)
-          @session.execute!(
-              :api_method => @session.drive.permissions.delete,
-              :parameters => {
-                  "fileId" => @file.id,
-                  "permissionId" => entry.id,
-                })
-          @entries.delete(entry)
-        end
+    def_delegators(:@entries, :size, :[], :each)
 
-        def update_role(entry) #:nodoc:
-          api_result = @session.execute!(
-              :api_method => @session.drive.permissions.update,
-              :body_object => entry.api_permission,
-              :parameters => {
-                  "fileId" => @file.id,
-                  "permissionId" => entry.id,
-              })
-          entry.api_permission = api_result.data
-          return entry
-        end
+    # Adds a new entry. +entry+ is either a GoogleDrive::AclEntry or a Hash with keys
+    # +:type+, +:email_address+, +:domain+, +:role+ and +:allow_file_discovery+.
+    # See GoogleDrive::AclEntry#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.
+    #   # A specific user can read or write.
+    #   spreadsheet.acl.push(
+    #       {type: "user", email_address: "example2@gmail.com", role: "reader"})
+    #   spreadsheet.acl.push(
+    #       {type: "user", email_address: "example3@gmail.com", role: "writer"})
+    #   # Share with a Google Apps domain.
+    #   spreadsheet.acl.push(
+    #       {type: "domain", domain: "gimite.net", role: "reader"})
+    #   # Publish on the Web.
+    #   spreadsheet.acl.push(
+    #       {type: "anyone", role: "reader"})
+    #   # Anyone who knows the link can read.
+    #   spreadsheet.acl.push(
+    #       {type: "anyone", allow_file_discovery: false, role: "reader"})
+    #   # Set ACL without sending notification emails
+    #   spreadsheet.acl.push(
+    #       {type: "user", email_address: "example2@gmail.com", role: "reader"},
+    #       {sendNotificationEmails: false})
+    #
+    # See here for parameter detais:
+    # 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: '*')
+      new_entry = AclEntry.new(api_permission, self)
+      @entries.push(new_entry)
+      new_entry
+    end
 
-        def inspect
-          return "\#<%p %p>" % [self.class, @entries]
-        end
+    # Deletes an ACL entry.
+    #
+    # e.g.
+    #   spreadsheet.acl.delete(spreadsheet.acl[1])
+    def delete(entry)
+      @session.drive.delete_permission(@file.id, entry.id)
+      @entries.delete(entry)
+    end
 
+    def update_role(entry) #:nodoc:
+      api_permission = @session.drive.update_permission(
+        @file.id, entry.id, {role: entry.role}, fields: '*')
+      entry.api_permission = api_permission
+      entry
     end
 
+    def inspect
+      "\#<%p %p>" % [self.class, @entries]
+    end
+  end
 end